EventBridge / Client / describe_connection

describe_connection#

EventBridge.Client.describe_connection(**kwargs)#

Retrieves details about a connection.

See also: AWS API Documentation

Request Syntax

response = client.describe_connection(
    Name='string'
)
Parameters:

Name (string) –

[REQUIRED]

The name of the connection to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'ConnectionArn': 'string',
    'Name': 'string',
    'Description': 'string',
    'InvocationConnectivityParameters': {
        'ResourceParameters': {
            'ResourceConfigurationArn': 'string',
            'ResourceAssociationArn': 'string'
        }
    },
    'ConnectionState': 'CREATING'|'UPDATING'|'DELETING'|'AUTHORIZED'|'DEAUTHORIZED'|'AUTHORIZING'|'DEAUTHORIZING'|'ACTIVE'|'FAILED_CONNECTIVITY',
    'StateReason': 'string',
    'AuthorizationType': 'BASIC'|'OAUTH_CLIENT_CREDENTIALS'|'API_KEY',
    'SecretArn': 'string',
    'AuthParameters': {
        'BasicAuthParameters': {
            'Username': 'string'
        },
        'OAuthParameters': {
            'ClientParameters': {
                'ClientID': 'string'
            },
            'AuthorizationEndpoint': 'string',
            'HttpMethod': 'GET'|'POST'|'PUT',
            'OAuthHttpParameters': {
                'HeaderParameters': [
                    {
                        'Key': 'string',
                        'Value': 'string',
                        'IsValueSecret': True|False
                    },
                ],
                'QueryStringParameters': [
                    {
                        'Key': 'string',
                        'Value': 'string',
                        'IsValueSecret': True|False
                    },
                ],
                'BodyParameters': [
                    {
                        'Key': 'string',
                        'Value': 'string',
                        'IsValueSecret': True|False
                    },
                ]
            }
        },
        'ApiKeyAuthParameters': {
            'ApiKeyName': 'string'
        },
        'InvocationHttpParameters': {
            'HeaderParameters': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'IsValueSecret': True|False
                },
            ],
            'QueryStringParameters': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'IsValueSecret': True|False
                },
            ],
            'BodyParameters': [
                {
                    'Key': 'string',
                    'Value': 'string',
                    'IsValueSecret': True|False
                },
            ]
        },
        'ConnectivityParameters': {
            'ResourceParameters': {
                'ResourceConfigurationArn': 'string',
                'ResourceAssociationArn': 'string'
            }
        }
    },
    'CreationTime': datetime(2015, 1, 1),
    'LastModifiedTime': datetime(2015, 1, 1),
    'LastAuthorizedTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • ConnectionArn (string) –

      The ARN of the connection retrieved.

    • Name (string) –

      The name of the connection retrieved.

    • Description (string) –

      The description for the connection retrieved.

    • InvocationConnectivityParameters (dict) –

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

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

      • ResourceParameters (dict) –

        The parameters for EventBridge to use when invoking the resource endpoint.

        • ResourceConfigurationArn (string) –

          The Amazon Resource Name (ARN) of the resource configuration for the private API.

        • ResourceAssociationArn (string) –

          For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API’s resource configuration.

    • ConnectionState (string) –

      The state of the connection retrieved.

    • StateReason (string) –

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

    • AuthorizationType (string) –

      The type of authorization specified for the connection.

    • SecretArn (string) –

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

    • AuthParameters (dict) –

      The parameters to use for authorization for the connection.

      • BasicAuthParameters (dict) –

        The authorization parameters for Basic authorization.

        • Username (string) –

          The user name to use for Basic authorization.

      • OAuthParameters (dict) –

        The OAuth parameters to use for authorization.

        • ClientParameters (dict) –

          Details about the client parameters returned when OAuth is specified as the authorization type.

          • ClientID (string) –

            The client ID associated with the response to the connection request.

        • AuthorizationEndpoint (string) –

          The URL to the HTTP endpoint that authorized the request.

        • HttpMethod (string) –

          The method used to connect to the HTTP endpoint.

        • OAuthHttpParameters (dict) –

          The additional HTTP parameters used for the OAuth authorization request.

          • HeaderParameters (list) –

            Any additional header parameters for the connection.

            • (dict) –

              Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

              • Key (string) –

                The key for the parameter.

              • Value (string) –

                The value associated with the key.

              • IsValueSecret (boolean) –

                Specifies whether the value is a secret.

          • QueryStringParameters (list) –

            Any additional query string parameters for the connection.

            • (dict) –

              Any additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

              • Key (string) –

                The key for a query string parameter.

              • Value (string) –

                The value associated with the key for the query string parameter.

              • IsValueSecret (boolean) –

                Specifies whether the value is secret.

          • BodyParameters (list) –

            Any additional body string parameters for the connection.

            • (dict) –

              Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

              • Key (string) –

                The key for the parameter.

              • Value (string) –

                The value associated with the key.

              • IsValueSecret (boolean) –

                Specifies whether the value is secret.

      • ApiKeyAuthParameters (dict) –

        The API Key parameters to use for authorization.

        • ApiKeyName (string) –

          The name of the header to use for the APIKeyValue used for authorization.

      • InvocationHttpParameters (dict) –

        Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.

        • HeaderParameters (list) –

          Any additional header parameters for the connection.

          • (dict) –

            Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

            • Key (string) –

              The key for the parameter.

            • Value (string) –

              The value associated with the key.

            • IsValueSecret (boolean) –

              Specifies whether the value is a secret.

        • QueryStringParameters (list) –

          Any additional query string parameters for the connection.

          • (dict) –

            Any additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

            • Key (string) –

              The key for a query string parameter.

            • Value (string) –

              The value associated with the key for the query string parameter.

            • IsValueSecret (boolean) –

              Specifies whether the value is secret.

        • BodyParameters (list) –

          Any additional body string parameters for the connection.

          • (dict) –

            Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

            • Key (string) –

              The key for the parameter.

            • Value (string) –

              The value associated with the key.

            • IsValueSecret (boolean) –

              Specifies whether the value is secret.

      • ConnectivityParameters (dict) –

        For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.

        For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

        • ResourceParameters (dict) –

          The parameters for EventBridge to use when invoking the resource endpoint.

          • ResourceConfigurationArn (string) –

            The Amazon Resource Name (ARN) of the resource configuration for the private API.

          • ResourceAssociationArn (string) –

            For connections to private APIs, the Amazon Resource Name (ARN) of the resource association EventBridge created between the connection and the private API’s resource configuration.

    • CreationTime (datetime) –

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

    • LastModifiedTime (datetime) –

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

    • LastAuthorizedTime (datetime) –

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

Exceptions