models

Creates, updates, deletes, gets or lists a models resource.

Overview

Name	models
Type	Resource
Id	aws.qconnect.models

Fields

The following fields are returned by SELECT queries:

list_models

Name	Datatype	Description
cross_region_status	string	The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference. (NONE, REGIONAL, GLOBAL)
display_name	string	The display name of the model.
end_of_life_timestamp	string (date-time)	The timestamp when the model will reach end of life and no longer be available for use.
legacy_timestamp	string (date-time)	The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.
model_id	string	The identifier of the model.
model_lifecycle	string	The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated. (ACTIVE, LEGACY)
supported_ai_prompt_types	array	The list of AI Prompt types that the model supports.
supports_prompt_caching	boolean	Whether the model supports prompt caching.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_models	select	assistant_id, region	aiPromptType, modelLifecycle, nextToken, maxResults	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assistant_id	string	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.
region	string	AWS region (default: us-east-1)
aiPromptType	string	The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.
maxResults	integer	The maximum number of results to return per page.
modelLifecycle	string	The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.
nextToken	string	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.

SELECT examples

list_models

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.

SELECT
cross_region_status,
display_name,
end_of_life_timestamp,
legacy_timestamp,
model_id,
model_lifecycle,
supported_ai_prompt_types,
supports_prompt_caching
FROM aws.qconnect.models
WHERE assistant_id = '{{ assistant_id }}' -- required
AND region = '{{ region }}' -- required
AND aiPromptType = '{{ aiPromptType }}'
AND modelLifecycle = '{{ modelLifecycle }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;