class Aws::DynamoDB::Types::TableDescription

@see docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TableDescription AWS API Documentation
@return [Types::ArchivalSummary]
Contains information about the table archive.
@!attribute [rw] archival_summary
@return [Types::SSEDescription]
specified table.
The description of the server-side encryption status on the
@!attribute [rw] sse_description
@return [Types::RestoreSummary]
Contains details for the restore.
@!attribute [rw] restore_summary
@return [Array<Types::ReplicaDescription>]
Represents replicas of the table.
@!attribute [rw] replicas
@return [String]<br>: docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html<br><br><br><br>replicated across Amazon Web Services Regions.
Represents the version of [global tables] in use, if the table is
@!attribute [rw] global_table_version
@return [String]
stream for this table.
The Amazon Resource Name (ARN) that uniquely identifies the latest
@!attribute [rw] latest_stream_arn
@return [String]
* ‘StreamLabel`
* Table name
* Amazon Web Services customer ID
following three elements is guaranteed to be unique:
might have the same timestamp. However, the combination of the
stream, because it is possible that a stream from another table
Note that `LatestStreamLabel` is not a unique identifier for the
A timestamp, in ISO 8601 format, for this stream.
@!attribute [rw] latest_stream_label
@return [Types::StreamSpecification]
The current DynamoDB Streams configuration for the table.
@!attribute [rw] stream_specification
@return [Array<Types::GlobalSecondaryIndexDescription>]
indexes will be returned.
If the table is in the `DELETING` state, no information about
units, along with data about increases and decreases.
the global secondary index, consisting of read and write capacity
* `ProvisionedThroughput` - The provisioned throughput settings for
counts as two distinct attributes when determining the total.
project the same attribute into two different indexes, this
across all of the secondary indexes, must not exceed 20. If you
count of attributes provided in `NonKeyAttributes`, summed
names that are projected into the secondary index. The total
* `NonKeyAttributes` - A list of one or more non-key attribute
index.
* `ALL` - All of the table attributes are projected into the
attributes that you specify.
`KEYS_ONLY`, the secondary index will include other non-key
* `INCLUDE` - In addition to the attributes described in
into the index.
* `KEYS_ONLY` - Only the index and primary keys are projected
* `ProjectionType` - One of the following:
of:
automatically projected. Each attribute specification is composed
primary key attributes and index key attributes, which are
from the table into the index. These are in addition to the
* `Projection` - Specifies attributes that are copied (projected)
partition key as the table.
characters (inclusive). The key schema must begin with the same
attribute names in the key schema must be between 1 and 255
* `KeySchema` - Specifies the complete index key schema. The
changes might not be reflected in this value.
DynamoDB updates this value approximately every six hours. Recent
* `ItemCount` - The number of items in the global secondary index.
* `ACTIVE` - The index is ready for use.
* `DELETING` - The index is being deleted.
* `UPDATING` - The index is being updated.
* `CREATING` - The index is being created.
* `IndexStatus` - The current status of the global secondary index:
hours. Recent changes might not be reflected in this value.
in bytes. DynamoDB updates this value approximately every six
* `IndexSizeBytes` - The total size of the global secondary index,
* `IndexName` - The name of the global secondary index.
created during a `CreateTable` operation.)
false. (This attribute does not appear for indexes that were
created when `IndexStatus` is set to CREATING and `Backfilling` is
`Backfilling` is true. You can’t delete the index that is being
`Backfilling` phase when ‘IndexStatus` is set to CREATING and
You can delete an index that is being created during the
`CreateTable` operation.)
attribute does not appear for indexes that were created during a
DynamoDB populates the new index with data from the table. (This
secondary index is added to the table. It is the process by which
backfilling phase. Backfilling occurs only when a new global
* `Backfilling` - If true, then the index is currently in the
scoped to a given partition key value. Each element is composed of:
The global secondary indexes, if any, on the table. Each index is
@!attribute [rw] global_secondary_indexes
@return [Array<Types::LocalSecondaryIndexDescription>]
indexes will be returned.
If the table is in the `DELETING` state, no information about
changes might not be reflected in this value.
DynamoDB updates this value approximately every six hours. Recent
* `ItemCount` - Represents the number of items in the index.
Recent changes might not be reflected in this value.
bytes. DynamoDB updates this value approximately every six hours.
* `IndexSizeBytes` - Represents the total size of the index, in
counts as two distinct attributes when determining the total.
project the same attribute into two different indexes, this
across all of the secondary indexes, must not exceed 20. If you
count of attributes provided in `NonKeyAttributes`, summed
names that are projected into the secondary index. The total
* `NonKeyAttributes` - A list of one or more non-key attribute
index.
* `ALL` - All of the table attributes are projected into the
`NonKeyAttributes`.
into the index. The list of projected attributes is in
* `INCLUDE` - Only the specified table attributes are projected
into the index.
* `KEYS_ONLY` - Only the index and primary keys are projected
* `ProjectionType` - One of the following:
of:
automatically projected. Each attribute specification is composed
primary key attributes and index key attributes, which are
from the table into the index. These are in addition to the
* `Projection` - Specifies attributes that are copied (projected)
partition key as the table.
characters (inclusive). The key schema must begin with the same
attribute names in the key schema must be between 1 and 255
* `KeySchema` - Specifies the complete index key schema. The
* `IndexName` - The name of the local secondary index.
cannot exceed 10 GB. Each element is composed of:
limit, where the amount of data within a given item collection
more local secondary indexes are subject to an item collection size
index is scoped to a given partition key value. Tables with one or
Represents one or more local secondary indexes on the table. Each
@!attribute [rw] local_secondary_indexes
@return [Types::BillingModeSummary]
Contains the details for the read/write capacity mode.
@!attribute [rw] billing_mode_summary
@return [String]
Unique identifier for the table for which the backup was created.
@!attribute [rw] table_id
@return [String]
The Amazon Resource Name (ARN) that uniquely identifies the table.
@!attribute [rw] table_arn
@return [Integer]
reflected in this value.
value approximately every six hours. Recent changes might not be
The number of items in the specified table. DynamoDB updates this
@!attribute [rw] item_count
@return [Integer]
be reflected in this value.
this value approximately every six hours. Recent changes might not
The total size of the specified table, in bytes. DynamoDB updates
@!attribute [rw] table_size_bytes
@return [Types::ProvisionedThroughputDescription]
decreases.
read and write capacity units, along with data about increases and
The provisioned throughput settings for the table, consisting of
@!attribute [rw] provisioned_throughput
@return [Time]<br>: www.epochconverter.com/<br><br><br><br>time][1] format.
The date and time when the table was created, in [UNIX epoch
@!attribute [rw] creation_date_time
@return [String]
for more information.
* `ARCHIVED` - The table has been archived. See the ArchivalReason
allowed until archival is complete.
* `ARCHIVING` - The table is being archived. Operations are not
more than seven days.
archival process when a table’s KMS key remains inaccessible for
to failure to use the KMS key. DynamoDB will initiate the table
encrypt the table in inaccessible. Table operations may fail due
* ‘INACCESSIBLE_ENCRYPTION_CREDENTIALS` - The KMS key used to
* `ACTIVE` - The table is ready for use.
* `DELETING` - The table is being deleted.
* `UPDATING` - The table is being updated.
* `CREATING` - The table is being created.
The current state of the table:
@!attribute [rw] table_status
@return [Array<Types::KeySchemaElement>]<br>: docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey<br><br><br><br>*Amazon DynamoDB Developer Guide*.
For more information about primary keys, see [Primary Key] in the
</note>
sorted order by the sort key value.
items with the same partition key physically close together, in
The term “range attribute” derives from the way DynamoDB stores
The sort key of an item is also known as its *range attribute*.
across partitions, based on their partition key values.
usage of an internal hash function to evenly distribute data items
attribute*. The term “hash attribute” derives from DynamoDB’s
<note markdown=“1”> The partition key of an item is also known as its *hash
* ‘RANGE` - sort key
* `HASH` - partition key
* `KeyType` - The role of the attribute:
* `AttributeName` - The name of the attribute.
consists of:
The primary key structure for the table. Each `KeySchemaElement`
@!attribute [rw] key_schema
@return [String]
The name of the table.
@!attribute [rw] table_name
@return [Array<Types::AttributeDefinition>]
* `AttributeType` - The data type for the attribute.
* `AttributeName` - The name of the attribute.
Each `AttributeDefinition` object in this array is composed of:
describes one attribute in the table and index key schema.
An array of `AttributeDefinition` objects. Each of these objects
@!attribute [rw] attribute_definitions
Represents the properties of a table.