- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListAIAgentsCommand
Lists AI Agents.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, ListAIAgentsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListAIAgentsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListAIAgentsRequest
assistantId: "STRING_VALUE", // required
nextToken: "STRING_VALUE",
maxResults: Number("int"),
origin: "STRING_VALUE",
};
const command = new ListAIAgentsCommand(input);
const response = await client.send(command);
// { // ListAIAgentsResponse
// aiAgentSummaries: [ // AIAgentSummaryList // required
// { // AIAgentSummary
// name: "STRING_VALUE", // required
// assistantId: "STRING_VALUE", // required
// assistantArn: "STRING_VALUE", // required
// aiAgentId: "STRING_VALUE", // required
// type: "STRING_VALUE", // required
// aiAgentArn: "STRING_VALUE", // required
// modifiedTime: new Date("TIMESTAMP"),
// visibilityStatus: "STRING_VALUE", // required
// configuration: { // AIAgentConfiguration Union: only one key present
// manualSearchAIAgentConfiguration: { // ManualSearchAIAgentConfiguration
// answerGenerationAIPromptId: "STRING_VALUE",
// answerGenerationAIGuardrailId: "STRING_VALUE",
// associationConfigurations: [ // AssociationConfigurationList
// { // AssociationConfiguration
// associationId: "STRING_VALUE",
// associationType: "STRING_VALUE",
// associationConfigurationData: { // AssociationConfigurationData Union: only one key present
// knowledgeBaseAssociationConfigurationData: { // KnowledgeBaseAssociationConfigurationData
// contentTagFilter: { // TagFilter Union: only one key present
// tagCondition: { // TagCondition
// key: "STRING_VALUE", // required
// value: "STRING_VALUE",
// },
// andConditions: [ // AndConditions
// {
// key: "STRING_VALUE", // required
// value: "STRING_VALUE",
// },
// ],
// orConditions: [ // OrConditions
// { // OrCondition Union: only one key present
// andConditions: [
// "<TagCondition>",
// ],
// tagCondition: "<TagCondition>",
// },
// ],
// },
// maxResults: Number("int"),
// overrideKnowledgeBaseSearchType: "STRING_VALUE",
// },
// },
// },
// ],
// locale: "STRING_VALUE",
// },
// answerRecommendationAIAgentConfiguration: { // AnswerRecommendationAIAgentConfiguration
// intentLabelingGenerationAIPromptId: "STRING_VALUE",
// queryReformulationAIPromptId: "STRING_VALUE",
// answerGenerationAIPromptId: "STRING_VALUE",
// answerGenerationAIGuardrailId: "STRING_VALUE",
// associationConfigurations: [
// {
// associationId: "STRING_VALUE",
// associationType: "STRING_VALUE",
// associationConfigurationData: {// Union: only one key present
// knowledgeBaseAssociationConfigurationData: {
// contentTagFilter: {// Union: only one key present
// tagCondition: "<TagCondition>",
// andConditions: [
// "<TagCondition>",
// ],
// orConditions: [
// {// Union: only one key present
// andConditions: [
// "<TagCondition>",
// ],
// tagCondition: "<TagCondition>",
// },
// ],
// },
// maxResults: Number("int"),
// overrideKnowledgeBaseSearchType: "STRING_VALUE",
// },
// },
// },
// ],
// locale: "STRING_VALUE",
// },
// selfServiceAIAgentConfiguration: { // SelfServiceAIAgentConfiguration
// selfServicePreProcessingAIPromptId: "STRING_VALUE",
// selfServiceAnswerGenerationAIPromptId: "STRING_VALUE",
// selfServiceAIGuardrailId: "STRING_VALUE",
// associationConfigurations: [
// {
// associationId: "STRING_VALUE",
// associationType: "STRING_VALUE",
// associationConfigurationData: {// Union: only one key present
// knowledgeBaseAssociationConfigurationData: {
// contentTagFilter: {// Union: only one key present
// tagCondition: "<TagCondition>",
// andConditions: [
// "<TagCondition>",
// ],
// orConditions: [
// {// Union: only one key present
// andConditions: "<AndConditions>",
// tagCondition: "<TagCondition>",
// },
// ],
// },
// maxResults: Number("int"),
// overrideKnowledgeBaseSearchType: "STRING_VALUE",
// },
// },
// },
// ],
// },
// },
// origin: "STRING_VALUE",
// description: "STRING_VALUE",
// status: "STRING_VALUE",
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListAIAgentsCommand Input
See ListAIAgentsCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
assistantIdRequired | string | undefined | The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. |
maxResults | number | undefined | The maximum number of results to return per page. |
nextToken | string | undefined | 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. |
origin | Origin | undefined | The origin of the AI Agents to be listed. |
ListAIAgentsCommand Output
See ListAIAgentsCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
aiAgentSummariesRequired | AIAgentSummary[] | undefined | The summaries of AI Agents. |
nextToken | string | undefined | 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. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | You do not have sufficient access to perform this action. |
| ResourceNotFoundException | client | The specified resource does not exist. |
| ThrottlingException | client | The throttling limit has been exceeded. |
| ValidationException | client | The input fails to satisfy the constraints specified by a service. |
| QConnectServiceException | Base exception class for all service exceptions from QConnect service. |