Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Gets information about an existing Amazon Kendra index.

post/#X-Amz-Target=AWSKendraFrontendService.DescribeIndex

Headers

X-Amz-Target'AWSKendraFrontendService.DescribeIndex' required

Request body

Idstring required

The identifier of the index you want to get information on.

Response

Success

Namestring

The name of the index.

Idstring

The identifier of the index.

Edition'DEVELOPER_EDITION' | 'ENTERPRISE_EDITION'

The Amazon Kendra edition used for the index. You decide the edition when you create the index.

RoleArnstring

The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.

Status'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | 'UPDATING' | 'SYSTEM_UPDATING'

The current status of the index. When the value is <code>ACTIVE</code>, the index is ready for use. If the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.

Descriptionstring

The description for the index.

CreatedAtstring date-time

The Unix timestamp when the index was created.

UpdatedAtstring date-time

The Unix when the index was last updated.

ErrorMessagestring

When the <code>Status</code> field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a message that explains why.

UserContextPolicy'ATTRIBUTE_FILTER' | 'USER_TOKEN'

The user context policy for the Amazon Kendra index.