AWS Elastic Beanstalk

List environments

Return descriptions for existing environments that you have access to. Returns an empty array if they don’t exist or if you don’t have the right permissions.

Inputs

Field

Type

Description

region [required]

enum

default: us-east-1

applicationName

string

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

environmentIds

[string]

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

environmentNames

[string]

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

Outputs

Expand All

Field

Type

Description

environments [required]

[object]

EnvironmentName

string

The name of this environment.

EnvironmentId

string

The ID of this environment.

ApplicationName

string

The name of the application associated with this environment.

VersionLabel

string

The application version deployed in this environment.

SolutionStackName

string

The name of the SolutionStack deployed with this environment.

PlatformArn

string

The ARN of the platform version.

TemplateName

string

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

Description

string

Describes this environment.

EndpointURL

string

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

CNAME

string

The URL to the CNAME for this environment.

DateCreated

date-time

The creation date for this environment.

DateUpdated

date-time

The last modified date for this environment.

Status

string

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.

AbortableOperationInProgress

boolean

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.

Health

string

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

HealthStatus

string

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

Resources

object

The description of the AWS resources used by this environment.

LoadBalancer

object

Describes the LoadBalancer.

LoadBalancerName

string

The name of the LoadBalancer.

Domain

string

The domain name of the LoadBalancer.

Listeners

[object]

A list of Listeners used by the LoadBalancer.

Protocol

string

The protocol that is used by the Listener.

Port

number

The port that is used by the Listener.

Tier

object

Describes the current tier of this environment.

Name

string

The name of this environment tier. Valid values: For Web server tier – WebServer For Worker tier – Worker

Type

string

The type of this environment tier. Valid values: For Web server tier – Standard For Worker tier – SQS/HTTP

Version

string

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.

EnvironmentLinks

[object]

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

LinkName

string

The name of the link.

EnvironmentName

string

The name of the linked environment (the dependency).

EnvironmentArn

string

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

OperationsRole

string

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

amzRequestId [required]

string