This table represents the DynamoDB resource from Amazon Web Services.

aws.dynamodb

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
archival_summarycorejsonContains information about the table archive.
attribute_definitionscorejsonAn array of <code>AttributeDefinition</code> objects. Each of these objects describes one attribute in the table and index key schema. Each <code>AttributeDefinition</code> object in this array is composed of:<br> <ul> <li> <code>AttributeName</code> - The name of the attribute. </li> <li> <code>AttributeType</code> - The data type for the attribute. </li> </ul>
billing_mode_summarycorejsonContains the details for the read/write capacity mode.
continuous_backups_descriptioncorejsonRepresents the continuous backups and point in time recovery settings on the table.
creation_date_timecoretimestampThe date and time when the table was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format.
deletion_protection_enabledcoreboolIndicates whether deletion protection is enabled (true) or disabled (false) on the table.
global_secondary_indexescorejsonThe global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. If the table is in the <code>DELETING</code> state, no information about indexes will be returned.
global_table_versioncorestringRepresents the version of <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">global tables</a> in use, if the table is replicated across Amazon Web Services Regions.
item_countcoreint64The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
key_schemacorejsonThe primary key structure for the table. Each <code>KeySchemaElement</code> consists of: <ul> <li> <code>AttributeName</code> - The name of the attribute. </li> <li> <code>KeyType</code> - The role of the attribute: <ul> <li> <code>HASH</code> - partition key </li> <li> <code>RANGE</code> - sort key </li> </ul> <note> The partition key of an item is also known as its <i>hash attribute</i>. 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 <i>range attribute</i>. 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. </note> </li> </ul> For more information about primary keys, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey">Primary Key</a> in the <i>Amazon DynamoDB Developer Guide</i>.
latest_stream_arncorestringThe Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
latest_stream_labelcorestringA timestamp, in ISO 8601 format, for this stream. Note that <code>LatestStreamLabel</code> 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: <ul> <li> Amazon Web Services customer ID </li> <li> Table name </li> <li> <code>StreamLabel</code> </li> </ul>
local_secondary_indexescorejsonRepresents 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. If the table is in the <code>DELETING</code> state, no information about indexes will be returned.
on_demand_throughputcorejsonThe maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify <code>MaxReadRequestUnits</code>, <code>MaxWriteRequestUnits</code>, or both.
provisioned_throughputcorejsonThe provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
replicascorejsonRepresents replicas of the table.
restore_summarycorejsonContains details for the restore.
sse_descriptioncorejsonThe description of the server-side encryption status on the specified table.
stream_specificationcorejsonThe current DynamoDB Streams configuration for the table.
table_arncorestringThe Amazon Resource Name (ARN) that uniquely identifies the table.
table_class_summarycorejsonContains details of the table class.
table_idcorestringUnique identifier for the table for which the backup was created.
table_namecorestringThe name of the table.
table_size_bytescoreint64The 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.
table_statuscorestringThe current state of the table: <ul> <li> <code>CREATING</code> - The table is being created. </li> <li> <code>UPDATING</code> - The table/index configuration is being updated. The table/index remains available for data operations when <code>UPDATING</code>. </li> <li> <code>DELETING</code> - The table is being deleted. </li> <li> <code>ACTIVE</code> - The table is ready for use. </li> <li> <code>INACCESSIBLE_ENCRYPTION_CREDENTIALS</code> - 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. </li> <li> <code>ARCHIVING</code> - The table is being archived. Operations are not allowed until archival is complete. </li> <li> <code>ARCHIVED</code> - The table has been archived. See the ArchivalReason for more information. </li> </ul>
tagscorehstore
time_to_live_descriptioncorejson<p/>
warm_throughputcorejsonDescribes the warm throughput value of the base table.