Documentation

Represents the properties of a table.

See: newTableDescription smart constructor.

Create a value of TableDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restoreSummary:TableDescription', tableDescription_restoreSummary - Contains details for the restore.

$sel:globalTableVersion:TableDescription', tableDescription_globalTableVersion - Represents the version of global tables in use, if the table is replicated across AWS Regions.

$sel:tableSizeBytes:TableDescription', tableDescription_tableSizeBytes - 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.

$sel:attributeDefinitions:TableDescription', tableDescription_attributeDefinitions - 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.

$sel:latestStreamArn:TableDescription', tableDescription_latestStreamArn - The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

$sel:provisionedThroughput:TableDescription', tableDescription_provisionedThroughput - The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

$sel:tableStatus:TableDescription', tableDescription_tableStatus - 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 AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS 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.

$sel:tableArn:TableDescription', tableDescription_tableArn - The Amazon Resource Name (ARN) that uniquely identifies the table.

$sel:keySchema:TableDescription', tableDescription_keySchema - 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.

$sel:globalSecondaryIndexes:TableDescription', tableDescription_globalSecondaryIndexes - 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.

$sel:latestStreamLabel:TableDescription', tableDescription_latestStreamLabel - 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:

• AWS customer ID
• Table name

• StreamLabel

$sel:billingModeSummary:TableDescription', tableDescription_billingModeSummary - Contains the details for the read/write capacity mode.

$sel:localSecondaryIndexes:TableDescription', tableDescription_localSecondaryIndexes - 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.

$sel:creationDateTime:TableDescription', tableDescription_creationDateTime - The date and time when the table was created, in UNIX epoch time format.

$sel:sSEDescription:TableDescription', tableDescription_sSEDescription - The description of the server-side encryption status on the specified table.

$sel:tableId:TableDescription', tableDescription_tableId - Unique identifier for the table for which the backup was created.

$sel:replicas:TableDescription', tableDescription_replicas - Represents replicas of the table.

$sel:itemCount:TableDescription', tableDescription_itemCount - 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.

$sel:archivalSummary:TableDescription', tableDescription_archivalSummary - Contains information about the table archive.

$sel:tableName:TableDescription', tableDescription_tableName - The name of the table.

$sel:streamSpecification:TableDescription', tableDescription_streamSpecification - The current DynamoDB Streams configuration for the table.

Contains details for the restore.

Represents the version of global tables in use, if the table is replicated across AWS Regions.

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.

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.

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

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 AWS KMS key used to encrypt the table in inaccessible. Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival process when a table's AWS 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.

The Amazon Resource Name (ARN) that uniquely identifies the table.

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.

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.

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:

• AWS customer ID
• Table name

• StreamLabel

Contains the details for the read/write capacity mode.

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.

The date and time when the table was created, in UNIX epoch time format.

The description of the server-side encryption status on the specified table.

Unique identifier for the table for which the backup was created.

Represents replicas of the table.

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.

Contains information about the table archive.

The name of the table.

The current DynamoDB Streams configuration for the table.