import { _AttributeDefinition, _UnmarshalledAttributeDefinition } from './_AttributeDefinition'; import { _KeySchemaElement, _UnmarshalledKeySchemaElement } from './_KeySchemaElement'; import { _ProvisionedThroughputDescription, _UnmarshalledProvisionedThroughputDescription } from './_ProvisionedThroughputDescription'; import { _LocalSecondaryIndexDescription, _UnmarshalledLocalSecondaryIndexDescription } from './_LocalSecondaryIndexDescription'; import { _GlobalSecondaryIndexDescription, _UnmarshalledGlobalSecondaryIndexDescription } from './_GlobalSecondaryIndexDescription'; import { _StreamSpecification, _UnmarshalledStreamSpecification } from './_StreamSpecification'; import { _RestoreSummary, _UnmarshalledRestoreSummary } from './_RestoreSummary'; import { _SSEDescription, _UnmarshalledSSEDescription } from './_SSEDescription'; /** *

Represents the properties of a table.

*/ export interface _TableDescription { /** *

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:

*/ AttributeDefinitions?: Array<_AttributeDefinition> | Iterable<_AttributeDefinition>; /** *

The name of the table.

*/ TableName?: string; /** *

The primary key structure for the table. Each KeySchemaElement consists of:

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

*/ KeySchema?: Array<_KeySchemaElement> | Iterable<_KeySchemaElement>; /** *

The current state of the table:

*/ TableStatus?: 'CREATING' | 'UPDATING' | 'DELETING' | 'ACTIVE' | string; /** *

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

*/ CreationDateTime?: Date | string | number; /** *

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

*/ ProvisionedThroughput?: _ProvisionedThroughputDescription; /** *

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.

*/ TableSizeBytes?: 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.

*/ ItemCount?: number; /** *

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

*/ TableArn?: string; /** *

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

*/ TableId?: string; /** *

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:

If the table is in the DELETING state, no information about indexes will be returned.

*/ LocalSecondaryIndexes?: Array<_LocalSecondaryIndexDescription> | Iterable<_LocalSecondaryIndexDescription>; /** *

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

If the table is in the DELETING state, no information about indexes will be returned.

*/ GlobalSecondaryIndexes?: Array<_GlobalSecondaryIndexDescription> | Iterable<_GlobalSecondaryIndexDescription>; /** *

The current DynamoDB Streams configuration for the table.

*/ StreamSpecification?: _StreamSpecification; /** *

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:

*/ LatestStreamLabel?: string; /** *

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

*/ LatestStreamArn?: string; /** *

Contains details for the restore.

*/ RestoreSummary?: _RestoreSummary; /** *

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

*/ SSEDescription?: _SSEDescription; } export interface _UnmarshalledTableDescription extends _TableDescription { /** *

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:

*/ AttributeDefinitions?: Array<_UnmarshalledAttributeDefinition>; /** *

The primary key structure for the table. Each KeySchemaElement consists of:

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

*/ KeySchema?: Array<_UnmarshalledKeySchemaElement>; /** *

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

*/ CreationDateTime?: Date; /** *

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

*/ ProvisionedThroughput?: _UnmarshalledProvisionedThroughputDescription; /** *

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:

If the table is in the DELETING state, no information about indexes will be returned.

*/ LocalSecondaryIndexes?: Array<_UnmarshalledLocalSecondaryIndexDescription>; /** *

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

If the table is in the DELETING state, no information about indexes will be returned.

*/ GlobalSecondaryIndexes?: Array<_UnmarshalledGlobalSecondaryIndexDescription>; /** *

The current DynamoDB Streams configuration for the table.

*/ StreamSpecification?: _UnmarshalledStreamSpecification; /** *

Contains details for the restore.

*/ RestoreSummary?: _UnmarshalledRestoreSummary; /** *

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

*/ SSEDescription?: _UnmarshalledSSEDescription; }