选择您的 Cookie 首选项

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

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

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

DescribeConnection

Retrieves details about a connection.

Request Syntax

{ "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.

Name

The name of the connection to retrieve.

Type: String

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

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

Required: Yes

Response Syntax

{ "AuthorizationType": "string", "AuthParameters": { "ApiKeyAuthParameters": { "ApiKeyName": "string" }, "BasicAuthParameters": { "Username": "string" }, "ConnectivityParameters": { "ResourceParameters": { "ResourceAssociationArn": "string", "ResourceConfigurationArn": "string" } }, "InvocationHttpParameters": { "BodyParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ], "HeaderParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ], "QueryStringParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ] }, "OAuthParameters": { "AuthorizationEndpoint": "string", "ClientParameters": { "ClientID": "string" }, "HttpMethod": "string", "OAuthHttpParameters": { "BodyParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ], "HeaderParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ], "QueryStringParameters": [ { "IsValueSecret": boolean, "Key": "string", "Value": "string" } ] } } }, "ConnectionArn": "string", "ConnectionState": "string", "CreationTime": number, "Description": "string", "InvocationConnectivityParameters": { "ResourceParameters": { "ResourceAssociationArn": "string", "ResourceConfigurationArn": "string" } }, "LastAuthorizedTime": number, "LastModifiedTime": number, "Name": "string", "SecretArn": "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.

AuthorizationType

The type of authorization specified for the connection.

Type: String

Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY

AuthParameters

The parameters to use for authorization for the connection.

Type: ConnectionAuthResponseParameters object

ConnectionArn

The ARN of the connection retrieved.

Type: String

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

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

ConnectionState

The state of the connection retrieved.

Type: String

Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY

CreationTime

A time stamp for the time that the connection was created.

Type: Timestamp

Description

The description for the connection retrieved.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

InvocationConnectivityParameters

For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.

For more information, see Connecting to private APIs in the Amazon EventBridge User Guide .

Type: DescribeConnectionConnectivityParameters object

LastAuthorizedTime

A time stamp for the time that the connection was last authorized.

Type: Timestamp

LastModifiedTime

A time stamp for the time that the connection was last modified.

Type: Timestamp

Name

The name of the connection retrieved.

Type: String

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

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

SecretArn

The ARN of the secret created from the authorization parameters specified for the connection.

Type: String

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

Pattern: ^arn:aws([a-z]|\-)*:secretsmanager:([a-z]|\d|\-)*:([0-9]{12})?:secret:[\/_+=\.@\-A-Za-z0-9]+$

StateReason

The reason that the connection is in the current connection state.

Type: String

Length Constraints: 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. 或其附属公司。保留所有权利。