IndexConfigurationSummary - Amazon Kendra

IndexConfigurationSummary

A summary of information about an index.

Contents

CreatedAt

The Unix timestamp when the index was created.

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_EDITION

Required: No

Id

A unique identifier for the index. Use this to identify the index when you are using operations such as Query, DescribeIndex, UpdateIndex, and DeleteIndex.

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

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_UPDATING

Required: Yes

UpdatedAt

The Unix timestamp when the index was last updated by the UpdateIndex operation.

Type: Timestamp

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: