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

Class: Aws::ServiceDiscovery::Types::GetInstancesHealthStatusRequest

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

Overview

Note:

When making an API call, you may pass GetInstancesHealthStatusRequest data as a hash:

{
  service_id: "ResourceId", # required
  instances: ["ResourceId"],
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#instancesArray<String>

An array that contains the IDs of all the instances that you want to get the health status for.

If you omit Instances, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.

To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

Returns:

  • (Array<String>)


631
632
633
634
635
636
637
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 631

class GetInstancesHealthStatusRequest < Struct.new(
  :service_id,
  :instances,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of instances that you want Route 53 to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, Route 53 returns up to 100 instances.

Returns:

  • (Integer)


631
632
633
634
635
636
637
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 631

class GetInstancesHealthStatusRequest < Struct.new(
  :service_id,
  :instances,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

For the first GetInstancesHealthStatus request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

Returns:

  • (String)


631
632
633
634
635
636
637
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 631

class GetInstancesHealthStatusRequest < Struct.new(
  :service_id,
  :instances,
  :max_results,
  :next_token)
  include Aws::Structure
end

#service_idString

The ID of the service that the instance is associated with.

Returns:

  • (String)


631
632
633
634
635
636
637
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 631

class GetInstancesHealthStatusRequest < Struct.new(
  :service_id,
  :instances,
  :max_results,
  :next_token)
  include Aws::Structure
end