[ aws . dynamodb ]

describe-global-table

Description

Returns information about the specified global table.

Note

This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use DescribeTable instead.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-global-table
--global-table-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--global-table-name (string)

The name of the global table.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 display information about a DynamoDB global table

The following describe-global-table example displays details about the MusicCollection global table.

aws dynamodb describe-global-table \
    --global-table-name MusicCollection

Output:

{
    "GlobalTableDescription": {
        "ReplicationGroup": [
            {
                "RegionName": "us-east-2"
            },
            {
                "RegionName": "us-east-1"
            }
        ],
        "GlobalTableArn": "arn:aws:dynamodb::123456789012:global-table/MusicCollection",
        "CreationDateTime": 1576625818.532,
        "GlobalTableStatus": "ACTIVE",
        "GlobalTableName": "MusicCollection"
    }
}

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

Output

GlobalTableDescription -> (structure)

Contains the details of the global table.

ReplicationGroup -> (list)

The Regions where the global table has replicas.

(structure)

Contains the details of the replica.

RegionName -> (string)

The name of the Region.

ReplicaStatus -> (string)

The current state of the replica:

• CREATING - The replica is being created.

• UPDATING - The replica is being updated.

• DELETING - The replica is being deleted.

• ACTIVE - The replica is ready for use.

• REGION_DISABLED - The replica is inaccessible because the AWS Region has been disabled.

Note

If the AWS Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

• INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table is inaccessible.

Note

If the AWS KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.

ReplicaStatusDescription -> (string)

Detailed information about the replica status.

ReplicaStatusPercentProgress -> (string)

Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.

KMSMasterKeyId -> (string)

The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.

ProvisionedThroughputOverride -> (structure)

Replica-specific provisioned throughput. If not described, uses the source table’s provisioned throughput settings.

ReadCapacityUnits -> (long)

Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.

GlobalSecondaryIndexes -> (list)

Replica-specific global secondary index settings.

(structure)

Represents the properties of a replica global secondary index.

IndexName -> (string)

The name of the global secondary index.

ProvisionedThroughputOverride -> (structure)

If not described, uses the source table GSI’s read capacity settings.

ReadCapacityUnits -> (long)

Replica-specific read capacity units. If not specified, uses the source table’s read capacity settings.

ReplicaInaccessibleDateTime -> (timestamp)

The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.

GlobalTableArn -> (string)

The unique identifier of the global table.

CreationDateTime -> (timestamp)

The creation time of the global table.

GlobalTableStatus -> (string)

The current state of the global table:

• CREATING - The global table is being created.

• UPDATING - The global table is being updated.

• DELETING - The global table is being deleted.

• ACTIVE - The global table is ready for use.

GlobalTableName -> (string)

The global table name.