list-models¶

Description¶

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.

Synopsis¶

  list-models
--assistant-id <value>
[--ai-prompt-type <value>]
[--model-lifecycle <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--assistant-id (string) [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.

Constraints:

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}

--ai-prompt-type (string)

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

Possible values:

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

--model-lifecycle (string)

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

Possible values:

ACTIVE

LEGACY

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

modelSummaries -> (list)

The summaries of the models available to the assistant.

(structure)

The summary of a model available to an Amazon Q in Connect assistant.

modelId -> (string) [required]

The identifier of the model.

Constraints:

min: 1

max: 256

displayName -> (string) [required]

The display name of the model.

Constraints:

min: 1

max: 256

crossRegionStatus -> (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.

Possible values:

NONE

REGIONAL

GLOBAL

supportsPromptCaching -> (boolean)

Whether the model supports prompt caching.

supportedAIPromptTypes -> (list)

The list of AI Prompt types that the model supports.

(string)

Possible values:

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

modelLifecycle -> (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.

Possible values:

ACTIVE

LEGACY

legacyTimestamp -> (timestamp)

The timestamp when the model lifecycle will transition from ACTIVE to LEGACY .

endOfLifeTimestamp -> (timestamp)

The timestamp when the model will reach end of life and no longer be available for use.

nextToken -> (string)

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

Constraints:

min: 1

max: 2048

Table of Contents

Feedback

User Guide