Invoke Rest Api

mwaa_invoke_rest_api

R Documentation

Invokes the Apache Airflow REST API on the webserver with the specified inputs¶

Description¶

Invokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API

Usage¶

mwaa_invoke_rest_api(Name, Path, Method, QueryParameters, Body)

Arguments¶

Name

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

Path

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

Method

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

QueryParameters

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

Body

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

Value¶

A list with the following syntax:

list(
  RestApiStatusCode = 123,
  RestApiResponse = list()
)

Request syntax¶

svc$invoke_rest_api(
  Name = "string",
  Path = "string",
  Method = "GET"|"PUT"|"POST"|"PATCH"|"DELETE",
  QueryParameters = list(),
  Body = list()
)