AmazonMWAA

2024/05/16 - AmazonMWAA - 3 updated api methods

Changes  Amazon MWAA now supports Airflow web server auto scaling to automatically handle increased demand from REST APIs, Command Line Interface (CLI), or more Airflow User Interface (UI) users. Customers can specify maximum and minimum web server instances during environment creation and update workflow.

CreateEnvironment (updated) Link ¶
Changes (request) 
{'MaxWebservers': 'integer', 'MinWebservers': 'integer'}

Creates an Amazon Managed Workflows for Apache Airflow (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',
    MinWorkers=123,
    Schedulers=123,
    EndpointManagement='CUSTOMER'|'SERVICE',
    MinWebservers=123,
    MaxWebservers=123
)
type Name

string

param Name

[REQUIRED]

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

type ExecutionRoleArn

string

param ExecutionRoleArn

[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, see Amazon MWAA Execution role.

type SourceBucketArn

string

param SourceBucketArn

[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, see Create an Amazon S3 bucket for Amazon MWAA.

type DagS3Path

string

param DagS3Path

[REQUIRED]

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags . For more information, see Adding or updating DAGs.

type NetworkConfiguration

dict

param NetworkConfiguration

[REQUIRED]

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.

type PluginsS3Path

string

param PluginsS3Path

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, see Installing custom plugins.

type PluginsS3ObjectVersion

string

param PluginsS3ObjectVersion

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, see How S3 Versioning works.

type RequirementsS3Path

string

param RequirementsS3Path

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, see Installing Python dependencies.

type RequirementsS3ObjectVersion

string

param RequirementsS3ObjectVersion

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, see How S3 Versioning works.

type StartupScriptS3Path

string

param StartupScriptS3Path

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, see Using a startup script.

type StartupScriptS3ObjectVersion

string

param StartupScriptS3ObjectVersion

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, see Using a startup script.

type AirflowConfigurationOptions

dict

param AirflowConfigurationOptions

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.

  • (string) --

    • (string) --

type EnvironmentClass

string

param EnvironmentClass

The environment class type. Valid values: mw1.small , mw1.medium , mw1.large , mw1.xlarge , and mw1.2xlarge . For more information, see Amazon MWAA environment class.

type MaxWorkers

integer

param MaxWorkers

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 .

type KmsKey

string

param KmsKey

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, see Create an Amazon MWAA environment.

type AirflowVersion

string

param AirflowVersion

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 2.8.1

type LoggingConfiguration

dict

param LoggingConfiguration

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.

type WeeklyMaintenanceWindowStart

string

param WeeklyMaintenanceWindowStart

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.

type Tags

dict

param Tags

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging" . For more information, see Tagging Amazon Web Services resources.

  • (string) --

    • (string) --

type WebserverAccessMode

string

param WebserverAccessMode

Defines the access mode for the Apache Airflow web server . For more information, see Apache Airflow access modes.

type MinWorkers

integer

param MinWorkers

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 .

type Schedulers

integer

param Schedulers

The number of Apache Airflow schedulers to run in your environment. Valid values:

  • v2 - Accepts between 2 to 5 . Defaults to 2 .

  • v1 - Accepts 1 .

type EndpointManagement

string

param EndpointManagement

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.

type MinWebservers

integer

param MinWebservers

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: Accepts between 2 and 5 . Defaults to 2 .

type MaxWebservers

integer

param MaxWebservers

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: Accepts between 2 and 5 . Defaults to 2 .

rtype

dict

returns

Response Syntax

{
    'Arn': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) returned in the response for the environment.

GetEnvironment (updated) Link ¶
Changes (response) 
{'Environment': {'MaxWebservers': 'integer', 'MinWebservers': 'integer'}}

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

See also: AWS API Documentation

Request Syntax

client.get_environment(
    Name='string'
)
type Name

string

param Name

[REQUIRED]

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

rtype

dict

returns

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'
        },
        'WeeklyMaintenanceWindowStart': 'string',
        'Tags': {
            'string': 'string'
        },
        'WebserverAccessMode': 'PRIVATE_ONLY'|'PUBLIC_ONLY',
        '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 - Indicates the request to create the environment is in progress.

        • CREATING_SNAPSHOT - Indicates 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 - Indicates the request to create the environment failed, and the environment could not be created.

        • AVAILABLE - Indicates the request was successful and the environment is ready to use.

        • PENDING - Indicates 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 - Indicates the request to update the environment is in progress.

        • ROLLING_BACK - Indicates 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 - Indicates the request to delete the environment is in progress.

        • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

        • UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.

        • MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see 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, see 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, see Amazon MWAA Execution role.

      • ServiceRoleArn (string) --

        The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see 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: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 , 2.8.1 .

      • 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, see 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, see 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, see 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, see 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, see 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, see 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, see 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, see 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, see Apache Airflow configuration options.

        • (string) --

          • (string) --

      • EnvironmentClass (string) --

        The environment class type. Valid values: mw1.small , mw1.medium , mw1.large , mw1.xlarge , and mw1.2xlarge . For more information, see 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, see About networking on Amazon MWAA.

      • 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.

      • 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, see Tagging Amazon Web Services resources.

        • (string) --

          • (string) --

      • WebserverAccessMode (string) --

        The Apache Airflow web server access mode. For more information, see 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: Accepts between 2 and 5 . Defaults to 2 .

      • 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: Accepts between 2 and 5 . Defaults to 2 .

UpdateEnvironment (updated) Link ¶
Changes (request) 
{'MaxWebservers': 'integer', 'MinWebservers': 'integer'}

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

See also: AWS API Documentation

Request Syntax

client.update_environment(
    Name='string',
    ExecutionRoleArn='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={
        'SecurityGroupIds': [
            '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',
    WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY',
    MinWorkers=123,
    Schedulers=123,
    MinWebservers=123,
    MaxWebservers=123
)
type Name

string

param Name

[REQUIRED]

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

type ExecutionRoleArn

string

param ExecutionRoleArn

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, see Amazon MWAA Execution role.

type AirflowVersion

string

param AirflowVersion

The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.

Before you upgrade 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 an Amazon MWAA environment.

Valid values: 1.10.12 , 2.0.2 , 2.2.2 , 2.4.3 , 2.5.1 , 2.6.3 , 2.7.2 , 2.8.1 .

type SourceBucketArn

string

param SourceBucketArn

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, see Create an Amazon S3 bucket for Amazon MWAA.

type DagS3Path

string

param DagS3Path

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags . For more information, see Adding or updating DAGs.

type PluginsS3Path

string

param PluginsS3Path

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, see Installing custom plugins.

type PluginsS3ObjectVersion

string

param PluginsS3ObjectVersion

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, see How S3 Versioning works.

type RequirementsS3Path

string

param RequirementsS3Path

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, see Installing Python dependencies.

type RequirementsS3ObjectVersion

string

param RequirementsS3ObjectVersion

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, see How S3 Versioning works.

type StartupScriptS3Path

string

param StartupScriptS3Path

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, see Using a startup script.

type StartupScriptS3ObjectVersion

string

param StartupScriptS3ObjectVersion

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, see Using a startup script.

type AirflowConfigurationOptions

dict

param AirflowConfigurationOptions

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options.

  • (string) --

    • (string) --

type EnvironmentClass

string

param EnvironmentClass

The environment class type. Valid values: mw1.small , mw1.medium , mw1.large , mw1.xlarge , and mw1.2xlarge . For more information, see Amazon MWAA environment class.

type MaxWorkers

integer

param MaxWorkers

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 .

type NetworkConfiguration

dict

param NetworkConfiguration

The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see 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, see Security in your VPC on Amazon MWAA.

    • (string) --

type LoggingConfiguration

dict

param LoggingConfiguration

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.

type WeeklyMaintenanceWindowStart

string

param WeeklyMaintenanceWindowStart

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.

type WebserverAccessMode

string

param WebserverAccessMode

The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.

type MinWorkers

integer

param MinWorkers

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 .

type Schedulers

integer

param Schedulers

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

type MinWebservers

integer

param MinWebservers

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: Accepts between 2 and 5 . Defaults to 2 .

type MaxWebservers

integer

param MaxWebservers

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: Accepts between 2 and 5 . Defaults to 2 .

rtype

dict

returns

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 .