[ aws . cloud9 ]

describe-environments

Description

Gets information about AWS Cloud9 development environments.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-environments
--environment-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--environment-ids (list)

The IDs of individual environments to get information about.

(string)

Syntax:

"string" "string" ...

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about AWS Cloud9 development environments

This example gets information about the specified AWS Cloud9 development environments.

Command:

aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX

Output:

{
  "environments": [
    {
      "id": "685f892f431b45c2b28cb69eadcdb0EX",
      "name": "my-demo-ec2-env",
      "description": "Created from CodeStar.",
      "type": "ec2",
      "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX",
      "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "lifecycle": {
        "status": "CREATED"
      }
    },
    {
      "id": "349c86d4579e4e7298d500ff57a6b2EX",
      "name": my-demo-ssh-env",
      "description": "",
      "type": "ssh",
      "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
      "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
      "lifecycle": {
        "status": "CREATED"
      }
    }
  ]
}

Output

environments -> (list)

Information about the environments that are returned.

(structure)

Information about an AWS Cloud9 development environment.

id -> (string)

The ID of the environment.

name -> (string)

The name of the environment.

description -> (string)

The description for the environment.

type -> (string)

The type of environment. Valid values include the following:

• ec2 : An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

• ssh : Your own server connects to the environment.

arn -> (string)

The Amazon Resource Name (ARN) of the environment.

ownerArn -> (string)

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

lifecycle -> (structure)

The state of the environment in its creation or deletion lifecycle.

status -> (string)

The current creation or deletion lifecycle state of the environment.

• CREATING : The environment is in the process of being created.

• CREATED : The environment was successfully created.

• CREATE_FAILED : The environment failed to be created.

• DELETING : The environment is in the process of being deleted.

• DELETE_FAILED : The environment failed to delete.

reason -> (string)

Any informational message about the lifecycle state of the environment.

failureResource -> (string)

If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.