Skip to content

DynamoDB  >  Operations  >  describe_global_table_settings

describe_global_table_settings

Operation

describe_global_table_settings async

describe_global_table_settings(input: DescribeGlobalTableSettingsInput, plugins: list[Plugin] | None = None) -> DescribeGlobalTableSettingsOutput

Describes Region-specific settings for a global table.

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.

Parameters:

Name Type Description Default
input DescribeGlobalTableSettingsInput

An instance of DescribeGlobalTableSettingsInput.

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
DescribeGlobalTableSettingsOutput

An instance of DescribeGlobalTableSettingsOutput.

Input

DescribeGlobalTableSettingsInput dataclass

Dataclass for DescribeGlobalTableSettingsInput structure.

Attributes

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

The name of the global table to describe.

Output

DescribeGlobalTableSettingsOutput dataclass

Dataclass for DescribeGlobalTableSettingsOutput structure.

Attributes

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

The name of the global table.

replica_settings class-attribute instance-attribute
replica_settings: list[ReplicaSettingsDescription] | None = None

The Region-specific settings for the global table.