Amazon AppIntegrations

(1)

Amazon AppIntegrations

Welcome

API Version 2020-07-29

(2)

Amazon AppIntegrations: Welcome

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

The Amazon AppIntegrations service enables you to conﬁgure and reuse connections to external applications.

For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide.

This document was last published on March 6, 2022.

API Version 2020-07-29 1

(7)

Actions

The following actions are supported:

• CreateDataIntegration (p. 3)

• CreateEventIntegration (p. 8)

• DeleteDataIntegration (p. 12)

• DeleteEventIntegration (p. 14)

• GetDataIntegration (p. 16)

• GetEventIntegration (p. 20)

• ListDataIntegrationAssociations (p. 23)

• ListDataIntegrations (p. 26)

• ListEventIntegrationAssociations (p. 29)

• ListEventIntegrations (p. 32)

• ListTagsForResource (p. 35)

• TagResource (p. 37)

• UntagResource (p. 39)

• UpdateDataIntegration (p. 41)

• UpdateEventIntegration (p. 44)

(8)

CreateDataIntegration

Creates and persists a DataIntegration resource.

NoteYou cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a diﬀerent DataIntegration, or recreate the DataIntegration using the

CreateDataIntegration API.

Request Syntax

POST /dataIntegrations HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "KmsKey": "string", "Name": "string", "ScheduleConfig": {

"FirstExecutionFrom": "string", "Object": "string",

"ScheduleExpression": "string"

},

"SourceURI": "string", "Tags": {

"string" : "string"

}}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken (p. 3)

A unique, case-sensitive identiﬁer that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: .*

Required: No Description (p. 3)

A description of the DataIntegration.

Type: String

Pattern: .*

(9)

Response Syntax

Required: No KmsKey (p. 3)

The KMS key for the DataIntegration.

Type: String

Pattern: .*\S.*

Required: Yes Name (p. 3)

The name of the DataIntegration.

Type: String

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

Required: Yes ScheduleConﬁg (p. 3)

The name of the data and how often it should be pulled from the source.

Type: ScheduleConﬁguration (p. 54) object Required: Yes

SourceURI (p. 3)

The URI of the data source.

Type: String

Pattern: ^\w+\:\/\/\w+\/[\w/!@#+=.-]+$

Required: Yes Tags (p. 3)

One or more tags.

Type: String to string map

Map Entries: Maximum number of 200 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

(10)

Content-type: application/json { "Arn": "string",

"ClientToken": "string", "Description": "string", "Id": "string",

"KmsKey": "string", "Name": "string",

"ScheduleConfiguration": { "FirstExecutionFrom": "string", "Object": "string",

},

"string" : "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.

Arn (p. 4)

The Amazon Resource Name (ARN) Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A- Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$

Type: String

Pattern: .*

Description (p. 4)

Type: String

Pattern: .*

Id (p. 4)

A unique identiﬁer.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

(11)

Errors

KmsKey (p. 4)

Type: String

Pattern: .*\S.*

Name (p. 4)

Type: String

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

ScheduleConﬁguration (p. 4)

Type: ScheduleConﬁguration (p. 54) object SourceURI (p. 4)

Type: String

Pattern: ^\w+\:\/\/\w+\/[\w/!@#+=.-]+$

Tags (p. 4)

One or more tags.

Errors

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

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 403 DuplicateResourceException

A resource with the speciﬁed name already exists.

(12)

HTTP Status Code: 409 InternalServiceError

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500 InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceQuotaExceededException

The allowed quota for the resource has been exceeded.

HTTP Status Code: 429 ThrottlingException

The throttling limit has been exceeded.

CreateEventIntegration

Creates an EventIntegration, given a speciﬁed name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.

Request Syntax

POST /eventIntegrations HTTP/1.1 Content-type: application/json { "ClientToken": "string", "Description": "string", "EventBridgeBus": "string", "EventFilter": {

"Source": "string"

},

"Name": "string", "Tags": {

"string" : "string"

}}

URI Request Parameters

The request does not use any URI parameters.

Request Body

Type: String

Pattern: .*

Required: No Description (p. 8)

The description of the event integration.

Type: String

Pattern: .*

Required: No EventBridgeBus (p. 8)

The EventBridge bus.

(14)

Type: String

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

Required: Yes EventFilter (p. 8)

The event ﬁlter.

Type: EventFilter (p. 49) object Required: Yes

Name (p. 8)

The name of the event integration.

Type: String

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

Required: Yes Tags (p. 8)

One or more tags.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "EventIntegrationArn": "string"

}

Response Elements

EventIntegrationArn (p. 9)

The Amazon Resource Name (ARN) of the event integration.

(15)

Errors

Type: String

Errors

HTTP Status Code: 403 DuplicateResourceException

A resource with the speciﬁed name already exists.

ResourceQuotaExceededException

The allowed quota for the resource has been exceeded.

DeleteDataIntegration

Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow ﬂow and service linked role.

Request Syntax

DELETE /dataIntegrations/Identifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Identiﬁer (p. 12)

A unique identiﬁer for the DataIntegration.

Pattern: .*\S.*

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

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

Errors

(18)

HTTP Status Code: 400 ResourceNotFoundException

The speciﬁed resource was not found.

DeleteEventIntegration

Deletes the speciﬁed existing event integration. If the event integration is associated with clients, the request is rejected.

Request Syntax

DELETE /eventIntegrations/Name HTTP/1.1

URI Request Parameters

Name (p. 14)

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

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(20)

GetDataIntegration

Returns information about the DataIntegration.

Request Syntax

GET /dataIntegrations/Identifier HTTP/1.1

URI Request Parameters

Identiﬁer (p. 16) A unique identiﬁer.

Pattern: .*\S.*

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Arn": "string",

"Description": "string", "Id": "string",

"KmsKey": "string", "Name": "string",

"ScheduleConfiguration": { "FirstExecutionFrom": "string", "Object": "string",

},

}}

Response Elements

(22)

Arn (p. 16)

The Amazon Resource Name (ARN) for the DataIntegration.

Type: String

Pattern: .*

Id (p. 16)

A unique identiﬁer.

Type: String

KmsKey (p. 16)

Type: String

Pattern: .*\S.*

Name (p. 16)

Type: String

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

ScheduleConﬁguration (p. 16)

Type: ScheduleConﬁguration (p. 54) object SourceURI (p. 16)

Type: String

Pattern: ^\w+\:\/\/\w+\/[\w/!@#+=.-]+$

(23)

Errors

Tags (p. 16)

One or more tags.

Errors

GetEventIntegration

Returns information about the event integration.

Request Syntax

GET /eventIntegrations/Name HTTP/1.1

URI Request Parameters

Name (p. 20)

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

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "Description": "string", "EventBridgeBus": "string", "EventFilter": {

"Source": "string"

},

"EventIntegrationArn": "string", "Name": "string",

"Tags": {

}}

Response Elements

The description of the event integration.

(26)

Type: String

Pattern: .*

EventBridgeBus (p. 20) The EventBridge bus.

Type: String

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

EventFilter (p. 20) The event ﬁlter.

Type: EventFilter (p. 49) object EventIntegrationArn (p. 20)

The Amazon Resource Name (ARN) for the event integration.

Type: String

Name (p. 20)

Type: String

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

Tags (p. 20)

One or more tags.

Errors

(27)

ListDataIntegrationAssociations

Returns a paginated list of DataIntegration associations in the account.

Note

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a diﬀerent DataIntegration, or recreate the DataIntegration using the

Request Syntax

GET /dataIntegrations/Identifier/associations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

Pattern: .*\S.*

Required: Yes MaxResults (p. 23)

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken (p. 23)

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.

Pattern: .*

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "DataIntegrationAssociations": [ {

"ClientId": "string",

(29)

Response Elements

"DataIntegrationArn": "string",

"DataIntegrationAssociationArn": "string"

} ],

"NextToken": "string"

}

Response Elements

DataIntegrationAssociations (p. 23)

The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.

Type: Array of DataIntegrationAssociationSummary (p. 47) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

If there are additional results, this is the token for the next set of results.

Type: String

Pattern: .*

Errors

(30)

ListDataIntegrations

Returns a paginated list of DataIntegrations in the account.

Note

You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a diﬀerent DataIntegration, or recreate the DataIntegration using the

Request Syntax

GET /dataIntegrations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

MaxResults (p. 26)

Pattern: .*

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "DataIntegrations": [ {

"Arn": "string", "Name": "string", "SourceURI": "string"

} ],

}

Response Elements

(32)

DataIntegrations (p. 26)

The DataIntegrations associated with this account.

Type: Array of DataIntegrationSummary (p. 48) objects

Type: String

Pattern: .*

Errors

ListEventIntegrationAssociations

Returns a paginated list of event integration associations in the account.

Request Syntax

GET /eventIntegrations/Name/associations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

Name (p. 29)

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

Required: Yes MaxResults (p. 29)

Pattern: .*

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "EventIntegrationAssociations": [ {

"ClientAssociationMetadata": { "string" : "string"

},

"ClientId": "string",

"EventBridgeRuleName": "string",

"EventIntegrationAssociationArn": "string", "EventIntegrationAssociationId": "string",

(35)

Response Elements

"EventIntegrationName": "string"

} ],

}

Response Elements

EventIntegrationAssociations (p. 29) The event integration associations.

Type: Array of EventIntegrationAssociation (p. 52) objects

Type: String

Pattern: .*

Errors

(36)

ListEventIntegrations

Returns a paginated list of event integrations in the account.

Request Syntax

GET /eventIntegrations?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

MaxResults (p. 32)

Pattern: .*

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "EventIntegrations": [ {

"Description": "string", "EventBridgeBus": "string", "EventFilter": {

"Source": "string"

},

"EventIntegrationArn": "string", "Name": "string",

"Tags": {

} } ],

}

Response Elements

(38)

EventIntegrations (p. 32) The event integrations.

Type: Array of EventIntegration (p. 50) objects

Type: String

Pattern: .*

Errors

ListTagsForResource

Lists the tags for the speciﬁed resource.

Request Syntax

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

resourceArn (p. 35)

The Amazon Resource Name (ARN) of the resource.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "tags": {

}}

Response Elements

tags (p. 35)

Information about the tags.

(41)

Errors

InternalServiceError

TagResource

Adds the speciﬁed tags to the speciﬁed resource.

Request Syntax

POST /tags/resourceArn HTTP/1.1 Content-type: application/json {

"tags": {

"string" : "string"

}}

URI Request Parameters

Required: Yes

Request Body

tags (p. 37)

One or more tags.

Required: Yes

Response Syntax

HTTP/1.1 200

(43)

Response Elements

Errors

UntagResource

Removes the speciﬁed tags from the speciﬁed resource.

Request Syntax

DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

Required: Yes tagKeys (p. 39)

The tag keys.

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

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

Response Elements

Errors

(45)

UpdateDataIntegration

Updates the description of a DataIntegration.

Request Syntax

PATCH /dataIntegrations/Identifier HTTP/1.1 Content-type: application/json

{

"Description": "string", "Name": "string"

}

URI Request Parameters

Pattern: .*\S.*

Required: Yes

Request Body

Type: String

Pattern: .*

Required: No Name (p. 41)

Type: String

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

(47)

Response Syntax

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

Errors

UpdateEventIntegration

Updates the description of an event integration.

Request Syntax

PATCH /eventIntegrations/Name HTTP/1.1 Content-type: application/json

{

"Description": "string"

}

URI Request Parameters

Name (p. 44)

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

Required: Yes

Request Body

The description of the event inegration.

Type: String

Pattern: .*

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

(50)

Errors

Data Types

The Amazon AppIntegrations Service API contains several data types that various actions use. This section describes each data type in detail.

Note

The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:

• DataIntegrationAssociationSummary (p. 47)

• DataIntegrationSummary (p. 48)

• EventFilter (p. 49)

• EventIntegration (p. 50)

• EventIntegrationAssociation (p. 52)

• ScheduleConﬁguration (p. 54)

(52)

DataIntegrationAssociationSummary

Summary information about the DataIntegration association.

DataIntegrationSummary

Summary information about the DataIntegration.

EventFilter

The event ﬁlter.

EventIntegration

The event integration.

EventIntegrationAssociation

The event integration association.

ScheduleConﬁguration

Common Parameters

The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

Action

The action to be performed.

Type: string Required: Yes Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string Required: Yes X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256 Required: Conditional

X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon Web Services General Reference.

Type: string

Required: Conditional X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:

20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is

(61)

not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Handling Dates in Signature Version 4 in the Amazon Web Services General Reference.

Type: string

Required: Conditional X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS Security Token Service, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, you must include the security token.

Type: string

Required: Conditional X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key.

Type: string

Required: Conditional X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Task 1: Create a Canonical Request For Signature Version 4 in the Amazon Web Services General Reference.

Type: string

Required: Conditional

(62)

Common Errors

This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action.

HTTP Status Code: 400 IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400 InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500 InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400 InvalidClientTokenId

The X.509 certiﬁcate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403 InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400 InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400 InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400 MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404 MissingAction

The request is missing an action or a required parameter.

(63)

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certiﬁcate.

HTTP Status Code: 403 MissingParameter

A required parameter for the speciﬁed action is not supplied.

HTTP Status Code: 400 NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400 OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403 RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

HTTP Status Code: 400 ServiceUnavailable

The request has failed due to a temporary failure of the server.

The request was denied due to request throttling.

HTTP Status Code: 400 ValidationError

The input fails to satisfy the constraints speciﬁed by an AWS service.

Amazon AppIntegrations

Amazon AppIntegrations

Welcome

API Version 2020-07-29

Amazon AppIntegrations: Welcome

Table of Contents

Welcome

Actions

CreateDataIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateEventIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteDataIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteEventIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

GetDataIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

GetEventIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListDataIntegrationAssociations

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListDataIntegrations

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListEventIntegrationAssociations

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also