Skip to content

aws.elasticbeanstalk.describe_environments

Example SQL Queries

SELECT * FROM
aws.elasticbeanstalk.describe_environments;

Description

Returns descriptions for existing environments.

Table Definition

Column NameColumn Data Type
application_name Input Column

The name of the application associated with this environment.

VARCHAR
environment_ids Input Column

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

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

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

VARCHAR[]
Show child fields
environment_names[]
include_deleted Input Column

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

BOOLEAN
included_deleted_back_to Input Column

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

TIMESTAMP_S
version_label Input Column

The application version deployed in this environment.

VARCHAR
_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
abortable_operation_in_progress

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

BOOLEAN
cname

The URL to the CNAME for this environment.

VARCHAR
date_created

The creation date for this environment.

TIMESTAMP_S
date_updated

The last modified date for this environment.

TIMESTAMP_S
description

Describes this environment.

VARCHAR
endpoint_url

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

VARCHAR
environment_arn

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

VARCHAR
environment_id

The ID of this environment.

VARCHAR
environment_links

A list of links to other environments in the same group.

STRUCT(
"link_name" VARCHAR,
"environment_name" VARCHAR
)[]
Show child fields
environment_links[]
Show child fields
environment_links[].environment_name

The name of the linked environment (the dependency).

environment_links[].link_name

The name of the link.

environment_name

The name of this environment.

VARCHAR
health

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

  • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

  • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

  • Green: Indicates the environment is healthy and fully functional.

  • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

Default: Grey

VARCHAR
health_status

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

VARCHAR
operations_role

The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

VARCHAR
platform_arn

The ARN of the platform version.

VARCHAR
resources

The description of the AWS resources used by this environment.

STRUCT(
"load_balancer" STRUCT(
"load_balancer_name" VARCHAR,
"domain" VARCHAR,
"listeners" STRUCT(
"protocol" VARCHAR,
"port" BIGINT
)[]
)
)
Show child fields
resources.load_balancer

Describes the LoadBalancer.

Show child fields
resources.load_balancer.domain

The domain name of the LoadBalancer.

resources.load_balancer.listeners[]
Show child fields
resources.load_balancer.listeners[].port

The port that is used by the Listener.

resources.load_balancer.listeners[].protocol

The protocol that is used by the Listener.

resources.load_balancer.load_balancer_name

The name of the LoadBalancer.

solution_stack_name

The name of the SolutionStack deployed with this environment.

VARCHAR
status

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • Updating: Environment is in the process of updating its configuration settings or application version.

  • Ready: Environment is available to have an action performed on it, such as update or terminate.

  • Terminating: Environment is in the shut-down process.

  • Terminated: Environment is not running.

VARCHAR
template_name

The name of the configuration template used to originally launch this environment.

VARCHAR
tier

Describes the current tier of this environment.

STRUCT(
"name" VARCHAR,
"type" VARCHAR,
"version" VARCHAR
)
Show child fields
tier.name

The name of this environment tier.

Valid values:

  • For Web server tierWebServer

  • For Worker tierWorker

tier.type

The type of this environment tier.

Valid values:

  • For Web server tierStandard

  • For Worker tierSQS/HTTP

tier.version

The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.