get-environment¶
Description¶
Get details of an existing 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 environment to retrieve.
--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)
A JSON blob with environment details.
AirflowConfigurationOptions -> (map)
The Airflow Configuration Options of the Amazon MWAA Environment.
key -> (string)
value -> (string)
AirflowVersion -> (string)
The AirflowV ersion of the Amazon MWAA Environment.
Arn -> (string)
The ARN of the Amazon MWAA Environment.
CreatedAt -> (timestamp)
The Created At date of the Amazon MWAA Environment.
DagS3Path -> (string)
The Dags S3 Path of the Amazon MWAA Environment.
EnvironmentClass -> (string)
The Environment Class (size) of the Amazon MWAA Environment.
ExecutionRoleArn -> (string)
The Execution Role ARN of the Amazon MWAA Environment.
KmsKey -> (string)
The Kms Key of the Amazon MWAA Environment.
LastUpdate -> (structure)
Last update information for the environment.
CreatedAt -> (timestamp)
Time that last update occurred.
Error -> (structure)
Error string of last update, if applicable.
ErrorCode -> (string)
Error code of update.
ErrorMessage -> (string)
Error message of update.
Status -> (string)
Status of last update of SUCCESS, FAILED, CREATING, DELETING.
LoggingConfiguration -> (structure)
The Logging Configuration of the Amazon MWAA Environment.
DagProcessingLogs -> (structure)
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
CloudWatchLogGroupArn -> (string)
Provides the ARN for the CloudWatch group where the logs will be published.
Enabled -> (boolean)
Defines that the logging module is enabled.
LogLevel -> (string)
Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.
SchedulerLogs -> (structure)
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
CloudWatchLogGroupArn -> (string)
Provides the ARN for the CloudWatch group where the logs will be published.
Enabled -> (boolean)
Defines that the logging module is enabled.
LogLevel -> (string)
Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.
TaskLogs -> (structure)
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
CloudWatchLogGroupArn -> (string)
Provides the ARN for the CloudWatch group where the logs will be published.
Enabled -> (boolean)
Defines that the logging module is enabled.
LogLevel -> (string)
Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.
WebserverLogs -> (structure)
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
CloudWatchLogGroupArn -> (string)
Provides the ARN for the CloudWatch group where the logs will be published.
Enabled -> (boolean)
Defines that the logging module is enabled.
LogLevel -> (string)
Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.
WorkerLogs -> (structure)
A JSON blob that provides configuration to use for logging with respect to the various Apache Airflow services: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, and WorkerLogs.
CloudWatchLogGroupArn -> (string)
Provides the ARN for the CloudWatch group where the logs will be published.
Enabled -> (boolean)
Defines that the logging module is enabled.
LogLevel -> (string)
Defines the log level, which can be CRITICAL, ERROR, WARNING, or INFO.
MaxWorkers -> (integer)
The maximum number of workers to run in your Amazon MWAA Environment.
MinWorkers -> (integer)
The minimum number of workers to run in your Amazon MWAA Environment.
Name -> (string)
The name of the Amazon MWAA Environment.
NetworkConfiguration -> (structure)
Provide the security group and subnet IDs for the workers and scheduler.
SecurityGroupIds -> (list)
A JSON list of 1 or more security groups IDs by name, in the same VPC as the subnets.
(string)
SubnetIds -> (list)
Provide a JSON list of 2 subnet IDs by name. These must be private subnets, in the same VPC, in two different availability zones.
(string)
PluginsS3ObjectVersion -> (string)
The Plugins.zip S3 Object Version of the Amazon MWAA Environment.
PluginsS3Path -> (string)
The Plugins.zip S3 Path of the Amazon MWAA Environment.
RequirementsS3ObjectVersion -> (string)
The Requirements.txt file S3 Object Version of the Amazon MWAA Environment.
RequirementsS3Path -> (string)
The Requirement.txt S3 Path of the Amazon MWAA Environment.
ServiceRoleArn -> (string)
The Service Role ARN of the Amazon MWAA Environment.
SourceBucketArn -> (string)
The Source S3 Bucket ARN of the Amazon MWAA Environment.
Status -> (string)
The status of the Amazon MWAA Environment.
Tags -> (map)
The Tags of the Amazon MWAA Environment.
key -> (string)
value -> (string)
WebserverAccessMode -> (string)
The Webserver Access Mode of the Amazon MWAA Environment (public or private only).
WebserverUrl -> (string)
The Webserver URL of the Amazon MWAA Environment.
WeeklyMaintenanceWindowStart -> (string)
The Weekly Maintenance Window Start of the Amazon MWAA Environment.