ListAssistantsCommand

Suggest an Edit

Lists information about assistants.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QConnectClient, ListAssistantsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListAssistantsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListAssistantsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListAssistantsCommand(input);
const response = await client.send(command);
// { // ListAssistantsResponse
//   assistantSummaries: [ // AssistantList // required
//     { // AssistantSummary
//       assistantId: "STRING_VALUE", // required
//       assistantArn: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       type: "STRING_VALUE", // required
//       status: "STRING_VALUE", // required
//       description: "STRING_VALUE",
//       tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//       serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
//         kmsKeyId: "STRING_VALUE",
//       },
//       integrationConfiguration: { // AssistantIntegrationConfiguration
//         topicIntegrationArn: "STRING_VALUE",
//       },
//       capabilityConfiguration: { // AssistantCapabilityConfiguration
//         type: "STRING_VALUE",
//       },
//       aiAgentConfiguration: { // AIAgentConfigurationMap
//         "<keys>": { // AIAgentConfigurationData
//           aiAgentId: "STRING_VALUE", // required
//         },
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListAssistantsCommand Input

See ListAssistantsCommandInput for more details

Parameter
Type
Description
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.

ListAssistantsCommand Output

See ListAssistantsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
assistantSummaries
Required
AssistantSummary[] | undefined

Information about the assistants.

nextToken
string | undefined

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

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.