Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

post/#X-Amz-Target=AWSEvents.CreateEndpoint

Headers

X-Amz-Target'AWSEvents.CreateEndpoint' required

Request body

Namestring required

The name of the global endpoint. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.

Descriptionstring

A description of the global endpoint.

RoleArnstring

The ARN of the role used for replication.

Response

Success

Namestring

The name of the endpoint that was created by this request.

Arnstring

The ARN of the endpoint that was created by this request.

RoleArnstring

The ARN of the role used by event replication for this request.

State'ACTIVE' | 'CREATING' | 'UPDATING' | 'DELETING' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED'

The state of the endpoint that was created by this request.