Skip to content

TestInvokeAuthorizerRequest

Source code in docs_src/capo_api_gateway/types/test_invoke_authorizer_request.py
class TestInvokeAuthorizerRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    authorizer_id: "capo_api_gateway.types.string.String"
    """<p>Specifies a test invoke authorizer request's Authorizer ID.</p>"""
    headers: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.</p>"""
    multi_value_headers: NotRequired[
        "capo_api_gateway.types.map_of_string_to_list.MapOfStringToList"
    ]
    """<p>The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.</p>"""
    path_with_query_string: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>"""
    body: NotRequired["capo_api_gateway.types.string.String"]
    """<p>The simulated request body of an incoming invocation request.</p>"""
    stage_variables: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p>"""
    additional_context: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>A key-value map of additional context variables.</p>"""

additional_context instance-attribute

additional_context: NotRequired[MapOfStringToString]

A key-value map of additional context variables.

authorizer_id instance-attribute

authorizer_id: String

Specifies a test invoke authorizer request's Authorizer ID.

body instance-attribute

body: NotRequired[String]

The simulated request body of an incoming invocation request.

headers instance-attribute

headers: NotRequired[MapOfStringToString]

A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

multi_value_headers instance-attribute

multi_value_headers: NotRequired[MapOfStringToList]

The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

path_with_query_string instance-attribute

path_with_query_string: NotRequired[String]

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

rest_api_id instance-attribute

rest_api_id: String

The string identifier of the associated RestApi.

stage_variables instance-attribute

stage_variables: NotRequired[MapOfStringToString]

A key-value map of stage variables to simulate an invocation on a deployed Stage.