SDK for PHP 3.x

AmazonMWAA 2020-07-01

Client: Aws\MWAA\MWAAClient
Service ID: mwaa
Version: 2020-07-01

This page describes the parameters and results for the operations of the AmazonMWAA (2020-07-01), and shows how to use the Aws\MWAA\MWAAClient object to call the described operations. This documentation is specific to the 2020-07-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateCliToken ( array $params = [] )
Creates a CLI token for the Airflow CLI.
CreateEnvironment ( array $params = [] )
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
CreateWebLoginToken ( array $params = [] )
Creates a web login token for the Airflow Web UI.
DeleteEnvironment ( array $params = [] )
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
GetEnvironment ( array $params = [] )
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
ListEnvironments ( array $params = [] )
Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.
ListTagsForResource ( array $params = [] )
Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment.
PublishMetrics ( array $params = [] )
Internal only.
TagResource ( array $params = [] )
Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
UntagResource ( array $params = [] )
Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment.
UpdateEnvironment ( array $params = [] )
Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListEnvironments

Operations

CreateCliToken 

$result = $client->createCliToken([/* ... */]);
$promise = $client->createCliTokenAsync([/* ... */]);

Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.

Parameter Syntax

$result = $client->createCliToken([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

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

Result Syntax

[
    'CliToken' => '<string>',
    'WebServerHostname' => '<string>',
]

Result Details

Members
CliToken
Type: string

An Airflow CLI login token.

WebServerHostname
Type: string

The Airflow web server hostname for the environment.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

CreateEnvironment 

$result = $client->createEnvironment([/* ... */]);
$promise = $client->createEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createEnvironment([
    'AirflowConfigurationOptions' => ['<string>', ...],
    'AirflowVersion' => '<string>',
    'DagS3Path' => '<string>', // REQUIRED
    'EndpointManagement' => 'CUSTOMER|SERVICE',
    'EnvironmentClass' => '<string>',
    'ExecutionRoleArn' => '<string>', // REQUIRED
    'KmsKey' => '<string>',
    'LoggingConfiguration' => [
        'DagProcessingLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'SchedulerLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'TaskLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'WebserverLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'WorkerLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
    ],
    'MaxWebservers' => <integer>,
    'MaxWorkers' => <integer>,
    'MinWebservers' => <integer>,
    'MinWorkers' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NetworkConfiguration' => [ // REQUIRED
        'SecurityGroupIds' => ['<string>', ...],
        'SubnetIds' => ['<string>', ...],
    ],
    'PluginsS3ObjectVersion' => '<string>',
    'PluginsS3Path' => '<string>',
    'RequirementsS3ObjectVersion' => '<string>',
    'RequirementsS3Path' => '<string>',
    'Schedulers' => <integer>,
    'SourceBucketArn' => '<string>', // REQUIRED
    'StartupScriptS3ObjectVersion' => '<string>',
    'StartupScriptS3Path' => '<string>',
    'Tags' => ['<string>', ...],
    'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY',
    'WeeklyMaintenanceWindowStart' => '<string>',
]);

Parameter Details

Members
AirflowConfigurationOptions
Type: Associative array of custom strings keys (ConfigKey) to strings

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.

AirflowVersion
Type: string

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

DagS3Path
Required: Yes
Type: string

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

EndpointManagement
Type: 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.

EnvironmentClass
Type: 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.

ExecutionRoleArn
Required: Yes
Type: string

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.

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

LoggingConfiguration
Type: LoggingConfigurationInput structure

Defines the Apache Airflow logs to send to CloudWatch Logs.

MaxWebservers
Type: int

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.

MaxWorkers
Type: int

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.

MinWebservers
Type: int

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.

MinWorkers
Type: int

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.

Name
Required: Yes
Type: string

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

NetworkConfiguration
Required: Yes
Type: NetworkConfiguration structure

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

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

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

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

Schedulers
Type: int

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.

SourceBucketArn
Required: Yes
Type: 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
Type: 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, see Using a startup script.

StartupScriptS3Path
Type: 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.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

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.

WebserverAccessMode
Type: string

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

WeeklyMaintenanceWindowStart
Type: 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.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

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

Errors

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

CreateWebLoginToken 

$result = $client->createWebLoginToken([/* ... */]);
$promise = $client->createWebLoginTokenAsync([/* ... */]);

Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.

Parameter Syntax

$result = $client->createWebLoginToken([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

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

Result Syntax

[
    'AirflowIdentity' => '<string>',
    'IamIdentity' => '<string>',
    'WebServerHostname' => '<string>',
    'WebToken' => '<string>',
]

Result Details

Members
AirflowIdentity
Type: string

The user name of the Apache Airflow identity creating the web login token.

IamIdentity
Type: string

The name of the IAM identity creating the web login token. This might be an IAM user, or an assumed or federated identity. For example, assumed-role/Admin/your-name.

WebServerHostname
Type: string

The Airflow web server hostname for the environment.

WebToken
Type: string

An Airflow web server login token.

Errors

AccessDeniedException:

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

DeleteEnvironment 

$result = $client->deleteEnvironment([/* ... */]);
$promise = $client->deleteEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteEnvironment([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

GetEnvironment 

$result = $client->getEnvironment([/* ... */]);
$promise = $client->getEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getEnvironment([
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members
Name
Required: Yes
Type: string

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

Result Syntax

[
    'Environment' => [
        'AirflowConfigurationOptions' => ['<string>', ...],
        'AirflowVersion' => '<string>',
        'Arn' => '<string>',
        'CeleryExecutorQueue' => '<string>',
        'CreatedAt' => <DateTime>,
        'DagS3Path' => '<string>',
        'DatabaseVpcEndpointService' => '<string>',
        'EndpointManagement' => 'CUSTOMER|SERVICE',
        'EnvironmentClass' => '<string>',
        'ExecutionRoleArn' => '<string>',
        'KmsKey' => '<string>',
        'LastUpdate' => [
            'CreatedAt' => <DateTime>,
            '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',
            ],
        ],
        'MaxWebservers' => <integer>,
        'MaxWorkers' => <integer>,
        'MinWebservers' => <integer>,
        'MinWorkers' => <integer>,
        'Name' => '<string>',
        'NetworkConfiguration' => [
            'SecurityGroupIds' => ['<string>', ...],
            'SubnetIds' => ['<string>', ...],
        ],
        'PluginsS3ObjectVersion' => '<string>',
        'PluginsS3Path' => '<string>',
        'RequirementsS3ObjectVersion' => '<string>',
        'RequirementsS3Path' => '<string>',
        'Schedulers' => <integer>,
        'ServiceRoleArn' => '<string>',
        'SourceBucketArn' => '<string>',
        'StartupScriptS3ObjectVersion' => '<string>',
        'StartupScriptS3Path' => '<string>',
        'Status' => 'CREATING|CREATE_FAILED|AVAILABLE|UPDATING|DELETING|DELETED|UNAVAILABLE|UPDATE_FAILED|ROLLING_BACK|CREATING_SNAPSHOT|PENDING|MAINTENANCE',
        'Tags' => ['<string>', ...],
        'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY',
        'WebserverUrl' => '<string>',
        'WebserverVpcEndpointService' => '<string>',
        'WeeklyMaintenanceWindowStart' => '<string>',
    ],
]

Result Details

Members
Environment
Type: Environment structure

An object containing all available details about the environment.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

ListEnvironments 

$result = $client->listEnvironments([/* ... */]);
$promise = $client->listEnvironmentsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listEnvironments([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to retrieve per page. For example, 5 environments per page.

NextToken
Type: string

Retrieves the next page of the results.

Result Syntax

[
    'Environments' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members
Environments
Required: Yes
Type: Array of strings

Returns a list of Amazon MWAA environments.

NextToken
Type: string

Retrieves the next page of the results.

Errors

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

ListTagsForResource 

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members
Tags
Type: Associative array of custom strings keys (TagKey) to strings

The key-value tag pairs associated to your environment. For more information, see Tagging Amazon Web Services resources.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

PublishMetrics 

$result = $client->publishMetrics([/* ... */]);
$promise = $client->publishMetricsAsync([/* ... */]);

Internal only. Publishes environment health metrics to Amazon CloudWatch.

Parameter Syntax

$result = $client->publishMetrics([
    'EnvironmentName' => '<string>', // REQUIRED
    'MetricData' => [ // REQUIRED
        [
            'Dimensions' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MetricName' => '<string>', // REQUIRED
            'StatisticValues' => [
                'Maximum' => <float>,
                'Minimum' => <float>,
                'SampleCount' => <integer>,
                'Sum' => <float>,
            ],
            'Timestamp' => <integer || string || DateTime>, // REQUIRED
            'Unit' => 'Seconds|Microseconds|Milliseconds|Bytes|Kilobytes|Megabytes|Gigabytes|Terabytes|Bits|Kilobits|Megabits|Gigabits|Terabits|Percent|Count|Bytes/Second|Kilobytes/Second|Megabytes/Second|Gigabytes/Second|Terabytes/Second|Bits/Second|Kilobits/Second|Megabits/Second|Gigabits/Second|Terabits/Second|Count/Second|None',
            'Value' => <float>,
        ],
        // ...
    ],
]);

Parameter Details

Members
EnvironmentName
Required: Yes
Type: string

Internal only. The name of the environment.

MetricData
Required: Yes
Type: Array of MetricDatum structures

Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

TagResource 

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

UntagResource 

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, "Environment": "Staging".

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

tagKeys
Required: Yes
Type: Array of strings

The key-value tag pair you want to remove. For example, "Environment": "Staging".

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

UpdateEnvironment 

$result = $client->updateEnvironment([/* ... */]);
$promise = $client->updateEnvironmentAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateEnvironment([
    'AirflowConfigurationOptions' => ['<string>', ...],
    'AirflowVersion' => '<string>',
    'DagS3Path' => '<string>',
    'EnvironmentClass' => '<string>',
    'ExecutionRoleArn' => '<string>',
    'LoggingConfiguration' => [
        'DagProcessingLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'SchedulerLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'TaskLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'WebserverLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
        'WorkerLogs' => [
            'Enabled' => true || false, // REQUIRED
            'LogLevel' => 'CRITICAL|ERROR|WARNING|INFO|DEBUG', // REQUIRED
        ],
    ],
    'MaxWebservers' => <integer>,
    'MaxWorkers' => <integer>,
    'MinWebservers' => <integer>,
    'MinWorkers' => <integer>,
    'Name' => '<string>', // REQUIRED
    'NetworkConfiguration' => [
        'SecurityGroupIds' => ['<string>', ...], // REQUIRED
    ],
    'PluginsS3ObjectVersion' => '<string>',
    'PluginsS3Path' => '<string>',
    'RequirementsS3ObjectVersion' => '<string>',
    'RequirementsS3Path' => '<string>',
    'Schedulers' => <integer>,
    'SourceBucketArn' => '<string>',
    'StartupScriptS3ObjectVersion' => '<string>',
    'StartupScriptS3Path' => '<string>',
    'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY',
    'WeeklyMaintenanceWindowStart' => '<string>',
]);

Parameter Details

Members
AirflowConfigurationOptions
Type: Associative array of custom strings keys (ConfigKey) to strings

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.

AirflowVersion
Type: string

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.

DagS3Path
Type: string

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

EnvironmentClass
Type: 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.

ExecutionRoleArn
Type: 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.

LoggingConfiguration
Type: LoggingConfigurationInput structure

The Apache Airflow log types to send to CloudWatch Logs.

MaxWebservers
Type: int

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.

MaxWorkers
Type: int

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.

MinWebservers
Type: int

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.

MinWorkers
Type: int

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.

Name
Required: Yes
Type: string

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

NetworkConfiguration
Type: UpdateNetworkConfigurationInput structure

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

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

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

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

Schedulers
Type: int

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

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

StartupScriptS3Path
Type: 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.

WebserverAccessMode
Type: string

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

WeeklyMaintenanceWindowStart
Type: 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.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members
Arn
Type: string

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

Errors

ResourceNotFoundException:

ResourceNotFoundException: The resource is not available.

ValidationException:

ValidationException: The provided input is not valid.

InternalServerException:

InternalServerException: An internal error has occurred.

Shapes

AccessDeniedException

Description

Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.

Members
Message
Type: string

Dimension

Description

Internal only. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

Members
Name
Required: Yes
Type: string

Internal only. The name of the dimension.

Value
Required: Yes
Type: string

Internal only. The value of the dimension.

Environment

Description

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

Members
AirflowConfigurationOptions
Type: Associative array of custom strings keys (ConfigKey) to strings

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

AirflowVersion
Type: 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.

Arn
Type: string

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

CeleryExecutorQueue
Type: 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.

CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The day and time the environment was created.

DagS3Path
Type: 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.

DatabaseVpcEndpointService
Type: string

The VPC endpoint for the environment's Amazon RDS database.

EndpointManagement
Type: 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.

EnvironmentClass
Type: 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.

ExecutionRoleArn
Type: 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
Type: string

The KMS encryption key used to encrypt the data in your environment.

LastUpdate
Type: LastUpdate structure

The status of the last update on the environment.

LoggingConfiguration
Type: LoggingConfiguration structure

The Apache Airflow logs published to CloudWatch Logs.

MaxWebservers
Type: int

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.

MaxWorkers
Type: int

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

MinWebservers
Type: int

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.

MinWorkers
Type: int

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

Name
Type: string

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

NetworkConfiguration
Type: NetworkConfiguration structure

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
Type: 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
Type: 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
Type: 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
Type: 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
Type: int

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

ServiceRoleArn
Type: string

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

SourceBucketArn
Type: 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
Type: 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
Type: 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
Type: 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.

Tags
Type: Associative array of custom strings keys (TagKey) to strings

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

WebserverAccessMode
Type: string

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

WebserverUrl
Type: string

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

WebserverVpcEndpointService
Type: string

The VPC endpoint for the environment's web server.

WeeklyMaintenanceWindowStart
Type: 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.

InternalServerException

Description

InternalServerException: An internal error has occurred.

Members
message
Type: string

LastUpdate

Description

Describes the status of the last update on the environment, and any errors that were encountered.

Members
CreatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The day and time of the last update on the environment.

Error
Type: UpdateError structure

The error that was encountered during the last update of the environment.

Source
Type: string

The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.

Status
Type: string

The status of the last update on the environment.

LoggingConfiguration

Description

Describes the Apache Airflow log types that are published to CloudWatch Logs.

Members
DagProcessingLogs
Type: ModuleLoggingConfiguration structure

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

SchedulerLogs
Type: ModuleLoggingConfiguration structure

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

TaskLogs
Type: ModuleLoggingConfiguration structure

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

WebserverLogs
Type: ModuleLoggingConfiguration structure

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

WorkerLogs
Type: ModuleLoggingConfiguration structure

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

LoggingConfigurationInput

Description

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

Members
DagProcessingLogs
Type: ModuleLoggingConfigurationInput structure

Publishes Airflow DAG processing logs to CloudWatch Logs.

SchedulerLogs
Type: ModuleLoggingConfigurationInput structure

Publishes Airflow scheduler logs to CloudWatch Logs.

TaskLogs
Type: ModuleLoggingConfigurationInput structure

Publishes Airflow task logs to CloudWatch Logs.

WebserverLogs
Type: ModuleLoggingConfigurationInput structure

Publishes Airflow web server logs to CloudWatch Logs.

WorkerLogs
Type: ModuleLoggingConfigurationInput structure

Publishes Airflow worker logs to CloudWatch Logs.

MetricDatum

Description

Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

Members
Dimensions
Type: Array of Dimension structures

Internal only. The dimensions associated with the metric.

MetricName
Required: Yes
Type: string

Internal only. The name of the metric.

StatisticValues
Type: StatisticSet structure

Internal only. The statistical values for the metric.

Timestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

Internal only. The time the metric data was received.

Unit
Type: string

Internal only. The unit used to store the metric.

Value
Type: double

Internal only. The value for the metric.

ModuleLoggingConfiguration

Description

Describes the Apache Airflow log details for the log type (e.g. DagProcessingLogs).

Members
CloudWatchLogGroupArn
Type: 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
Type: boolean

Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.

LogLevel
Type: string

The Apache Airflow log level for the log type (e.g. DagProcessingLogs).

ModuleLoggingConfigurationInput

Description

Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log level to send to CloudWatch Logs (e.g. INFO).

Members
Enabled
Required: Yes
Type: boolean

Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).

LogLevel
Required: Yes
Type: string

Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.

NetworkConfiguration

Description

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.

Members
SecurityGroupIds
Type: Array of strings

A list of security group IDs. For more information, see Security in your VPC on Amazon MWAA.

SubnetIds
Type: Array of strings

A list of subnet IDs. For more information, see About networking on Amazon MWAA.

ResourceNotFoundException

Description

ResourceNotFoundException: The resource is not available.

Members
message
Type: string

StatisticSet

Description

Internal only. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.

Members
Maximum
Type: double

Internal only. The maximum value of the sample set.

Minimum
Type: double

Internal only. The minimum value of the sample set.

SampleCount
Type: int

Internal only. The number of samples used for the statistic set.

Sum
Type: double

Internal only. The sum of values for the sample set.

UpdateError

Description

Describes the error(s) encountered with the last update of the environment.

Members
ErrorCode
Type: string

The error code that corresponds to the error with the last update.

ErrorMessage
Type: string

The error message that corresponds to the error code.

UpdateNetworkConfigurationInput

Description

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

Members
SecurityGroupIds
Required: Yes
Type: Array of strings

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.

ValidationException

Description

ValidationException: The provided input is not valid.

Members
message
Type: string