ConnectCampaignServiceV2 / Paginator / ListConnectInstanceIntegrations

ListConnectInstanceIntegrations

class ConnectCampaignServiceV2.Paginator.ListConnectInstanceIntegrations

paginator = client.get_paginator('list_connect_instance_integrations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConnectCampaignServiceV2.Client.list_connect_instance_integrations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    connectInstanceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• connectInstanceId (string) –

  [REQUIRED]

  Amazon Connect Instance Id

• 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

{
    'integrationSummaryList': [
        {
            'customerProfiles': {
                'domainArn': 'string',
                'objectTypeNames': {
                    'string': 'string'
                }
            },
            'qConnect': {
                'knowledgeBaseArn': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  The response for ListConnectInstanceIntegrations API.

  • integrationSummaryList (list) –

    A list of Amazon Connect Instance Integrations.

    • (dict) –

      Integration summary for Connect instance.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: customerProfiles, qConnect. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • customerProfiles (dict) –

        Customer Profiles integration summary

        • domainArn (string) –

          Amazon Resource Names(ARN)

        • objectTypeNames (dict) –

          Object type names map.

          • (string) –

            Enumeration of Customer Profiles event type

            • (string) –

              Object type name

      • qConnect (dict) –

        Q Connect integration summary

        • knowledgeBaseArn (string) –

          Amazon Resource Names(ARN)

  • NextToken (string) –

    A token to resume pagination.