Skip to content

DescribeConnectionResponse

Source code in docs_src/capo_eventbridge/types/describe_connection_response.py
class DescribeConnectionResponse(TypedDict, closed=True):
    connection_arn: NotRequired["capo_eventbridge.types.connection_arn.ConnectionArn"]
    """<p>The ARN of the connection retrieved.</p>"""
    name: NotRequired["capo_eventbridge.types.connection_name.ConnectionName"]
    """<p>The name of the connection retrieved.</p>"""
    description: NotRequired[
        "capo_eventbridge.types.connection_description.ConnectionDescription"
    ]
    """<p>The description for the connection retrieved.</p>"""
    invocation_connectivity_parameters: NotRequired[
        "capo_eventbridge.types.describe_connection_connectivity_parameters.DescribeConnectionConnectivityParameters"
    ]
    """<p>For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html">Connecting to private APIs</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>"""
    connection_state: NotRequired[
        "capo_eventbridge.types.connection_state.ConnectionState"
    ]
    """<p>The state of the connection retrieved.</p>"""
    state_reason: NotRequired[
        "capo_eventbridge.types.connection_state_reason.ConnectionStateReason"
    ]
    """<p>The reason that the connection is in the current connection state.</p>"""
    authorization_type: NotRequired[
        "capo_eventbridge.types.connection_authorization_type.ConnectionAuthorizationType"
    ]
    """<p>The type of authorization specified for the connection.</p>"""
    secret_arn: NotRequired[
        "capo_eventbridge.types.secrets_manager_secret_arn.SecretsManagerSecretArn"
    ]
    """<p>The ARN of the secret created from the authorization parameters specified for the connection.</p>"""
    kms_key_identifier: NotRequired[
        "capo_eventbridge.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-connections.html">Encrypting connections</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    auth_parameters: NotRequired[
        "capo_eventbridge.types.connection_auth_response_parameters.ConnectionAuthResponseParameters"
    ]
    """<p>The parameters to use for authorization for the connection.</p>"""
    creation_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the connection was created.</p>"""
    last_modified_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the connection was last modified.</p>"""
    last_authorized_time: NotRequired["capo_eventbridge.types.timestamp.Timestamp"]
    """<p>A time stamp for the time that the connection was last authorized.</p>"""

auth_parameters instance-attribute

auth_parameters: NotRequired[ConnectionAuthResponseParameters]

The parameters to use for authorization for the connection.

authorization_type instance-attribute

authorization_type: NotRequired[ConnectionAuthorizationType]

The type of authorization specified for the connection.

connection_arn instance-attribute

connection_arn: NotRequired[ConnectionArn]

The ARN of the connection retrieved.

connection_state instance-attribute

connection_state: NotRequired[ConnectionState]

The state of the connection retrieved.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

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

description instance-attribute

description: NotRequired[ConnectionDescription]

The description for the connection retrieved.

invocation_connectivity_parameters instance-attribute

invocation_connectivity_parameters: NotRequired[
    DescribeConnectionConnectivityParameters
]

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 .

kms_key_identifier instance-attribute

kms_key_identifier: NotRequired[KmsKeyIdentifier]

The identifier of the KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.

For more information, see Encrypting connections in the Amazon EventBridge User Guide.

last_authorized_time instance-attribute

last_authorized_time: NotRequired[Timestamp]

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

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

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

name instance-attribute

name: NotRequired[ConnectionName]

The name of the connection retrieved.

secret_arn instance-attribute

secret_arn: NotRequired[SecretsManagerSecretArn]

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

state_reason instance-attribute

state_reason: NotRequired[ConnectionStateReason]

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