Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
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?.
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListEnvironments = ListEnvironments' (Maybe Text) (Maybe Natural)
- newListEnvironments :: ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe Text) Int [Text]
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data UpdateEnvironment = UpdateEnvironment' (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe LoggingConfigurationInput) (Maybe Text) (Maybe UpdateNetworkConfigurationInput) (Maybe Text) (Maybe Natural) Text
- newUpdateEnvironment :: Text -> UpdateEnvironment
- data UpdateEnvironmentResponse = UpdateEnvironmentResponse' (Maybe Text) Int
- newUpdateEnvironmentResponse :: Int -> UpdateEnvironmentResponse
- data DeleteEnvironment = DeleteEnvironment' Text
- newDeleteEnvironment :: Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' Int
- newDeleteEnvironmentResponse :: Int -> DeleteEnvironmentResponse
- data CreateWebLoginToken = CreateWebLoginToken' Text
- newCreateWebLoginToken :: Text -> CreateWebLoginToken
- data CreateWebLoginTokenResponse = CreateWebLoginTokenResponse' (Maybe Text) (Maybe (Sensitive Text)) Int
- newCreateWebLoginTokenResponse :: Int -> CreateWebLoginTokenResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data GetEnvironment = GetEnvironment' Text
- newGetEnvironment :: Text -> GetEnvironment
- data GetEnvironmentResponse = GetEnvironmentResponse' (Maybe Environment) Int
- newGetEnvironmentResponse :: Int -> GetEnvironmentResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data PublishMetrics = PublishMetrics' Text [MetricDatum]
- newPublishMetrics :: Text -> PublishMetrics
- data PublishMetricsResponse = PublishMetricsResponse' Int
- newPublishMetricsResponse :: Int -> PublishMetricsResponse
- data CreateEnvironment = CreateEnvironment' (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe LoggingConfigurationInput) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Natural) Text Text Text NetworkConfiguration Text
- newCreateEnvironment :: Text -> Text -> Text -> NetworkConfiguration -> Text -> CreateEnvironment
- data CreateEnvironmentResponse = CreateEnvironmentResponse' (Maybe Text) Int
- newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
- data CreateCliToken = CreateCliToken' Text
- newCreateCliToken :: Text -> CreateCliToken
- data CreateCliTokenResponse = CreateCliTokenResponse' (Maybe Text) (Maybe (Sensitive Text)) Int
- newCreateCliTokenResponse :: Int -> CreateCliTokenResponse
- 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 Text) (Maybe Int) (Maybe EnvironmentStatus) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LastUpdate) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe LoggingConfiguration) (Maybe Text) (Maybe NetworkConfiguration) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Natural)
- newEnvironment :: Environment
- data LastUpdate = LastUpdate' (Maybe UpdateStatus) (Maybe POSIX) (Maybe UpdateError)
- 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 Double) (Maybe [Dimension]) (Maybe Unit) (Maybe StatisticSet) Text POSIX
- newMetricDatum :: Text -> UTCTime -> MetricDatum
- data ModuleLoggingConfiguration = ModuleLoggingConfiguration' (Maybe LoggingLevel) (Maybe Bool) (Maybe Text)
- 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 Int) (Maybe Double) (Maybe Double) (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
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ValidationException: The provided input is not valid.
AccessDeniedException
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Access to the Airflow Web UI or CLI has been Denied. Please follow the MWAA user guide to setup permissions to access the Web UI and CLI functionality.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
InternalServerException: An internal error has occurred.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
ResourceNotFoundException: The resource is not available.
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.
ListEnvironments (Paginated)
data ListEnvironments Source #
See: newListEnvironments
smart constructor.
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:nextToken:ListEnvironments'
, listEnvironments_nextToken
- Retrieves the next page of the results.
$sel:maxResults:ListEnvironments'
, listEnvironments_maxResults
- The maximum number of results to retrieve per page. For example, 5
environments per page.
data ListEnvironmentsResponse Source #
See: newListEnvironmentsResponse
smart constructor.
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:
$sel:nextToken: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 the list of Amazon MWAA environments.
UpdateEnvironment
data UpdateEnvironment Source #
See: newUpdateEnvironment
smart constructor.
UpdateEnvironment' (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe LoggingConfigurationInput) (Maybe Text) (Maybe UpdateNetworkConfigurationInput) (Maybe Text) (Maybe Natural) Text |
Instances
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:
$sel:schedulers:UpdateEnvironment'
, updateEnvironment_schedulers
- The number of Apache Airflow schedulers to run in your Amazon MWAA
environment.
$sel: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
.
$sel:pluginsS3Path: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.
$sel:webserverAccessMode:UpdateEnvironment'
, updateEnvironment_webserverAccessMode
- The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
$sel:airflowVersion:UpdateEnvironment'
, updateEnvironment_airflowVersion
- The Apache Airflow version for your environment. For example,
v1.10.12
. If no value is specified, defaults to the latest version.
Valid values: v1.10.12
.
$sel:weeklyMaintenanceWindowStart:UpdateEnvironment'
, updateEnvironment_weeklyMaintenanceWindowStart
- The day and time of the week to start weekly maintenance updates of your
environment in the following format: DAY:HH:MM
. For example:
TUE:03:30
. You can specify a start time in 30 minute increments only.
Supported input includes the following:
- MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
$sel:executionRoleArn:UpdateEnvironment'
, updateEnvironment_executionRoleArn
- The Amazon Resource Name (ARN) of the execution role in IAM that allows
MWAA to access AWS resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. To learn more, see
Amazon MWAA Execution role.
$sel:requirementsS3ObjectVersion: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.
$sel:sourceBucketArn: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.
$sel:dagS3Path: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.
$sel:pluginsS3ObjectVersion: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.
$sel:airflowConfigurationOptions: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.
$sel:loggingConfiguration:UpdateEnvironment'
, updateEnvironment_loggingConfiguration
- Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
,
WorkerLogs
.
$sel:environmentClass:UpdateEnvironment'
, updateEnvironment_environmentClass
- The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
. To learn more, see
Amazon MWAA environment class.
$sel:networkConfiguration:UpdateEnvironment'
, updateEnvironment_networkConfiguration
- The VPC networking components used to secure and enable network traffic
between the AWS resources for your environment. To learn more, see
About networking on Amazon MWAA.
$sel:requirementsS3Path: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.
$sel:maxWorkers: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
.
$sel:name:UpdateEnvironment'
, updateEnvironment_name
- The name of your Amazon MWAA environment. For example,
MyMWAAEnvironment
.
data UpdateEnvironmentResponse Source #
See: newUpdateEnvironmentResponse
smart constructor.
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:
$sel:arn: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.
DeleteEnvironment
data DeleteEnvironment Source #
See: newDeleteEnvironment
smart constructor.
Instances
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:
$sel:name:DeleteEnvironment'
, deleteEnvironment_name
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
data DeleteEnvironmentResponse Source #
See: newDeleteEnvironmentResponse
smart constructor.
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.
CreateWebLoginToken
data CreateWebLoginToken Source #
See: newCreateWebLoginToken
smart constructor.
Instances
newCreateWebLoginToken Source #
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:
$sel:name:CreateWebLoginToken'
, createWebLoginToken_name
- Create an Airflow Web UI login token request for a MWAA environment.
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
- Create an Airflow Web UI login token response for the provided webserver
hostname.
$sel:webToken:CreateWebLoginTokenResponse'
, createWebLoginTokenResponse_webToken
- Create an Airflow Web UI login token response for the provided JWT
token.
$sel:httpStatus:CreateWebLoginTokenResponse'
, createWebLoginTokenResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
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:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The key-value tag pairs associated to your environment. To learn more,
see
Tagging AWS resources.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
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
.
$sel:tags:TagResource'
, tagResource_tags
- The key-value tag pairs you want to associate to your environment. For
example, "Environment": "Staging"
. To learn more, see
Tagging AWS resources.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
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.
GetEnvironment
data GetEnvironment Source #
See: newGetEnvironment
smart constructor.
Instances
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:
$sel:name:GetEnvironment'
, getEnvironment_name
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
data GetEnvironmentResponse Source #
See: newGetEnvironmentResponse
smart constructor.
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.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
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.
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.
PublishMetrics
data PublishMetrics Source #
See: newPublishMetrics
smart constructor.
Instances
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
- Publishes environment metric data to Amazon CloudWatch.
$sel:metricData:PublishMetrics'
, publishMetrics_metricData
- Publishes metric data points to Amazon CloudWatch. CloudWatch associates
the data points with the specified metrica.
data PublishMetricsResponse Source #
See: newPublishMetricsResponse
smart constructor.
Instances
Eq PublishMetricsResponse Source # | |
Defined in Amazonka.MwAA.PublishMetrics | |
Read PublishMetricsResponse Source # | |
Show PublishMetricsResponse Source # | |
Defined in Amazonka.MwAA.PublishMetrics showsPrec :: Int -> PublishMetricsResponse -> ShowS # show :: PublishMetricsResponse -> String # showList :: [PublishMetricsResponse] -> ShowS # | |
Generic PublishMetricsResponse Source # | |
Defined in Amazonka.MwAA.PublishMetrics type Rep PublishMetricsResponse :: Type -> Type # | |
NFData PublishMetricsResponse Source # | |
Defined in Amazonka.MwAA.PublishMetrics rnf :: PublishMetricsResponse -> () # | |
type Rep PublishMetricsResponse Source # | |
Defined in Amazonka.MwAA.PublishMetrics type Rep PublishMetricsResponse = D1 ('MetaData "PublishMetricsResponse" "Amazonka.MwAA.PublishMetrics" "libZSservicesZSamazonka-mwaaZSamazonka-mwaa" 'False) (C1 ('MetaCons "PublishMetricsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
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.
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.
CreateEnvironment' (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (Sensitive (HashMap Text Text))) (Maybe LoggingConfigurationInput) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Natural) Text Text Text NetworkConfiguration Text |
Instances
:: 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:
$sel:schedulers:CreateEnvironment'
, createEnvironment_schedulers
- The number of Apache Airflow schedulers to run in your environment.
$sel: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
.
$sel:pluginsS3Path: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.
$sel:webserverAccessMode:CreateEnvironment'
, createEnvironment_webserverAccessMode
- The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
$sel:airflowVersion:CreateEnvironment'
, createEnvironment_airflowVersion
- The Apache Airflow version for your environment. For example,
v1.10.12
. If no value is specified, defaults to the latest version.
Valid values: v1.10.12
.
$sel:kmsKey:CreateEnvironment'
, createEnvironment_kmsKey
- The AWS Key Management Service (KMS) key to encrypt the data in your
environment. You can use an AWS owned CMK, or a Customer managed CMK
(advanced). To learn more, see
Get started with Amazon Managed Workflows for Apache Airflow.
$sel:weeklyMaintenanceWindowStart:CreateEnvironment'
, createEnvironment_weeklyMaintenanceWindowStart
- The day and time of the week to start weekly maintenance updates of your
environment in the following format: DAY:HH:MM
. For example:
TUE:03:30
. You can specify a start time in 30 minute increments only.
Supported input includes the following:
- MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)
$sel:requirementsS3ObjectVersion: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.
$sel:pluginsS3ObjectVersion: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.
$sel:airflowConfigurationOptions: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.
$sel:loggingConfiguration:CreateEnvironment'
, createEnvironment_loggingConfiguration
- Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
,
WorkerLogs
.
$sel:environmentClass:CreateEnvironment'
, createEnvironment_environmentClass
- The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
. To learn more, see
Amazon MWAA environment class.
$sel:tags:CreateEnvironment'
, createEnvironment_tags
- The key-value tag pairs you want to associate to your environment. For
example, "Environment": "Staging"
. To learn more, see
Tagging AWS resources.
$sel:requirementsS3Path: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.
$sel:maxWorkers: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
.
$sel:dagS3Path: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.
$sel:executionRoleArn:CreateEnvironment'
, createEnvironment_executionRoleArn
- The Amazon Resource Name (ARN) of the execution role for your
environment. An execution role is an AWS Identity and Access Management
(IAM) role that grants MWAA permission to access AWS services and
resources used by your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. To learn more, see
Amazon MWAA Execution role.
$sel:name:CreateEnvironment'
, createEnvironment_name
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
$sel:networkConfiguration:CreateEnvironment'
, createEnvironment_networkConfiguration
- The VPC networking components used to secure and enable network traffic
between the AWS resources for your environment. To learn more, see
About networking on Amazon MWAA.
$sel:sourceBucketArn: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.
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:
$sel:arn: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.
CreateCliToken
data CreateCliToken Source #
See: newCreateCliToken
smart constructor.
Instances
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:
$sel:name:CreateCliToken'
, createCliToken_name
- Create a CLI token request for a MWAA environment.
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:webServerHostname:CreateCliTokenResponse'
, createCliTokenResponse_webServerHostname
- Create an Airflow CLI login token response for the provided webserver
hostname.
$sel:cliToken:CreateCliTokenResponse'
, createCliTokenResponse_cliToken
- Create an Airflow CLI login token response for the provided JWT token.
$sel:httpStatus:CreateCliTokenResponse'
, createCliTokenResponse_httpStatus
- The response's http status code.
Types
EnvironmentStatus
newtype EnvironmentStatus Source #
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 #
pattern LoggingLevel_CRITICAL :: LoggingLevel | |
pattern LoggingLevel_DEBUG :: LoggingLevel | |
pattern LoggingLevel_ERROR :: LoggingLevel | |
pattern LoggingLevel_INFO :: LoggingLevel | |
pattern LoggingLevel_WARNING :: LoggingLevel |
Instances
Unit
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 |
Instances
UpdateStatus
newtype UpdateStatus Source #
pattern UpdateStatus_FAILED :: UpdateStatus | |
pattern UpdateStatus_PENDING :: UpdateStatus | |
pattern UpdateStatus_SUCCESS :: UpdateStatus |
Instances
WebserverAccessMode
newtype WebserverAccessMode Source #
pattern WebserverAccessMode_PRIVATE_ONLY :: WebserverAccessMode | |
pattern WebserverAccessMode_PUBLIC_ONLY :: WebserverAccessMode |
Instances
Dimension
Internal only API.
See: newDimension
smart constructor.
Instances
Eq Dimension Source # | |
Read Dimension Source # | |
Show Dimension Source # | |
Generic Dimension Source # | |
NFData Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension | |
Hashable Dimension Source # | |
Defined in Amazonka.MwAA.Types.Dimension | |
ToJSON 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" "libZSservicesZSamazonka-mwaaZSamazonka-mwaa" '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 API.
$sel:value:Dimension'
, dimension_value
- Internal only API.
Environment
data Environment Source #
The Amazon Managed Workflows for Apache Airflow (MWAA) environment.
See: newEnvironment
smart constructor.
Environment' (Maybe Text) (Maybe Int) (Maybe EnvironmentStatus) (Maybe Natural) (Maybe Text) (Maybe WebserverAccessMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe LastUpdate) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe LoggingConfiguration) (Maybe Text) (Maybe NetworkConfiguration) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Natural) |
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: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:schedulers:Environment'
, environment_schedulers
- The number of Apache Airflow schedulers that run in your Amazon MWAA
environment.
$sel:status: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:minWorkers:Environment'
, environment_minWorkers
- The minimum number of workers that run in your environment. For example,
2
.
$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:webserverAccessMode:Environment'
, environment_webserverAccessMode
- The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
$sel:airflowVersion:Environment'
, environment_airflowVersion
- The Apache Airflow version on your environment. For example, v1.10.12
.
$sel:kmsKey:Environment'
, environment_kmsKey
- The Key Management Service (KMS) encryption key used to encrypt the data
in your environment.
$sel:arn:Environment'
, environment_arn
- The Amazon Resource Name (ARN) of the Amazon MWAA environment.
$sel:createdAt:Environment'
, environment_createdAt
- The day and time the environment was created.
$sel:weeklyMaintenanceWindowStart:Environment'
, environment_weeklyMaintenanceWindowStart
- The day and time of the week that weekly maintenance updates are
scheduled. For example: TUE:03:30
.
$sel:executionRoleArn:Environment'
, environment_executionRoleArn
- The Amazon Resource Name (ARN) of the execution role in IAM that allows
MWAA to access AWS resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. To learn more, see
Amazon MWAA Execution role.
$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:lastUpdate:Environment'
, environment_lastUpdate
- Undocumented member.
$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.
$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: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:name:Environment'
, environment_name
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
$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: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:loggingConfiguration:Environment'
, environment_loggingConfiguration
- The Apache Airflow logs being sent to CloudWatch Logs:
DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
,
WorkerLogs
.
$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:networkConfiguration:Environment'
, environment_networkConfiguration
- Undocumented member.
$sel:tags:Environment'
, environment_tags
- The key-value tag pairs associated to your environment. For example,
"Environment": "Staging"
. To learn more, see
Tagging AWS resources.
$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:maxWorkers:Environment'
, environment_maxWorkers
- The maximum number of workers that run in your environment. For example,
20
.
LastUpdate
data LastUpdate Source #
The status of the last update on the environment, and any errors that were encountered.
See: newLastUpdate
smart constructor.
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:status:LastUpdate'
, lastUpdate_status
- The status of the last update on the environment. Valid values:
SUCCESS
, PENDING
, FAILED
.
$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.
LoggingConfiguration
data LoggingConfiguration Source #
Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
,
WorkerLogs
.
See: newLoggingConfiguration
smart constructor.
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:taskLogs:LoggingConfiguration'
, loggingConfiguration_taskLogs
- Undocumented member.
$sel:webserverLogs:LoggingConfiguration'
, loggingConfiguration_webserverLogs
- Undocumented member.
$sel:schedulerLogs:LoggingConfiguration'
, loggingConfiguration_schedulerLogs
- Undocumented member.
$sel:dagProcessingLogs:LoggingConfiguration'
, loggingConfiguration_dagProcessingLogs
- Undocumented member.
$sel:workerLogs:LoggingConfiguration'
, loggingConfiguration_workerLogs
- Undocumented member.
LoggingConfigurationInput
data LoggingConfigurationInput Source #
Defines the Apache Airflow logs to send to CloudWatch Logs:
DagProcessingLogs
, SchedulerLogs
, TaskLogs
, WebserverLogs
,
WorkerLogs
.
See: newLoggingConfigurationInput
smart constructor.
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:taskLogs:LoggingConfigurationInput'
, loggingConfigurationInput_taskLogs
- Undocumented member.
$sel:webserverLogs:LoggingConfigurationInput'
, loggingConfigurationInput_webserverLogs
- Undocumented member.
$sel:schedulerLogs:LoggingConfigurationInput'
, loggingConfigurationInput_schedulerLogs
- Undocumented member.
$sel:dagProcessingLogs:LoggingConfigurationInput'
, loggingConfigurationInput_dagProcessingLogs
- Undocumented member.
$sel:workerLogs:LoggingConfigurationInput'
, loggingConfigurationInput_workerLogs
- Undocumented member.
MetricDatum
data MetricDatum Source #
Internal only API.
See: newMetricDatum
smart constructor.
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:value:MetricDatum'
, metricDatum_value
- Internal only API.
$sel:dimensions:MetricDatum'
, metricDatum_dimensions
- Internal only API.
$sel:unit:MetricDatum'
, metricDatum_unit
- Undocumented member.
$sel:statisticValues:MetricDatum'
, metricDatum_statisticValues
- Internal only API.
$sel:metricName:MetricDatum'
, metricDatum_metricName
- Internal only API.
$sel:timestamp:MetricDatum'
, metricDatum_timestamp
- Internal only API.
ModuleLoggingConfiguration
data ModuleLoggingConfiguration Source #
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs
). Valid values: CloudWatchLogGroupArn
, Enabled
,
LogLevel
.
See: newModuleLoggingConfiguration
smart constructor.
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:logLevel:ModuleLoggingConfiguration'
, moduleLoggingConfiguration_logLevel
- Defines the Apache Airflow logs to send for the log type (e.g.
DagProcessingLogs
) to CloudWatch Logs. Valid values: CRITICAL
,
ERROR
, WARNING
, INFO
.
$sel:enabled:ModuleLoggingConfiguration'
, moduleLoggingConfiguration_enabled
- Indicates whether to enable the Apache Airflow log type (e.g.
DagProcessingLogs
) in CloudWatch Logs.
$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:*
.
ModuleLoggingConfigurationInput
data ModuleLoggingConfigurationInput Source #
Defines the type of logs to send for the Apache Airflow log type (e.g.
DagProcessingLogs
). Valid values: CloudWatchLogGroupArn
, Enabled
,
LogLevel
.
See: newModuleLoggingConfigurationInput
smart constructor.
Instances
newModuleLoggingConfigurationInput Source #
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
) in CloudWatch Logs.
$sel:logLevel:ModuleLoggingConfigurationInput'
, moduleLoggingConfigurationInput_logLevel
- Defines the Apache Airflow logs to send for the log type (e.g.
DagProcessingLogs
) to CloudWatch Logs. Valid values: CRITICAL
,
ERROR
, WARNING
, INFO
.
NetworkConfiguration
data NetworkConfiguration Source #
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
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 1 or more security group IDs. Accepts up to 5 security group
IDs. A security group must be attached to the same VPC as the subnets.
To learn more, see
Security in your VPC on Amazon MWAA.
$sel:subnetIds:NetworkConfiguration'
, networkConfiguration_subnetIds
- A list of 2 subnet IDs. Required to create an environment. Must be
private subnets in two different availability zones. A subnet must be
attached to the same VPC as the security group.
StatisticSet
data StatisticSet Source #
Internal only API.
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:sampleCount:StatisticSet'
, statisticSet_sampleCount
- Internal only API.
$sel:maximum:StatisticSet'
, statisticSet_maximum
- Internal only API.
$sel:minimum:StatisticSet'
, statisticSet_minimum
- Internal only API.
$sel:sum:StatisticSet'
, statisticSet_sum
- Internal only API.
UpdateError
data UpdateError Source #
An object containing the error encountered with the last update:
ErrorCode
, ErrorMessage
.
See: newUpdateError
smart constructor.
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 #
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
See: newUpdateNetworkConfigurationInput
smart constructor.
Instances
Eq UpdateNetworkConfigurationInput Source # | |
Read UpdateNetworkConfigurationInput Source # | |
Show UpdateNetworkConfigurationInput Source # | |
Generic UpdateNetworkConfigurationInput Source # | |
NFData UpdateNetworkConfigurationInput Source # | |
Defined in Amazonka.MwAA.Types.UpdateNetworkConfigurationInput rnf :: UpdateNetworkConfigurationInput -> () # | |
Hashable UpdateNetworkConfigurationInput Source # | |
ToJSON UpdateNetworkConfigurationInput Source # | |
type Rep UpdateNetworkConfigurationInput Source # | |
Defined in Amazonka.MwAA.Types.UpdateNetworkConfigurationInput type Rep UpdateNetworkConfigurationInput = D1 ('MetaData "UpdateNetworkConfigurationInput" "Amazonka.MwAA.Types.UpdateNetworkConfigurationInput" "libZSservicesZSamazonka-mwaaZSamazonka-mwaa" 'False) (C1 ('MetaCons "UpdateNetworkConfigurationInput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) |
newUpdateNetworkConfigurationInput Source #
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 1 or more security group IDs. Accepts up to 5 security group
IDs. A security group must be attached to the same VPC as the subnets.
To learn more, see
Security in your VPC on Amazon MWAA.