Skip to content

TestInvokeMethodRequest

Source code in docs_src/capo_api_gateway/types/test_invoke_method_request.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class TestInvokeMethodRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    resource_id: "capo_api_gateway.types.string.String"
    """<p>Specifies a test invoke method request's resource ID.</p>"""
    http_method: "capo_api_gateway.types.string.String"
    """<p>Specifies a test invoke method request's HTTP method.</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>"""
    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.</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.</p>"""
    client_certificate_id: NotRequired["capo_api_gateway.types.string.String"]
    """<p>A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.</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>"""

body instance-attribute 

body: NotRequired[String]

The simulated request body of an incoming invocation request.

client_certificate_id instance-attribute 

client_certificate_id: NotRequired[String]

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

headers instance-attribute 

headers: NotRequired[MapOfStringToString]

A key-value map of headers to simulate an incoming invocation request.

http_method instance-attribute 

http_method: String

Specifies a test invoke method request's HTTP method.

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.

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.

resource_id instance-attribute 

resource_id: String

Specifies a test invoke method request's resource ID.

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.