AmazonMWAA

2023/04/03 - AmazonMWAA - 3 updated api methods

Changes  This Amazon MWAA release adds the ability to customize the Apache Airflow environment by launching a shell script at startup. This shell script is hosted in your environment's Amazon S3 bucket. Amazon MWAA runs the script before installing requirements and initializing the Apache Airflow process.

CreateEnvironment (updated) Link ¶
Changes (request) 
{'StartupScriptS3ObjectVersion': 'string', 'StartupScriptS3Path': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.create_environment(
    AirflowConfigurationOptions={
        'string': 'string'
    },
    AirflowVersion='string',
    DagS3Path='string',
    EnvironmentClass='string',
    ExecutionRoleArn='string',
    KmsKey='string',
    LoggingConfiguration={
        'DagProcessingLogs': {
            'Enabled': True|False,
            'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
        },
        'SchedulerLogs': {
            'Enabled': True|False,
            'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
        },
        'TaskLogs': {
            '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'
        }
    },
    MaxWorkers=123,
    MinWorkers=123,
    Name='string',
    NetworkConfiguration={
        'SecurityGroupIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ]
    },
    PluginsS3ObjectVersion='string',
    PluginsS3Path='string',
    RequirementsS3ObjectVersion='string',
    RequirementsS3Path='string',
    Schedulers=123,
    SourceBucketArn='string',
    StartupScriptS3ObjectVersion='string',
    StartupScriptS3Path='string',
    Tags={
        'string': 'string'
    },
    WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY',
    WeeklyMaintenanceWindowStart='string'
)
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 AirflowVersion

string

param AirflowVersion

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12 , 2.0.2 , 2.2.2 , and 2.4.3 . For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (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 EnvironmentClass

string

param EnvironmentClass

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

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

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

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

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 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 Name

string

param Name

[REQUIRED]

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

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

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

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.

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': {'StartupScriptS3ObjectVersion': 'string',
                 'StartupScriptS3Path': 'string'}}

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': {
        'AirflowConfigurationOptions': {
            'string': 'string'
        },
        'AirflowVersion': 'string',
        'Arn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'DagS3Path': 'string',
        'EnvironmentClass': 'string',
        'ExecutionRoleArn': 'string',
        'KmsKey': 'string',
        'LastUpdate': {
            'CreatedAt': datetime(2015, 1, 1),
            'Error': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            },
            'Source': 'string',
            'Status': 'SUCCESS'|'PENDING'|'FAILED'
        },
        'LoggingConfiguration': {
            'DagProcessingLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'SchedulerLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'TaskLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'WebserverLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            },
            'WorkerLogs': {
                'CloudWatchLogGroupArn': 'string',
                'Enabled': True|False,
                'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
            }
        },
        'MaxWorkers': 123,
        'MinWorkers': 123,
        'Name': 'string',
        'NetworkConfiguration': {
            'SecurityGroupIds': [
                'string',
            ],
            'SubnetIds': [
                'string',
            ]
        },
        'PluginsS3ObjectVersion': 'string',
        'PluginsS3Path': 'string',
        'RequirementsS3ObjectVersion': 'string',
        'RequirementsS3Path': 'string',
        'Schedulers': 123,
        'ServiceRoleArn': 'string',
        'SourceBucketArn': 'string',
        'StartupScriptS3ObjectVersion': 'string',
        'StartupScriptS3Path': 'string',
        'Status': 'CREATING'|'CREATE_FAILED'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED'|'UNAVAILABLE'|'UPDATE_FAILED',
        'Tags': {
            'string': 'string'
        },
        'WebserverAccessMode': 'PRIVATE_ONLY'|'PUBLIC_ONLY',
        'WebserverUrl': 'string',
        'WeeklyMaintenanceWindowStart': 'string'
    }
}

Response Structure

  • (dict) --

    • Environment (dict) --

      An object containing all available details about the environment.

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

      • AirflowVersion (string) --

        The Apache Airflow version on your environment. Valid values: 1.10.12 , 2.0.2 , 2.2.2 , and 2.4.3 .

      • Arn (string) --

        The Amazon Resource Name (ARN) of the Amazon MWAA environment.

      • CreatedAt (datetime) --

        The day and time the environment was created.

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

      • EnvironmentClass (string) --

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

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

      • KmsKey (string) --

        The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.

      • LastUpdate (dict) --

        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.

        • Status (string) --

          The status of the last update on the environment.

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

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

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

        • SchedulerLogs (dict) --

          The Airflow scheduler logs published to CloudWatch Logs and the log level.

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

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

        • TaskLogs (dict) --

          The Airflow task logs published to CloudWatch Logs and the log level.

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

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

        • WebserverLogs (dict) --

          The Airflow web server logs published to CloudWatch Logs and the log level.

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

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

        • WorkerLogs (dict) --

          The Airflow worker logs published to CloudWatch Logs and the log level.

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

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

      • MaxWorkers (integer) --

        The maximum number of workers that run in your environment. For example, 20 .

      • MinWorkers (integer) --

        The minimum number of workers that run in your environment. For example, 2 .

      • Name (string) --

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

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

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

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

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

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

      • Schedulers (integer) --

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

      • ServiceRoleArn (string) --

        The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role .

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

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

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

      • Status (string) --

        The status of the Amazon MWAA environment. Valid values:

        • CREATING - Indicates the request to create the environment is in progress.

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

        • UPDATING - Indicates the request to update the environment is in progress.

        • 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 was unable to rollback and is not in a stable state.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting .

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

      • WebserverUrl (string) --

        The Apache Airflow Web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI .

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

UpdateEnvironment (updated) Link ¶
Changes (request) 
{'StartupScriptS3ObjectVersion': 'string', 'StartupScriptS3Path': 'string'}

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

See also: AWS API Documentation

Request Syntax

client.update_environment(
    AirflowConfigurationOptions={
        'string': 'string'
    },
    AirflowVersion='string',
    DagS3Path='string',
    EnvironmentClass='string',
    ExecutionRoleArn='string',
    LoggingConfiguration={
        'DagProcessingLogs': {
            'Enabled': True|False,
            'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
        },
        'SchedulerLogs': {
            'Enabled': True|False,
            'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
        },
        'TaskLogs': {
            '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'
        }
    },
    MaxWorkers=123,
    MinWorkers=123,
    Name='string',
    NetworkConfiguration={
        'SecurityGroupIds': [
            'string',
        ]
    },
    PluginsS3ObjectVersion='string',
    PluginsS3Path='string',
    RequirementsS3ObjectVersion='string',
    RequirementsS3Path='string',
    Schedulers=123,
    SourceBucketArn='string',
    StartupScriptS3ObjectVersion='string',
    StartupScriptS3Path='string',
    WebserverAccessMode='PRIVATE_ONLY'|'PUBLIC_ONLY',
    WeeklyMaintenanceWindowStart='string'
)
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 AirflowVersion

string

param AirflowVersion

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

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 EnvironmentClass

string

param EnvironmentClass

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

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

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

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

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 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 Name

string

param Name

[REQUIRED]

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

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 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 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 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 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 Schedulers

integer

param Schedulers

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

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 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 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 WebserverAccessMode

string

param WebserverAccessMode

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

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.

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 .