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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass DescribeEnvironmentHealthRequest data as a 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.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_namesArray<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>)


1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1795

class DescribeEnvironmentHealthRequest < Struct.new(
  :environment_name,
  :environment_id,
  :attribute_names)
  include Aws::Structure
end

#environment_idString

Specify the environment by ID.

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

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1795

class DescribeEnvironmentHealthRequest < Struct.new(
  :environment_name,
  :environment_id,
  :attribute_names)
  include Aws::Structure
end

#environment_nameString

Specify the environment by name.

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

Returns:

  • (String)


1795
1796
1797
1798
1799
1800
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1795

class DescribeEnvironmentHealthRequest < Struct.new(
  :environment_name,
  :environment_id,
  :attribute_names)
  include Aws::Structure
end