class Aws::ServiceDiscovery::Types::GetInstancesHealthStatusRequest
@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", }
@!attribute [rw] service_id
The ID of the service that the instance is associated with. @return [String]
@!attribute [rw] instances
An array that contains the IDs of all the instances that you want to get the health status for. If you omit `Instances`, Cloud Map returns the health status for all the instances that are associated with the specified service. <note markdown="1"> To get the IDs for the instances that you've registered by using a specified service, submit a [ListInstances][1] request. </note> [1]: https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html @return [Array<String>]
@!attribute [rw] max_results
The maximum number of instances that you want Cloud Map to return in the response to a `GetInstancesHealthStatus` request. If you don't specify a value for `MaxResults`, Cloud Map returns up to 100 instances. @return [Integer]
@!attribute [rw] next_token
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/servicediscovery-2017-03-14/GetInstancesHealthStatusRequest AWS API Documentation
Constants
- SENSITIVE