IndexConfigurationSummary
Summary information on the configuration of an index.
Contents
- CreatedAt
-
The Unix timestamp when the index was created.
Type: Timestamp
Required: Yes
- Status
-
The current status of the index. When the status is
ACTIVE, the index is ready to search.Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED | UPDATING | SYSTEM_UPDATINGRequired: Yes
- UpdatedAt
-
The Unix timestamp when the index was last updated.
Type: Timestamp
Required: Yes
- Edition
-
Indicates whether the index is a Enterprise Edition index or a Developer Edition index.
Type: String
Valid Values:
DEVELOPER_EDITION | ENTERPRISE_EDITIONRequired: No
- Id
-
A identifier for the index. Use this to identify the index when you are using APIs such as
Query,DescribeIndex,UpdateIndex, andDeleteIndex.Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*Required: No
- Name
-
The name of the index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
