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.
List AI Agent versions.
See also: AWS API Documentation
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
list-ai-agent-versions
--ai-agent-id <value>
--assistant-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>]
--ai-agent-id
(string)
The identifier of the Amazon Q in Connect AI Agent for which versions are to be listed.
--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.
--origin
(string)
The origin of the AI Agent versions to be listed.
SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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.
--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.
--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.
--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.
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.
aiAgentArn -> (string)
The Amazon Resource Name (ARN) of the AI agent.aiAgentId -> (string)
The identifier of the AI Agent.assistantArn -> (string)
The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.assistantId -> (string)
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.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:answerRecommendationAIAgentConfiguration
,manualSearchAIAgentConfiguration
,selfServiceAIAgentConfiguration
.answerRecommendationAIAgentConfiguration -> (structure)
The configuration for AI Agents of type
ANSWER_RECOMMENDATION
.answerGenerationAIGuardrailId -> (string)
The AI Guardrail identifier for the Answer Generation Guardrail used by theANSWER_RECOMMENDATION
AI Agent.answerGenerationAIPromptId -> (string)
The AI Prompt identifier for the Answer Generation prompt used by theANSWER_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.
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:andConditions
,orConditions
,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.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.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 beSEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw textassociationId -> (string)
The identifier of the association for this Association Configuration.associationType -> (string)
The type of the association for this Association Configuration.intentLabelingGenerationAIPromptId -> (string)
The AI Prompt identifier for the Intent Labeling prompt used by theANSWER_RECOMMENDATION
AI Agent.queryReformulationAIPromptId -> (string)
The AI Prompt identifier for the Query Reformulation prompt used by theANSWER_RECOMMENDATION
AI Agent.manualSearchAIAgentConfiguration -> (structure)
The configuration for AI Agents of type
MANUAL_SEARCH
.answerGenerationAIGuardrailId -> (string)
The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.answerGenerationAIPromptId -> (string)
The AI Prompt identifier for the Answer Generation prompt 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.
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:andConditions
,orConditions
,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.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.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 beSEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw textassociationId -> (string)
The identifier of the association for this Association Configuration.associationType -> (string)
The type of the association for this Association Configuration.selfServiceAIAgentConfiguration -> (structure)
The configuration for AI Agents of type SELF_SERVICE.
associationConfigurations -> (list)
The association configurations for overriding behavior on this AI Agent.
(structure)
The configuration for an Amazon Q in Connect Assistant Association.
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:andConditions
,orConditions
,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.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.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 beSEMANTIC
which uses vector embeddings orHYBRID
which use vector embeddings and raw textassociationId -> (string)
The identifier of the association for this Association Configuration.associationType -> (string)
The type of the association for this Association Configuration.selfServiceAIGuardrailId -> (string)
The AI Guardrail identifier 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 AgentselfServicePreProcessingAIPromptId -> (string)
The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agentdescription -> (string)
The description of the AI Agent.modifiedTime -> (timestamp)
The time the AI Agent was last modified.name -> (string)
The name of the AI Agent.origin -> (string)
The origin of the AI Agent.SYSTEM
for a default AI Agent created by Q in Connect orCUSTOMER
for an AI Agent created by calling AI Agent creation APIs.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)
type -> (string)
The type of the AI Agent.visibilityStatus -> (string)
The visibility status of the AI Agent.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.