2022/01/06 - AmazonMWAA - 1 updated api methods
Changes This release adds a "Source" field that provides the initiator of an update, such as due to an automated patch from AWS or due to modification via Console or API.
{'Environment': {'LastUpdate': {'Source': 'string'}}}
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
See also: AWS API Documentation
Request Syntax
client.get_environment(
Name='string'
)
string
[REQUIRED]
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment .
dict
Response Syntax
{
'Environment': {
'AirflowConfigurationOptions': {
'string': 'string'
},
'AirflowVersion': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DagS3Path': 'string',
'EnvironmentClass': 'string',
'ExecutionRoleArn': 'string',
'KmsKey': 'string',
'LastUpdate': {
'CreatedAt': datetime(2015, 1, 1),
'Error': {
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
'Source': 'string',
'Status': 'SUCCESS'|'PENDING'|'FAILED'
},
'LoggingConfiguration': {
'DagProcessingLogs': {
'CloudWatchLogGroupArn': 'string',
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'SchedulerLogs': {
'CloudWatchLogGroupArn': 'string',
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'TaskLogs': {
'CloudWatchLogGroupArn': 'string',
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WebserverLogs': {
'CloudWatchLogGroupArn': 'string',
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
},
'WorkerLogs': {
'CloudWatchLogGroupArn': 'string',
'Enabled': True|False,
'LogLevel': 'CRITICAL'|'ERROR'|'WARNING'|'INFO'|'DEBUG'
}
},
'MaxWorkers': 123,
'MinWorkers': 123,
'Name': 'string',
'NetworkConfiguration': {
'SecurityGroupIds': [
'string',
],
'SubnetIds': [
'string',
]
},
'PluginsS3ObjectVersion': 'string',
'PluginsS3Path': 'string',
'RequirementsS3ObjectVersion': 'string',
'RequirementsS3Path': 'string',
'Schedulers': 123,
'ServiceRoleArn': 'string',
'SourceBucketArn': 'string',
'Status': 'CREATING'|'CREATE_FAILED'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED'|'UNAVAILABLE'|'UPDATE_FAILED',
'Tags': {
'string': 'string'
},
'WebserverAccessMode': 'PRIVATE_ONLY'|'PUBLIC_ONLY',
'WebserverUrl': 'string',
'WeeklyMaintenanceWindowStart': 'string'
}
}
Response Structure
(dict) --
Environment (dict) --
An object containing all available details about the environment.
AirflowConfigurationOptions (dict) --
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options .
(string) --
(string) --
AirflowVersion (string) --
The Apache Airflow version on your environment. Valid values: 1.10.12 , 2.0.2 .
Arn (string) --
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
CreatedAt (datetime) --
The day and time the environment was created.
DagS3Path (string) --
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags . To learn more, see Adding or updating DAGs .
EnvironmentClass (string) --
The environment class type. Valid values: mw1.small , mw1.medium , mw1.large . To learn more, see Amazon MWAA environment class .
ExecutionRoleArn (string) --
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 .
KmsKey (string) --
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
LastUpdate (dict) --
The status of the last update on the environment.
CreatedAt (datetime) --
The day and time of the last update on the environment.
Error (dict) --
The error that was encountered during the last update of the environment.
ErrorCode (string) --
The error code that corresponds to the error with the last update.
ErrorMessage (string) --
The error message that corresponds to the error code.
Source (string) --
The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
Status (string) --
The status of the last update on the environment.
LoggingConfiguration (dict) --
The Apache Airflow logs published to CloudWatch Logs.
DagProcessingLogs (dict) --
The Airflow DAG processing logs published to CloudWatch Logs and the log level.
CloudWatchLogGroupArn (string) --
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:* .
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
SchedulerLogs (dict) --
The Airflow scheduler logs published to CloudWatch Logs and the log level.
CloudWatchLogGroupArn (string) --
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:* .
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
TaskLogs (dict) --
The Airflow task logs published to CloudWatch Logs and the log level.
CloudWatchLogGroupArn (string) --
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:* .
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
WebserverLogs (dict) --
The Airflow web server logs published to CloudWatch Logs and the log level.
CloudWatchLogGroupArn (string) --
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:* .
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
WorkerLogs (dict) --
The Airflow worker logs published to CloudWatch Logs and the log level.
CloudWatchLogGroupArn (string) --
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:* .
Enabled (boolean) --
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs ) is enabled.
LogLevel (string) --
The Apache Airflow log level for the log type (e.g. DagProcessingLogs ).
MaxWorkers (integer) --
The maximum number of workers that run in your environment. For example, 20 .
MinWorkers (integer) --
The minimum number of workers that run in your environment. For example, 2 .
Name (string) --
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment .
NetworkConfiguration (dict) --
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 .
SecurityGroupIds (list) --
A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA .
(string) --
SubnetIds (list) --
A list of subnet IDs. To learn more, see About networking on Amazon MWAA .
(string) --
PluginsS3ObjectVersion (string) --
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
PluginsS3Path (string) --
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .
RequirementsS3ObjectVersion (string) --
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
RequirementsS3Path (string) --
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .
Schedulers (integer) --
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
ServiceRoleArn (string) --
The Amazon Resource Name (ARN) for the service-linked role of the environment. To learn more, see Amazon MWAA Service-linked role .
SourceBucketArn (string) --
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 .
Status (string) --
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 .
Tags (dict) --
The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging Amazon Web Services resources .
(string) --
(string) --
WebserverAccessMode (string) --
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes .
WebserverUrl (string) --
The Apache Airflow Web server host name for the Amazon MWAA environment. To learn more, see Accessing the Apache Airflow UI .
WeeklyMaintenanceWindowStart (string) --
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 .