DynamoDB / Client / list_global_tables

list_global_tables#

DynamoDB.Client.list_global_tables(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_global_tables(
    ExclusiveStartGlobalTableName='string',
    Limit=123,
    RegionName='string'
)
Parameters:

  • ExclusiveStartGlobalTableName (string) – The first global table name that this operation will evaluate.

  • Limit (integer) –

    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.

  • RegionName (string) – Lists the global tables in a specific Region.

Return type:

dict

Returns:

Response Syntax

{
    'GlobalTables': [
        {
            'GlobalTableName': 'string',
            'ReplicationGroup': [
                {
                    'RegionName': 'string'
                },
            ]
        },
    ],
    'LastEvaluatedGlobalTableName': 'string'
}

Response Structure

  • (dict) –

    • GlobalTables (list) –

      List of global table names.

      • (dict) –

        Represents the properties of a global table.

        • GlobalTableName (string) –

          The global table name.

        • ReplicationGroup (list) –

          The Regions where the global table has replicas.

          • (dict) –

            Represents the properties of a replica.

            • RegionName (string) –

              The Region where the replica needs to be created.

    • LastEvaluatedGlobalTableName (string) –

      Last evaluated global table name.

Exceptions

  • DynamoDB.Client.exceptions.InternalServerError