Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Get the information about an existing global 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.DescribeEndpoint

Headers

X-Amz-Target'AWSEvents.DescribeEndpoint' required

Request body

Namestring required

The name of the endpoint you want to get information about. For example, <code>"Name":"us-east-2-custom_bus_A-endpoint"</code>.

HomeRegionstring

The primary Region of the endpoint you want to get information about. For example <code>"HomeRegion": "us-east-1"</code>.

Response

Success

Namestring

The name of the endpoint you asked for information about.

Descriptionstring

The description of the endpoint you asked for information about.

Arnstring

The ARN of the endpoint you asked for information about.

RoleArnstring

The ARN of the role used by the endpoint you asked for information about.

EndpointIdstring

The ID of the endpoint you asked for information about.

EndpointUrlstring

The URL of the endpoint you asked for information about.

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

The current state of the endpoint you asked for information about.

StateReasonstring

The reason the endpoint you asked for information about is in its current state.

CreationTimestring date-time

The time the endpoint you asked for information about was created.

LastModifiedTimestring date-time

The last time the endpoint you asked for information about was modified.