ListIntegrationAssociationsCommand

Suggest an Edit

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

Example Syntax

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

import { ConnectClient, ListIntegrationAssociationsCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, ListIntegrationAssociationsCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // ListIntegrationAssociationsRequest
  InstanceId: "STRING_VALUE", // required
  IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY" || "ANALYTICS_CONNECTOR" || "CALL_TRANSFER_CONNECTOR" || "COGNITO_USER_POOL",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  IntegrationArn: "STRING_VALUE",
};
const command = new ListIntegrationAssociationsCommand(input);
const response = await client.send(command);
// { // ListIntegrationAssociationsResponse
//   IntegrationAssociationSummaryList: [ // IntegrationAssociationSummaryList
//     { // IntegrationAssociationSummary
//       IntegrationAssociationId: "STRING_VALUE",
//       IntegrationAssociationArn: "STRING_VALUE",
//       InstanceId: "STRING_VALUE",
//       IntegrationType: "EVENT" || "VOICE_ID" || "PINPOINT_APP" || "WISDOM_ASSISTANT" || "WISDOM_KNOWLEDGE_BASE" || "WISDOM_QUICK_RESPONSES" || "Q_MESSAGE_TEMPLATES" || "CASES_DOMAIN" || "APPLICATION" || "FILE_SCANNER" || "SES_IDENTITY" || "ANALYTICS_CONNECTOR" || "CALL_TRANSFER_CONNECTOR" || "COGNITO_USER_POOL",
//       IntegrationArn: "STRING_VALUE",
//       SourceApplicationUrl: "STRING_VALUE",
//       SourceApplicationName: "STRING_VALUE",
//       SourceType: "SALESFORCE" || "ZENDESK" || "CASES",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListIntegrationAssociationsCommand Input

See ListIntegrationAssociationsCommandInput for more details

Parameter
Type
Description
InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance. You can find the instance ID  in the Amazon Resource Name (ARN) of the instance.

IntegrationArn
string | undefined

The Amazon Resource Name (ARN) of the integration.

IntegrationType
IntegrationType | undefined

The integration type.

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.

ListIntegrationAssociationsCommand Output

See ListIntegrationAssociationsCommandOutput for details

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

The associations.

NextToken
string | undefined

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

Throws

Name
Fault
Details
InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidRequestException
client

The request is not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.