Skip to content

ConnectionAuthResponseParameters

Source code in docs_src/capo_eventbridge/types/connection_auth_response_parameters.py
class ConnectionAuthResponseParameters(TypedDict, closed=True):
    basic_auth_parameters: NotRequired[
        "capo_eventbridge.types.connection_basic_auth_response_parameters.ConnectionBasicAuthResponseParameters"
    ]
    """<p>The authorization parameters for Basic authorization.</p>"""
    o_auth_parameters: NotRequired[
        "capo_eventbridge.types.connection_o_auth_response_parameters.ConnectionOAuthResponseParameters"
    ]
    """<p>The OAuth parameters to use for authorization.</p>"""
    api_key_auth_parameters: NotRequired[
        "capo_eventbridge.types.connection_api_key_auth_response_parameters.ConnectionApiKeyAuthResponseParameters"
    ]
    """<p>The API Key parameters to use for authorization.</p>"""
    invocation_http_parameters: NotRequired[
        "capo_eventbridge.types.connection_http_parameters.ConnectionHttpParameters"
    ]
    """<p>Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.</p>"""
    connectivity_parameters: NotRequired[
        "capo_eventbridge.types.describe_connection_connectivity_parameters.DescribeConnectionConnectivityParameters"
    ]
    """<p>For private OAuth authentication endpoints. The parameters EventBridge uses to authenticate against the endpoint.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection-auth.html">Authorization methods for connections</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>"""

api_key_auth_parameters instance-attribute

api_key_auth_parameters: NotRequired[ConnectionApiKeyAuthResponseParameters]

The API Key parameters to use for authorization.

basic_auth_parameters instance-attribute

basic_auth_parameters: NotRequired[ConnectionBasicAuthResponseParameters]

The authorization parameters for Basic authorization.

connectivity_parameters instance-attribute

connectivity_parameters: NotRequired[DescribeConnectionConnectivityParameters]

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 .

invocation_http_parameters instance-attribute

invocation_http_parameters: NotRequired[ConnectionHttpParameters]

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

o_auth_parameters instance-attribute

o_auth_parameters: NotRequired[ConnectionOAuthResponseParameters]

The OAuth parameters to use for authorization.