UpdateTable

Last Updated: Nov 07, 2017

Action:

This API updates the reserved read or write throughput settings of the specified table. The new settings will take effect within one minute of a successful update.

Request structure:

  1. message UpdateTableRequest {
  2. required string table_name = 1;
  3. optional ReservedThroughput reserved_throughput = 2;
  4. optional TableOptions table_options = 3;
  5. optional StreamSpecification stream_spec = 4;
  6. }

table_name:

  • Type: String

  • Required parameter: Yes

  • The name of the table for which the reserved read/write throughput settings are to be modified.

reserved_throughput:

  • Type: ReservedThroughput

  • Required parameter: Yes

  • The reserved read/write throughput settings to be modified for the table. These settings will take effect in one minute.

  • You may modify either the table’s reserved read or write throughput settings, or both.

  • In capacity_unit, read and write should at least have a non-null value. Otherwise, the request will fail and an error will be returned.

table_options:

  • Type: TableOptions

  • Required parameter: Yes

  • Sets TimeToLive and MaxVersions.

StreamSpecification:

  • Type: StreamSpecification

  • Required parameter: No

  • Specifies whether to enable Stream-related attributes.

Response message structure:

  1. message UpdateTableResponse {
  2. required ReservedThroughputDetails reserved_throughput_details = 1;
  3. required TableOptions table_options = 2;
  4. }

capacity_unit_details:

  • Type: ReservedThroughputDetails

  • After the update, besides containing the current reserved read/write throughput settings, the table’s reserved read/write throughput settings information will also contain the time these settings were last updated and the number of times they have been lowered for the current date.

Note:

  • The minimum time interval between adjustments to a table’s reserved read/write throughput is two minutes. If the current UpdateTable operation comes less than two minutes after the last one, it will be rejected.
  • Within a single calendar day (from 00:00:00 to 00:00:00 the next day in UTC time), each table’s reserved read/write throughput may be raised and lowered an unlimited number of times.

table_options:

  • Type: TableOptions

  • The latest value of the table_options parameter after the modification.

Thank you! We've received your feedback.