| 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
Description
Derived from API version 2020-07-01 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Managed Workflows for Apache Airflow
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
Endpoints
api.airflow.{region}.amazonaws.com- This endpoint is used for environment management.env.airflow.{region}.amazonaws.com- This endpoint is used to operate the Airflow environment.ops.airflow.{region}.amazonaws.com- This endpoint is used to push environment metrics that track environment health.
Regions
For a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateCliToken = CreateCliToken' Text
- newCreateCliToken :: Text -> CreateCliToken
- data CreateCliTokenResponse = CreateCliTokenResponse' (Maybe (Sensitive Text)) (Maybe Text) Int
- newCreateCliTokenResponse :: Int -> CreateCliTokenResponse
- data CreateEnvironment = CreateEnvironment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationInput) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe (HashMap Text Text)) (Maybe WebserverAccessMode) (Maybe Text) Text Text Text NetworkConfiguration Text
- newCreateEnvironment :: Text -> Text -> Text -> NetworkConfiguration -> Text -> CreateEnvironment
- data CreateEnvironmentResponse = CreateEnvironmentResponse' (Maybe Text) Int
- newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
- data CreateWebLoginToken = CreateWebLoginToken' Text
- newCreateWebLoginToken :: Text -> CreateWebLoginToken
- data CreateWebLoginTokenResponse = CreateWebLoginTokenResponse' (Maybe Text) (Maybe (Sensitive Text)) Int
- newCreateWebLoginTokenResponse :: Int -> CreateWebLoginTokenResponse
- data DeleteEnvironment = DeleteEnvironment' Text
- newDeleteEnvironment :: Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' Int
- newDeleteEnvironmentResponse :: Int -> DeleteEnvironmentResponse
- data GetEnvironment = GetEnvironment' Text
- newGetEnvironment :: Text -> GetEnvironment
- data GetEnvironmentResponse = GetEnvironmentResponse' (Maybe Environment) Int
- newGetEnvironmentResponse :: Int -> GetEnvironmentResponse
- data ListEnvironments = ListEnvironments' (Maybe Natural) (Maybe Text)
- newListEnvironments :: ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe Text) Int [Text]
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data PublishMetrics = PublishMetrics' Text [MetricDatum]
- newPublishMetrics :: Text -> PublishMetrics
- data PublishMetricsResponse = PublishMetricsResponse' Int
- newPublishMetricsResponse :: Int -> PublishMetricsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateEnvironment = UpdateEnvironment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationInput) (Maybe Natural) (Maybe Natural) (Maybe UpdateNetworkConfigurationInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) Text
- newUpdateEnvironment :: Text -> UpdateEnvironment
- data UpdateEnvironmentResponse = UpdateEnvironmentResponse' (Maybe Text) Int
- newUpdateEnvironmentResponse :: Int -> UpdateEnvironmentResponse
- newtype EnvironmentStatus where
- EnvironmentStatus' { }
- pattern EnvironmentStatus_AVAILABLE :: EnvironmentStatus
- pattern EnvironmentStatus_CREATE_FAILED :: EnvironmentStatus
- pattern EnvironmentStatus_CREATING :: EnvironmentStatus
- pattern EnvironmentStatus_DELETED :: EnvironmentStatus
- pattern EnvironmentStatus_DELETING :: EnvironmentStatus
- pattern EnvironmentStatus_UNAVAILABLE :: EnvironmentStatus
- pattern EnvironmentStatus_UPDATE_FAILED :: EnvironmentStatus
- pattern EnvironmentStatus_UPDATING :: EnvironmentStatus
- newtype LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_CRITICAL :: LoggingLevel
- pattern LoggingLevel_DEBUG :: LoggingLevel
- pattern LoggingLevel_ERROR :: LoggingLevel
- pattern LoggingLevel_INFO :: LoggingLevel
- pattern LoggingLevel_WARNING :: LoggingLevel
- newtype Unit where
- Unit' { }
- pattern Unit_Bits :: Unit
- pattern Unit_Bits_Second :: Unit
- pattern Unit_Bytes :: Unit
- pattern Unit_Bytes_Second :: Unit
- pattern Unit_Count :: Unit
- pattern Unit_Count_Second :: Unit
- pattern Unit_Gigabits :: Unit
- pattern Unit_Gigabits_Second :: Unit
- pattern Unit_Gigabytes :: Unit
- pattern Unit_Gigabytes_Second :: Unit
- pattern Unit_Kilobits :: Unit
- pattern Unit_Kilobits_Second :: Unit
- pattern Unit_Kilobytes :: Unit
- pattern Unit_Kilobytes_Second :: Unit
- pattern Unit_Megabits :: Unit
- pattern Unit_Megabits_Second :: Unit
- pattern Unit_Megabytes :: Unit
- pattern Unit_Megabytes_Second :: Unit
- pattern Unit_Microseconds :: Unit
- pattern Unit_Milliseconds :: Unit
- pattern Unit_None :: Unit
- pattern Unit_Percent :: Unit
- pattern Unit_Seconds :: Unit
- pattern Unit_Terabits :: Unit
- pattern Unit_Terabits_Second :: Unit
- pattern Unit_Terabytes :: Unit
- pattern Unit_Terabytes_Second :: Unit
- newtype UpdateStatus where
- UpdateStatus' { }
- pattern UpdateStatus_FAILED :: UpdateStatus
- pattern UpdateStatus_PENDING :: UpdateStatus
- pattern UpdateStatus_SUCCESS :: UpdateStatus
- newtype WebserverAccessMode where
- data Dimension = Dimension' Text Text
- newDimension :: Text -> Text -> Dimension
- data Environment = Environment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LastUpdate) (Maybe LoggingConfiguration) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe NetworkConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe EnvironmentStatus) (Maybe (HashMap Text Text)) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text)
- newEnvironment :: Environment
- data LastUpdate = LastUpdate' (Maybe POSIX) (Maybe UpdateError) (Maybe Text) (Maybe UpdateStatus)
- newLastUpdate :: LastUpdate
- data LoggingConfiguration = LoggingConfiguration' (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration)
- newLoggingConfiguration :: LoggingConfiguration
- data LoggingConfigurationInput = LoggingConfigurationInput' (Maybe ModuleLoggingConfigurationInput) (Maybe ModuleLoggingConfigurationInput) (Maybe ModuleLoggingConfigurationInput) (Maybe ModuleLoggingConfigurationInput) (Maybe ModuleLoggingConfigurationInput)
- newLoggingConfigurationInput :: LoggingConfigurationInput
- data MetricDatum = MetricDatum' (Maybe [Dimension]) (Maybe StatisticSet) (Maybe Unit) (Maybe Double) Text POSIX
- newMetricDatum :: Text -> UTCTime -> MetricDatum
- data ModuleLoggingConfiguration = ModuleLoggingConfiguration' (Maybe Text) (Maybe Bool) (Maybe LoggingLevel)
- newModuleLoggingConfiguration :: ModuleLoggingConfiguration
- data ModuleLoggingConfigurationInput = ModuleLoggingConfigurationInput' Bool LoggingLevel
- newModuleLoggingConfigurationInput :: Bool -> LoggingLevel -> ModuleLoggingConfigurationInput
- data NetworkConfiguration = NetworkConfiguration' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text))
- newNetworkConfiguration :: NetworkConfiguration
- data StatisticSet = StatisticSet' (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Double)
- newStatisticSet :: StatisticSet
- data UpdateError = UpdateError' (Maybe Text) (Maybe Text)
- newUpdateError :: UpdateError
- data UpdateNetworkConfigurationInput = UpdateNetworkConfigurationInput' (NonEmpty Text)
- newUpdateNetworkConfigurationInput :: NonEmpty Text -> UpdateNetworkConfigurationInput
Service Configuration
defaultService :: Service Source #
API version 2020-07-01 of the Amazon MWAA SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MwAA.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
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.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
InternalServerException: An internal error has occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
ResourceNotFoundException: The resource is not available.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
ValidationException: The provided input is not valid.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCliToken
data CreateCliToken Source #
See: newCreateCliToken smart constructor.
Constructors
| CreateCliToken' Text |
Instances
Arguments
| :: Text | |
| -> CreateCliToken |
Create a value of CreateCliToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateCliToken, createCliToken_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
data CreateCliTokenResponse Source #
See: newCreateCliTokenResponse smart constructor.
Instances
newCreateCliTokenResponse Source #
Create a value of CreateCliTokenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cliToken:CreateCliTokenResponse', createCliTokenResponse_cliToken - An Airflow CLI login token.
$sel:webServerHostname:CreateCliTokenResponse', createCliTokenResponse_webServerHostname - The Airflow web server hostname for the environment.
$sel:httpStatus:CreateCliTokenResponse', createCliTokenResponse_httpStatus - The response's http status code.
CreateEnvironment
data CreateEnvironment Source #
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.
See: newCreateEnvironment smart constructor.
Constructors
| CreateEnvironment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationInput) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe (HashMap Text Text)) (Maybe WebserverAccessMode) (Maybe Text) Text Text Text NetworkConfiguration Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> NetworkConfiguration | |
| -> Text | |
| -> CreateEnvironment |
Create a value of CreateEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEnvironment, createEnvironment_airflowConfigurationOptions - 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, createEnvironment_airflowVersion - 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, createEnvironment_environmentClass - The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
CreateEnvironment, createEnvironment_kmsKey - 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, createEnvironment_loggingConfiguration - Defines the Apache Airflow logs to send to CloudWatch Logs.
CreateEnvironment, createEnvironment_maxWorkers - 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, createEnvironment_minWorkers - 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, createEnvironment_pluginsS3ObjectVersion - 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, createEnvironment_pluginsS3Path - 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, createEnvironment_requirementsS3ObjectVersion - 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, createEnvironment_requirementsS3Path - 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, createEnvironment_schedulers - 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, createEnvironment_tags - 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, createEnvironment_webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
CreateEnvironment, createEnvironment_weeklyMaintenanceWindowStart - 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, createEnvironment_dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
CreateEnvironment, createEnvironment_executionRoleArn - 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, createEnvironment_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
CreateEnvironment, createEnvironment_networkConfiguration - 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, createEnvironment_sourceBucketArn - 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.
data CreateEnvironmentResponse Source #
See: newCreateEnvironmentResponse smart constructor.
Constructors
| CreateEnvironmentResponse' (Maybe Text) Int |
Instances
newCreateEnvironmentResponse Source #
Create a value of CreateEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateEnvironmentResponse, createEnvironmentResponse_arn - The Amazon Resource Name (ARN) returned in the response for the
environment.
$sel:httpStatus:CreateEnvironmentResponse', createEnvironmentResponse_httpStatus - The response's http status code.
CreateWebLoginToken
data CreateWebLoginToken Source #
See: newCreateWebLoginToken smart constructor.
Constructors
| CreateWebLoginToken' Text |
Instances
newCreateWebLoginToken Source #
Arguments
| :: Text | |
| -> CreateWebLoginToken |
Create a value of CreateWebLoginToken with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWebLoginToken, createWebLoginToken_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
data CreateWebLoginTokenResponse Source #
See: newCreateWebLoginTokenResponse smart constructor.
Instances
newCreateWebLoginTokenResponse Source #
Create a value of CreateWebLoginTokenResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:webServerHostname:CreateWebLoginTokenResponse', createWebLoginTokenResponse_webServerHostname - The Airflow web server hostname for the environment.
$sel:webToken:CreateWebLoginTokenResponse', createWebLoginTokenResponse_webToken - An Airflow web server login token.
$sel:httpStatus:CreateWebLoginTokenResponse', createWebLoginTokenResponse_httpStatus - The response's http status code.
DeleteEnvironment
data DeleteEnvironment Source #
See: newDeleteEnvironment smart constructor.
Constructors
| DeleteEnvironment' Text |
Instances
Arguments
| :: Text | |
| -> DeleteEnvironment |
Create a value of DeleteEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteEnvironment, deleteEnvironment_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
data DeleteEnvironmentResponse Source #
See: newDeleteEnvironmentResponse smart constructor.
Constructors
| DeleteEnvironmentResponse' Int |
Instances
newDeleteEnvironmentResponse Source #
Create a value of DeleteEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteEnvironmentResponse', deleteEnvironmentResponse_httpStatus - The response's http status code.
GetEnvironment
data GetEnvironment Source #
See: newGetEnvironment smart constructor.
Constructors
| GetEnvironment' Text |
Instances
Arguments
| :: Text | |
| -> GetEnvironment |
Create a value of GetEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetEnvironment, getEnvironment_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
data GetEnvironmentResponse Source #
See: newGetEnvironmentResponse smart constructor.
Constructors
| GetEnvironmentResponse' (Maybe Environment) Int |
Instances
newGetEnvironmentResponse Source #
Create a value of GetEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environment:GetEnvironmentResponse', getEnvironmentResponse_environment - An object containing all available details about the environment.
$sel:httpStatus:GetEnvironmentResponse', getEnvironmentResponse_httpStatus - The response's http status code.
ListEnvironments (Paginated)
data ListEnvironments Source #
See: newListEnvironments smart constructor.
Constructors
| ListEnvironments' (Maybe Natural) (Maybe Text) |
Instances
newListEnvironments :: ListEnvironments Source #
Create a value of ListEnvironments with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListEnvironments', listEnvironments_maxResults - The maximum number of results to retrieve per page. For example, 5
environments per page.
ListEnvironments, listEnvironments_nextToken - Retrieves the next page of the results.
data ListEnvironmentsResponse Source #
See: newListEnvironmentsResponse smart constructor.
Constructors
| ListEnvironmentsResponse' (Maybe Text) Int [Text] |
Instances
newListEnvironmentsResponse Source #
Create a value of ListEnvironmentsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListEnvironments, listEnvironmentsResponse_nextToken - Retrieves the next page of the results.
$sel:httpStatus:ListEnvironmentsResponse', listEnvironmentsResponse_httpStatus - The response's http status code.
$sel:environments:ListEnvironmentsResponse', listEnvironmentsResponse_environments - Returns a list of Amazon MWAA environments.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse, listTagsForResourceResponse_tags - The key-value tag pairs associated to your environment. To learn more,
see
Tagging Amazon Web Services resources.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
PublishMetrics
data PublishMetrics Source #
See: newPublishMetrics smart constructor.
Constructors
| PublishMetrics' Text [MetricDatum] |
Instances
Arguments
| :: Text | |
| -> PublishMetrics |
Create a value of PublishMetrics with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:environmentName:PublishMetrics', publishMetrics_environmentName - Internal only. The name of the environment.
$sel:metricData:PublishMetrics', publishMetrics_metricData - 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.
data PublishMetricsResponse Source #
See: newPublishMetricsResponse smart constructor.
Constructors
| PublishMetricsResponse' Int |
Instances
newPublishMetricsResponse Source #
Create a value of PublishMetricsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:PublishMetricsResponse', publishMetricsResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
TagResource, tagResource_tags - 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.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The key-value tag pair you want to remove. For example,
"Environment": "Staging".
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateEnvironment
data UpdateEnvironment Source #
See: newUpdateEnvironment smart constructor.
Constructors
| UpdateEnvironment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LoggingConfigurationInput) (Maybe Natural) (Maybe Natural) (Maybe UpdateNetworkConfigurationInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> UpdateEnvironment |
Create a value of UpdateEnvironment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEnvironment, updateEnvironment_airflowConfigurationOptions - 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, updateEnvironment_airflowVersion - 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, updateEnvironment_dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
UpdateEnvironment, updateEnvironment_environmentClass - The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
UpdateEnvironment, updateEnvironment_executionRoleArn - 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, updateEnvironment_loggingConfiguration - The Apache Airflow log types to send to CloudWatch Logs.
UpdateEnvironment, updateEnvironment_maxWorkers - 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, updateEnvironment_minWorkers - 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, updateEnvironment_networkConfiguration - 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, updateEnvironment_pluginsS3ObjectVersion - 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, updateEnvironment_pluginsS3Path - 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, updateEnvironment_requirementsS3ObjectVersion - 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, updateEnvironment_requirementsS3Path - 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, updateEnvironment_schedulers - The number of Apache Airflow schedulers to run in your Amazon MWAA
environment.
UpdateEnvironment, updateEnvironment_sourceBucketArn - 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, updateEnvironment_webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
UpdateEnvironment, updateEnvironment_weeklyMaintenanceWindowStart - 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, updateEnvironment_name - The name of your Amazon MWAA environment. For example,
MyMWAAEnvironment.
data UpdateEnvironmentResponse Source #
See: newUpdateEnvironmentResponse smart constructor.
Constructors
| UpdateEnvironmentResponse' (Maybe Text) Int |
Instances
newUpdateEnvironmentResponse Source #
Create a value of UpdateEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateEnvironmentResponse, updateEnvironmentResponse_arn - The Amazon Resource Name (ARN) of the Amazon MWAA environment. For
example,
arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.
$sel:httpStatus:UpdateEnvironmentResponse', updateEnvironmentResponse_httpStatus - The response's http status code.
Types
EnvironmentStatus
newtype EnvironmentStatus Source #
Constructors
| EnvironmentStatus' | |
Fields | |
Bundled Patterns
| pattern EnvironmentStatus_AVAILABLE :: EnvironmentStatus | |
| pattern EnvironmentStatus_CREATE_FAILED :: EnvironmentStatus | |
| pattern EnvironmentStatus_CREATING :: EnvironmentStatus | |
| pattern EnvironmentStatus_DELETED :: EnvironmentStatus | |
| pattern EnvironmentStatus_DELETING :: EnvironmentStatus | |
| pattern EnvironmentStatus_UNAVAILABLE :: EnvironmentStatus | |
| pattern EnvironmentStatus_UPDATE_FAILED :: EnvironmentStatus | |
| pattern EnvironmentStatus_UPDATING :: EnvironmentStatus |
Instances
LoggingLevel
newtype LoggingLevel Source #
Constructors
| LoggingLevel' | |
Fields | |
Bundled Patterns
| pattern LoggingLevel_CRITICAL :: LoggingLevel | |
| pattern LoggingLevel_DEBUG :: LoggingLevel | |
| pattern LoggingLevel_ERROR :: LoggingLevel | |
| pattern LoggingLevel_INFO :: LoggingLevel | |
| pattern LoggingLevel_WARNING :: LoggingLevel |
Instances
Unit
Bundled Patterns
| pattern Unit_Bits :: Unit | |
| pattern Unit_Bits_Second :: Unit | |
| pattern Unit_Bytes :: Unit | |
| pattern Unit_Bytes_Second :: Unit | |
| pattern Unit_Count :: Unit | |
| pattern Unit_Count_Second :: Unit | |
| pattern Unit_Gigabits :: Unit | |
| pattern Unit_Gigabits_Second :: Unit | |
| pattern Unit_Gigabytes :: Unit | |
| pattern Unit_Gigabytes_Second :: Unit | |
| pattern Unit_Kilobits :: Unit | |
| pattern Unit_Kilobits_Second :: Unit | |
| pattern Unit_Kilobytes :: Unit | |
| pattern Unit_Kilobytes_Second :: Unit | |
| pattern Unit_Megabits :: Unit | |
| pattern Unit_Megabits_Second :: Unit | |
| pattern Unit_Megabytes :: Unit | |
| pattern Unit_Megabytes_Second :: Unit | |
| pattern Unit_Microseconds :: Unit | |
| pattern Unit_Milliseconds :: Unit | |
| pattern Unit_None :: Unit | |
| pattern Unit_Percent :: Unit | |
| pattern Unit_Seconds :: Unit | |
| pattern Unit_Terabits :: Unit | |
| pattern Unit_Terabits_Second :: Unit | |
| pattern Unit_Terabytes :: Unit | |
| pattern Unit_Terabytes_Second :: Unit |
Instances
UpdateStatus
newtype UpdateStatus Source #
Constructors
| UpdateStatus' | |
Fields | |
Bundled Patterns
| pattern UpdateStatus_FAILED :: UpdateStatus | |
| pattern UpdateStatus_PENDING :: UpdateStatus | |
| pattern UpdateStatus_SUCCESS :: UpdateStatus |
Instances
WebserverAccessMode
newtype WebserverAccessMode Source #
Constructors
| WebserverAccessMode' | |
Fields | |
Bundled Patterns
| pattern WebserverAccessMode_PRIVATE_ONLY :: WebserverAccessMode | |
| pattern WebserverAccessMode_PUBLIC_ONLY :: WebserverAccessMode |
Instances
Dimension
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.
See: newDimension smart constructor.
Constructors
| Dimension' Text Text |
Instances
| ToJSON Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension | |
| Generic Dimension Source # | |
| Read Dimension Source # | |
| Show Dimension Source # | |
| NFData Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension | |
| Eq Dimension Source # | |
| Hashable Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension | |
| type Rep Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension type Rep Dimension = D1 ('MetaData "Dimension" "Amazonka.MwAA.Types.Dimension" "amazonka-mwaa-2.0-KORB5SeCyuF7wioeYKG3eR" 'False) (C1 ('MetaCons "Dimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Dimension with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Dimension', dimension_name - Internal only. The name of the dimension.
$sel:value:Dimension', dimension_value - Internal only. The value of the dimension.
Environment
data Environment Source #
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe (Sensitive (HashMap Text (Sensitive Text)))) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LastUpdate) (Maybe LoggingConfiguration) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe NetworkConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe EnvironmentStatus) (Maybe (HashMap Text Text)) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) |
Instances
newEnvironment :: Environment Source #
Create a value of Environment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:airflowConfigurationOptions:Environment', environment_airflowConfigurationOptions - A list of key-value pairs containing the Apache Airflow configuration
options attached to your environment. To learn more, see
Apache Airflow configuration options.
$sel:airflowVersion:Environment', environment_airflowVersion - The Apache Airflow version on your environment. Valid values: 1.10.12,
2.0.2, 2.2.2, and 2.4.3.
$sel:arn:Environment', environment_arn - The Amazon Resource Name (ARN) of the Amazon MWAA environment.
Environment, environment_createdAt - The day and time the environment was created.
$sel:dagS3Path:Environment', environment_dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
$sel:environmentClass:Environment', environment_environmentClass - The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
$sel:executionRoleArn:Environment', environment_executionRoleArn - 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.
$sel:kmsKey:Environment', environment_kmsKey - The Amazon Web Services Key Management Service (KMS) encryption key used
to encrypt the data in your environment.
$sel:lastUpdate:Environment', environment_lastUpdate - The status of the last update on the environment.
$sel:loggingConfiguration:Environment', environment_loggingConfiguration - The Apache Airflow logs published to CloudWatch Logs.
$sel:maxWorkers:Environment', environment_maxWorkers - The maximum number of workers that run in your environment. For example,
20.
$sel:minWorkers:Environment', environment_minWorkers - The minimum number of workers that run in your environment. For example,
2.
$sel:name:Environment', environment_name - The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
$sel:networkConfiguration:Environment', environment_networkConfiguration - 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.
$sel:pluginsS3ObjectVersion:Environment', environment_pluginsS3ObjectVersion - The version of the plugins.zip file on your Amazon S3 bucket. To learn
more, see
Installing custom plugins.
$sel:pluginsS3Path:Environment', environment_pluginsS3Path - The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. To learn more, see
Installing custom plugins.
$sel:requirementsS3ObjectVersion:Environment', environment_requirementsS3ObjectVersion - The version of the requirements.txt file on your Amazon S3 bucket. To
learn more, see
Installing Python dependencies.
$sel:requirementsS3Path:Environment', environment_requirementsS3Path - The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. To learn more, see
Installing Python dependencies.
$sel:schedulers:Environment', environment_schedulers - The number of Apache Airflow schedulers that run in your Amazon MWAA
environment.
$sel:serviceRoleArn:Environment', environment_serviceRoleArn - The Amazon Resource Name (ARN) for the service-linked role of the
environment. To learn more, see
Amazon MWAA Service-linked role.
$sel:sourceBucketArn:Environment', environment_sourceBucketArn - 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, environment_status - 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.
$sel:tags:Environment', environment_tags - The key-value tag pairs associated to your environment. For example,
"Environment": "Staging". To learn more, see
Tagging Amazon Web Services resources.
$sel:webserverAccessMode:Environment', environment_webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
$sel:webserverUrl:Environment', environment_webserverUrl - The Apache Airflow Web server host name for the Amazon MWAA
environment. To learn more, see
Accessing the Apache Airflow UI.
$sel:weeklyMaintenanceWindowStart:Environment', environment_weeklyMaintenanceWindowStart - 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
data LastUpdate Source #
Describes the status of the last update on the environment, and any errors that were encountered.
See: newLastUpdate smart constructor.
Constructors
| LastUpdate' (Maybe POSIX) (Maybe UpdateError) (Maybe Text) (Maybe UpdateStatus) |
Instances
newLastUpdate :: LastUpdate Source #
Create a value of LastUpdate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:LastUpdate', lastUpdate_createdAt - The day and time of the last update on the environment.
$sel:error:LastUpdate', lastUpdate_error - The error that was encountered during the last update of the
environment.
$sel:source:LastUpdate', lastUpdate_source - The source of the last update to the environment. Includes internal
processes by Amazon MWAA, such as an environment maintenance update.
$sel:status:LastUpdate', lastUpdate_status - The status of the last update on the environment.
LoggingConfiguration
data LoggingConfiguration Source #
Describes the Apache Airflow log types that are published to CloudWatch Logs.
See: newLoggingConfiguration smart constructor.
Constructors
| LoggingConfiguration' (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) (Maybe ModuleLoggingConfiguration) |
Instances
newLoggingConfiguration :: LoggingConfiguration Source #
Create a value of LoggingConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dagProcessingLogs:LoggingConfiguration', loggingConfiguration_dagProcessingLogs - The Airflow DAG processing logs published to CloudWatch Logs and the log
level.
$sel:schedulerLogs:LoggingConfiguration', loggingConfiguration_schedulerLogs - The Airflow scheduler logs published to CloudWatch Logs and the log
level.
$sel:taskLogs:LoggingConfiguration', loggingConfiguration_taskLogs - The Airflow task logs published to CloudWatch Logs and the log level.
$sel:webserverLogs:LoggingConfiguration', loggingConfiguration_webserverLogs - The Airflow web server logs published to CloudWatch Logs and the log
level.
$sel:workerLogs:LoggingConfiguration', loggingConfiguration_workerLogs - The Airflow worker logs published to CloudWatch Logs and the log level.
LoggingConfigurationInput
data LoggingConfigurationInput Source #
Defines the Apache Airflow log types to send to CloudWatch Logs.
See: newLoggingConfigurationInput smart constructor.
Constructors
Instances
newLoggingConfigurationInput :: LoggingConfigurationInput Source #
Create a value of LoggingConfigurationInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dagProcessingLogs:LoggingConfigurationInput', loggingConfigurationInput_dagProcessingLogs - Publishes Airflow DAG processing logs to CloudWatch Logs.
$sel:schedulerLogs:LoggingConfigurationInput', loggingConfigurationInput_schedulerLogs - Publishes Airflow scheduler logs to CloudWatch Logs.
$sel:taskLogs:LoggingConfigurationInput', loggingConfigurationInput_taskLogs - Publishes Airflow task logs to CloudWatch Logs.
$sel:webserverLogs:LoggingConfigurationInput', loggingConfigurationInput_webserverLogs - Publishes Airflow web server logs to CloudWatch Logs.
$sel:workerLogs:LoggingConfigurationInput', loggingConfigurationInput_workerLogs - Publishes Airflow worker logs to CloudWatch Logs.
MetricDatum
data MetricDatum Source #
Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
See: newMetricDatum smart constructor.
Constructors
| MetricDatum' (Maybe [Dimension]) (Maybe StatisticSet) (Maybe Unit) (Maybe Double) Text POSIX |
Instances
Create a value of MetricDatum with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:MetricDatum', metricDatum_dimensions - Internal only. The dimensions associated with the metric.
$sel:statisticValues:MetricDatum', metricDatum_statisticValues - Internal only. The statistical values for the metric.
$sel:unit:MetricDatum', metricDatum_unit - Internal only. The unit used to store the metric.
MetricDatum, metricDatum_value - Internal only. The value for the metric.
$sel:metricName:MetricDatum', metricDatum_metricName - Internal only. The name of the metric.
$sel:timestamp:MetricDatum', metricDatum_timestamp - Internal only. The time the metric data was received.
ModuleLoggingConfiguration
data ModuleLoggingConfiguration Source #
Describes the Apache Airflow log details for the log type (e.g.
DagProcessingLogs).
See: newModuleLoggingConfiguration smart constructor.
Constructors
| ModuleLoggingConfiguration' (Maybe Text) (Maybe Bool) (Maybe LoggingLevel) |
Instances
newModuleLoggingConfiguration :: ModuleLoggingConfiguration Source #
Create a value of ModuleLoggingConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cloudWatchLogGroupArn:ModuleLoggingConfiguration', moduleLoggingConfiguration_cloudWatchLogGroupArn - 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:*.
$sel:enabled:ModuleLoggingConfiguration', moduleLoggingConfiguration_enabled - Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs)
is enabled.
$sel:logLevel:ModuleLoggingConfiguration', moduleLoggingConfiguration_logLevel - The Apache Airflow log level for the log type (e.g.
DagProcessingLogs).
ModuleLoggingConfigurationInput
data ModuleLoggingConfigurationInput Source #
Enables the Apache Airflow log type (e.g. DagProcessingLogs) and
defines the log level to send to CloudWatch Logs (e.g. INFO).
See: newModuleLoggingConfigurationInput smart constructor.
Constructors
| ModuleLoggingConfigurationInput' Bool LoggingLevel |
Instances
newModuleLoggingConfigurationInput Source #
Arguments
| :: Bool | |
| -> LoggingLevel | |
| -> ModuleLoggingConfigurationInput |
Create a value of ModuleLoggingConfigurationInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:ModuleLoggingConfigurationInput', moduleLoggingConfigurationInput_enabled - Indicates whether to enable the Apache Airflow log type (e.g.
DagProcessingLogs).
$sel:logLevel:ModuleLoggingConfigurationInput', moduleLoggingConfigurationInput_logLevel - Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch
Logs.
NetworkConfiguration
data 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.
See: newNetworkConfiguration smart constructor.
Instances
newNetworkConfiguration :: NetworkConfiguration Source #
Create a value of NetworkConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:NetworkConfiguration', networkConfiguration_securityGroupIds - A list of security group IDs. To learn more, see
Security in your VPC on Amazon MWAA.
$sel:subnetIds:NetworkConfiguration', networkConfiguration_subnetIds - A list of subnet IDs. To learn more, see
About networking on Amazon MWAA.
StatisticSet
data StatisticSet Source #
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.
See: newStatisticSet smart constructor.
Instances
newStatisticSet :: StatisticSet Source #
Create a value of StatisticSet with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maximum:StatisticSet', statisticSet_maximum - Internal only. The maximum value of the sample set.
$sel:minimum:StatisticSet', statisticSet_minimum - Internal only. The minimum value of the sample set.
$sel:sampleCount:StatisticSet', statisticSet_sampleCount - Internal only. The number of samples used for the statistic set.
$sel:sum:StatisticSet', statisticSet_sum - Internal only. The sum of values for the sample set.
UpdateError
data UpdateError Source #
Describes the error(s) encountered with the last update of the environment.
See: newUpdateError smart constructor.
Constructors
| UpdateError' (Maybe Text) (Maybe Text) |
Instances
newUpdateError :: UpdateError Source #
Create a value of UpdateError with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCode:UpdateError', updateError_errorCode - The error code that corresponds to the error with the last update.
$sel:errorMessage:UpdateError', updateError_errorMessage - The error message that corresponds to the error code.
UpdateNetworkConfigurationInput
data UpdateNetworkConfigurationInput Source #
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.
See: newUpdateNetworkConfigurationInput smart constructor.
Constructors
| UpdateNetworkConfigurationInput' (NonEmpty Text) |
Instances
newUpdateNetworkConfigurationInput Source #
Arguments
| :: NonEmpty Text | |
| -> UpdateNetworkConfigurationInput |
Create a value of UpdateNetworkConfigurationInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:UpdateNetworkConfigurationInput', updateNetworkConfigurationInput_securityGroupIds - 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.