Selecione suas preferências de cookies

Usamos cookies essenciais e ferramentas semelhantes que são necessárias para fornecer nosso site e serviços. Usamos cookies de desempenho para coletar estatísticas anônimas, para que possamos entender como os clientes usam nosso site e fazer as devidas melhorias. Cookies essenciais não podem ser desativados, mas você pode clicar em “Personalizar” ou “Recusar” para recusar cookies de desempenho.

Se você concordar, a AWS e terceiros aprovados também usarão cookies para fornecer recursos úteis do site, lembrar suas preferências e exibir conteúdo relevante, incluindo publicidade relevante. Para aceitar ou recusar todos os cookies não essenciais, clique em “Aceitar” ou “Recusar”. Para fazer escolhas mais detalhadas, clique em “Personalizar”.

DescribeConnection - Amazon EventBridge
Esta página não foi traduzida para seu idioma. Solicitar tradução

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:

PrivacidadeTermos do sitePreferências de cookies
© 2025, Amazon Web Services, Inc. ou suas afiliadas. Todos os direitos reservados.