Own AWS? Customize your docs with AI search, analytics, and more.

Claim your docs

AWS

PATCH

/environments/{Name}

http://airflow.{region}.amazonaws.com/environments/{Name}

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

Access Token Required: API Key

Path Parameters

Namestringrequired

The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.

Body Params

DagS3Pathstring

The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.

MaxWorkersinteger

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. For example, <code>20</code>. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in <code>MinWorkers</code>.

MinWorkersinteger

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the <code>MaxWorkers</code> field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the <code>MinWorkers</code> field. For example, <code>2</code>.

Schedulersinteger

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

PluginsS3Pathstring

The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.

AirflowVersionstring

The Apache Airflow version for your environment. If no value is specified, defaults to the latest version. Valid values: <code>1.10.12</code>, <code>2.0.2</code>, <code>2.2.2</code>, and <code>2.4.3</code>.

SourceBucketArnstring

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.

EnvironmentClassstring

The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.

ExecutionRoleArnstring

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.

RequirementsS3Pathstring

The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.

StartupScriptS3Pathstring

The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>. Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.

WebserverAccessModestring

The Apache Airflow Web server access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.

LoggingConfigurationobject

Defines the Apache Airflow log types to send to CloudWatch Logs.

NetworkConfigurationobject

Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.

PluginsS3ObjectVersionstring

The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <code>plugins.zip</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.

AirflowConfigurationOptionsobject

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.

RequirementsS3ObjectVersionstring

The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <code>requirements.txt</code> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.

StartupScriptS3ObjectVersionstring

The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example: <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>.

WeeklyMaintenanceWindowStartstring

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://airflow.{region}.amazonaws.com/environments/{Name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PATCH

/environments/{Name}

http://airflow.{region}.amazonaws.com/environments/{Name}

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

Access Token Required: API Key

Path Parameters

Namestringrequired

The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.

Body Params

DagS3Pathstring

MaxWorkersinteger

MinWorkersinteger

Schedulersinteger

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

PluginsS3Pathstring

AirflowVersionstring

SourceBucketArnstring

EnvironmentClassstring

ExecutionRoleArnstring

RequirementsS3Pathstring

StartupScriptS3Pathstring

WebserverAccessModestring

The Apache Airflow Web server access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.

LoggingConfigurationobject

Defines the Apache Airflow log types to send to CloudWatch Logs.

NetworkConfigurationobject

PluginsS3ObjectVersionstring

AirflowConfigurationOptionsobject

RequirementsS3ObjectVersionstring

StartupScriptS3ObjectVersionstring

WeeklyMaintenanceWindowStartstring

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://airflow.{region}.amazonaws.com/environments/{Name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PATCH

/environments/{Name}

http://airflow.{region}.amazonaws.com/environments/{Name}

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

Access Token Required: API Key

Path Parameters

Namestringrequired

The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.

Body Params

DagS3Pathstring

MaxWorkersinteger

MinWorkersinteger

Schedulersinteger

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

PluginsS3Pathstring

AirflowVersionstring

SourceBucketArnstring

EnvironmentClassstring

ExecutionRoleArnstring

RequirementsS3Pathstring

StartupScriptS3Pathstring

WebserverAccessModestring

The Apache Airflow Web server access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.

LoggingConfigurationobject

Defines the Apache Airflow log types to send to CloudWatch Logs.

NetworkConfigurationobject

PluginsS3ObjectVersionstring

AirflowConfigurationOptionsobject

RequirementsS3ObjectVersionstring

StartupScriptS3ObjectVersionstring

WeeklyMaintenanceWindowStartstring

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://airflow.{region}.amazonaws.com/environments/{Name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PATCH

/environments/{Name}

http://airflow.{region}.amazonaws.com/environments/{Name}

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

Access Token Required: API Key

Path Parameters

Namestringrequired

The name of your Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.

Body Params

DagS3Pathstring

MaxWorkersinteger

MinWorkersinteger

Schedulersinteger

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

PluginsS3Pathstring

AirflowVersionstring

SourceBucketArnstring

EnvironmentClassstring

ExecutionRoleArnstring

RequirementsS3Pathstring

StartupScriptS3Pathstring

WebserverAccessModestring

The Apache Airflow Web server access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.

LoggingConfigurationobject

Defines the Apache Airflow log types to send to CloudWatch Logs.

NetworkConfigurationobject

PluginsS3ObjectVersionstring

AirflowConfigurationOptionsobject

RequirementsS3ObjectVersionstring

StartupScriptS3ObjectVersionstring

WeeklyMaintenanceWindowStartstring

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://airflow.{region}.amazonaws.com/environments/{Name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}