Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEndpoint

Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.

Request Syntax


{
   "HomeRegion": "string",
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

HomeRegion

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

Type: String

Length Constraints: Minimum length of 9. Maximum length of 20.

Pattern: ^[\-a-z0-9]+$

Required: No

Name

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

Type: String

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

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax


{
   "Arn": "string",
   "CreationTime": number,
   "Description": "string",
   "EndpointId": "string",
   "EndpointUrl": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "LastModifiedTime": number,
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string",
   "StateReason": "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.

Arn

The ARN of the endpoint you asked for information about.

Type: String

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

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$

CreationTime

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

Type: Timestamp

Description

The description of the endpoint you asked for information about.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

EndpointId

The ID of the endpoint you asked for information about.

Type: String

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

Pattern: ^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$

EndpointUrl

The URL of the endpoint you asked for information about.

Type: String

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

Pattern: ^(https://)?[\.\-a-z0-9]+$

EventBuses

The event buses being used by the endpoint you asked for information about.

Type: Array of EndpointEventBus objects

Array Members: Fixed number of 2 items.

LastModifiedTime

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

Type: Timestamp

Name

The name of the endpoint you asked for information about.

Type: String

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

Pattern: [\.\-_A-Za-z0-9]+

ReplicationConfig

Whether replication is enabled or disabled for the endpoint you asked for information about.

Type: ReplicationConfig object

RoleArn

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

Type: String

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

Pattern: ^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$

RoutingConfig

The routing configuration of the endpoint you asked for information about.

Type: RoutingConfig object

State

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

Type: String

StateReason

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

Type: String

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

Pattern: .*

Errors

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

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400