list_integration_associations

Connect.Client.list_integration_associations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_integration_associations(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
    NextToken='string',
    MaxResults=123
)

Parameters

• InstanceId (string) --

  [REQUIRED]

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

• IntegrationType (string) -- The integration type.
• 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.
• MaxResults (integer) -- The maximum number of results to return per page.

Return type

dict

Returns

Response Syntax

{
    'IntegrationAssociationSummaryList': [
        {
            'IntegrationAssociationId': 'string',
            'IntegrationAssociationArn': 'string',
            'InstanceId': 'string',
            'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
            'IntegrationArn': 'string',
            'SourceApplicationUrl': 'string',
            'SourceApplicationName': 'string',
            'SourceType': 'SALESFORCE'|'ZENDESK'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • IntegrationAssociationSummaryList (list) --

    The associations.

    • (dict) --

      Contains summary information about the associated AppIntegrations.

      • IntegrationAssociationId (string) --

        The identifier for the AppIntegration association.

      • IntegrationAssociationArn (string) --

        The Amazon Resource Name (ARN) for the AppIntegration association.

      • InstanceId (string) --

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

      • IntegrationType (string) --

        The integration type.

      • IntegrationArn (string) --

        The Amazon Resource Name (ARN) for the AppIntegration.

      • SourceApplicationUrl (string) --

        The URL for the external application.

      • SourceApplicationName (string) --

        The user-provided, friendly name for the external application.

      • SourceType (string) --

        The name of the source.

  • NextToken (string) --

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

Exceptions

• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.InternalServiceException
• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.ThrottlingException