get-environment¶

Description¶

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Synopsis¶

  get-environment
--name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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. Valid values: 1.10.12 , 2.0.2 , and 2.2.2 .

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

The status of the last update on the environment.

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.

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

The Apache Airflow logs published to CloudWatch Logs.

DagProcessingLogs -> (structure)

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

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

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

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

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

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

The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging Amazon Web Services 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 in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30 .

Table of Contents

Feedback

User Guide