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:
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
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. If no value is specified, it defaults to the latest version. Valid values:
1.10.12,2.0.2, and2.2.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA). - 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 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. To learn more, 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). To learn more, see Create an Amazon MWAA environment.
- LoggingConfiguration
-
- Type: LoggingConfigurationInput structure
Defines the Apache Airflow logs to send to CloudWatch Logs.
- 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 Amazon Web Services 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. 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. 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 Amazon Web Services 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 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
Errors
-
ValidationException: The provided input is not valid.
-
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
Result Syntax
[
'WebServerHostname' => '<string>',
'WebToken' => '<string>',
]
Result Details
Members
Errors
-
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: 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([/* ... */]);
Describes 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>',
],
'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' => <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 Amazon Web Services 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([/* ... */]);
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
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 Amazon Web Services 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. If no value is specified, defaults to the latest version. Valid values:
1.10.12,2.0.2, and2.2.2. - 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 Amazon Web Services 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
The Apache Airflow log types to send to CloudWatch Logs.
- 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 Amazon Web Services 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 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
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 Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.
Members
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
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. To learn more, see Apache Airflow configuration options.
- AirflowVersion
-
- Type: string
The Apache Airflow version on your environment. Valid values:
1.10.12,2.0.2, and2.2.2. - 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 Amazon Web Services 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 Amazon Web Services 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.
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The Apache Airflow logs published to CloudWatch Logs.
- 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
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services 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 Amazon Web Services 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 in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example:
TUE:03:30.
InternalServerException
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
NetworkConfiguration
Description
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
Members
- SecurityGroupIds
-
- Type: Array of strings
A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.
- SubnetIds
-
- Type: Array of strings
A list of subnet IDs. To learn more, see About networking on Amazon MWAA.
ResourceNotFoundException
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
UpdateNetworkConfigurationInput
Description
Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, 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. To learn more, see Security in your VPC on Amazon MWAA.