Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateIntegrationAssociation

Creates an AWS resource association with an Amazon Connect instance.

Request Syntax


PUT /instance/InstanceId/integration-associations HTTP/1.1
Content-type: application/json

{
   "IntegrationArn": "string",
   "IntegrationType": "string",
   "SourceApplicationName": "string",
   "SourceApplicationUrl": "string",
   "SourceType": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

Request Body

The request accepts the following data in JSON format.

IntegrationArn

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: String

Required: Yes

IntegrationType

The type of information to be ingested.

Type: String

Required: Yes

SourceApplicationName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^[a-zA-Z0-9_ -]+$

Required: No

SourceApplicationUrl

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2000.

Required: No

SourceType

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

Type: String

Valid Values: SALESFORCE | ZENDESK

Required: No

Tags

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IntegrationAssociationArn": "string",
   "IntegrationAssociationId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

IntegrationAssociationArn

The Amazon Resource Name (ARN) for the association.

Type: String

IntegrationAssociationId

The identifier for the integration association.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateResourceException

A resource with the specified name already exists.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429