Skip to content
AWS for Query.Farm

aws.cloud9.describe_environments

Example SQL Queries

SELECT * FROM
aws.cloud9.describe_environments
WHERE
"environment_ids" = 'VALUE';

Description

Gets information about Cloud9 development environments.

Table Definition

Column NameColumn Data Type
environment_ids Required Input Column

The IDs of individual environments to get information about.

VARCHAR[]
Show child fields
environment_ids[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
environments

Information about the environments that are returned.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "description" VARCHAR,
    "type" VARCHAR,
    "connection_type" VARCHAR,
    "arn" VARCHAR,
    "owner_arn" VARCHAR,
    "lifecycle" STRUCT(
        "status" VARCHAR,
        "reason" VARCHAR,
        "failure_resource" VARCHAR
    ),
    "managed_credentials_status" VARCHAR
)[]
Show child fields
environments[]
Show child fields
environments[].arn

The Amazon Resource Name (ARN) of the environment.

environments[].connection_type

The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default.

environments[].description

The description for the environment.

environments[].id

The ID of the environment.

environments[].lifecycle

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

Show child fields
environments[].lifecycle.failure_resource

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

environments[].lifecycle.reason

Any informational message about the lifecycle state of the environment.

environments[].lifecycle.status

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.

environments[].managed_credentials_status

Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are:

  • ENABLED_ON_CREATE

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

  • DISABLED_BY_OWNER

  • DISABLED_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_COLLABORATOR

  • PENDING_REMOVAL_BY_OWNER

  • FAILED_REMOVAL_BY_COLLABORATOR

  • ENABLED_BY_OWNER

  • DISABLED_BY_DEFAULT

environments[].name

The name of the environment.

environments[].owner_arn

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

environments[].type

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.