Amazon Web Services, Inc.

AmazonMWAA

Amazon Managed Workflows for Apache Airflow This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Managed Workflows for Apache Airflow This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What is Amazon MWAA? . Endpoints api.airflow.{region}.amazonaws.com (use api.airflow.{region}.api.aws for IPv6) - This endpoint is used for environment management. CreateEnvironment DeleteEnvironment GetEnvironment ListEnvironments ListTagsForResource TagResource UntagResource UpdateEnvironment env.airflow.{region}.amazonaws.com (use env.airflow.{region}.api.aws for IPv6) - This endpoint is used to operate the Airflow environment. CreateCliToken CreateWebLoginToken InvokeRestApi Regions For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference .

Endpoints 12

  • POSTCreate cli token/clitoken/:NameCreates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token .
  • GETGet environment/environments/:NameDescribes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
  • PUTCreate environment/environments/:NameCreates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.
  • DELETEDelete environment/environments/:NameDeletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.
  • PATCHUpdate environment/environments/:NameUpdates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
  • POSTCreate web login token/webtoken/:NameCreates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token .
  • POSTInvoke rest api/restapi/:NameInvokes the Apache Airflow REST API on the webserver with the specified inputs. To learn more, see Using the Apache Airflow REST API
  • GETList environments/environments?NextToken=string&MaxResults=0Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
  • GETList tags for resource/tags/:ResourceArnLists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging" .
  • POSTTag resource/tags/:ResourceArnAssociates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging" .
  • POSTPublish metrics/metrics/environments/:EnvironmentNameDeprecated. Internal only . Publishes environment health metrics to Amazon CloudWatch.

API details

Base URL
https://airflow.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
12 operations on 7 pathsPOST 5GET 3DELETE 2PUT 1PATCH 1
1 marked deprecated
Description format
AWS Smithy model, API version 2020-07-01

How to test the AmazonMWAA in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonMWAA collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create cli token” (POST /clitoken/:Name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AmazonMWAA?

Amazon Managed Workflows for Apache Airflow This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more… It is listed under Developer tools and has 12 endpoints.

Who publishes the AmazonMWAA?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AmazonMWAA?

Requests go to https://airflow.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AmazonMWAA?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AmazonMWAA have?

12 operations on 7 paths (5 POST, 3 GET, 2 DELETE, 1 PUT, 1 PATCH).

Is forking the AmazonMWAA free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.