Amazon Connect Service

{'IntegrationType': {'CASES_DOMAIN'}}

Creates an Amazon Web Services resource association with an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_integration_association(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'CASES_DOMAIN',
    IntegrationArn='string',
    SourceApplicationUrl='string',
    SourceApplicationName='string',
    SourceType='SALESFORCE'|'ZENDESK',
    Tags={
        'string': 'string'
    }
)

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type IntegrationType

string

param IntegrationType

[REQUIRED]

The type of information to be ingested.

type IntegrationArn

string

param IntegrationArn

[REQUIRED]

The Amazon Resource Name (ARN) of the integration.

Note

When integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.

type SourceApplicationUrl

string

param SourceApplicationUrl

The URL for the external application. This field is only required for the EVENT integration type.

type SourceApplicationName

string

param SourceApplicationName

The name of the external application. This field is only required for the EVENT integration type.

type SourceType

string

param SourceType

The type of the data source. This field is only required for the EVENT integration type.

type Tags

dict

param Tags

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

• (string) --

  • (string) --

rtype

dict

returns

Response Syntax

{
    'IntegrationAssociationId': 'string',
    'IntegrationAssociationArn': 'string'
}

Response Structure

• (dict) --

  • IntegrationAssociationId (string) --

    The identifier for the integration association.

  • IntegrationAssociationArn (string) --

    The Amazon Resource Name (ARN) for the association.

{'IntegrationType': {'CASES_DOMAIN'}}

{'IntegrationAssociationSummaryList': {'IntegrationType': {'CASES_DOMAIN'}}}

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

See also: AWS API Documentation

Request Syntax

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

type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

type IntegrationType

string

param IntegrationType

The integration type.

type NextToken

string

param NextToken

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.

type MaxResults

integer

param MaxResults

The maximum number of results to return per page.

rtype

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 instanceId in the 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.