2026/05/06 - AmazonMWAA - 3 updated api methods
Changes Amazon MWAA now supports a PublicAndPrivate webserver access mode. The Airflow web server is accessible over both public and private endpoints, enabling workers in VPCs without internet access to reach the Task API privately while retaining public access to the Airflow UI.
{'WebserverAccessMode': {'PUBLIC_AND_PRIVATE'}}
Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.
See also: AWS API Documentation
Request Syntax
client.create_environment(
Name='string',
ExecutionRoleArn='string',
SourceBucketArn='string',
DagS3Path='string',
NetworkConfiguration={
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
PluginsS3Path='string',
PluginsS3ObjectVersion='string',
RequirementsS3Path='string',
RequirementsS3ObjectVersion='string',
StartupScriptS3Path='string',
StartupScriptS3ObjectVersion='string',
AirflowConfigurationOptions={
'string': 'string'
},
EnvironmentClass='string',
MaxWorkers=123,
KmsKey='string',
AirflowVersion='string',
LoggingConfiguration={
'DagProcessingLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'SchedulerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WebserverLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WorkerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'TaskLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
}
},
WeeklyMaintenanceWindowStart='string',
Tags={
'string': 'string'
},
WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY'|'PUBLIC_AND_PRIVATE',
MinWorkers=123,
Schedulers=123,
EndpointManagement='CUSTOMER'|'SERVICE',
MinWebservers=123,
MaxWebservers=123
)
string
[REQUIRED]
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, refer to Amazon MWAA Execution role.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. For more information, refer to Create an Amazon S3 bucket for Amazon MWAA.
string
[REQUIRED]
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, refer to Adding or updating DAGs.
dict
[REQUIRED]
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to About networking on Amazon MWAA.
SubnetIds (list) --
A list of subnet IDs. For more information, refer to About networking on Amazon MWAA.
(string) --
SecurityGroupIds (list) --
A list of security group IDs. For more information, refer to Security in your VPC on Amazon MWAA.
(string) --
string
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, refer to Installing custom plugins.
string
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, refer to How S3 Versioning works.
string
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. For more information, refer to Installing Python dependencies.
string
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, refer to How S3 Versioning works.
string
The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
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, refer to Using a startup script.
string
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID 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:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, refer to Using a startup script.
dict
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to Apache Airflow configuration options.
(string) --
(string) --
string
The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, refer to Amazon MWAA environment class.
integer
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 MaxWorkers field. For example, 20. 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 MinWorkers.
string
The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, refer to Create an Amazon MWAA environment.
string
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, refer to Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA).
Valid values: 2.7.2, 2.8.1, 2.9.2, 2.10.1, 2.10.3, 2.11.0, and 3.0.6.
dict
Defines the Apache Airflow logs to send to CloudWatch Logs.
DagProcessingLogs (dict) --
Publishes Airflow DAG processing logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
SchedulerLogs (dict) --
Publishes Airflow scheduler logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
WebserverLogs (dict) --
Publishes Airflow web server logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
WorkerLogs (dict) --
Publishes Airflow worker logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
TaskLogs (dict) --
Publishes Airflow task logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
string
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: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.
dict
The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". For more information, refer to Tagging Amazon Web Services resources.
(string) --
(string) --
string
Defines the access mode for the Apache Airflow web server. For more information, refer to Apache Airflow access modes.
integer
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 MaxWorkers 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 MinWorkers field. For example, 2.
integer
The number of Apache Airflow schedulers to run in your environment. Valid values:
v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
v1 - Accepts 1.
string
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
integer
The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
integer
The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) returned in the response for the environment.
{'Environment': {'WebserverAccessMode': {'PUBLIC_AND_PRIVATE'}}}
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
Name='string'
)
string
[REQUIRED]
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
dict
Response Syntax
{
'Environment': {
'Name': 'string',
'Status': 'CREATING'|'CREATE_FAILED'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED'|'UNAVAILABLE'|'UPDATE_FAILED'|'ROLLING_BACK'|'CREATING_SNAPSHOT'|'PENDING'|'MAINTENANCE',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'WebserverUrl': 'string',
'ExecutionRoleArn': 'string',
'ServiceRoleArn': 'string',
'KmsKey': 'string',
'AirflowVersion': 'string',
'SourceBucketArn': 'string',
'DagS3Path': 'string',
'PluginsS3Path': 'string',
'PluginsS3ObjectVersion': 'string',
'RequirementsS3Path': 'string',
'RequirementsS3ObjectVersion': 'string',
'StartupScriptS3Path': 'string',
'StartupScriptS3ObjectVersion': 'string',
'AirflowConfigurationOptions': {
'string': 'string'
},
'EnvironmentClass': 'string',
'MaxWorkers': 123,
'NetworkConfiguration': {
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
]
},
'LoggingConfiguration': {
'DagProcessingLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG',
'CloudWatchLogGroupArn': 'string'
},
'SchedulerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG',
'CloudWatchLogGroupArn': 'string'
},
'WebserverLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG',
'CloudWatchLogGroupArn': 'string'
},
'WorkerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG',
'CloudWatchLogGroupArn': 'string'
},
'TaskLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG',
'CloudWatchLogGroupArn': 'string'
}
},
'LastUpdate': {
'Status': 'SUCCESS'|'PENDING'|'FAILED',
'CreatedAt': datetime(2015, 1, 1),
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Source': 'string',
'WorkerReplacementStrategy': 'FORCED'|'GRACEFUL'
},
'WeeklyMaintenanceWindowStart': 'string',
'Tags': {
'string': 'string'
},
'WebserverAccessMode': 'PRIVATE_ONLY'|'PUBLIC_ONLY'|'PUBLIC_AND_PRIVATE',
'MinWorkers': 123,
'Schedulers': 123,
'WebserverVpcEndpointService': 'string',
'DatabaseVpcEndpointService': 'string',
'CeleryExecutorQueue': 'string',
'EndpointManagement': 'CUSTOMER'|'SERVICE',
'MinWebservers': 123,
'MaxWebservers': 123
}
}
Response Structure
(dict) --
Environment (dict) --
An object containing all available details about the environment.
Name (string) --
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Status (string) --
The status of the Amazon MWAA environment.
Valid values:
CREATING - The request to create the environment is in progress.
CREATING_SNAPSHOT - The request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
CREATE_FAILED - The request to create the environment failed and the environment was not created.
AVAILABLE - The request was successful and the environment is ready to use.
PENDING - The request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.
UPDATING - The request to update the environment is in progress.
ROLLING_BACK - The request to update environment details or upgrade the environment version failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
DELETING - The request to delete the environment is in progress.
DELETED - The request to delete the environment is complete, and the environment has been deleted.
UNAVAILABLE - The request failed, but the environment did not return to its previous state and is not stable.
UPDATE_FAILED - The request to update the environment failed and the environment was restored to its previous state successfully and is ready to use.
MAINTENANCE - The environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might be unavailable during this process. Note that as part of the maintenance work, Amazon MWAA performs with a GRACEFUL workerReplacementStrategy.
You can review our troubleshooting guide for a list of common errors and their solutions. For more information, refer to Amazon MWAA troubleshooting.
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
CreatedAt (datetime) --
The day and time the environment was created.
WebserverUrl (string) --
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, refer to Accessing the Apache Airflow UI.
ExecutionRoleArn (string) --
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, arn:aws:iam::123456789:role/my-execution-role. For more information, refer to Amazon MWAA Execution role.
ServiceRoleArn (string) --
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, refer to Amazon MWAA Service-linked role.
KmsKey (string) --
The KMS encryption key used to encrypt the data in your environment.
AirflowVersion (string) --
The Apache Airflow version on your environment.
Valid values: 2.7.2, 2.8.1, 2.9.2, 2.10.1, 2.10.3, 2.11.0, and 3.0.6.
SourceBucketArn (string) --
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. For more information, refer to Create an Amazon S3 bucket for Amazon MWAA.
DagS3Path (string) --
The relative path to the DAGs folder in your Amazon S3 bucket. For example, s3://mwaa-environment/dags. For more information, refer to Adding or updating DAGs.
PluginsS3Path (string) --
The relative path to the file in your Amazon S3 bucket. For example, s3://mwaa-environment/plugins.zip. For more information, refer to Installing custom plugins.
PluginsS3ObjectVersion (string) --
The version of the plugins.zip file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
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:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, refer to Installing custom plugins.
RequirementsS3Path (string) --
The relative path to the requirements.txt file in your Amazon S3 bucket. For example, s3://mwaa-environment/requirements.txt. For more information, refer to Installing Python dependencies.
RequirementsS3ObjectVersion (string) --
The version of the requirements.txt file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
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:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, refer to Installing Python dependencies.
StartupScriptS3Path (string) --
The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
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, refer to Using a startup script.
StartupScriptS3ObjectVersion (string) --
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
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:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, refer to Using a startup script.
AirflowConfigurationOptions (dict) --
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, refer to Apache Airflow configuration options.
(string) --
(string) --
EnvironmentClass (string) --
The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, refer to Amazon MWAA environment class.
MaxWorkers (integer) --
The maximum number of workers that run in your environment. For example, 20.
NetworkConfiguration (dict) --
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to About networking on Amazon MWAA.
SubnetIds (list) --
A list of subnet IDs. For more information, refer to About networking on Amazon MWAA.
(string) --
SecurityGroupIds (list) --
A list of security group IDs. For more information, refer to Security in your VPC on Amazon MWAA.
(string) --
LoggingConfiguration (dict) --
The Apache Airflow logs published to CloudWatch Logs.
DagProcessingLogs (dict) --
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
SchedulerLogs (dict) --
The Airflow scheduler logs published to CloudWatch Logs and the log level.
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
WebserverLogs (dict) --
The Airflow web server logs published to CloudWatch Logs and the log level.
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
WorkerLogs (dict) --
The Airflow worker logs published to CloudWatch Logs and the log level.
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
TaskLogs (dict) --
The Airflow task logs published to CloudWatch Logs and the log level.
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
CloudWatchLogGroupArn (string) --
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the Apache Airflow log type (e.g. DagProcessingLogs) is published. For example, arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
LastUpdate (dict) --
The status of the last update on the environment.
Status (string) --
The status of the last update on the environment.
CreatedAt (datetime) --
The day and time of the last update on the environment.
Error (dict) --
The error that was encountered during the last update of the environment.
ErrorCode (string) --
The error code that corresponds to the error with the last update.
ErrorMessage (string) --
The error message that corresponds to the error code.
Source (string) --
The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
WorkerReplacementStrategy (string) --
The worker replacement strategy used in the last update of the environment.
WeeklyMaintenanceWindowStart (string) --
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
Tags (dict) --
The key-value tag pairs associated to your environment. For example, "Environment": "Staging". For more information, refer to Tagging Amazon Web Services resources.
(string) --
(string) --
WebserverAccessMode (string) --
The Apache Airflow web server access mode. For more information, refer to Apache Airflow access modes.
MinWorkers (integer) --
The minimum number of workers that run in your environment. For example, 2.
Schedulers (integer) --
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
WebserverVpcEndpointService (string) --
The VPC endpoint for the environment's web server.
DatabaseVpcEndpointService (string) --
The VPC endpoint for the environment's Amazon RDS database.
CeleryExecutorQueue (string) --
The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
EndpointManagement (string) --
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
MinWebservers (integer) --
The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
MaxWebservers (integer) --
The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
{'WebserverAccessMode': {'PUBLIC_AND_PRIVATE'}}
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
See also: AWS API Documentation
Request Syntax
client.update_environment(
Name='string',
ExecutionRoleArn='string',
AirflowConfigurationOptions={
'string': 'string'
},
AirflowVersion='string',
DagS3Path='string',
EnvironmentClass='string',
LoggingConfiguration={
'DagProcessingLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'SchedulerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WebserverLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WorkerLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'TaskLogs': {
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
}
},
MaxWorkers=123,
MinWorkers=123,
MaxWebservers=123,
MinWebservers=123,
WorkerReplacementStrategy='FORCED'|'GRACEFUL',
NetworkConfiguration={
'SecurityGroupIds': [
'string',
]
},
PluginsS3Path='string',
PluginsS3ObjectVersion='string',
RequirementsS3Path='string',
RequirementsS3ObjectVersion='string',
Schedulers=123,
SourceBucketArn='string',
StartupScriptS3Path='string',
StartupScriptS3ObjectVersion='string',
WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY'|'PUBLIC_AND_PRIVATE',
WeeklyMaintenanceWindowStart='string'
)
string
[REQUIRED]
The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.
string
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, arn:aws:iam::123456789:role/my-execution-role. For more information, refer to Amazon MWAA Execution role.
dict
A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to Apache Airflow configuration options.
(string) --
(string) --
string
The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA. To downgrade your environment, specify an older version of Apache Airflow supported by Amazon MWAA.
Before you upgrade or downgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading and downgrading an Amazon MWAA environment.
Valid values: 2.7.2, 2.8.1, 2.9.2, 2.10.1, 2.10.3, 2.11.0, and 3.0.6.
string
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, refer to Adding or updating DAGs.
string
The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, refer to Amazon MWAA environment class.
dict
The Apache Airflow log types to send to CloudWatch Logs.
DagProcessingLogs (dict) --
Publishes Airflow DAG processing logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
SchedulerLogs (dict) --
Publishes Airflow scheduler logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
WebserverLogs (dict) --
Publishes Airflow web server logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
WorkerLogs (dict) --
Publishes Airflow worker logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
TaskLogs (dict) --
Publishes Airflow task logs to CloudWatch Logs.
Enabled (boolean) -- [REQUIRED]
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
LogLevel (string) -- [REQUIRED]
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
integer
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 MaxWorkers field. For example, 20. 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 MinWorkers.
integer
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 MaxWorkers 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 MinWorkers field. For example, 2.
integer
The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
integer
The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers.
Valid values: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
string
The worker replacement strategy to use when updating the environment.
You can select one of the following strategies:
Forced - Stops and replaces Apache Airflow workers without waiting for tasks to complete before an update.
Graceful - Allows Apache Airflow workers to complete running tasks for up to 12 hours during an update before they're stopped and replaced.
dict
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to About networking on Amazon MWAA.
SecurityGroupIds (list) -- [REQUIRED]
A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information, refer to Security in your VPC on Amazon MWAA.
(string) --
string
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, refer to Installing custom plugins.
string
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, refer to How S3 Versioning works.
string
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. For more information, refer to Installing Python dependencies.
string
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, refer to How S3 Versioning works.
integer
The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
string
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. For more information, refer to Create an Amazon S3 bucket for Amazon MWAA.
string
The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.
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, refer to Using a startup script.
string
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID 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:
3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo
For more information, refer to Using a startup script.
string
The Apache Airflow Web server access mode. For more information, refer to Apache Airflow access modes.
string
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: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.
dict
Response Syntax
{
'Arn': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.