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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#instances ⇒ Array<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.

<note markdown=“1”> To get the IDs for the instances that you’ve registered by using a specified service, submit a ListInstances request.

</note>

Returns:

  • (Array<String>) 


763
764
765
766
767
768
769
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 763

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

#max_results ⇒ Integer

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) 


763
764
765
766
767
768
769
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 763

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

#next_token ⇒ String

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) 


763
764
765
766
767
768
769
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 763

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

#service_id ⇒ String

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

Returns:

  • (String) 


763
764
765
766
767
768
769
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 763

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