Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListModels

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

Request Syntax


GET /assistants/assistantId/models?aiPromptType=aiPromptType&maxResults=maxResults&modelLifecycle=modelLifecycle&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

aiPromptType

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

assistantId

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.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}

Required: Yes

maxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

modelLifecycle

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

Valid Values: ACTIVE | LEGACY

nextToken

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.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "modelSummaries": [ 
      { 
         "crossRegionStatus": "string",
         "displayName": "string",
         "endOfLifeTimestamp": number,
         "legacyTimestamp": number,
         "modelId": "string",
         "modelLifecycle": "string",
         "supportedAIPromptTypes": [ "string" ],
         "supportsPromptCaching": boolean
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

modelSummaries

The summaries of the models available to the assistant.

Type: Array of ModelSummary objects

nextToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource does not exist.

resourceName: The specified resource name.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 400

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400