Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about an existing retriever used by an Amazon Q Business application.

get/applications/{applicationId}/retrievers/{retrieverId}

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application using the retriever.

retrieverIdstring required

The identifier of the retriever.

Response

Success

applicationIdstring

The identifier of the Amazon Q Business application using the retriever.

retrieverIdstring

The identifier of the retriever.

retrieverArnstring

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

type'NATIVE_INDEX' | 'KENDRA_INDEX'

The type of the retriever.

status'CREATING' | 'ACTIVE' | 'FAILED'

The status of the retriever.

displayNamestring

The name of the retriever.

roleArnstring

The Amazon Resource Name (ARN) of the role with the permission to access the retriever and required resources.

createdAtstring date-time

The Unix timestamp when the retriever was created.

updatedAtstring date-time

The Unix timestamp when the retriever was last updated.