Describe Endpoint

eventbridge_describe_endpoint

R Documentation

Get the information about an existing global endpoint¶

Description¶

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 .

Usage¶

eventbridge_describe_endpoint(Name, HomeRegion)

Arguments¶

Name: [required] The name of the endpoint you want to get information about. For example, "Name":"us-east-2-custom_bus_A-endpoint".
HomeRegion: The primary Region of the endpoint you want to get information about. For example "HomeRegion": "us-east-1".

Value¶

A list with the following syntax:

list(
  Name = "string",
  Description = "string",
  Arn = "string",
  RoutingConfig = list(
    FailoverConfig = list(
      Primary = list(
        HealthCheck = "string"
      ),
      Secondary = list(
        Route = "string"
      )
    )
  ),
  ReplicationConfig = list(
    State = "ENABLED"|"DISABLED"
  ),
  EventBuses = list(
    list(
      EventBusArn = "string"
    )
  ),
  RoleArn = "string",
  EndpointId = "string",
  EndpointUrl = "string",
  State = "ACTIVE"|"CREATING"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"DELETE_FAILED",
  StateReason = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$describe_endpoint(
  Name = "string",
  HomeRegion = "string"
)