aws_sdk_apigateway/client/
test_invoke_method.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`TestInvokeMethod`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`rest_api_id(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::rest_api_id) / [`set_rest_api_id(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_rest_api_id):<br>required: **true**<br><p>The string identifier of the associated RestApi.</p><br>
7    ///   - [`resource_id(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::resource_id) / [`set_resource_id(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_resource_id):<br>required: **true**<br><p>Specifies a test invoke method request's resource ID.</p><br>
8    ///   - [`http_method(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::http_method) / [`set_http_method(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_http_method):<br>required: **true**<br><p>Specifies a test invoke method request's HTTP method.</p><br>
9    ///   - [`path_with_query_string(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::path_with_query_string) / [`set_path_with_query_string(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_path_with_query_string):<br>required: **false**<br><p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p><br>
10    ///   - [`body(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::body) / [`set_body(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_body):<br>required: **false**<br><p>The simulated request body of an incoming invocation request.</p><br>
11    ///   - [`headers(impl Into<String>, impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::headers) / [`set_headers(Option<HashMap::<String, String>>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_headers):<br>required: **false**<br><p>A key-value map of headers to simulate an incoming invocation request.</p><br>
12    ///   - [`multi_value_headers(impl Into<String>, Vec::<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::multi_value_headers) / [`set_multi_value_headers(Option<HashMap::<String, Vec::<String>>>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_multi_value_headers):<br>required: **false**<br><p>The headers as a map from string to list of values to simulate an incoming invocation request.</p><br>
13    ///   - [`client_certificate_id(impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::client_certificate_id) / [`set_client_certificate_id(Option<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_client_certificate_id):<br>required: **false**<br><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><br>
14    ///   - [`stage_variables(impl Into<String>, impl Into<String>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::stage_variables) / [`set_stage_variables(Option<HashMap::<String, String>>)`](crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::set_stage_variables):<br>required: **false**<br><p>A key-value map of stage variables to simulate an invocation on a deployed Stage.</p><br>
15    /// - On success, responds with [`TestInvokeMethodOutput`](crate::operation::test_invoke_method::TestInvokeMethodOutput) with field(s):
16    ///   - [`status(i32)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::status): <p>The HTTP status code.</p>
17    ///   - [`body(Option<String>)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::body): <p>The body of the HTTP response.</p>
18    ///   - [`headers(Option<HashMap::<String, String>>)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::headers): <p>The headers of the HTTP response.</p>
19    ///   - [`multi_value_headers(Option<HashMap::<String, Vec::<String>>>)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::multi_value_headers): <p>The headers of the HTTP response as a map from string to list of values.</p>
20    ///   - [`log(Option<String>)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::log): <p>The API Gateway execution log for the test invoke request.</p>
21    ///   - [`latency(i64)`](crate::operation::test_invoke_method::TestInvokeMethodOutput::latency): <p>The execution latency, in ms, of the test invoke request.</p>
22    /// - On failure, responds with [`SdkError<TestInvokeMethodError>`](crate::operation::test_invoke_method::TestInvokeMethodError)
23    pub fn test_invoke_method(&self) -> crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder {
24        crate::operation::test_invoke_method::builders::TestInvokeMethodFluentBuilder::new(self.handle.clone())
25    }
26}