Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . appconfig ]

get-environment

Description

Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-environment
--application-id <value>
--environment-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The ID of the application that includes the environment you want to get.

--environment-id (string)

The ID of the environment you wnat to get.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. 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

ApplicationId -> (string)

The application ID.

Id -> (string)

The environment ID.

Name -> (string)

The name of the environment.

Description -> (string)

The description of the environment.

State -> (string)

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT , DEPLOYING , ROLLING_BACK , or ROLLED_BACK

Monitors -> (list)

Amazon CloudWatch alarms monitored during the deployment.

(structure)

Amazon CloudWatch alarms to monitor during the deployment process.

AlarmArn -> (string)

ARN of the Amazon CloudWatch alarm.

AlarmRoleArn -> (string)

ARN of an IAM role for AppConfig to monitor AlarmArn .