CreateIntegrationAssociation
This API is in preview release for Amazon Connect and is subject to change.
Create an AppIntegration 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
"
}
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect 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.
Type: String
Required: Yes
- IntegrationType
-
The type of information to be ingested.
Type: String
Valid Values:
EVENT
Required: Yes
- SourceApplicationName
-
The name of the external application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^[a-zA-Z0-9_ -]+$
Required: Yes
- SourceApplicationUrl
-
The URL for the external application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2000.
Required: Yes
- SourceType
-
The type of the data source.
Type: String
Valid Values:
SALESFORCE | ZENDESK
Required: Yes
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 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: