See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

API Version 2020-07-29 19

GetEventIntegration

Returns information about the event integration.

Request Syntax

GET /eventIntegrations/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Name (p. 20)

The name of the event integration.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

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

"Source": "string"

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

"Tags": {

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

Description (p. 20)

The description of the event integration.

Type: String

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

Pattern: .*

EventBridgeBus (p. 20) The EventBridge bus.

Type: String

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

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

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

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}$

Name (p. 20)

The name of the event integration.

Type: String

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

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

Tags (p. 20)

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.

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.

API Version 2020-07-29 21

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

CreateDataIntegration API.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

Identiﬁer (p. 23)

A unique identiﬁer for the DataIntegration.

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

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.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

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

"ClientId": "string",

API Version 2020-07-29 23

Response Elements

"DataIntegrationArn": "string",

"DataIntegrationAssociationArn": "string"

} ],

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

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.

NextToken (p. 23)

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

Type: String

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

Pattern: .*

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 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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 26)

The maximum number of results to return per page.

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

NextToken (p. 26)

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.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

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

DataIntegrations (p. 26)

The DataIntegrations associated with this account.

Type: Array of DataIntegrationSummary (p. 48) objects

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

NextToken (p. 26)

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

Type: String

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

Pattern: .*

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 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 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

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

The request uses the following URI parameters.

Name (p. 29)

The name of the event integration.

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

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

Required: Yes MaxResults (p. 29)

The maximum number of results to return per page.

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

NextToken (p. 29)

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.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

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

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

"ClientId": "string",

"EventBridgeRuleName": "string",

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

API Version 2020-07-29 29

Response Elements

"EventIntegrationName": "string"

} ],

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

EventIntegrationAssociations (p. 29) The event integration associations.

Type: Array of EventIntegrationAssociation (p. 52) objects

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

NextToken (p. 29)

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

Type: String

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

Pattern: .*

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 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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

MaxResults (p. 32)

The maximum number of results to return per page.

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

NextToken (p. 32)

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.

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

Pattern: .*

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

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

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

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

EventIntegrations (p. 32) The event integrations.

Type: Array of EventIntegration (p. 50) objects

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

NextToken (p. 32)

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

Type: String

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

Pattern: .*

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 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 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

ListTagsForResource

Lists the tags for the speciﬁed resource.

Request Syntax

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 35)

The Amazon Resource Name (ARN) of the resource.

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

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}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

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

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

tags (p. 35)

Information about the tags.

Type: String to string map

Map Entries: Maximum number of 200 items.

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

API Version 2020-07-29 35

Errors

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

Value Length Constraints: Maximum length of 256.

Errors

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

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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

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

The request uses the following URI parameters.

resourceArn (p. 37)

The Amazon Resource Name (ARN) of the resource.

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

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}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

tags (p. 37)

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

Response Syntax

HTTP/1.1 200

API Version 2020-07-29 37

Response Elements

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

Errors

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

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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

UntagResource

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

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

resourceArn (p. 39)

The Amazon Resource Name (ARN) of the resource.

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

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}$

Required: Yes tagKeys (p. 39)

The tag keys.

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

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

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

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

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

InternalServiceError

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

API Version 2020-07-29 39

UpdateDataIntegration

Updates the description of a DataIntegration.

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

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

{

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

}

URI Request Parameters

The request uses the following URI parameters.

Identiﬁer (p. 41)

A unique identiﬁer for the DataIntegration.

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

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description (p. 41)

A description of the DataIntegration.

Type: String

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

Pattern: .*

Required: No Name (p. 41)

The name of the DataIntegration.

Type: String

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

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

API Version 2020-07-29 41

Response Syntax

Required: No

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

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 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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Request Syntax

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

{

"Description": "string"

}

URI Request Parameters

The request uses the following URI parameters.

Name (p. 44)

The name of the event integration.

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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description (p. 44)

The description of the event inegration.

Type: String

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

Pattern: .*

Required: No

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

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 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 ResourceNotFoundException

The speciﬁed resource was not found.

HTTP Status Code: 404 ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

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

ListEventIntegrations

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListTagsForResource

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

TagResource

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

UntagResource

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

UpdateDataIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

UpdateEventIntegration

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors