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

CreateEventIntegration

Creates an EventIntegration, given a specified 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

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

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

Pattern: .*

Required: No

Description

The description of the event integration.

Type: String

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

Pattern: .*

Required: No

EventBridgeBus

The EventBridge bus.

Type: String

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

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

Required: Yes

EventFilter

The event filter.

Type: EventFilter object

Required: Yes

Name

The name of the event integration.

Type: String

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

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

Required: Yes

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 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
Content-type: application/json

{
   "EventIntegrationArn": "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.

EventIntegrationArn

The Amazon Resource Name (ARN) of 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}$

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

DuplicateResourceException

A resource with the specified name already exists.

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.

HTTP Status Code: 429