aws_sdk_mwaa/client/
invoke_rest_api.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 [`InvokeRestApi`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`name(impl Into<String>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::set_name):<br>required: **true**<br><p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p><br>
7    ///   - [`path(impl Into<String>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::path) / [`set_path(Option<String>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::set_path):<br>required: **true**<br><p>The Apache Airflow REST API endpoint path to be called. For example, <code>/dags/123456/clearTaskInstances</code>. For more information, see <a href="https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html">Apache Airflow API</a></p><br>
8    ///   - [`method(RestApiMethod)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::method) / [`set_method(Option<RestApiMethod>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::set_method):<br>required: **true**<br><p>The HTTP method used for making Airflow REST API calls. For example, <code>POST</code>.</p><br>
9    ///   - [`query_parameters(Document)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::query_parameters) / [`set_query_parameters(Option<Document>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::set_query_parameters):<br>required: **false**<br><p>Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.</p><br>
10    ///   - [`body(Document)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::body) / [`set_body(Option<Document>)`](crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::set_body):<br>required: **false**<br><p>The request body for the Apache Airflow REST API call, provided as a JSON object.</p><br>
11    /// - On success, responds with [`InvokeRestApiOutput`](crate::operation::invoke_rest_api::InvokeRestApiOutput) with field(s):
12    ///   - [`rest_api_status_code(Option<i32>)`](crate::operation::invoke_rest_api::InvokeRestApiOutput::rest_api_status_code): <p>The HTTP status code returned by the Apache Airflow REST API call.</p>
13    ///   - [`rest_api_response(Option<Document>)`](crate::operation::invoke_rest_api::InvokeRestApiOutput::rest_api_response): <p>The response data from the Apache Airflow REST API call, provided as a JSON object.</p>
14    /// - On failure, responds with [`SdkError<InvokeRestApiError>`](crate::operation::invoke_rest_api::InvokeRestApiError)
15    pub fn invoke_rest_api(&self) -> crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder {
16        crate::operation::invoke_rest_api::builders::InvokeRestApiFluentBuilder::new(self.handle.clone())
17    }
18}