Return information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.
Inputs
Field
Type
Description
region [required]
enum
default: us-east-1
tableName [required]
string
The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
Outputs
Expand All
Field
Type
Description
table [required]
object
AttributeDefinitions
[object]
An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema. Each AttributeDefinition object in this array is composed of: AttributeName - The name of the attribute. AttributeType - The data type for the attribute.
AttributeName [required]
string
A name for the attribute.
AttributeType [required]
string
The data type for the attribute, where: S - the attribute is of type String N - the attribute is of type Number B - the attribute is of type Binary
TableName
string
The name of the table.
KeySchema
[object]
The primary key structure for the table. Each KeySchemaElement consists of: AttributeName - The name of the attribute. KeyType - The role of the attribute: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
AttributeName [required]
string
The name of a key attribute.
KeyType [required]
string
The role that this key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
TableStatus
string
The current state of the table: CREATING - The table is being created. UPDATING - The table is being updated. DELETING - The table is being deleted. ACTIVE - The table is ready for use. INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the KMS key. DynamoDB will initiate the table archival process when a table's KMS key remains inaccessible for more than seven days. ARCHIVING - The table is being archived. Operations are not allowed until archival is complete. ARCHIVED - The table has been archived. See the ArchivalReason for more information.
CreationDateTime
date-time
The date and time when the table was created, in UNIX epoch time format.
ProvisionedThroughput
object
The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
LastIncreaseDateTime
date-time
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime
date-time
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday
number
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits
number
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits
number
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
TableSizeBytes
number
The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
number
The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
TableArn
string
The Amazon Resource Name (ARN) that uniquely identifies the table.
TableId
string
Unique identifier for the table for which the backup was created.
BillingModeSummary
object
Contains the details for the read/write capacity mode.
BillingMode
string
Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later. PROVISIONED - Sets the read/write capacity mode to PROVISIONED. AWS recommends using PROVISIONED for predictable workloads. PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. AWS recommends using PAY_PER_REQUEST for unpredictable workloads.
LastUpdateToPayPerRequestDateTime
date-time
Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
LocalSecondaryIndexes
[object]
Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of: IndexName - The name of the local secondary index. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. If the table is in the DELETING state, no information about indexes will be returned.
IndexName
string
Represents the name of the local secondary index.
KeySchema
[object]
The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
AttributeName [required]
string
The name of a key attribute.
KeyType [required]
string
The role that this key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection
object
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType
string
The set of attributes that are projected into the index: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify. ALL - All of the table attributes are projected into the index.
NonKeyAttributes
[string]
Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexSizeBytes
number
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
number
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn
string
The Amazon Resource Name (ARN) that uniquely identifies the index.
GlobalSecondaryIndexes
[object]
The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of: Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.) You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. (This attribute does not appear for indexes that were created during a CreateTable operation.) IndexName - The name of the global secondary index. IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. **IndexStatus** - The current status of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use. ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value. KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table. Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of: ProjectionType - One of the following: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify. ALL - All of the table attributes are projected into the index. NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases. If the table is in the DELETING state, no information about indexes will be returned.
IndexName
string
The name of the global secondary index.
KeySchema
[object]
The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
AttributeName [required]
string
The name of a key attribute.
KeyType [required]
string
The role that this key attribute will assume: HASH - partition key RANGE - sort key The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
Projection
object
Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
ProjectionType
string
The set of attributes that are projected into the index: KEYS_ONLY - Only the index and primary keys are projected into the index. INCLUDE - In addition to the attributes described in KEYS_ONLY, the secondary index will include other non-key attributes that you specify. ALL - All of the table attributes are projected into the index.
NonKeyAttributes
[string]
Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
IndexStatus
string
The current state of the global secondary index: CREATING - The index is being created. UPDATING - The index is being updated. DELETING - The index is being deleted. ACTIVE - The index is ready for use.
Backfilling
boolean
Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false. You can delete an index that is being created during the Backfilling phase when IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that is being created when IndexStatus is set to CREATING and Backfilling is false. For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
ProvisionedThroughput
object
Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
LastIncreaseDateTime
date-time
The date and time of the last provisioned throughput increase for this table.
LastDecreaseDateTime
date-time
The date and time of the last provisioned throughput decrease for this table.
NumberOfDecreasesToday
number
The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
ReadCapacityUnits
number
The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.
WriteCapacityUnits
number
The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
IndexSizeBytes
number
The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
ItemCount
number
The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
IndexArn
string
The Amazon Resource Name (ARN) that uniquely identifies the index.
OnDemandThroughput
object
The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits
number
Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits
number
Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
StreamSpecification
object
The current DynamoDB Streams configuration for the table.
StreamEnabled [required]
boolean
Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
StreamViewType
string
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified item are written to the stream. NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream. OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream. NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.
LatestStreamLabel
string
A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique: Amazon Web Services customer ID Table name StreamLabel
LatestStreamArn
string
The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
GlobalTableVersion
string
Represents the version of global tables in use, if the table is replicated across Amazon Web Services Regions.
Replicas
[object]
Represents replicas of the table.
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 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.
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 KMS key of the replica that will be used for KMS encryption.
ProvisionedThroughputOverride
object
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
ReadCapacityUnits
number
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride
object
Overrides the maximum on-demand throughput settings for the specified replica table.
MaxReadRequestUnits
number
Maximum number of read request units for the specified replica table.
GlobalSecondaryIndexes
[object]
Replica-specific global secondary index settings.
IndexName
string
The name of the global secondary index.
ProvisionedThroughputOverride
object
If not described, uses the source table GSI's read capacity settings.
ReadCapacityUnits
number
Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
OnDemandThroughputOverride
object
Overrides the maximum on-demand throughput for the specified global secondary index in the specified replica table.
MaxReadRequestUnits
number
Maximum number of read request units for the specified replica table.
ReplicaInaccessibleDateTime
date-time
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus property.
ReplicaTableClassSummary
object
TableClass
string
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime
date-time
The date and time at which the table class was last updated.
RestoreSummary
object
Contains details for the restore.
SourceBackupArn
string
The Amazon Resource Name (ARN) of the backup from which the table was restored.
SourceTableArn
string
The ARN of the source table of the backup that is being restored.
RestoreDateTime [required]
date-time
Point in time or source backup time.
RestoreInProgress [required]
boolean
Indicates if a restore is in progress or not.
SSEDescription
object
The description of the server-side encryption status on the specified table.
Status
string
Represents the current state of server-side encryption. The only supported values are: ENABLED - Server-side encryption is enabled. UPDATING - Server-side encryption is being updated.
SSEType
string
Server-side encryption type. The only supported value is: KMS - Server-side encryption that uses Key Management Service. The key is stored in your account and is managed by KMS (KMS charges apply).
KMSMasterKeyArn
string
The KMS key ARN used for the KMS encryption.
InaccessibleEncryptionDateTime
date-time
Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's KMS key was inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's KMS key is accessible again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.
ArchivalSummary
object
Contains information about the table archive.
ArchivalDateTime
date-time
The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
ArchivalReason
string
The reason DynamoDB archived the table. Currently, the only possible value is: INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's KMS key being inaccessible for more than seven days. An On-Demand backup was created at the archival time.
ArchivalBackupArn
string
The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason. If you wish to restore this backup to the same table name, you will need to delete the original table.
TableClassSummary
object
Contains details of the table class.
TableClass
string
The table class of the specified table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.
LastUpdateDateTime
date-time
The date and time at which the table class was last updated.
DeletionProtectionEnabled
boolean
Indicates whether deletion protection is enabled (true) or disabled (false) on the table.
OnDemandThroughput
object
The maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.
MaxReadRequestUnits
number
Maximum number of read request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxReadRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxReadRequestUnits to -1.
MaxWriteRequestUnits
number
Maximum number of write request units for the specified table. To specify a maximum OnDemandThroughput on your table, set the value of MaxWriteRequestUnits as greater than or equal to 1. To remove the maximum OnDemandThroughput that is currently set on your table, set the value of MaxWriteRequestUnits to -1.
