v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Update an existing endpoint. For more information about global endpoints, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html">Making applications Regional-fault tolerant with global endpoints and event replication</a> in the Amazon EventBridge User Guide..

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

Headers

X-Amz-Target'AWSEvents.UpdateEndpoint' required

Request body

Namestring required

The name of the endpoint you want to update.

Descriptionstring

A description for the endpoint.

RoleArnstring

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

Response

Success

Namestring

The name of the endpoint you updated in this request.

Arnstring

The ARN of the endpoint you updated in this request.

RoleArnstring

The ARN of the role used by event replication for the endpoint you updated in this request.

EndpointIdstring

The ID of the endpoint you updated in this request.

EndpointUrlstring

The URL of the endpoint you updated in this request.

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

The state of the endpoint you updated in this request.