Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1453442446.0 KB

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

This operation only applies to Version 2019.11.21 (Current) of global tables.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

post/#X-Amz-Target=DynamoDB_20120810.UpdateTable

Headers

X-Amz-Target'DynamoDB_20120810.UpdateTable' required

Request body

TableNamestring required

The name of the table to be updated.

BillingMode'PROVISIONED' | 'PAY_PER_REQUEST'
<p>Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.</p> <ul> <li> <p> <code>PROVISIONED</code> - We recommend using <code>PROVISIONED</code> for predictable workloads. <code>PROVISIONED</code> sets the billing mode to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual">Provisioned Mode</a>.</p> </li> <li> <p> <code>PAY_PER_REQUEST</code> - We recommend using <code>PAY_PER_REQUEST</code> for unpredictable workloads. <code>PAY_PER_REQUEST</code> sets the billing mode to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand">On-Demand Mode</a>. </p> </li> </ul>
TableClass'STANDARD' | 'STANDARD_INFREQUENT_ACCESS'

The table class of the table to be updated. Valid values are <code>STANDARD</code> and <code>STANDARD_INFREQUENT_ACCESS</code>.

DeletionProtectionEnabledboolean

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

Response

Success

Example response

{
  "TableDescription": {
    "AttributeDefinitions": [
      {
        "AttributeName": "Artist",
        "AttributeType": "S"
      },
      {
        "AttributeName": "SongTitle",
        "AttributeType": "S"
      }
    ],
    "CreationDateTime": "1421866952.062",
    "ItemCount": 0,
    "KeySchema": [
      {
        "AttributeName": "Artist",
        "KeyType": "HASH"
      },
      {
        "AttributeName": "SongTitle",
        "KeyType": "RANGE"
      }
    ],
    "ProvisionedThroughput": {
      "LastIncreaseDateTime": "1421874759.194",
      "NumberOfDecreasesToday": 1,
      "ReadCapacityUnits": 1,
      "WriteCapacityUnits": 1
    },
    "TableName": "MusicCollection",
    "TableSizeBytes": 0,
    "TableStatus": "UPDATING"
  }
}