Skip to content

ListModelsRequest

Source code in docs_src/capo_qconnect/types/list_models_request.py 
15
16
17
18
19
20
21
22
23
24
25
class ListModelsRequest(TypedDict, closed=True):
    assistant_id: "capo_qconnect.types.uuid_or_arn.UuidOrArn"
    """<p>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.</p>"""
    ai_prompt_type: NotRequired["capo_qconnect.types.ai_prompt_type.AIPromptType"]
    """<p>The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.</p>"""
    model_lifecycle: NotRequired["capo_qconnect.types.model_lifecycle.ModelLifecycle"]
    """<p>The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.</p>"""
    next_token: NotRequired["capo_qconnect.types.next_token.NextToken"]
    """<p>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.</p>"""
    max_results: NotRequired["capo_qconnect.types.max_results.MaxResults"]
    """<p>The maximum number of results to return per page.</p>"""

ai_prompt_type instance-attribute 

ai_prompt_type: NotRequired[AIPromptType]

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

assistant_id instance-attribute 

assistant_id: UuidOrArn

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.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return per page.

model_lifecycle instance-attribute 

model_lifecycle: NotRequired[ModelLifecycle]

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

next_token instance-attribute 

next_token: NotRequired[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.