Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451299221.6 KB

Retrieves details about a connection.

post/#X-Amz-Target=AWSEvents.DescribeConnection

Headers

X-Amz-Target'AWSEvents.DescribeConnection' required

Request body

Namestring required

The name of the connection to retrieve.

Response

Success

ConnectionArnstring

The ARN of the connection retrieved.

Namestring

The name of the connection retrieved.

Descriptionstring

The description for the connection retrieved.

ConnectionState'CREATING' | 'UPDATING' | 'DELETING' | 'AUTHORIZED' | 'DEAUTHORIZED' | 'AUTHORIZING' | 'DEAUTHORIZING'

The state of the connection retrieved.

StateReasonstring

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

AuthorizationType'BASIC' | 'OAUTH_CLIENT_CREDENTIALS' | 'API_KEY'

The type of authorization specified for the connection.

SecretArnstring

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

CreationTimestring date-time

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

LastModifiedTimestring date-time

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

LastAuthorizedTimestring date-time

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