Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Gets information about chat controls configured for an existing Amazon Q Business application.

get/applications/{applicationId}/chatcontrols

Path parameters

applicationIdstring required

The identifier of the application for which the chat controls are configured.

Query parameters

maxResultsinteger

The maximum number of configured chat controls to return.

nextTokenstring

If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.

Response

Success

responseScope'ENTERPRISE_CONTENT_ONLY' | 'EXTENDED_KNOWLEDGE_ENABLED'

The response scope configured for a Amazon Q Business application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.

nextTokenstring

If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business chat controls configured.