PartitionIndexDescriptor
A descriptor for a partition index in a table.
Contents
- IndexName
-
The name of the partition index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
- IndexStatus
-
The status of the partition index.
The possible statuses are:
-
CREATING: The index is being created. When an index is in a CREATING state, the index or its table cannot be deleted.
-
ACTIVE: The index creation succeeds.
-
FAILED: The index creation fails.
-
DELETING: The index is deleted from the list of indexes.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILEDRequired: Yes
-
- Keys
-
A list of one or more keys, as
KeySchemaElementstructures, for the partition index.Type: Array of KeySchemaElement objects
Array Members: Minimum number of 1 item.
Required: Yes
- BackfillErrors
-
A list of errors that can occur when registering partition indexes for an existing table.
Type: Array of BackfillError objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
