选择您的 Cookie 首选项

我们使用必要 Cookie 和类似工具提供我们的网站和服务。我们使用性能 Cookie 收集匿名统计数据,以便我们可以了解客户如何使用我们的网站并进行改进。必要 Cookie 无法停用,但您可以单击“自定义”或“拒绝”来拒绝性能 Cookie。

如果您同意,AWS 和经批准的第三方还将使用 Cookie 提供有用的网站功能、记住您的首选项并显示相关内容,包括相关广告。要接受或拒绝所有非必要 Cookie,请单击“接受”或“拒绝”。要做出更详细的选择,请单击“自定义”。

DescribeEndpoint - Amazon EventBridge
此页面尚未翻译为您的语言。 请求翻译

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

Valid Values: ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隐私网站条款Cookie 首选项
© 2025, Amazon Web Services, Inc. 或其附属公司。保留所有权利。