Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

InvokeRestApi

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

Request Syntax


POST /restapi/Name HTTP/1.1
Content-type: application/json

{
   "Body": JSON value,
   "Method": "string",
   "Path": "string",
   "QueryParameters": JSON value
}

URI Request Parameters

The request uses the following URI parameters.

Name

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

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: [a-zA-Z][0-9a-zA-Z-_]*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Body

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

Type: JSON value

Required: No

Method

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

Type: String

Valid Values: GET | PUT | POST | PATCH | DELETE

Required: Yes

Path

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

QueryParameters

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

Type: JSON value

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RestApiResponse": JSON value,
   "RestApiStatusCode": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

RestApiResponse

The response data from the Apache Airflow REST API call, provided as a JSON object.

Type: JSON value

RestApiStatusCode

The HTTP status code returned by the Apache Airflow REST API call.

Type: Integer

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

HTTP Status Code: 403

InternalServerException

InternalServerException: An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

ResourceNotFoundException: The resource is not available.

HTTP Status Code: 404

RestApiClientException

An exception indicating that a client-side error occurred during the Apache Airflow REST API call.

RestApiResponse: The error response data from the Apache Airflow REST API call, provided as a JSON object.
RestApiStatusCode: The HTTP status code returned by the Apache Airflow REST API call.

HTTP Status Code: 400

RestApiServerException

An exception indicating that a server-side error occurred during the Apache Airflow REST API call.

RestApiResponse: The error response data from the Apache Airflow REST API call, provided as a JSON object.
RestApiStatusCode: The HTTP status code returned by the Apache Airflow REST API call.

HTTP Status Code: 400

ValidationException

ValidationException: The provided input is not valid.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of InvokeRestApi.

Sample Request


{
      "name": "MyEnvironment",
      "path": "/dags",
      "method": "GET"
}

Example

This example illustrates one usage of InvokeRestApi.

Sample Response


{
      "restApiResponse": {"dags":[],"total_entries":0},
      "restApiStatusCode": 200,
}