[ aws . events ]

describe-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..

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-endpoint
--name <value>
[--home-region <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

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

--home-region (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

Name -> (string)

The name of the endpoint you asked for information about.

Description -> (string)

The description of the endpoint you asked for information about.

Arn -> (string)

The ARN of the endpoint you asked for information about.

RoutingConfig -> (structure)

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

FailoverConfig -> (structure)

The failover configuration for an endpoint. This includes what triggers failover and what happens when it’s triggered.

Primary -> (structure)

The main Region of the endpoint.

HealthCheck -> (string)

The ARN of the health check used by the endpoint to determine whether failover is triggered.

Secondary -> (structure)

The Region that events are routed to when failover is triggered or event replication is enabled.

Route -> (string)

Defines the secondary Region.

ReplicationConfig -> (structure)

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

State -> (string)

The state of event replication.

EventBuses -> (list)

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

(structure)

The event buses the endpoint is associated with.

EventBusArn -> (string)

The ARN of the event bus the endpoint is associated with.

RoleArn -> (string)

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

EndpointId -> (string)

The ID of the endpoint you asked for information about.

EndpointUrl -> (string)

The URL of the endpoint you asked for information about.

State -> (string)

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

StateReason -> (string)

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

CreationTime -> (timestamp)

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

LastModifiedTime -> (timestamp)

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