Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dynamodb ]

list-global-tables

Description

Lists all global tables that have a replica in the specified Region.

Note

This method only applies to Version 2017.11.29 of global tables.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-global-tables
[--exclusive-start-global-table-name <value>]
[--limit <value>]
[--region-name <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--exclusive-start-global-table-name (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.

--region-name (string)

Lists the global tables in a specific Region.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To list existing DynamoDB global tables

The following list-global-tables example lists all of your existing global tables.

aws dynamodb list-global-tables

Output:

{
    "GlobalTables": [
        {
            "GlobalTableName": "MusicCollection",
            "ReplicationGroup": [
                {
                    "RegionName": "us-east-2"
                },
                {
                    "RegionName": "us-east-1"
                }
            ]
        }
    ]
}

For more information, see DynamoDB Global Tables in the Amazon DynamoDB Developer Guide.

Output

GlobalTables -> (list)

List of global table names.

(structure)

Represents the properties of a global table.

GlobalTableName -> (string)

The global table name.

ReplicationGroup -> (list)

The Regions where the global table has replicas.

(structure)

Represents the properties of a replica.

RegionName -> (string)

The Region where the replica needs to be created.

LastEvaluatedGlobalTableName -> (string)

Last evaluated global table name.