Skip to content

update_global_table

Operation

update_global_table

update_global_table(request: UpdateGlobalTableInput | UpdateGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGlobalTableInputDict]) -> UpdateGlobalTableOutput

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Warning

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

Note: If you are using global tables Version 2019.11.21 (Current) you can use UpdateTable instead.

Although you can use `UpdateGlobalTable` to add replicas and remove
replicas in a single request, for simplicity we recommend that you issue
separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

Parameters:

Name Type Description Default
request UpdateGlobalTableInput | UpdateGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGlobalTableOutput

An instance of UpdateGlobalTableOutput.

update_global_table async

update_global_table(request: UpdateGlobalTableInput | UpdateGlobalTableInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateGlobalTableInputDict]) -> UpdateGlobalTableOutput

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Warning

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

Note: If you are using global tables Version 2019.11.21 (Current) you can use UpdateTable instead.

Although you can use `UpdateGlobalTable` to add replicas and remove
replicas in a single request, for simplicity we recommend that you issue
separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

Parameters:

Name Type Description Default
request UpdateGlobalTableInput | UpdateGlobalTableInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[UpdateGlobalTableInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateGlobalTableOutput

An instance of UpdateGlobalTableOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

UpdateGlobalTableInputDict

Bases: TypedDict

Dictionary form of UpdateGlobalTableInput.

Attributes

global_table_name instance-attribute
global_table_name: Required[str]

The global table name.

replica_updates instance-attribute

A list of Regions that should be added or removed from the global table.

UpdateGlobalTableInput dataclass

Bases: _SerdeShape

Dataclass for UpdateGlobalTableInput structure.

Attributes

global_table_name class-attribute instance-attribute
global_table_name: str | None = ...

The global table name.

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

A list of Regions that should be added or removed from the global table.

Output

UpdateGlobalTableOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateGlobalTableOutput structure.

Attributes

global_table_description class-attribute instance-attribute
global_table_description: GlobalTableDescription | None = ...

Contains the details of the global table.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.