Connect / Paginator / ListIntegrationAssociations

ListIntegrationAssociations

class Connect.Paginator.ListIntegrationAssociations

paginator = client.get_paginator('list_integration_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_integration_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER',
    IntegrationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.

• IntegrationArn (string) – The Amazon Resource Name (ARN) of the integration.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.