list_global_tables¶
Operation¶
list_global_tables
¶
list_global_tables(request: ListGlobalTablesInput | ListGlobalTablesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGlobalTablesInputDict]) -> ListGlobalTablesOutput
Lists all global tables that have a replica in the specified Region.
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
|
ListGlobalTablesInput | ListGlobalTablesInputDict | 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[ListGlobalTablesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGlobalTablesOutput
|
An instance of |
list_global_tables
async
¶
list_global_tables(request: ListGlobalTablesInput | ListGlobalTablesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListGlobalTablesInputDict]) -> ListGlobalTablesOutput
Lists all global tables that have a replica in the specified Region.
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
|
ListGlobalTablesInput | ListGlobalTablesInputDict | 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[ListGlobalTablesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListGlobalTablesOutput
|
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.
ListGlobalTablesInputDict
¶
Bases: TypedDict
Dictionary form of ListGlobalTablesInput.
Attributes¶
exclusive_start_global_table_name
instance-attribute
¶
exclusive_start_global_table_name: str | None
The first global table name that this operation will evaluate.
limit
instance-attribute
¶
limit: int | None
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it
stops the operation and returns the table names collected up to that
point, with a table name in the LastEvaluatedGlobalTableName to apply
in a subsequent operation to the ExclusiveStartGlobalTableName
parameter.
ListGlobalTablesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGlobalTablesInput structure.
Attributes¶
exclusive_start_global_table_name
class-attribute
instance-attribute
¶
exclusive_start_global_table_name: str | None = ...
The first global table name that this operation will evaluate.
limit
class-attribute
instance-attribute
¶
limit: int | None = ...
The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.
If the number of global tables DynamoDB finds reaches this limit, it
stops the operation and returns the table names collected up to that
point, with a table name in the LastEvaluatedGlobalTableName to apply
in a subsequent operation to the ExclusiveStartGlobalTableName
parameter.
Output¶
ListGlobalTablesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListGlobalTablesOutput structure.
Attributes¶
global_tables
class-attribute
instance-attribute
¶
global_tables: list[GlobalTable] | None = ...
List of global table names.
last_evaluated_global_table_name
class-attribute
instance-attribute
¶
last_evaluated_global_table_name: str | None = ...
Last evaluated global table name.
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.