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 = [] )
JSON blob that describes the environment to create.
- CreateWebLoginToken ( array $params = [] )
Create a JWT token to be used to login to Airflow Web UI with claims based Authentication.
- DeleteEnvironment ( array $params = [] )
Delete an existing environment.
- GetEnvironment ( array $params = [] )
Get details of an existing environment.
- ListEnvironments ( array $params = [] )
List Amazon MWAA Environments.
- ListTagsForResource ( array $params = [] )
List the tags for MWAA environments.
- PublishMetrics ( array $params = [] )
An operation for publishing metrics from the customers to the Ops plane.
- TagResource ( array $params = [] )
Add tag to the MWAA environments.
- UntagResource ( array $params = [] )
Remove a tag from the MWAA environments.
- UpdateEnvironment ( array $params = [] )
Update an 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
([/* ... */]);
JSON blob that describes the environment to create.
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>, 'Name' => '<string>', // REQUIRED 'NetworkConfiguration' => [ // REQUIRED 'SecurityGroupIds' => ['<string>', ...], 'SubnetIds' => ['<string>', ...], ], 'PluginsS3ObjectVersion' => '<string>', 'PluginsS3Path' => '<string>', 'RequirementsS3ObjectVersion' => '<string>', 'RequirementsS3Path' => '<string>', '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
The Apache Airflow configuration setting you want to override in your environment. For more information, see Environment configuration.
- AirflowVersion
-
- Type: string
The Apache Airflow version you want to use for your environment.
- DagS3Path
-
- Required: Yes
- Type: string
The relative path to the DAG folder on your Amazon S3 storage bucket. For example,
dags
. For more information, see Importing DAGs on Amazon MWAA. - EnvironmentClass
-
- Type: string
The environment class you want to use for your environment. The environment class determines the size of the containers and database used for your Apache Airflow services.
- 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
. For more information, see Managing access to Amazon Managed Workflows for Apache Airflow. - KmsKey
-
- Type: string
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a custom KMS key (advanced). For more information, see Customer master keys (CMKs) in the AWS KMS developer guide.
- LoggingConfiguration
-
- Type: LoggingConfigurationInput structure
The Apache Airflow logs you want to send to Amazon 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 and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.
- Name
-
- Required: Yes
- Type: string
The name of your MWAA environment.
- NetworkConfiguration
-
- Required: Yes
- Type: NetworkConfiguration structure
The VPC networking components you want to use for your environment. At least two private subnet identifiers and one VPC security group identifier are required to create an environment. For more information, see Creating the VPC network for a MWAA environment.
- PluginsS3ObjectVersion
-
- Type: string
The
plugins.zip
file version you want to use. - PluginsS3Path
-
- Type: string
The relative path to the
plugins.zip
file on your Amazon S3 storage bucket. For example,plugins.zip
. If a relative path is provided in the request, thenPluginsS3ObjectVersion
is required. For more information, see Importing DAGs on Amazon MWAA. - RequirementsS3ObjectVersion
-
- Type: string
The
requirements.txt
file version you want to use. - RequirementsS3Path
-
- Type: string
The relative path to the
requirements.txt
file on your Amazon S3 storage bucket. For example,requirements.txt
. If a relative path is provided in the request, thenRequirementsS3ObjectVersion
is required. For more information, see Importing DAGs on Amazon MWAA. - SourceBucketArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example,
arn:aws:s3:::airflow-mybucketname
. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The metadata tags you want to attach to your environment. For more information, see Tagging AWS resources.
- WebserverAccessMode
-
- Type: string
The networking access of your Apache Airflow web server. A public network allows your Airflow UI to be accessed over the Internet by users granted access in your IAM policy. A private network limits access of your Airflow UI to users within your VPC. For more information, see Creating the VPC network for a MWAA environment.
- WeeklyMaintenanceWindowStart
-
- Type: string
The day and time you want MWAA to start weekly maintenance updates on your environment.
Result Syntax
[ 'Arn' => '<string>', ]
Result Details
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
([/* ... */]);
Delete an existing environment.
Parameter Syntax
$result = $client->deleteEnvironment([ 'Name' => '<string>', // REQUIRED ]);
Parameter Details
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
([/* ... */]);
Get details of an existing environment.
Parameter Syntax
$result = $client->getEnvironment([ 'Name' => '<string>', // REQUIRED ]);
Parameter Details
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>, 'Name' => '<string>', 'NetworkConfiguration' => [ 'SecurityGroupIds' => ['<string>', ...], 'SubnetIds' => ['<string>', ...], ], 'PluginsS3ObjectVersion' => '<string>', 'PluginsS3Path' => '<string>', 'RequirementsS3ObjectVersion' => '<string>', 'RequirementsS3Path' => '<string>', 'ServiceRoleArn' => '<string>', 'SourceBucketArn' => '<string>', 'Status' => 'CREATING|CREATE_FAILED|AVAILABLE|UPDATING|DELETING|DELETED', 'Tags' => ['<string>', ...], 'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY', 'WebserverUrl' => '<string>', 'WeeklyMaintenanceWindowStart' => '<string>', ], ]
Result Details
Members
- Environment
-
- Type: Environment structure
A JSON blob with environment details.
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
([/* ... */]);
List Amazon 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
([/* ... */]);
List the tags for MWAA environments.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Result Syntax
[ 'Tags' => ['<string>', ...], ]
Result Details
Members
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
([/* ... */]);
Add tag to the MWAA environments.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => ['<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.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Remove a tag from the MWAA environments.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<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.
UpdateEnvironment
$result = $client->updateEnvironment
([/* ... */]); $promise = $client->updateEnvironmentAsync
([/* ... */]);
Update an 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>, 'Name' => '<string>', // REQUIRED 'NetworkConfiguration' => [ 'SecurityGroupIds' => ['<string>', ...], // REQUIRED ], 'PluginsS3ObjectVersion' => '<string>', 'PluginsS3Path' => '<string>', 'RequirementsS3ObjectVersion' => '<string>', 'RequirementsS3Path' => '<string>', 'SourceBucketArn' => '<string>', 'WebserverAccessMode' => 'PRIVATE_ONLY|PUBLIC_ONLY', 'WeeklyMaintenanceWindowStart' => '<string>', ]);
Parameter Details
Members
- AirflowConfigurationOptions
-
- Type: Associative array of custom strings keys (ConfigKey) to strings
The Airflow Configuration Options to update of your Amazon MWAA environment.
- AirflowVersion
-
- Type: string
The Airflow Version to update of your Amazon MWAA environment.
- DagS3Path
-
- Type: string
The Dags folder S3 Path to update of your Amazon MWAA environment.
- EnvironmentClass
-
- Type: string
The Environment Class to update of your Amazon MWAA environment.
- ExecutionRoleArn
-
- Type: string
The Executio Role ARN to update of your Amazon MWAA environment.
- LoggingConfiguration
-
- Type: LoggingConfigurationInput structure
The Logging Configuration to update of your Amazon MWAA environment.
- MaxWorkers
-
- Type: int
The Maximum Workers to update of your Amazon MWAA environment.
- Name
-
- Required: Yes
- Type: string
The name of your Amazon MWAA environment that you wish to update.
- NetworkConfiguration
-
- Type: UpdateNetworkConfigurationInput structure
The Network Configuration to update of your Amazon MWAA environment.
- PluginsS3ObjectVersion
-
- Type: string
The Plugins.zip S3 Object Version to update of your Amazon MWAA environment.
- PluginsS3Path
-
- Type: string
The Plugins.zip S3 Path to update of your Amazon MWAA environment.
- RequirementsS3ObjectVersion
-
- Type: string
The Requirements.txt S3 ObjectV ersion to update of your Amazon MWAA environment.
- RequirementsS3Path
-
- Type: string
The Requirements.txt S3 Path to update of your Amazon MWAA environment.
- SourceBucketArn
-
- Type: string
The S3 Source Bucket ARN to update of your Amazon MWAA environment.
- WebserverAccessMode
-
- Type: string
The Webserver Access Mode to update of your Amazon MWAA environment.
- WeeklyMaintenanceWindowStart
-
- Type: string
The Weekly Maintenance Window Start to update of your Amazon MWAA environment.
Result Syntax
[ 'Arn' => '<string>', ]
Result Details
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
An Amazon MWAA environment.
Members
- AirflowConfigurationOptions
-
- Type: Associative array of custom strings keys (ConfigKey) to strings
The Airflow Configuration Options of the Amazon MWAA Environment.
- AirflowVersion
-
- Type: string
The AirflowV ersion of the Amazon MWAA Environment.
- Arn
-
- Type: string
The ARN of the Amazon MWAA Environment.
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Created At date of the Amazon MWAA Environment.
- DagS3Path
-
- Type: string
The Dags S3 Path of the Amazon MWAA Environment.
- EnvironmentClass
-
- Type: string
The Environment Class (size) of the Amazon MWAA Environment.
- ExecutionRoleArn
-
- Type: string
The Execution Role ARN of the Amazon MWAA Environment.
- KmsKey
-
- Type: string
The Kms Key of the Amazon MWAA Environment.
- LastUpdate
-
- Type: LastUpdate structure
Last update information for the environment.
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The Logging Configuration of the Amazon MWAA Environment.
- MaxWorkers
-
- Type: int
The Maximum Workers of the Amazon MWAA Environment.
- Name
-
- Type: string
The name of the Amazon MWAA Environment.
- NetworkConfiguration
-
- Type: NetworkConfiguration structure
Provide the security group and subnet IDs for the workers and scheduler.
- PluginsS3ObjectVersion
-
- Type: string
The Plugins.zip S3 Object Version of the Amazon MWAA Environment.
- PluginsS3Path
-
- Type: string
The Plugins.zip S3 Path of the Amazon MWAA Environment.
- RequirementsS3ObjectVersion
-
- Type: string
The Requirements.txt file S3 Object Version of the Amazon MWAA Environment.
- RequirementsS3Path
-
- Type: string
The Requirement.txt S3 Path of the Amazon MWAA Environment.
- ServiceRoleArn
-
- Type: string
The Service Role ARN of the Amazon MWAA Environment.
- SourceBucketArn
-
- Type: string
The Source S3 Bucket ARN of the Amazon MWAA Environment.
- Status
-
- Type: string
The status of the Amazon MWAA Environment.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The Tags of the Amazon MWAA Environment.
- WebserverAccessMode
-
- Type: string
The Webserver Access Mode of the Amazon MWAA Environment (public or private only).
- WebserverUrl
-
- Type: string
The Webserver URL of the Amazon MWAA Environment.
- WeeklyMaintenanceWindowStart
-
- Type: string
The Weekly Maintenance Window Start of the Amazon MWAA Environment.
InternalServerException
LastUpdate
Description
Last update information for the environment.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time that last update occurred.
- Error
-
- Type: UpdateError structure
Error string of last update, if applicable.
- Status
-
- Type: string
Status of last update of SUCCESS, FAILED, CREATING, DELETING.
LoggingConfiguration
Description
The Logging Configuration of your Amazon MWAA environment.
Members
- DagProcessingLogs
-
- Type: ModuleLoggingConfiguration structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- SchedulerLogs
-
- Type: ModuleLoggingConfiguration structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- TaskLogs
-
- Type: ModuleLoggingConfiguration structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- WebserverLogs
-
- Type: ModuleLoggingConfiguration structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- WorkerLogs
-
- Type: ModuleLoggingConfiguration structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
LoggingConfigurationInput
Description
The Logging Configuration of your Amazon MWAA environment.
Members
- DagProcessingLogs
-
- Type: ModuleLoggingConfigurationInput structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- SchedulerLogs
-
- Type: ModuleLoggingConfigurationInput structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- TaskLogs
-
- Type: ModuleLoggingConfigurationInput structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- WebserverLogs
-
- Type: ModuleLoggingConfigurationInput structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
- WorkerLogs
-
- Type: ModuleLoggingConfigurationInput structure
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
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
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
Members
ModuleLoggingConfigurationInput
Description
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
Members
NetworkConfiguration
Description
Provide the security group and subnet IDs for the workers and scheduler.
Members
ResourceNotFoundException
StatisticSet
Description
Internal only API.
Members
UpdateError
Description
Error information of update, if applicable.
Members
UpdateNetworkConfigurationInput
Description
Provide the security group and subnet IDs for the workers and scheduler.