[ aws . mwaa ]

get-environment

Description

Retrieves the details of an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-environment
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Environment -> (structure)

An object containing all available details about the environment.

AirflowConfigurationOptions -> (map)

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. To learn more, see Apache Airflow configuration options .

key -> (string)

value -> (string)

AirflowVersion -> (string)

The Apache Airflow version on your environment. For example, v1.10.12 .

Arn -> (string)

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

CreatedAt -> (timestamp)

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 AWS 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 Key Management Service (KMS) encryption key used to encrypt the data in your environment.

LastUpdate -> (structure)

The status of the last update on the environment, and any errors that were encountered.

CreatedAt -> (timestamp)

The day and time of the last update on the environment.

Error -> (structure)

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.

Status -> (string)

The status of the last update on the environment. Valid values: SUCCESS , PENDING , FAILED .

LoggingConfiguration -> (structure)

The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

DagProcessingLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

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 to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

SchedulerLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

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 to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

TaskLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

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 to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

WebserverLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

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 to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

WorkerLogs -> (structure)

Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs ). Valid values: CloudWatchLogGroupArn , Enabled , LogLevel .

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 to enable the Apache Airflow log type (e.g. DagProcessingLogs ) in CloudWatch Logs.

LogLevel -> (string)

Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs ) to CloudWatch Logs. Valid values: CRITICAL , ERROR , WARNING , INFO .

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 -> (structure)

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 .

SecurityGroupIds -> (list)

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 .

(string)

SubnetIds -> (list)

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.

(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 -> (map)

The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging AWS resources .

key -> (string)

value -> (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 that weekly maintenance updates are scheduled. For example: TUE:03:30 .