aws-elixir

View Source AWS.MWAA (aws-elixir v1.0.4)

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

 Endpoints

*

api.airflow.{region}.amazonaws.com - This endpoint is used for environment management.

*

CreateEnvironment 

*

DeleteEnvironment

*

GetEnvironment 

*

ListEnvironments

*

ListTagsForResource 

*

TagResource

*

UntagResource 

*

UpdateEnvironment

*

env.airflow.{region}.amazonaws.com - This endpoint is used to operate the Airflow environment.

*

CreateCliToken

*

CreateWebLoginToken

*

InvokeRestApi

regions

 Regions

For a list of supported regions, see Amazon MWAA endpoints and quotas in the Amazon Web Services General Reference.

Link to this section Summary

Functions

create_cli_token(client, name, input, options \\ [])

Creates a CLI token for the Airflow CLI.

create_environment(client, name, input, options \\ [])

Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

create_web_login_token(client, name, input, options \\ [])

Creates a web login token for the Airflow Web UI.

delete_environment(client, name, input, options \\ [])

Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

get_environment(client, name, options \\ [])

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

invoke_rest_api(client, name, input, options \\ [])

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

list_environments(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.

metadata()
publish_metrics(client, environment_name, input, options \\ [])

Internal only.

tag_resource(client, resource_arn, input, options \\ [])

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

untag_resource(client, resource_arn, input, options \\ [])

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

update_environment(client, name, input, options \\ [])

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Link to this section Functions

Link to this function

create_cli_token(client, name, input, options \\ [])

View Source

Creates a CLI token for the Airflow CLI.

To learn more, see Creating an Apache Airflow CLI token.

Link to this function

create_environment(client, name, input, options \\ [])

View Source

Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Link to this function

create_web_login_token(client, name, input, options \\ [])

View Source

Creates a web login token for the Airflow Web UI.

To learn more, see Creating an Apache Airflow web login token.

Link to this function

delete_environment(client, name, input, options \\ [])

View Source

Deletes an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Link to this function

get_environment(client, name, options \\ [])

View Source

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Link to this function

invoke_rest_api(client, name, input, options \\ [])

View Source

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

To learn more, see Using the Apache Airflow REST API

Link to this function

list_environments(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.

For example, "Environment": "Staging".

Link to this function

metadata()

View Source
Link to this function

publish_metrics(client, environment_name, input, options \\ [])

View Source

Internal only.

Publishes environment health metrics to Amazon CloudWatch.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.

For example, "Environment": "Staging".

Link to this function

update_environment(client, name, input, options \\ [])

View Source

Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.