Skip to content

aws.dynamodb.describe_global_table

Example SQL Queries

SELECT * FROM
aws.dynamodb.describe_global_table
WHERE
"global_table_name" = 'VALUE';

Description

Returns information about the specified global table.

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.

Table Definition

Column NameColumn Data Type
global_table_name Required Input Column

The name of the global table.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
global_table_description

Contains the details of the global table.

STRUCT(
"replication_group" STRUCT(
"region_name" VARCHAR,
"replica_status" VARCHAR,
"replica_status_description" VARCHAR,
"replica_status_percent_progress" VARCHAR,
"kms_master_key_id" VARCHAR,
"provisioned_throughput_override" STRUCT(
"read_capacity_units" BIGINT
),
"on_demand_throughput_override" STRUCT(
"max_read_request_units" BIGINT
),
"global_secondary_indexes" STRUCT(
"index_name" VARCHAR,
"provisioned_throughput_override" STRUCT(
"read_capacity_units" BIGINT
),
"on_demand_throughput_override" STRUCT(
"max_read_request_units" BIGINT
)
)[],
"replica_inaccessible_date_time" TIMESTAMP_S,
"replica_table_class_summary" STRUCT(
"table_class" VARCHAR,
"last_update_date_time" TIMESTAMP_S
)
)[],
"global_table_arn" VARCHAR,
"creation_date_time" TIMESTAMP_S,
"global_table_status" VARCHAR,
"global_table_name" VARCHAR
)
Show child fields
global_table_description.creation_date_time

The creation time of the global table.

global_table_description.global_table_arn

The unique identifier of the global table.

global_table_description.global_table_name

The global table name.

global_table_description.global_table_status

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.

global_table_description.replication_group[]
Show child fields
global_table_description.replication_group[].global_secondary_indexes[]
Show child fields
global_table_description.replication_group[].global_secondary_indexes[].index_name

The name of the global secondary index.

global_table_description.replication_group[].global_secondary_indexes[].on_demand_throughput_override

Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.

Show child fields
global_table_description.replication_group[].global_secondary_indexes[].on_demand_throughput_override.max_read_request_units

Maximum number of read request units for the specified replica table.

global_table_description.replication_group[].global_secondary_indexes[].provisioned_throughput_override

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

Show child fields
global_table_description.replication_group[].global_secondary_indexes[].provisioned_throughput_override.read_capacity_units

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

global_table_description.replication_group[].kms_master_key_id

The KMS key of the replica that will be used for KMS encryption.

global_table_description.replication_group[].on_demand_throughput_override

Overrides the maximum on-demand throughput settings for the specified replica table.

Show child fields
global_table_description.replication_group[].on_demand_throughput_override.max_read_request_units

Maximum number of read request units for the specified replica table.

global_table_description.replication_group[].provisioned_throughput_override

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

Show child fields
global_table_description.replication_group[].provisioned_throughput_override.read_capacity_units

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

global_table_description.replication_group[].region_name

The name of the Region.

global_table_description.replication_group[].replica_inaccessible_date_time

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

global_table_description.replication_group[].replica_status

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 Amazon Web Services Region has been disabled.

    If the Amazon Web Services 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 KMS key used to encrypt the table is inaccessible.

    If the 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.

global_table_description.replication_group[].replica_status_description

Detailed information about the replica status.

global_table_description.replication_group[].replica_status_percent_progress

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

global_table_description.replication_group[].replica_table_class_summary

Contains details of the table class.

Show child fields
global_table_description.replication_group[].replica_table_class_summary.last_update_date_time

The date and time at which the table class was last updated.

global_table_description.replication_group[].replica_table_class_summary.table_class

The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.