DescribeEndpointCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EventBridgeClient, DescribeEndpointCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
// const { EventBridgeClient, DescribeEndpointCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
const client = new EventBridgeClient(config);
const input = { // DescribeEndpointRequest
  Name: "STRING_VALUE", // required
  HomeRegion: "STRING_VALUE",
};
const command = new DescribeEndpointCommand(input);
const response = await client.send(command);
// { // DescribeEndpointResponse
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Arn: "STRING_VALUE",
//   RoutingConfig: { // RoutingConfig
//     FailoverConfig: { // FailoverConfig
//       Primary: { // Primary
//         HealthCheck: "STRING_VALUE", // required
//       },
//       Secondary: { // Secondary
//         Route: "STRING_VALUE", // required
//       },
//     },
//   },
//   ReplicationConfig: { // ReplicationConfig
//     State: "ENABLED" || "DISABLED",
//   },
//   EventBuses: [ // EndpointEventBusList
//     { // EndpointEventBus
//       EventBusArn: "STRING_VALUE", // required
//     },
//   ],
//   RoleArn: "STRING_VALUE",
//   EndpointId: "STRING_VALUE",
//   EndpointUrl: "STRING_VALUE",
//   State: "ACTIVE" || "CREATING" || "UPDATING" || "DELETING" || "CREATE_FAILED" || "UPDATE_FAILED" || "DELETE_FAILED",
//   StateReason: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LastModifiedTime: new Date("TIMESTAMP"),
// };

DescribeEndpointCommand Input

See DescribeEndpointCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

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

HomeRegion
string | undefined

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

DescribeEndpointCommand Output

See DescribeEndpointCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The ARN of the endpoint you asked for information about.

CreationTime
Date | undefined

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

Description
string | undefined

The description of the endpoint you asked for information about.

EndpointId
string | undefined

The ID of the endpoint you asked for information about.

EndpointUrl
string | undefined

The URL of the endpoint you asked for information about.

EventBuses
EndpointEventBus[] | undefined

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

LastModifiedTime
Date | undefined

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

Name
string | undefined

The name of the endpoint you asked for information about.

ReplicationConfig
ReplicationConfig | undefined

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

RoleArn
string | undefined

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

RoutingConfig
RoutingConfig | undefined

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

State
EndpointState | undefined

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

StateReason
string | undefined

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

Throws

Name
Fault
Details
InternalException
server

This exception occurs due to unexpected causes.

ResourceNotFoundException
client

An entity that you specified does not exist.

EventBridgeServiceException
Base exception class for all service exceptions from EventBridge service.