ListAssistantAssociationsCommand

Suggest an Edit

Lists information about assistant associations.

Example Syntax

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

import { QConnectClient, ListAssistantAssociationsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListAssistantAssociationsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListAssistantAssociationsRequest
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  assistantId: "STRING_VALUE", // required
};
const command = new ListAssistantAssociationsCommand(input);
const response = await client.send(command);
// { // ListAssistantAssociationsResponse
//   assistantAssociationSummaries: [ // AssistantAssociationSummaryList // required
//     { // AssistantAssociationSummary
//       assistantAssociationId: "STRING_VALUE", // required
//       assistantAssociationArn: "STRING_VALUE", // required
//       assistantId: "STRING_VALUE", // required
//       assistantArn: "STRING_VALUE", // required
//       associationType: "STRING_VALUE", // required
//       associationData: { // AssistantAssociationOutputData Union: only one key present
//         knowledgeBaseAssociation: { // KnowledgeBaseAssociationData
//           knowledgeBaseId: "STRING_VALUE",
//           knowledgeBaseArn: "STRING_VALUE",
//         },
//       },
//       tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListAssistantAssociationsCommand Input

See ListAssistantAssociationsCommandInput for more details

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

ListAssistantAssociationsCommand Output

See ListAssistantAssociationsCommandOutput for details

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

Summary information about assistant associations.

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.

ResourceNotFoundException
client

The specified resource does not exist.

ValidationException
client

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

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