IAmazonDynamoDB.UpdateTable Method (UpdateTableRequest)

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's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateTableAsync.

Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public abstract UpdateTableResponse UpdateTable(
         UpdateTableRequest request
)

Parameters

request: Type: Amazon.DynamoDBv2.Model.UpdateTableRequest

Container for the necessary parameters to execute the UpdateTable service method.

Return Value

Type: UpdateTableResponse

The response from the UpdateTable service method, as returned by DynamoDB.

Exceptions

Exception	Condition
InternalServerErrorException	An error occurred on the server side.
LimitExceededException	There is no limit to the number of daily on-demand backups that can be taken. For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime. When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations. When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account. There is a soft account quota of 2,500 tables. GetRecords was called with a value of more than 1000 for the limit request parameter. More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.
ResourceInUseException	The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.
ResourceNotFoundException	The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

Examples

This example shows how to update the throughput settings of a table. New throughput will be 40 ReadCapacityUnits and 50 WriteCapacityUnits.

UpdateTable sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define new table throughput:
//  Table will now have capacity of 40 reads and 50 writes
ProvisionedThroughput throughput = new ProvisionedThroughput
{
    ReadCapacityUnits = 40,
    WriteCapacityUnits = 50
};

// Compose the UpdateTable request
UpdateTableRequest request = new UpdateTableRequest
{
    TableName = "SampleTable",
    ProvisionedThroughput = throughput
};

// View new table properties
TableDescription tableDescription = client.UpdateTable(request).TableDescription;
Console.WriteLine("Table name: {0}", tableDescription.TableName);
Console.WriteLine("Throughput: Reads = {0}, Writes = {1}",
    tableDescription.ProvisionedThroughput.ReadCapacityUnits,
    tableDescription.ProvisionedThroughput.WriteCapacityUnits);

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonDynamoDB.UpdateTable (UpdateTableRequest)

Method