ElasticDW Docs

Command: environment describe

The environment describe command shows the details about all environments the token has access to.

Usage

edw environment describe [flags]

Optional Flag

  • -id - Filters the environment list to the id listed requested.

Output

If the -id flag is omitted, then an array of environment objects are displayed, otherwise just the environment filtered by the id is displayed. The fields for the environment objects shown are:

  • id - The Environment ID
  • name - The Name that was supplied by the command.
  • iam_role_arn - The IAM role ARN attached to the environment.
  • created_at - The Date that the Environment was created.
  • updated_at - The Date that the Environment was updated.

Example: All Environments

$ edw environment describe

[
    {
        "id": k9don5r4e7ut,
        "name": "CLI_example",
        "iam_role_arn": "arn:aws:iam::xxx:role/edw/edw-b5ecf6ba-d32e-4322-82c3-d4eb03f5e878",
        "created_at": "2020-04-09T18:20:25Z",
        "updated_at": "2020-04-09T18:20:25Z"
    },
    {
        "id": k9don5r4e8ue,
        "name": "CLI_example_2",
        "iam_role_arn": "arn:aws:iam::xxx:role/edw/edw-b5ecf6ba-d32e-4322-82c3-d4eb03f5e878",
        "created_at": "2020-04-09T18:28:56Z",
        "updated_at": "2020-04-09T18:28:56Z"
    }
]

Example: Filtered by ID

$ edw environment describe -id k9don5r4e7ut

{
    "id": k9don5r4e7ut,
    "name": "CLI_example",
    "iam_role_arn": "arn:aws:iam::xxx:role/edw/edw-b5ecf6ba-d32e-4322-82c3-d4eb03f5e878",
    "created_at": "2020-04-09T18:20:25Z",
    "updated_at": "2020-04-09T18:20:25Z"
}