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 = [] )
Create a CLI token to use Airflow CLI.
- CreateEnvironment ( array $params = [] )
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
- CreateWebLoginToken ( array $params = [] )
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
- DeleteEnvironment ( array $params = [] )
Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
- GetEnvironment ( array $params = [] )
Retrieves the details of 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 = [] )
An operation for publishing metrics from the customers to the Ops plane.
- 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:
Operations
CreateCliToken
$result = $client->createCliToken([/* ... */]); $promise = $client->createCliTokenAsync([/* ... */]);
Create a CLI token to use Airflow CLI.
Parameter Syntax
$result = $client->createCliToken([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CliToken' => '<string>',
'WebServerHostname' => '<string>',
]
Result Details
Members
Errors
-
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
'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
],
],
'MaxWorkers' => <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
'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. To learn more, see Apache Airflow configuration options.
- AirflowVersion
-
- Type: string
The Apache Airflow version for your environment. For example,
v1.10.12. If no value is specified, defaults to the latest version. Valid values:v1.10.12. - DagS3Path
-
- Required: Yes
- Type: string
The relative path to the DAGs folder on your Amazon S3 bucket. For example,
dags. To learn more, see Adding or updating DAGs. - EnvironmentClass
-
- Type: string
The environment class type. Valid values:
mw1.small,mw1.medium,mw1.large. To learn more, 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 AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example,
arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role. - KmsKey
-
- Type: string
The AWS Key Management Service (KMS) key to encrypt the data in your environment. You can use an AWS owned CMK, or a Customer managed CMK (advanced). To learn more, see Get started with Amazon Managed Workflows for Apache Airflow.
- LoggingConfiguration
-
- Type: LoggingConfigurationInput structure
Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs,SchedulerLogs,TaskLogs,WebserverLogs,WorkerLogs. - 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
MaxWorkersfield. 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 inMinWorkers. - 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
MaxWorkersfield. 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 theMinWorkersfield. 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 AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
- PluginsS3ObjectVersion
-
- Type: string
The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.
- PluginsS3Path
-
- Type: string
The relative path to the
plugins.zipfile on your Amazon S3 bucket. For example,plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins. - RequirementsS3ObjectVersion
-
- Type: string
The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.
- RequirementsS3Path
-
- Type: string
The relative path to the
requirements.txtfile on your Amazon S3 bucket. For example,requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies. - Schedulers
-
- Type: int
The number of Apache Airflow schedulers to run in your environment.
- 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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA. - 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". To learn more, see Tagging AWS resources. - WebserverAccessMode
-
- Type: string
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week 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. Supported input includes the following:-
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Members
Errors
-
ValidationException: The provided input is not valid.
-
InternalServerException: An internal error has occurred.
CreateWebLoginToken
$result = $client->createWebLoginToken([/* ... */]); $promise = $client->createWebLoginTokenAsync([/* ... */]);
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
Parameter Syntax
$result = $client->createWebLoginToken([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'WebServerHostname' => '<string>',
'WebToken' => '<string>',
]
Result Details
Members
Errors
-
Access to the Airflow Web UI or CLI has been Denied. Please follow the MWAA user guide to setup permissions to access the Web UI and CLI functionality.
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
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
Result Syntax
[]
Result Details
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
InternalServerException: An internal error has occurred.
GetEnvironment
$result = $client->getEnvironment([/* ... */]); $promise = $client->getEnvironmentAsync([/* ... */]);
Retrieves the details of an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Parameter Syntax
$result = $client->getEnvironment([
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Environment' => [
'AirflowConfigurationOptions' => ['<string>', ...],
'AirflowVersion' => '<string>',
'Arn' => '<string>',
'CreatedAt' => <DateTime>,
'DagS3Path' => '<string>',
'EnvironmentClass' => '<string>',
'ExecutionRoleArn' => '<string>',
'KmsKey' => '<string>',
'LastUpdate' => [
'CreatedAt' => <DateTime>,
'Error' => [
'ErrorCode' => '<string>',
'ErrorMessage' => '<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' => <integer>,
'MinWorkers' => <integer>,
'Name' => '<string>',
'NetworkConfiguration' => [
'SecurityGroupIds' => ['<string>', ...],
'SubnetIds' => ['<string>', ...],
],
'PluginsS3ObjectVersion' => '<string>',
'PluginsS3Path' => '<string>',
'RequirementsS3ObjectVersion' => '<string>',
'RequirementsS3Path' => '<string>',
'Schedulers' => <integer>,
'ServiceRoleArn' => '<string>',
'SourceBucketArn' => '<string>',
'Status' => 'CREATING|CREATE_FAILED|AVAILABLE|UPDATING|DELETING|DELETED|UNAVAILABLE|UPDATE_FAILED',
'Tags' => ['<string>', ...],
'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY',
'WebserverUrl' => '<string>',
'WeeklyMaintenanceWindowStart' => '<string>',
],
]
Result Details
Members
- Environment
-
- Type: Environment structure
An object containing all available details about the environment.
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
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
Result Syntax
[
'Environments' => ['<string>', ...],
'NextToken' => '<string>',
]
Result Details
Members
Errors
-
ValidationException: The provided input is not valid.
-
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
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. To learn more, see Tagging AWS resources.
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
InternalServerException: An internal error has occurred.
PublishMetrics
$result = $client->publishMetrics([/* ... */]); $promise = $client->publishMetricsAsync([/* ... */]);
An operation for publishing metrics from the customers to the Ops plane.
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
Publishes environment metric data to Amazon CloudWatch.
- MetricData
-
- Required: Yes
- Type: Array of MetricDatum structures
Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metrica.
Result Syntax
[]
Result Details
Errors
-
ValidationException: The provided input is not valid.
-
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". To learn more, see Tagging AWS resources.
Result Syntax
[]
Result Details
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
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
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
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
],
],
'MaxWorkers' => <integer>,
'MinWorkers' => <integer>,
'Name' => '<string>', // REQUIRED
'NetworkConfiguration' => [
'SecurityGroupIds' => ['<string>', ...], // REQUIRED
],
'PluginsS3ObjectVersion' => '<string>',
'PluginsS3Path' => '<string>',
'RequirementsS3ObjectVersion' => '<string>',
'RequirementsS3Path' => '<string>',
'Schedulers' => <integer>,
'SourceBucketArn' => '<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. To learn more, see Apache Airflow configuration options.
- AirflowVersion
-
- Type: string
The Apache Airflow version for your environment. For example,
v1.10.12. If no value is specified, defaults to the latest version. Valid values:v1.10.12. - DagS3Path
-
- Type: string
The relative path to the DAGs folder on your Amazon S3 bucket. For example,
dags. To learn more, see Adding or updating DAGs. - EnvironmentClass
-
- Type: string
The environment class type. Valid values:
mw1.small,mw1.medium,mw1.large. To learn more, see Amazon MWAA environment class. - ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role. - LoggingConfiguration
-
- Type: LoggingConfigurationInput structure
Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs,SchedulerLogs,TaskLogs,WebserverLogs,WorkerLogs. - 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
MaxWorkersfield. 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 inMinWorkers. - 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
MaxWorkersfield. 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 theMinWorkersfield. 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 AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
- PluginsS3ObjectVersion
-
- Type: string
The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works.
- PluginsS3Path
-
- Type: string
The relative path to the
plugins.zipfile on your Amazon S3 bucket. For example,plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins. - RequirementsS3ObjectVersion
-
- Type: string
The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works.
- RequirementsS3Path
-
- Type: string
The relative path to the
requirements.txtfile on your Amazon S3 bucket. For example,requirements.txt. If specified, then a file version is required. To learn more, 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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA. - WebserverAccessMode
-
- Type: string
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week 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. Supported input includes the following:-
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Members
Errors
-
ResourceNotFoundException: The resource is not available.
-
ValidationException: The provided input is not valid.
-
InternalServerException: An internal error has occurred.
Shapes
AccessDeniedException
Description
Access to the Airflow Web UI or CLI has been Denied. Please follow the MWAA user guide to setup permissions to access the Web UI and CLI functionality.
Members
Dimension
Description
Internal only API.
Members
Environment
Description
The 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. To learn more, see Apache Airflow configuration options.
- AirflowVersion
-
- Type: string
The Apache Airflow version on your environment. For example,
v1.10.12. - Arn
-
- Type: string
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
- 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 on your Amazon S3 bucket. For example,
dags. To learn more, see Adding or updating DAGs. - EnvironmentClass
-
- Type: string
The environment class type. Valid values:
mw1.small,mw1.medium,mw1.large. To learn more, see Amazon MWAA environment class. - ExecutionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role. - KmsKey
-
- Type: string
The Key Management Service (KMS) encryption key used to encrypt the data in your environment.
- LastUpdate
-
- Type: LastUpdate structure
The status of the last update on the environment, and any errors that were encountered.
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The Apache Airflow logs being sent to CloudWatch Logs:
DagProcessingLogs,SchedulerLogs,TaskLogs,WebserverLogs,WorkerLogs. - MaxWorkers
-
- Type: int
The maximum number of workers that run in your environment. For example,
20. - 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
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
- PluginsS3ObjectVersion
-
- Type: string
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.
- PluginsS3Path
-
- Type: string
The relative path to the
plugins.zipfile on your Amazon S3 bucket. For example,plugins.zip. To learn more, see Installing custom plugins. - RequirementsS3ObjectVersion
-
- Type: string
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.
- RequirementsS3Path
-
- Type: string
The relative path to the
requirements.txtfile on your Amazon S3 bucket. For example,requirements.txt. To learn more, 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. To learn more, 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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA. - Status
-
- Type: 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. To learn more, 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". To learn more, see Tagging AWS resources. - WebserverAccessMode
-
- Type: string
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
- WebserverUrl
-
- Type: string
The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time of the week that weekly maintenance updates are scheduled. For example:
TUE:03:30.
InternalServerException
LastUpdate
Description
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.
- Status
-
- Type: string
The status of the last update on the environment. Valid values:
SUCCESS,PENDING,FAILED.
LoggingConfiguration
Description
Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Members
- DagProcessingLogs
-
- Type: ModuleLoggingConfiguration structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - SchedulerLogs
-
- Type: ModuleLoggingConfiguration structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - TaskLogs
-
- Type: ModuleLoggingConfiguration structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - WebserverLogs
-
- Type: ModuleLoggingConfiguration structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - WorkerLogs
-
- Type: ModuleLoggingConfiguration structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel.
LoggingConfigurationInput
Description
Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Members
- DagProcessingLogs
-
- Type: ModuleLoggingConfigurationInput structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - SchedulerLogs
-
- Type: ModuleLoggingConfigurationInput structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - TaskLogs
-
- Type: ModuleLoggingConfigurationInput structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - WebserverLogs
-
- Type: ModuleLoggingConfigurationInput structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel. - WorkerLogs
-
- Type: ModuleLoggingConfigurationInput structure
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs). Valid values:CloudWatchLogGroupArn,Enabled,LogLevel.
MetricDatum
Description
Internal only API.
Members
- Dimensions
-
- Type: Array of Dimension structures
Internal only API.
- MetricName
-
- Required: Yes
- Type: string
Internal only API.
- StatisticValues
-
- Type: StatisticSet structure
Internal only API.
- Timestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Internal only API.
- Unit
-
- Type: string
Unit
- Value
-
- Type: double
Internal only API.
ModuleLoggingConfiguration
Description
Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
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 to enable the Apache Airflow log type (e.g.
DagProcessingLogs) in CloudWatch Logs. - LogLevel
-
- Type: string
Defines the Apache Airflow logs to send for the log type (e.g.
DagProcessingLogs) to CloudWatch Logs. Valid values:CRITICAL,ERROR,WARNING,INFO.
ModuleLoggingConfigurationInput
Description
Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
Members
- Enabled
-
- Required: Yes
- Type: boolean
Indicates whether to enable the Apache Airflow log type (e.g.
DagProcessingLogs) in CloudWatch Logs. - LogLevel
-
- Required: Yes
- Type: string
Defines the Apache Airflow logs to send for the log type (e.g.
DagProcessingLogs) to CloudWatch Logs. Valid values:CRITICAL,ERROR,WARNING,INFO.
NetworkConfiguration
Description
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
Members
- SecurityGroupIds
-
- Type: Array of strings
A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
- SubnetIds
-
- Type: Array of strings
A list of 2 subnet IDs. Required to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group.
ResourceNotFoundException
StatisticSet
Description
Internal only API.
Members
UpdateError
Description
An object containing the error encountered with the last update: ErrorCode, ErrorMessage.
Members
UpdateNetworkConfigurationInput
Description
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
Members
- SecurityGroupIds
-
- Required: Yes
- Type: Array of strings
A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.