ConnectCampaignServiceV2 / Client / list_connect_instance_integrations

list_connect_instance_integrations#

ConnectCampaignServiceV2.Client.list_connect_instance_integrations(**kwargs)#

Provides summary information about the integration under the specified Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_connect_instance_integrations(
    connectInstanceId='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • connectInstanceId (string) –

    [REQUIRED]

    Amazon Connect Instance Id

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    The response for ListConnectInstanceIntegrations API.

    • nextToken (string) –

      The token for the next set of results.

    • 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)

Exceptions

  • ConnectCampaignServiceV2.Client.exceptions.InternalServerException

  • ConnectCampaignServiceV2.Client.exceptions.ResourceNotFoundException

  • ConnectCampaignServiceV2.Client.exceptions.ValidationException

  • ConnectCampaignServiceV2.Client.exceptions.AccessDeniedException

  • ConnectCampaignServiceV2.Client.exceptions.ThrottlingException