Skip to content

InvokeRestApiRequest

Source code in docs_src/capo_mwaa/types/invoke_rest_api_request.py 
16
17
18
19
20
21
22
23
24
25
26
class InvokeRestApiRequest(TypedDict, closed=True):
    name: "capo_mwaa.types.environment_name.EnvironmentName"
    """<p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>"""
    path: "capo_mwaa.types.rest_api_path.RestApiPath"
    """<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>"""
    method: "capo_mwaa.types.rest_api_method.RestApiMethod"
    """<p>The HTTP method used for making Airflow REST API calls. For example, <code>POST</code>. </p>"""
    query_parameters: NotRequired["object"]
    """<p>Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object. </p>"""
    body: NotRequired["capo_mwaa.types.rest_api_request_body.RestApiRequestBody"]
    """<p>The request body for the Apache Airflow REST API call, provided as a JSON object.</p>"""

body instance-attribute 

body: NotRequired[RestApiRequestBody]

The request body for the Apache Airflow REST API call, provided as a JSON object.

method instance-attribute 

method: RestApiMethod

The HTTP method used for making Airflow REST API calls. For example, POST.

name instance-attribute 

name: EnvironmentName

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

path instance-attribute 

path: RestApiPath

The Apache Airflow REST API endpoint path to be called. For example, /dags/123456/clearTaskInstances. For more information, see Apache Airflow API

query_parameters instance-attribute 

query_parameters: NotRequired[object]

Query parameters to be included in the Apache Airflow REST API call, provided as a JSON object.