AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . qconnect ]

list-ai-agent-versions

Description

List AI Agent versions.

See also: AWS API Documentation

list-ai-agent-versions uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

list-ai-agent-versions is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: aiAgentVersionSummaries

Synopsis

  list-ai-agent-versions
--assistant-id <value>
--ai-agent-id <value>
[--origin <value>]
[--cli-input-json <value>]
[--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>]

Options

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

--ai-agent-id (string)

The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.

--origin (string)

The origin of the AI Agent versions to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

Possible values:

  • SYSTEM
  • CUSTOMER

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

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

Output

aiAgentVersionSummaries -> (list)

The summaries of AI Agent versions.

(structure)

The summary of the AI Agent version.

aiAgentSummary -> (structure)

The data for the summary of the AI Agent version.

name -> (string)

The name of the AI Agent.

assistantId -> (string)

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

assistantArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

aiAgentId -> (string)

The identifier of the AI Agent.

type -> (string)

The type of the AI Agent.

aiAgentArn -> (string)

The Amazon Resource Name (ARN) of the AI agent.

modifiedTime -> (timestamp)

The time the AI Agent was last modified.

visibilityStatus -> (string)

The visibility status of the AI Agent.

configuration -> (tagged union structure)

The configuration for the AI Agent.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: manualSearchAIAgentConfiguration, answerRecommendationAIAgentConfiguration, selfServiceAIAgentConfiguration, emailResponseAIAgentConfiguration, emailOverviewAIAgentConfiguration, emailGenerativeAnswerAIAgentConfiguration, orchestrationAIAgentConfiguration, noteTakingAIAgentConfiguration, caseSummarizationAIAgentConfiguration.

manualSearchAIAgentConfiguration -> (structure)

The configuration for AI Agents of type MANUAL_SEARCH .

answerGenerationAIPromptId -> (string)

The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.

answerGenerationAIGuardrailId -> (string)

The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.

associationConfigurations -> (list)

The association configurations for overriding behavior on this AI Agent.

(structure)

The configuration for an Amazon Q in Connect Assistant Association.

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

associationConfigurationData -> (tagged union structure)

The data of the configuration for an Amazon Q in Connect Assistant Association.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseAssociationConfigurationData.

knowledgeBaseAssociationConfigurationData -> (structure)

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

contentTagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tagCondition, andConditions, orConditions.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

maxResults -> (integer)

The maximum number of results to return per page.

overrideKnowledgeBaseSearchType -> (string)

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

locale -> (string)

The locale to which specifies the language and region settings that determine the response language for QueryAssistant .

Note

For more information on supported locales, see Language support for Amazon Q in Connect .

answerRecommendationAIAgentConfiguration -> (structure)

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

intentLabelingGenerationAIPromptId -> (string)

The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.

queryReformulationAIPromptId -> (string)

The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.

answerGenerationAIPromptId -> (string)

The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.

answerGenerationAIGuardrailId -> (string)

The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.

associationConfigurations -> (list)

The association configurations for overriding behavior on this AI Agent.

(structure)

The configuration for an Amazon Q in Connect Assistant Association.

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

associationConfigurationData -> (tagged union structure)

The data of the configuration for an Amazon Q in Connect Assistant Association.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseAssociationConfigurationData.

knowledgeBaseAssociationConfigurationData -> (structure)

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

contentTagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tagCondition, andConditions, orConditions.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

maxResults -> (integer)

The maximum number of results to return per page.

overrideKnowledgeBaseSearchType -> (string)

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

locale -> (string)

The locale to which specifies the language and region settings that determine the response language for QueryAssistant .

Note

For more information on supported locales, see Language support for Amazon Q in Connect .

suggestedMessages -> (list)

The suggested messages configuration for the Answer Recommendation AI Agent.

(string)

selfServiceAIAgentConfiguration -> (structure)

The configuration for AI Agents of type SELF_SERVICE.

selfServicePreProcessingAIPromptId -> (string)

The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent

selfServiceAnswerGenerationAIPromptId -> (string)

The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent

selfServiceAIGuardrailId -> (string)

The AI Guardrail identifier used by the SELF_SERVICE AI Agent.

associationConfigurations -> (list)

The association configurations for overriding behavior on this AI Agent.

(structure)

The configuration for an Amazon Q in Connect Assistant Association.

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

associationConfigurationData -> (tagged union structure)

The data of the configuration for an Amazon Q in Connect Assistant Association.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseAssociationConfigurationData.

knowledgeBaseAssociationConfigurationData -> (structure)

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

contentTagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tagCondition, andConditions, orConditions.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

maxResults -> (integer)

The maximum number of results to return per page.

overrideKnowledgeBaseSearchType -> (string)

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

emailResponseAIAgentConfiguration -> (structure)

Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.

emailResponseAIPromptId -> (string)

The ID of the System AI prompt used for generating professional email responses based on knowledge base content.

emailQueryReformulationAIPromptId -> (string)

The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.

locale -> (string)

The locale setting for language-specific email response generation (for example, en_US, es_ES).

associationConfigurations -> (list)

Configuration settings for knowledge base associations used by the email response agent.

(structure)

