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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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


1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1005

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

#max_results ⇒ Integer

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.

Returns:

  • (Integer) 


1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1005

class GetInstancesHealthStatusRequest < Struct.new(
  :service_id,
  :instances,
  :max_results,
  :next_token)
  SENSITIVE = []
  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) 


1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1005

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

#service_id ⇒ String

The ID or Amazon Resource Name (ARN) of the service that the instance is associated with. For services created in a shared namespace, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

Returns:

  • (String) 


1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 1005

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