Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Adds a retriever to your Amazon Q Business application.

post/applications/{applicationId}/retrievers

Path parameters

applicationIdstring required

The identifier of your Amazon Q Business application.

Request body

type'NATIVE_INDEX' | 'KENDRA_INDEX' required

The type of retriever you are using.

displayNamestring required

The name of your retriever.

roleArnstring

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

clientTokenstring

A token that you provide to identify the request to create your Amazon Q Business application retriever.

Response

Success

retrieverIdstring

The identifier of the retriever you are using.

retrieverArnstring

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