The configuration for an Amazon Q in Connect Assistant Association.

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

associationConfigurationData -> (tagged union structure)

The data of the configuration for an Amazon Q in Connect Assistant Association.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseAssociationConfigurationData.

knowledgeBaseAssociationConfigurationData -> (structure)

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

contentTagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tagCondition, andConditions, orConditions.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

maxResults -> (integer)

The maximum number of results to return per page.

overrideKnowledgeBaseSearchType -> (string)

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

emailOverviewAIAgentConfiguration -> (structure)

Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.

emailOverviewAIPromptId -> (string)

The ID of the System AI prompt used for generating structured email conversation summaries.

locale -> (string)

The locale setting for language-specific email overview processing (for example, en_US, es_ES).

emailGenerativeAnswerAIAgentConfiguration -> (structure)

Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.

emailGenerativeAnswerAIPromptId -> (string)

The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.

emailQueryReformulationAIPromptId -> (string)

The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.

locale -> (string)

The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).

associationConfigurations -> (list)

Configuration settings for knowledge base associations used by the email generative answer agent.

(structure)

The configuration for an Amazon Q in Connect Assistant Association.

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

associationConfigurationData -> (tagged union structure)

The data of the configuration for an Amazon Q in Connect Assistant Association.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: knowledgeBaseAssociationConfigurationData.

knowledgeBaseAssociationConfigurationData -> (structure)

The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.

contentTagFilter -> (tagged union structure)

An object that can be used to specify Tag conditions.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: tagCondition, andConditions, orConditions.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

orConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(tagged union structure)

A list of conditions which would be applied together with an OR condition.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: andConditions, tagCondition.

andConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

tagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition.

key -> (string)

The tag key in the tag condition.

value -> (string)

The tag value in the tag condition.

maxResults -> (integer)

The maximum number of results to return per page.

overrideKnowledgeBaseSearchType -> (string)

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

orchestrationAIAgentConfiguration -> (structure)

The configuration for AI Agents of type ORCHESTRATION .

orchestrationAIPromptId -> (string)

The AI Prompt identifier used by the Orchestration AI Agent.

orchestrationAIGuardrailId -> (string)

The AI Guardrail identifier used by the Orchestration AI Agent.

toolConfigurations -> (list)

The tool configurations used by the Orchestration AI Agent.

(structure)

Configuration settings for a tool used by AI Agents.

toolName -> (string)

The name of the tool.

toolType -> (string)

The type of the tool.

title -> (string)

The title of the tool configuration.

toolId -> (string)

The identifier of the tool, for example toolName from Model Context Provider server.

description -> (string)

The description of the tool configuration.

instruction -> (structure)

Instructions for using the tool.

instruction -> (string)

The instruction text for the tool.

examples -> (list)

Examples for using the tool.

(string)

overrideInputValues -> (list)

Override input values for the tool configuration.

(structure)

An input value override for tools.

jsonPath -> (string)

The JSON path for the input value override.

value -> (tagged union structure)

The override input value.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: constant.

constant -> (structure)

Constant input value configuration for tool override.

type -> (string)

Override tool input value with constant values

value -> (string)

The constant input override value.

outputFilters -> (list)

Output filters applies to the tool result.

(structure)

Filter configuration for tool output.

jsonPath -> (string)

The JSON path for filtering tool output.

outputConfiguration -> (structure)

The output configuration for the filter.

outputVariableNameOverride -> (string)

Override the tool output results to different variable name.

sessionDataNamespace -> (string)

The session data namespace for tool output.

inputSchema -> (document)

The input schema for the tool configuration.

outputSchema -> (document)

The output schema for the tool configuration.

annotations -> (structure)

Annotations for the tool configuration.

title -> (string)

The title of the annotation.

destructiveHint -> (boolean)

A hint indicating that the annotation contains potentially destructive content.

userInteractionConfiguration -> (structure)

Configuration for user interaction with the tool.

isUserConfirmationRequired -> (boolean)

Indicates whether user confirmation is required for the interaction.

connectInstanceArn -> (string)

The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.

locale -> (string)

The locale setting for the Orchestration AI Agent.

noteTakingAIAgentConfiguration -> (structure)

The configuration for AI Agents of type NOTE_TAKING .

noteTakingAIPromptId -> (string)

The AI Prompt identifier used by the Note Taking AI Agent.

noteTakingAIGuardrailId -> (string)

The AI Guardrail identifier used by the Note Taking AI Agent.

locale -> (string)

The locale setting for language-specific case summarization generation (for example, en_US, es_ES).

caseSummarizationAIAgentConfiguration -> (structure)

The configuration for AI Agents of type CASE_SUMMARIZATION .

caseSummarizationAIPromptId -> (string)

The AI Prompt identifier used by the Case Summarization AI Agent.

caseSummarizationAIGuardrailId -> (string)

The AI Guardrail identifier used by the Case Summarization AI Agent.

locale -> (string)

The locale setting for the Case Summarization AI Agent.

origin -> (string)

The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.

description -> (string)

The description of the AI Agent.

status -> (string)

The status of the AI Agent.

tags -> (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

versionNumber -> (long)

The version number for this AI Agent version.

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.