[ aws . appconfig ]

list-environments

Description

List the environments for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-environments
--application-id <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--application-id (string)

The application ID.

--max-results (integer)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

--next-token (string)

A token to start the list. Use this token to get the next set of results.

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

Examples

To list environments for an AppConfig application

This list-environments example lists the environments that exist for an application.

aws appconfig list-environments \
    --application-id abc1234

Output:

{
    "Items": [
        {
            "Description": "My AppConfig environment",
            "Id": "2d4e6f8",
            "State": "ReadyForDeployment",
            "ApplicationId": "abc1234",
            "Monitors": [],
            "Name": "TestEnvironment"
        }
    ]
}

For more information, see Create an Environment in the AWS Systems Manager User Guide.

Output

Items -> (list)

The elements from this collection.

(structure)

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 .

NextToken -> (string)

The token for the next set of items to return. Use this token to get the next set of results.