| 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.Types
Contents
- Service Configuration
- Errors
- EnvironmentStatus
- LoggingLevel
- Unit
- UpdateStatus
- WebserverAccessMode
- Dimension
- Environment
- LastUpdate
- LoggingConfiguration
- LoggingConfigurationInput
- MetricDatum
- ModuleLoggingConfiguration
- ModuleLoggingConfigurationInput
- NetworkConfiguration
- StatisticSet
- UpdateError
- UpdateNetworkConfigurationInput
Description
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
- 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' {}
- newDimension :: Text -> Text -> Dimension
- dimension_name :: Lens' Dimension Text
- dimension_value :: Lens' Dimension Text
- data Environment = Environment' {
- airflowConfigurationOptions :: Maybe (Sensitive (HashMap Text (Sensitive Text)))
- airflowVersion :: Maybe Text
- arn :: Maybe Text
- createdAt :: Maybe POSIX
- dagS3Path :: Maybe Text
- environmentClass :: Maybe Text
- executionRoleArn :: Maybe Text
- kmsKey :: Maybe Text
- lastUpdate :: Maybe LastUpdate
- loggingConfiguration :: Maybe LoggingConfiguration
- maxWorkers :: Maybe Natural
- minWorkers :: Maybe Natural
- name :: Maybe Text
- networkConfiguration :: Maybe NetworkConfiguration
- pluginsS3ObjectVersion :: Maybe Text
- pluginsS3Path :: Maybe Text
- requirementsS3ObjectVersion :: Maybe Text
- requirementsS3Path :: Maybe Text
- schedulers :: Maybe Int
- serviceRoleArn :: Maybe Text
- sourceBucketArn :: Maybe Text
- status :: Maybe EnvironmentStatus
- tags :: Maybe (HashMap Text Text)
- webserverAccessMode :: Maybe WebserverAccessMode
- webserverUrl :: Maybe Text
- weeklyMaintenanceWindowStart :: Maybe Text
- newEnvironment :: Environment
- environment_airflowConfigurationOptions :: Lens' Environment (Maybe (HashMap Text Text))
- environment_airflowVersion :: Lens' Environment (Maybe Text)
- environment_arn :: Lens' Environment (Maybe Text)
- environment_createdAt :: Lens' Environment (Maybe UTCTime)
- environment_dagS3Path :: Lens' Environment (Maybe Text)
- environment_environmentClass :: Lens' Environment (Maybe Text)
- environment_executionRoleArn :: Lens' Environment (Maybe Text)
- environment_kmsKey :: Lens' Environment (Maybe Text)
- environment_lastUpdate :: Lens' Environment (Maybe LastUpdate)
- environment_loggingConfiguration :: Lens' Environment (Maybe LoggingConfiguration)
- environment_maxWorkers :: Lens' Environment (Maybe Natural)
- environment_minWorkers :: Lens' Environment (Maybe Natural)
- environment_name :: Lens' Environment (Maybe Text)
- environment_networkConfiguration :: Lens' Environment (Maybe NetworkConfiguration)
- environment_pluginsS3ObjectVersion :: Lens' Environment (Maybe Text)
- environment_pluginsS3Path :: Lens' Environment (Maybe Text)
- environment_requirementsS3ObjectVersion :: Lens' Environment (Maybe Text)
- environment_requirementsS3Path :: Lens' Environment (Maybe Text)
- environment_schedulers :: Lens' Environment (Maybe Int)
- environment_serviceRoleArn :: Lens' Environment (Maybe Text)
- environment_sourceBucketArn :: Lens' Environment (Maybe Text)
- environment_status :: Lens' Environment (Maybe EnvironmentStatus)
- environment_tags :: Lens' Environment (Maybe (HashMap Text Text))
- environment_webserverAccessMode :: Lens' Environment (Maybe WebserverAccessMode)
- environment_webserverUrl :: Lens' Environment (Maybe Text)
- environment_weeklyMaintenanceWindowStart :: Lens' Environment (Maybe Text)
- data LastUpdate = LastUpdate' {}
- newLastUpdate :: LastUpdate
- lastUpdate_createdAt :: Lens' LastUpdate (Maybe UTCTime)
- lastUpdate_error :: Lens' LastUpdate (Maybe UpdateError)
- lastUpdate_source :: Lens' LastUpdate (Maybe Text)
- lastUpdate_status :: Lens' LastUpdate (Maybe UpdateStatus)
- data LoggingConfiguration = LoggingConfiguration' {}
- newLoggingConfiguration :: LoggingConfiguration
- loggingConfiguration_dagProcessingLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_schedulerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_taskLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_webserverLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- loggingConfiguration_workerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration)
- data LoggingConfigurationInput = LoggingConfigurationInput' {}
- newLoggingConfigurationInput :: LoggingConfigurationInput
- loggingConfigurationInput_dagProcessingLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_schedulerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_taskLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_webserverLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- loggingConfigurationInput_workerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput)
- data MetricDatum = MetricDatum' {
- dimensions :: Maybe [Dimension]
- statisticValues :: Maybe StatisticSet
- unit :: Maybe Unit
- value :: Maybe Double
- metricName :: Text
- timestamp :: POSIX
- newMetricDatum :: Text -> UTCTime -> MetricDatum
- metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension])
- metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet)
- metricDatum_unit :: Lens' MetricDatum (Maybe Unit)
- metricDatum_value :: Lens' MetricDatum (Maybe Double)
- metricDatum_metricName :: Lens' MetricDatum Text
- metricDatum_timestamp :: Lens' MetricDatum UTCTime
- data ModuleLoggingConfiguration = ModuleLoggingConfiguration' {}
- newModuleLoggingConfiguration :: ModuleLoggingConfiguration
- moduleLoggingConfiguration_cloudWatchLogGroupArn :: Lens' ModuleLoggingConfiguration (Maybe Text)
- moduleLoggingConfiguration_enabled :: Lens' ModuleLoggingConfiguration (Maybe Bool)
- moduleLoggingConfiguration_logLevel :: Lens' ModuleLoggingConfiguration (Maybe LoggingLevel)
- data ModuleLoggingConfigurationInput = ModuleLoggingConfigurationInput' {
- enabled :: Bool
- logLevel :: LoggingLevel
- newModuleLoggingConfigurationInput :: Bool -> LoggingLevel -> ModuleLoggingConfigurationInput
- moduleLoggingConfigurationInput_enabled :: Lens' ModuleLoggingConfigurationInput Bool
- moduleLoggingConfigurationInput_logLevel :: Lens' ModuleLoggingConfigurationInput LoggingLevel
- data NetworkConfiguration = NetworkConfiguration' {}
- newNetworkConfiguration :: NetworkConfiguration
- networkConfiguration_securityGroupIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text))
- networkConfiguration_subnetIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text))
- data StatisticSet = StatisticSet' {}
- newStatisticSet :: StatisticSet
- statisticSet_maximum :: Lens' StatisticSet (Maybe Double)
- statisticSet_minimum :: Lens' StatisticSet (Maybe Double)
- statisticSet_sampleCount :: Lens' StatisticSet (Maybe Int)
- statisticSet_sum :: Lens' StatisticSet (Maybe Double)
- data UpdateError = UpdateError' {}
- newUpdateError :: UpdateError
- updateError_errorCode :: Lens' UpdateError (Maybe Text)
- updateError_errorMessage :: Lens' UpdateError (Maybe Text)
- data UpdateNetworkConfigurationInput = UpdateNetworkConfigurationInput' {}
- newUpdateNetworkConfigurationInput :: NonEmpty Text -> UpdateNetworkConfigurationInput
- updateNetworkConfigurationInput_securityGroupIds :: Lens' UpdateNetworkConfigurationInput (NonEmpty Text)
Service Configuration
defaultService :: Service Source #
API version 2020-07-01 of the Amazon MWAA SDK configuration.
Errors
_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 :: AsError a => Fold a ServiceError Source #
InternalServerException: An internal error has occurred.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
ResourceNotFoundException: The resource is not available.
_ValidationException :: AsError a => Fold a ServiceError Source #
ValidationException: The provided input is not valid.
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' | |
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' | |
Fields
| |
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.
environment_airflowConfigurationOptions :: Lens' Environment (Maybe (HashMap Text Text)) Source #
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options.
environment_airflowVersion :: Lens' Environment (Maybe Text) Source #
The Apache Airflow version on your environment. Valid values: 1.10.12,
2.0.2, 2.2.2, and 2.4.3.
environment_arn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
environment_createdAt :: Lens' Environment (Maybe UTCTime) Source #
The day and time the environment was created.
environment_dagS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags. To learn more, see
Adding or updating DAGs.
environment_environmentClass :: Lens' Environment (Maybe Text) Source #
The environment class type. Valid values: mw1.small, mw1.medium,
mw1.large. To learn more, see
Amazon MWAA environment class.
environment_executionRoleArn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) of the execution role in IAM that allows
MWAA to access Amazon Web Services resources in your environment. For
example, arn:aws:iam::123456789:role/my-execution-role. To learn
more, see
Amazon MWAA Execution role.
environment_kmsKey :: Lens' Environment (Maybe Text) Source #
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
environment_lastUpdate :: Lens' Environment (Maybe LastUpdate) Source #
The status of the last update on the environment.
environment_loggingConfiguration :: Lens' Environment (Maybe LoggingConfiguration) Source #
The Apache Airflow logs published to CloudWatch Logs.
environment_maxWorkers :: Lens' Environment (Maybe Natural) Source #
The maximum number of workers that run in your environment. For example,
20.
environment_minWorkers :: Lens' Environment (Maybe Natural) Source #
The minimum number of workers that run in your environment. For example,
2.
environment_name :: Lens' Environment (Maybe Text) Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment.
environment_networkConfiguration :: Lens' Environment (Maybe NetworkConfiguration) Source #
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
environment_pluginsS3ObjectVersion :: Lens' Environment (Maybe Text) Source #
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins.
environment_pluginsS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the plugins.zip file on your Amazon S3 bucket.
For example, plugins.zip. To learn more, see
Installing custom plugins.
environment_requirementsS3ObjectVersion :: Lens' Environment (Maybe Text) Source #
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies.
environment_requirementsS3Path :: Lens' Environment (Maybe Text) Source #
The relative path to the requirements.txt file on your Amazon S3
bucket. For example, requirements.txt. To learn more, see
Installing Python dependencies.
environment_schedulers :: Lens' Environment (Maybe Int) Source #
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
environment_serviceRoleArn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role.
environment_sourceBucketArn :: Lens' Environment (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG
code and supporting files are stored. For example,
arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see
Create an Amazon S3 bucket for Amazon MWAA.
environment_status :: Lens' Environment (Maybe EnvironmentStatus) Source #
The status of the Amazon MWAA environment. Valid values:
CREATING- Indicates the request to create the environment is in progress.CREATE_FAILED- Indicates the request to create the environment failed, and the environment could not be created.AVAILABLE- Indicates the request was successful and the environment is ready to use.UPDATING- Indicates the request to update the environment is in progress.DELETING- Indicates the request to delete the environment is in progress.DELETED- Indicates the request to delete the environment is complete, and the environment has been deleted.UNAVAILABLE- Indicates the request failed, but the environment was unable to rollback and is not in a stable state.UPDATE_FAILED- Indicates the request to update the environment failed, and the environment has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. To learn more, see Amazon MWAA troubleshooting.
environment_tags :: Lens' Environment (Maybe (HashMap Text Text)) Source #
The key-value tag pairs associated to your environment. For example,
"Environment": "Staging". To learn more, see
Tagging Amazon Web Services resources.
environment_webserverAccessMode :: Lens' Environment (Maybe WebserverAccessMode) Source #
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
environment_webserverUrl :: Lens' Environment (Maybe Text) Source #
The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI.
environment_weeklyMaintenanceWindowStart :: Lens' Environment (Maybe Text) Source #
The day and time of the week in Coordinated Universal Time (UTC) 24-hour
standard time that weekly maintenance updates are scheduled. For
example: TUE:03:30.
LastUpdate
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' | |
Fields
| |
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.
lastUpdate_createdAt :: Lens' LastUpdate (Maybe UTCTime) Source #
The day and time of the last update on the environment.
lastUpdate_error :: Lens' LastUpdate (Maybe UpdateError) Source #
The error that was encountered during the last update of the environment.
lastUpdate_source :: Lens' LastUpdate (Maybe Text) Source #
The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
lastUpdate_status :: Lens' LastUpdate (Maybe UpdateStatus) Source #
The status of the last update on the environment.
LoggingConfiguration
data LoggingConfiguration Source #
Describes the Apache Airflow log types that are published to CloudWatch Logs.
See: newLoggingConfiguration smart constructor.
Constructors
| LoggingConfiguration' | |
Fields
| |
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.
loggingConfiguration_dagProcessingLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
loggingConfiguration_schedulerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow scheduler logs published to CloudWatch Logs and the log level.
loggingConfiguration_taskLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow task logs published to CloudWatch Logs and the log level.
loggingConfiguration_webserverLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow web server logs published to CloudWatch Logs and the log level.
loggingConfiguration_workerLogs :: Lens' LoggingConfiguration (Maybe ModuleLoggingConfiguration) Source #
The Airflow worker logs published to CloudWatch Logs and the log level.
LoggingConfigurationInput
data LoggingConfigurationInput Source #
Defines the Apache Airflow log types to send to CloudWatch Logs.
See: newLoggingConfigurationInput smart constructor.
Constructors
| LoggingConfigurationInput' | |
Fields
| |
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.
loggingConfigurationInput_dagProcessingLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow DAG processing logs to CloudWatch Logs.
loggingConfigurationInput_schedulerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow scheduler logs to CloudWatch Logs.
loggingConfigurationInput_taskLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow task logs to CloudWatch Logs.
loggingConfigurationInput_webserverLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow web server logs to CloudWatch Logs.
loggingConfigurationInput_workerLogs :: Lens' LoggingConfigurationInput (Maybe ModuleLoggingConfigurationInput) Source #
Publishes Airflow worker logs to CloudWatch Logs.
MetricDatum
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' | |
Fields
| |
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.
metricDatum_dimensions :: Lens' MetricDatum (Maybe [Dimension]) Source #
Internal only. The dimensions associated with the metric.
metricDatum_statisticValues :: Lens' MetricDatum (Maybe StatisticSet) Source #
Internal only. The statistical values for the metric.
metricDatum_unit :: Lens' MetricDatum (Maybe Unit) Source #
Internal only. The unit used to store the metric.
metricDatum_value :: Lens' MetricDatum (Maybe Double) Source #
Internal only. The value for the metric.
metricDatum_metricName :: Lens' MetricDatum Text Source #
Internal only. The name of the metric.
metricDatum_timestamp :: Lens' MetricDatum UTCTime Source #
Internal only. The time the metric data was received.
ModuleLoggingConfiguration
data ModuleLoggingConfiguration Source #
Describes the Apache Airflow log details for the log type (e.g.
DagProcessingLogs).
See: newModuleLoggingConfiguration smart constructor.
Constructors
| ModuleLoggingConfiguration' | |
Fields
| |
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).
moduleLoggingConfiguration_cloudWatchLogGroupArn :: Lens' ModuleLoggingConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) for the CloudWatch Logs group where the
Apache Airflow log type (e.g. DagProcessingLogs) is published. For
example,
arn:aws:logs:us-east-1:123456789012:log-group:airflow-MyMWAAEnvironment-MwaaEnvironment-DAGProcessing:*.
moduleLoggingConfiguration_enabled :: Lens' ModuleLoggingConfiguration (Maybe Bool) Source #
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs)
is enabled.
moduleLoggingConfiguration_logLevel :: Lens' ModuleLoggingConfiguration (Maybe LoggingLevel) Source #
The Apache Airflow log level for the log type (e.g.
DagProcessingLogs).
ModuleLoggingConfigurationInput
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' | |
Fields
| |
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.
moduleLoggingConfigurationInput_enabled :: Lens' ModuleLoggingConfigurationInput Bool Source #
Indicates whether to enable the Apache Airflow log type (e.g.
DagProcessingLogs).
moduleLoggingConfigurationInput_logLevel :: Lens' ModuleLoggingConfigurationInput LoggingLevel Source #
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch
Logs.
NetworkConfiguration
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.
Constructors
| NetworkConfiguration' | |
Fields
| |
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.
networkConfiguration_securityGroupIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text)) Source #
A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.
networkConfiguration_subnetIds :: Lens' NetworkConfiguration (Maybe (NonEmpty Text)) Source #
A list of subnet IDs. To learn more, see About networking on Amazon MWAA.
StatisticSet
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.
Constructors
| StatisticSet' | |
Fields
| |
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.
statisticSet_maximum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The maximum value of the sample set.
statisticSet_minimum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The minimum value of the sample set.
statisticSet_sampleCount :: Lens' StatisticSet (Maybe Int) Source #
Internal only. The number of samples used for the statistic set.
statisticSet_sum :: Lens' StatisticSet (Maybe Double) Source #
Internal only. The sum of values for the sample set.
UpdateError
data UpdateError Source #
Describes the error(s) encountered with the last update of the environment.
See: newUpdateError smart constructor.
Constructors
| UpdateError' | |
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.
updateError_errorCode :: Lens' UpdateError (Maybe Text) Source #
The error code that corresponds to the error with the last update.
updateError_errorMessage :: Lens' UpdateError (Maybe Text) Source #
The error message that corresponds to the error code.
UpdateNetworkConfigurationInput
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' | |
Fields
| |
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.
updateNetworkConfigurationInput_securityGroupIds :: Lens' UpdateNetworkConfigurationInput (NonEmpty Text) Source #
A list of security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.