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

Class: Aws::ElasticBeanstalk::Types::DescribeInstancesHealthRequest

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 DescribeInstancesHealthRequest data as a hash:

{
  environment_name: "EnvironmentName",
  environment_id: "EnvironmentId",
  attribute_names: ["HealthStatus"], # accepts HealthStatus, Color, Causes, ApplicationMetrics, RefreshedAt, LaunchedAt, System, Deployment, AvailabilityZone, InstanceType, All
  next_token: "NextToken",
}

Parameters for a call to DescribeInstancesHealth.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_namesArray<String>

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

Returns:

  • (Array<String>)


2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2212

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

#environment_idString

Specify the AWS Elastic Beanstalk environment by ID.

Returns:

  • (String)


2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2212

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

#environment_nameString

Specify the AWS Elastic Beanstalk environment by name.

Returns:

  • (String)


2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2212

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

#next_tokenString

Specify the pagination token returned by a previous call.

Returns:

  • (String)


2212
2213
2214
2215
2216
2217
2218
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 2212

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