[ aws . qconnect ]

list-ai-agents

Description

Lists AI Agents.

See also: AWS API Documentation

list-ai-agents 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: aiAgentSummaries

Synopsis

  list-ai-agents
--assistant-id <value>
[--origin <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]

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.

--origin (string)

The origin of the AI Agents 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 | --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

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

Output

aiAgentSummaries -> (list)

The summaries of AI Agents.

(structure)

The summary of the AI Agent.

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.

answerRecommendationAIAgentConfiguration -> (structure)

The configuration for AI Agents of type ANSWER_RECOMMENDATION .

answerGenerationAIPromptId -> (string)

The AI Prompt identifier for the Answer Generation prompt 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.

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 be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

associationId -> (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 the ANSWER_RECOMMENDATION AI Agent.

queryReformulationAIPromptId -> (string)

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

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.

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 be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text

associationId -> (string)

The identifier of the association for this Association Configuration.

associationType -> (string)

The type of the association for this Association Configuration.

description -> (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 or CUSTOMER 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.

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.