describe_global_table_settings¶
Operation¶
describe_global_table_settings
¶
describe_global_table_settings(request: DescribeGlobalTableSettingsInput | DescribeGlobalTableSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGlobalTableSettingsInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeGlobalTableSettingsInput | DescribeGlobalTableSettingsInputDict | 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[DescribeGlobalTableSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeGlobalTableSettingsOutput
|
An instance of |
describe_global_table_settings
async
¶
describe_global_table_settings(request: DescribeGlobalTableSettingsInput | DescribeGlobalTableSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeGlobalTableSettingsInputDict]) -> 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 |
|---|---|---|---|
request
|
DescribeGlobalTableSettingsInput | DescribeGlobalTableSettingsInputDict | 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[DescribeGlobalTableSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DescribeGlobalTableSettingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DescribeGlobalTableSettingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeGlobalTableSettingsOutput structure.
Attributes¶
global_table_name
class-attribute
instance-attribute
¶
global_table_name: str | None = ...
The name of the global table.
replica_settings
class-attribute
instance-attribute
¶
replica_settings: list[ReplicaSettingsDescription] | None = ...
The Region-specific settings for the global table.
response_metadata
class-attribute
instance-attribute
¶
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.