test_invoke_method¶
Operation¶
async
¶
test_invoke_method(input: TestInvokeMethodInput, plugins: list[Plugin] | None = None) -> TestInvokeMethodOutput
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TestInvokeMethodInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
TestInvokeMethodOutput
|
An instance of |
Input¶
dataclass
¶
Make a request to simulate the invocation of a Method.
Attributes¶
class-attribute
instance-attribute
¶
body: str | None = None
The simulated request body of an incoming invocation request.
class-attribute
instance-attribute
¶
client_certificate_id: str | None = None
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.
class-attribute
instance-attribute
¶
headers: dict[str, str] | None = None
A key-value map of headers to simulate an incoming invocation request.
class-attribute
instance-attribute
¶
http_method: str | None = None
Specifies a test invoke method request's HTTP method.
class-attribute
instance-attribute
¶
multi_value_headers: dict[str, list[str]] | None = None
The headers as a map from string to list of values to simulate an incoming invocation request.
class-attribute
instance-attribute
¶
path_with_query_string: str | None = None
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
class-attribute
instance-attribute
¶
resource_id: str | None = None
Specifies a test invoke method request's resource ID.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
stage_variables: dict[str, str] | None = None
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Output¶
dataclass
¶
Represents the response of the test invoke request in the HTTP method.
Attributes¶
class-attribute
instance-attribute
¶
headers: dict[str, str] | None = None
The headers of the HTTP response.
class-attribute
instance-attribute
¶
latency: int = 0
The execution latency, in ms, of the test invoke request.
class-attribute
instance-attribute
¶
log: str | None = None
The API Gateway execution log for the test invoke request.
class-attribute
instance-attribute
¶
multi_value_headers: dict[str, list[str]] | None = None
The headers of the HTTP response as a map from string to list of values.