Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1494674591.3 KB

Lists the models available to an Amazon Q in Connect assistant in the assistant's Amazon Web Services Region. The available models are determined by the region of the specified assistant.

get/assistants/{assistantId}/models

Path parameters

assistantIdstring required

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. The assistant's region determines which models are available.

Query parameters

aiPromptType'ANSWER_GENERATION' | 'INTENT_LABELING_GENERATION' | 'QUERY_REFORMULATION' | 'SELF_SERVICE_PRE_PROCESSING' | 'SELF_SERVICE_ANSWER_GENERATION' | 'EMAIL_RESPONSE' | 'EMAIL_OVERVIEW' | 'EMAIL_GENERATIVE_ANSWER' | 'EMAIL_QUERY_REFORMULATION' | 'ORCHESTRATION' | 'NOTE_TAKING' | 'CASE_SUMMARIZATION'

The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.

modelLifecycle'ACTIVE' | 'LEGACY'

The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.

nextTokenstring

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

maxResultsinteger

The maximum number of results to return per page.

Response

Success

nextTokenstring

If there are additional results, this is the token for the next set of results.