AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

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

Overview

Note:

When passing GetInstancesHealthStatusRequest as input to an Aws::Client method, you can use a vanilla 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, AWS Cloud Map 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>)

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

#max_resultsInteger

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

Returns:

  • (Integer)

    The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request.

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

    For the first GetInstancesHealthStatus request, omit this value.

#service_idString

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

Returns:

  • (String)

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