You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::DescribeEnvironmentHealthRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeEnvironmentHealthRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  environment_name: "EnvironmentName",
  environment_id: "EnvironmentId",
  attribute_names: ["Status"], # accepts Status, Color, Causes, ApplicationMetrics, InstancesHealth, All, HealthStatus, RefreshedAt
}

See the example below to learn how to create a request body.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_names ⇒ Array<String>

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

Returns:

  • (Array<String>) —

    Specify the response elements to return.

#environment_id ⇒ String

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

Returns:

  • (String) —

    Specify the environment by ID.

#environment_name ⇒ String

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

Returns:

  • (String) —

    Specify the environment by name.