| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MwAA.Lens
Contents
Description
Synopsis
- createCliToken_name :: Lens' CreateCliToken Text
- createCliTokenResponse_cliToken :: Lens' CreateCliTokenResponse (Maybe Text)
- createCliTokenResponse_webServerHostname :: Lens' CreateCliTokenResponse (Maybe Text)
- createCliTokenResponse_httpStatus :: Lens' CreateCliTokenResponse Int
- createEnvironment_airflowConfigurationOptions :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_airflowVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_environmentClass :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_kmsKey :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_loggingConfiguration :: Lens' CreateEnvironment (Maybe LoggingConfigurationInput)
- createEnvironment_maxWorkers :: Lens' CreateEnvironment (Maybe Natural)
- createEnvironment_minWorkers :: Lens' CreateEnvironment (Maybe Natural)
- createEnvironment_pluginsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_pluginsS3Path :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_requirementsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_requirementsS3Path :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_schedulers :: Lens' CreateEnvironment (Maybe Int)
- createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_webserverAccessMode :: Lens' CreateEnvironment (Maybe WebserverAccessMode)
- createEnvironment_weeklyMaintenanceWindowStart :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_dagS3Path :: Lens' CreateEnvironment Text
- createEnvironment_executionRoleArn :: Lens' CreateEnvironment Text
- createEnvironment_name :: Lens' CreateEnvironment Text
- createEnvironment_networkConfiguration :: Lens' CreateEnvironment NetworkConfiguration
- createEnvironment_sourceBucketArn :: Lens' CreateEnvironment Text
- createEnvironmentResponse_arn :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
- createWebLoginToken_name :: Lens' CreateWebLoginToken Text
- createWebLoginTokenResponse_webServerHostname :: Lens' CreateWebLoginTokenResponse (Maybe Text)
- createWebLoginTokenResponse_webToken :: Lens' CreateWebLoginTokenResponse (Maybe Text)
- createWebLoginTokenResponse_httpStatus :: Lens' CreateWebLoginTokenResponse Int
- deleteEnvironment_name :: Lens' DeleteEnvironment Text
- deleteEnvironmentResponse_httpStatus :: Lens' DeleteEnvironmentResponse Int
- getEnvironment_name :: Lens' GetEnvironment Text
- getEnvironmentResponse_environment :: Lens' GetEnvironmentResponse (Maybe Environment)
- getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int
- listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural)
- listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text)
- listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text)
- listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int
- listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse [Text]
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text))
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- publishMetrics_environmentName :: Lens' PublishMetrics Text
- publishMetrics_metricData :: Lens' PublishMetrics [MetricDatum]
- publishMetricsResponse_httpStatus :: Lens' PublishMetricsResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource (HashMap Text Text)
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateEnvironment_airflowConfigurationOptions :: Lens' UpdateEnvironment (Maybe (HashMap Text Text))
- updateEnvironment_airflowVersion :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_dagS3Path :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_environmentClass :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_executionRoleArn :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_loggingConfiguration :: Lens' UpdateEnvironment (Maybe LoggingConfigurationInput)
- updateEnvironment_maxWorkers :: Lens' UpdateEnvironment (Maybe Natural)
- updateEnvironment_minWorkers :: Lens' UpdateEnvironment (Maybe Natural)
- updateEnvironment_networkConfiguration :: Lens' UpdateEnvironment (Maybe UpdateNetworkConfigurationInput)
- updateEnvironment_pluginsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_pluginsS3Path :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_requirementsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_requirementsS3Path :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_schedulers :: Lens' UpdateEnvironment (Maybe Int)
- updateEnvironment_sourceBucketArn :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_webserverAccessMode :: Lens' UpdateEnvironment (Maybe WebserverAccessMode)
- updateEnvironment_weeklyMaintenanceWindowStart :: Lens' UpdateEnvironment (Maybe Text)
- updateEnvironment_name :: Lens' UpdateEnvironment Text
- updateEnvironmentResponse_arn :: Lens' UpdateEnvironmentResponse (Maybe Text)
- updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int
- dimension_name :: Lens' Dimension Text
- dimension_value :: Lens' Dimension Text
- environment_airflowConfigurationOptions :: Lens' Environment (Maybe (HashMap Text Text))
- environment_airflowVersion :: Lens' Environment (Maybe Text)
- environment_arn :: Lens' Environment (Maybe Text)
- environment_createdAt :: Lens' Environment (Maybe UTCTime)
- environment_dagS3Path :: Lens' Environment (Maybe Text)
- environment_environmentClass :: Lens' Environment (Maybe Text)
- environment_executionRoleArn :: Lens' Environment (Maybe Text)
- environment_kmsKey :: Lens' Environment (Maybe Text)
- environment_lastUpdate :: Lens' Environment (Maybe LastUpdate)
- environment_loggingConfiguration :: Lens' Environment (Maybe LoggingConfiguration)
- environment_maxWorkers :: Lens' Environment (Maybe Natural)
- environment_minWorkers :: Lens' Environment (Maybe Natural)
- environment_name :: Lens' Environment (Maybe Text)
- environment_networkConfiguration :: Lens' Environment (Maybe NetworkConfiguration)
- environment_pluginsS3ObjectVersion :: Lens' Environment (Maybe Text)
- environment_pluginsS3Path :: Lens' Environment (Maybe Text)
- environment_requirementsS3ObjectVersion :: Lens' Environment (Maybe Text)
- environment_requirementsS3Path :: Lens' Environment (Maybe Text)
- environment_schedulers :: Lens' Environment (Maybe Int)
- environment_serviceRoleArn :: Lens' Environment (Maybe Text)
- environment_sourceBucketArn :: Lens' Environment (Maybe Text)
- environment_status :: Lens' Environment (Maybe EnvironmentStatus)
- environment_tags :: Lens' Environment (Maybe (HashMap Text Text))
- environment_webserverAccessMode :: Lens' Environment (Maybe WebserverAccessMode)
- environment_webserverUrl :: Lens' Environment (Maybe Text)
- environment_weeklyMaintenanceWindowStart :: Lens' Environment (Maybe Text)
- lastUpdate_createdAt :: Lens' LastUpdate (Maybe UTCTime)
- lastUpdate_error :: Lens' LastUpdate (Maybe UpdateError)
- lastUpdate_source :: Lens' LastUpdate (Maybe Text)
- lastUpdate_status :: Lens' LastUpdate (Maybe UpdateStatus)
- loggingConfiguration_dagProcessingLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_schedulerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_taskLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_webserverLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_workerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfigurationInput_dagProcessingLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_schedulerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_taskLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_webserverLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_workerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
- metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
- metricDatum_unit :: Lens' MetricDatum (Maybe Unit)
- metricDatum_value :: Lens' MetricDatum (Maybe Double)
- metricDatum_metricName :: Lens' MetricDatum Text
- metricDatum_timestamp :: Lens' MetricDatum UTCTime
- moduleLoggingConfiguration_cloudWatchLogGroupArn :: Lens' ModuleLoggingConfiguration (Maybe Text)
- moduleLoggingConfiguration_enabled :: Lens' ModuleLoggingConfiguration (Maybe Bool)
- moduleLoggingConfiguration_logLevel :: Lens' ModuleLoggingConfiguration (Maybe LoggingLevel)
- moduleLoggingConfigurationInput_enabled :: Lens' ModuleLoggingConfigurationInput Bool
- moduleLoggingConfigurationInput_logLevel :: Lens' ModuleLoggingConfigurationInput LoggingLevel
- networkConfiguration_securityGroupIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text))
- networkConfiguration_subnetIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text))
- statisticSet_maximum :: Lens' StatisticSet (Maybe Double)
- statisticSet_minimum :: Lens' StatisticSet (Maybe Double)
- statisticSet_sampleCount :: Lens' StatisticSet (Maybe Int)
- statisticSet_sum :: Lens' StatisticSet (Maybe Double)
- updateError_errorCode :: Lens' UpdateError (Maybe Text)
- updateError_errorMessage :: Lens' UpdateError (Maybe Text)
- updateNetworkConfigurationInput_securityGroupIds :: Lens' UpdateNetworkConfigurationInput (NonEmpty Text)
Operations
CreateCliToken
createCliToken_name :: Lens' CreateCliToken Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
createCliTokenResponse_cliToken :: Lens' CreateCliTokenResponse (Maybe Text) Source #
An Airflow CLI login token.
createCliTokenResponse_webServerHostname :: Lens' CreateCliTokenResponse (Maybe Text) Source #
The Airflow web server hostname for the environment.
createCliTokenResponse_httpStatus :: Lens' CreateCliTokenResponse Int Source #
The response's http status code.
CreateEnvironment
createEnvironment_airflowConfigurationOptions :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #
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.
createEnvironment_airflowVersion :: Lens' CreateEnvironment (Maybe Text) Source #
The Apache Airflow version for your environment. If no value is
specified, it defaults to the latest version. Valid values: 1.10.12,
2.0.2, 2.2.2, and 2.4.3. For more information, see
Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
createEnvironment_environmentClass :: Lens' CreateEnvironment (Maybe Text) Source #
The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
createEnvironment_kmsKey :: Lens' CreateEnvironment (Maybe Text) Source #
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.
createEnvironment_loggingConfiguration :: Lens' CreateEnvironment (Maybe LoggingConfigurationInput) Source #
Defines the Apache Airflow logs to send to CloudWatch Logs.
createEnvironment_maxWorkers :: Lens' CreateEnvironment (Maybe Natural) Source #
The maximum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you
specify in the MaxWorkers field. For example, 20. When there are no
more tasks running, and no more in the queue, MWAA disposes of the extra
workers leaving the one worker that is included with your environment,
or the number you specify in MinWorkers.
createEnvironment_minWorkers :: Lens' CreateEnvironment (Maybe Natural) Source #
The minimum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you
specify in the MaxWorkers field. When there are no more tasks running,
and no more in the queue, MWAA disposes of the extra workers leaving the
worker count you specify in the MinWorkers field. For example, 2.
createEnvironment_pluginsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text) Source #
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.
createEnvironment_pluginsS3Path :: Lens' CreateEnvironment (Maybe Text) Source #
The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. If specified, then the plugins.zip version
is required. To learn more, see
Installing custom plugins.
createEnvironment_requirementsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text) Source #
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.
createEnvironment_requirementsS3Path :: Lens' CreateEnvironment (Maybe Text) Source #
The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. If specified, then a file
version is required. To learn more, see
Installing Python dependencies.
createEnvironment_schedulers :: Lens' CreateEnvironment (Maybe Int) Source #
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.
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #
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.
createEnvironment_webserverAccessMode :: Lens' CreateEnvironment (Maybe WebserverAccessMode) Source #
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
createEnvironment_weeklyMaintenanceWindowStart :: Lens' CreateEnvironment (Maybe Text) Source #
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.
createEnvironment_dagS3Path :: Lens' CreateEnvironment Text Source #
The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
createEnvironment_executionRoleArn :: Lens' CreateEnvironment Text Source #
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.
createEnvironment_name :: Lens' CreateEnvironment Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
createEnvironment_networkConfiguration :: Lens' CreateEnvironment NetworkConfiguration Source #
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.
createEnvironment_sourceBucketArn :: Lens' CreateEnvironment Text Source #
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.
createEnvironmentResponse_arn :: Lens' CreateEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) returned in the response for the environment.
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #
The response's http status code.
CreateWebLoginToken
createWebLoginToken_name :: Lens' CreateWebLoginToken Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
createWebLoginTokenResponse_webServerHostname :: Lens' CreateWebLoginTokenResponse (Maybe Text) Source #
The Airflow web server hostname for the environment.
createWebLoginTokenResponse_webToken :: Lens' CreateWebLoginTokenResponse (Maybe Text) Source #
An Airflow web server login token.
createWebLoginTokenResponse_httpStatus :: Lens' CreateWebLoginTokenResponse Int Source #
The response's http status code.
DeleteEnvironment
deleteEnvironment_name :: Lens' DeleteEnvironment Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
deleteEnvironmentResponse_httpStatus :: Lens' DeleteEnvironmentResponse Int Source #
The response's http status code.
GetEnvironment
getEnvironment_name :: Lens' GetEnvironment Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
getEnvironmentResponse_environment :: Lens' GetEnvironmentResponse (Maybe Environment) Source #
An object containing all available details about the environment.
getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int Source #
The response's http status code.
ListEnvironments
listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #
The maximum number of results to retrieve per page. For example, 5
environments per page.
listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #
Retrieves the next page of the results.
listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #
Retrieves the next page of the results.
listEnvironmentsResponse_httpStatus :: Lens' ListEnvironmentsResponse Int Source #
The response's http status code.
listEnvironmentsResponse_environments :: Lens' ListEnvironmentsResponse [Text] Source #
Returns a list of Amazon MWAA environments.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #
The key-value tag pairs associated to your environment. To learn more, see Tagging Amazon Web Services resources.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
PublishMetrics
publishMetrics_environmentName :: Lens' PublishMetrics Text Source #
Internal only. The name of the environment.
publishMetrics_metricData :: Lens' PublishMetrics [MetricDatum] Source #
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.
publishMetricsResponse_httpStatus :: Lens' PublishMetricsResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #
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.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The key-value tag pair you want to remove. For example,
"Environment": "Staging".
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateEnvironment
updateEnvironment_airflowConfigurationOptions :: Lens' UpdateEnvironment (Maybe (HashMap Text Text)) Source #
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.
updateEnvironment_airflowVersion :: Lens' UpdateEnvironment (Maybe Text) Source #
The Apache Airflow version for your environment. If no value is
specified, defaults to the latest version. Valid values: 1.10.12,
2.0.2, 2.2.2, and 2.4.3.
updateEnvironment_dagS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #
The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
updateEnvironment_environmentClass :: Lens' UpdateEnvironment (Maybe Text) Source #
The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
updateEnvironment_executionRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #
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.
updateEnvironment_loggingConfiguration :: Lens' UpdateEnvironment (Maybe LoggingConfigurationInput) Source #
The Apache Airflow log types to send to CloudWatch Logs.
updateEnvironment_maxWorkers :: Lens' UpdateEnvironment (Maybe Natural) Source #
The maximum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you
specify in the MaxWorkers field. For example, 20. When there are no
more tasks running, and no more in the queue, MWAA disposes of the extra
workers leaving the one worker that is included with your environment,
or the number you specify in MinWorkers.
updateEnvironment_minWorkers :: Lens' UpdateEnvironment (Maybe Natural) Source #
The minimum number of workers that you want to run in your environment.
MWAA scales the number of Apache Airflow workers up to the number you
specify in the MaxWorkers field. When there are no more tasks running,
and no more in the queue, MWAA disposes of the extra workers leaving the
worker count you specify in the MinWorkers field. For example, 2.
updateEnvironment_networkConfiguration :: Lens' UpdateEnvironment (Maybe UpdateNetworkConfigurationInput) Source #
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.
updateEnvironment_pluginsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text) Source #
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.
updateEnvironment_pluginsS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #
The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. If specified, then the plugins.zip version
is required. To learn more, see
Installing custom plugins.
updateEnvironment_requirementsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text) Source #
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.
updateEnvironment_requirementsS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #
The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. If specified, then a file
version is required. To learn more, see
Installing Python dependencies.
updateEnvironment_schedulers :: Lens' UpdateEnvironment (Maybe Int) Source #
The number of Apache Airflow schedulers to run in your Amazon MWAA environment.
updateEnvironment_sourceBucketArn :: Lens' UpdateEnvironment (Maybe Text) Source #
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.
updateEnvironment_webserverAccessMode :: Lens' UpdateEnvironment (Maybe WebserverAccessMode) Source #
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
updateEnvironment_weeklyMaintenanceWindowStart :: Lens' UpdateEnvironment (Maybe Text) Source #
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.
updateEnvironment_name :: Lens' UpdateEnvironment Text Source #
The name of your Amazon MWAA environment. For example,
MyMWAAEnvironment.
updateEnvironmentResponse_arn :: Lens' UpdateEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
updateEnvironmentResponse_httpStatus :: Lens' UpdateEnvironmentResponse Int Source #
The response's http status code.
Types
Dimension
Environment
environment_airflowConfigurationOptions :: Lens' Environment (Maybe (HashMap Text Text)) Source #
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.
environment_airflowVersion :: Lens' Environment (Maybe Text) Source #
The Apache Airflow version on your environment. Valid values: 1.10.12,
2.0.2, 2.2.2, and 2.4.3.
environment_arn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
environment_createdAt :: Lens' Environment (Maybe UTCTime) Source #
The day and time the environment was created.
environment_dagS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
environment_environmentClass :: Lens' Environment (Maybe Text) Source #
The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
environment_executionRoleArn :: Lens' Environment (Maybe Text) Source #
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.
environment_kmsKey :: Lens' Environment (Maybe Text) Source #
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
environment_lastUpdate :: Lens' Environment (Maybe LastUpdate) Source #
The status of the last update on the environment.
environment_loggingConfiguration :: Lens' Environment (Maybe LoggingConfiguration) Source #
The Apache Airflow logs published to CloudWatch Logs.
environment_maxWorkers :: Lens' Environment (Maybe Natural) Source #
The maximum number of workers that run in your environment. For example,
20.
environment_minWorkers :: Lens' Environment (Maybe Natural) Source #
The minimum number of workers that run in your environment. For example,
2.
environment_name :: Lens' Environment (Maybe Text) Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
environment_networkConfiguration :: Lens' Environment (Maybe NetworkConfiguration) Source #
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.
environment_pluginsS3ObjectVersion :: Lens' Environment (Maybe Text) Source #
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.
environment_pluginsS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. To learn more, see
Installing custom plugins.
environment_requirementsS3ObjectVersion :: Lens' Environment (Maybe Text) Source #
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.
environment_requirementsS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. To learn more, see
Installing Python dependencies.
environment_schedulers :: Lens' Environment (Maybe Int) Source #
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
environment_serviceRoleArn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.
environment_sourceBucketArn :: Lens' Environment (Maybe Text) Source #
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.
environment_status :: Lens' Environment (Maybe EnvironmentStatus) Source #
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.
environment_tags :: Lens' Environment (Maybe (HashMap Text Text)) Source #
The key-value tag pairs associated to your environment. For example,
"Environment": "Staging". To learn more, see
Tagging Amazon Web Services resources.
environment_webserverAccessMode :: Lens' Environment (Maybe WebserverAccessMode) Source #
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
environment_webserverUrl :: Lens' Environment (Maybe Text) Source #
The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.
environment_weeklyMaintenanceWindowStart :: Lens' Environment (Maybe Text) Source #
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.
LastUpdate
lastUpdate_createdAt :: Lens' LastUpdate (Maybe UTCTime) Source #
The day and time of the last update on the environment.
lastUpdate_error :: Lens' LastUpdate (Maybe UpdateError) Source #
The error that was encountered during the last update of the environment.
lastUpdate_source :: Lens' LastUpdate (Maybe Text) Source #
The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
lastUpdate_status :: Lens' LastUpdate (Maybe UpdateStatus) Source #
The status of the last update on the environment.
LoggingConfiguration
loggingConfiguration_dagProcessingLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
loggingConfiguration_schedulerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow scheduler logs published to CloudWatch Logs and the log level.
loggingConfiguration_taskLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow task logs published to CloudWatch Logs and the log level.
loggingConfiguration_webserverLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow web server logs published to CloudWatch Logs and the log level.
loggingConfiguration_workerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow worker logs published to CloudWatch Logs and the log level.
LoggingConfigurationInput
loggingConfigurationInput_dagProcessingLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow DAG processing logs to CloudWatch Logs.
loggingConfigurationInput_schedulerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow scheduler logs to CloudWatch Logs.
loggingConfigurationInput_taskLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow task logs to CloudWatch Logs.
loggingConfigurationInput_webserverLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow web server logs to CloudWatch Logs.
loggingConfigurationInput_workerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow worker logs to CloudWatch Logs.
MetricDatum
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension]) Source #
Internal only. The dimensions associated with the metric.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source #
Internal only. The statistical values for the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe Unit) Source #
Internal only. The unit used to store the metric.
metricDatum_value :: Lens' MetricDatum (Maybe Double) Source #
Internal only. The value for the metric.
metricDatum_metricName :: Lens' MetricDatum Text Source #
Internal only. The name of the metric.
metricDatum_timestamp :: Lens' MetricDatum UTCTime Source #
Internal only. The time the metric data was received.
ModuleLoggingConfiguration
moduleLoggingConfiguration_cloudWatchLogGroupArn :: Lens' ModuleLoggingConfiguration (Maybe Text) Source #
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:*.
moduleLoggingConfiguration_enabled :: Lens' ModuleLoggingConfiguration (Maybe Bool) Source #
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs)
is enabled.
moduleLoggingConfiguration_logLevel :: Lens' ModuleLoggingConfiguration (Maybe LoggingLevel) Source #
The Apache Airflow log level for the log type (e.g.
DagProcessingLogs).
ModuleLoggingConfigurationInput
moduleLoggingConfigurationInput_enabled :: Lens' ModuleLoggingConfigurationInput Bool Source #
Indicates whether to enable the Apache Airflow log type (e.g.
DagProcessingLogs).
moduleLoggingConfigurationInput_logLevel :: Lens' ModuleLoggingConfigurationInput LoggingLevel Source #
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch
Logs.
NetworkConfiguration
networkConfiguration_securityGroupIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text)) Source #
A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.
networkConfiguration_subnetIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text)) Source #
A list of subnet IDs. To learn more, see About networking on Amazon MWAA.
StatisticSet
statisticSet_maximum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The maximum value of the sample set.
statisticSet_minimum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The minimum value of the sample set.
statisticSet_sampleCount :: Lens' StatisticSet (Maybe Int) Source #
Internal only. The number of samples used for the statistic set.
statisticSet_sum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The sum of values for the sample set.
UpdateError
updateError_errorCode :: Lens' UpdateError (Maybe Text) Source #
The error code that corresponds to the error with the last update.
updateError_errorMessage :: Lens' UpdateError (Maybe Text) Source #
The error message that corresponds to the error code.
UpdateNetworkConfigurationInput
updateNetworkConfigurationInput_securityGroupIds :: Lens' UpdateNetworkConfigurationInput (NonEmpty Text) Source #
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.