Skip to content

DynamoDB  >  Operations  >  update_table

update_table

Operation

update_table async 

update_table(input: UpdateTableInput, plugins: list[Plugin] | None = None) -> UpdateTableOutput

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

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.

Parameters:

Name Type Description Default
input UpdateTableInput

An instance of UpdateTableInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateTableOutput

An instance of UpdateTableOutput.

Input

UpdateTableInput dataclass

Represents the input of an UpdateTable operation.

Attributes

attribute_definitions class-attribute instance-attribute 
attribute_definitions: list[AttributeDefinition] | None = None

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

billing_mode class-attribute instance-attribute 
billing_mode: BillingMode | None = None

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.

  • PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

  • PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode.

deletion_protection_enabled class-attribute instance-attribute 
deletion_protection_enabled: bool | None = None

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

global_secondary_index_updates class-attribute instance-attribute 
global_secondary_index_updates: list[GlobalSecondaryIndexUpdate] | None = None

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

global_table_settings_replication_mode class-attribute instance-attribute 
global_table_settings_replication_mode: GlobalTableSettingsReplicationMode | None = None

Controls the settings replication mode for a global table replica. This attribute can be defined using UpdateTable operation only on a regional table with values:

  • ENABLED: Defines settings replication on a regional table to be used as a source table for creating Multi-Account Global Table.

  • DISABLED: Remove settings replication on a regional table. Settings replication needs to be defined to ENABLED again in order to create a Multi-Account Global Table using this table.

global_table_witness_updates class-attribute instance-attribute 
global_table_witness_updates: list[GlobalTableWitnessGroupUpdate] | None = None

A list of witness updates for a MRSC global table. A witness provides a cost-effective alternative to a full replica in a MRSC global table by maintaining replicated change data written to global table replicas. You cannot perform read or write operations on a witness. For each witness, you can request one action:

  • Create - add a new witness to the global table.

  • Delete - remove a witness from the global table.

You can create or delete only one witness per UpdateTable operation.

For more information, see Multi-Region strong consistency (MRSC) in the Amazon DynamoDB Developer Guide

multi_region_consistency class-attribute instance-attribute 
multi_region_consistency: MultiRegionConsistency | None = None

Specifies the consistency mode for a new global table. This parameter is only valid when you create a global table by specifying one or more Create actions in the ReplicaUpdates action list.

You can specify one of the following consistency modes:

  • EVENTUAL: Configures a new global table for multi-Region eventual consistency (MREC). This is the default consistency mode for global tables.

  • STRONG: Configures a new global table for multi-Region strong consistency (MRSC).

If you don't specify this field, the global table consistency mode defaults to EVENTUAL. For more information about global tables consistency modes, see Consistency modes in DynamoDB developer guide.

on_demand_throughput class-attribute instance-attribute 
on_demand_throughput: OnDemandThroughput | None = None

Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

provisioned_throughput class-attribute instance-attribute 
provisioned_throughput: ProvisionedThroughput | None = None

The new provisioned throughput settings for the specified table or index.

replica_updates class-attribute instance-attribute 
replica_updates: list[ReplicationGroupUpdate] | None = None

A list of replica update actions (create, delete, or update) for the table.

sse_specification class-attribute instance-attribute 
sse_specification: SSESpecification | None = None

The new server-side encryption settings for the specified table.

stream_specification class-attribute instance-attribute 
stream_specification: StreamSpecification | None = None

Represents the DynamoDB Streams configuration for the table.

Note

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

table_class class-attribute instance-attribute 
table_class: TableClass | None = None

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

table_name class-attribute instance-attribute 
table_name: str | None = None

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

vector_index_updates class-attribute instance-attribute 
vector_index_updates: list[VectorIndexUpdate] | None = None

A list of vector indexes to be added to or removed from the table. You can add or remove one vector index for each UpdateTable operation.

To add a vector index, specify IndexName, VectorAttribute, Dimensions, DistanceFunction, and Projection. To remove a vector index, specify only the IndexName.

warm_throughput class-attribute instance-attribute 
warm_throughput: WarmThroughput | None = None

Represents the warm throughput (in read units per second and write units per second) for updating a table.

Output

UpdateTableOutput dataclass

Represents the output of an UpdateTable operation.

Attributes

table_description class-attribute instance-attribute 
table_description: TableDescription | None = None

Represents the properties of the table.