Get applicationsapplicationidindicesindexid

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing Amazon Q Business index.

get/applications/{applicationId}/indices/{indexId}

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application connected to the index.

indexIdstring required

The identifier of the Amazon Q Business index you want information on.

Response

Success

applicationIdstring

The identifier of the Amazon Q Business application associated with the index.

indexIdstring

The identifier of the Amazon Q Business index.

displayNamestring

The name of the Amazon Q Business index.

indexArnstring

The Amazon Resource Name (ARN) of the Amazon Q Business index.

status'CREATING' | 'ACTIVE' | 'DELETING' | 'FAILED' | '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.

type'ENTERPRISE' | 'STARTER'

The type of index attached to your Amazon Q Business application.

descriptionstring

The description for the Amazon Q Business index.

createdAtstring date-time

The Unix timestamp when the Amazon Q Business index was created.

updatedAtstring date-time

The Unix timestamp when the Amazon Q Business index was last updated.