AwsDynamoDbTableDetails
Provides details about a DynamoDB table.
Contents
- AttributeDefinitions
-
A list of attribute definitions for the table.
Type: Array of AwsDynamoDbTableAttributeDefinition objects
Required: No
- BillingModeSummary
-
Information about the billing for read/write capacity on the table.
Type: AwsDynamoDbTableBillingModeSummary object
Required: No
- CreationDateTime
-
Indicates when the table was created.
This field accepts only the specified formats. Timestamps can end with
Zor("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:-
YYYY-MM-DDTHH:MM:SSZ(for example,2019-01-31T23:00:00Z) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ(for example,2019-01-31T23:00:00.123456789Z) -
YYYY-MM-DDTHH:MM:SS+HH:MM(for example,2024-01-04T15:25:10+17:59) -
YYYY-MM-DDTHH:MM:SS-HHMM(for example,2024-01-04T15:25:10-1759) -
YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM(for example,2024-01-04T15:25:10.123456789+17:59)
Type: String
Pattern:
.*\S.*Required: No
-
- DeletionProtectionEnabled
-
Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
Type: Boolean
Required: No
- GlobalSecondaryIndexes
-
List of global secondary indexes for the table.
Type: Array of AwsDynamoDbTableGlobalSecondaryIndex objects
Required: No
- GlobalTableVersion
-
The version of global tables being used.
Type: String
Pattern:
.*\S.*Required: No
- ItemCount
-
The number of items in the table.
Type: Integer
Required: No
- KeySchema
-
The primary key structure for the table.
Type: Array of AwsDynamoDbTableKeySchema objects
Required: No
- LatestStreamArn
-
The ARN of the latest stream for the table.
Type: String
Pattern:
.*\S.*Required: No
- LatestStreamLabel
-
The label of the latest stream. The label is not a unique identifier.
Type: String
Pattern:
.*\S.*Required: No
- LocalSecondaryIndexes
-
The list of local secondary indexes for the table.
Type: Array of AwsDynamoDbTableLocalSecondaryIndex objects
Required: No
- ProvisionedThroughput
-
Information about the provisioned throughput for the table.
Type: AwsDynamoDbTableProvisionedThroughput object
Required: No
- Replicas
-
The list of replicas of this table.
Type: Array of AwsDynamoDbTableReplica objects
Required: No
- RestoreSummary
-
Information about the restore for the table.
Type: AwsDynamoDbTableRestoreSummary object
Required: No
- SseDescription
-
Information about the server-side encryption for the table.
Type: AwsDynamoDbTableSseDescription object
Required: No
- StreamSpecification
-
The current DynamoDB Streams configuration for the table.
Type: AwsDynamoDbTableStreamSpecification object
Required: No
- TableId
-
The identifier of the table.
Type: String
Pattern:
.*\S.*Required: No
- TableName
-
The name of the table.
Type: String
Pattern:
.*\S.*Required: No
- TableSizeBytes
-
The total size of the table in bytes.
Type: Long
Required: No
- TableStatus
-
The current status of the table. Valid values are as follows:
-
ACTIVE -
ARCHIVED -
ARCHIVING -
CREATING -
DELETING -
INACCESSIBLE_ENCRYPTION_CREDENTIALS -
UPDATING
Type: String
Pattern:
.*\S.*Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
