/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ServiceDiscovery::GetInstancesHealthStatus

NAME

Paws::ServiceDiscovery::GetInstancesHealthStatus - Arguments for method GetInstancesHealthStatus on Paws::ServiceDiscovery

DESCRIPTION

This class represents the parameters used for calling the method GetInstancesHealthStatus on the AWS Cloud Map service. Use the attributes of this class as arguments to method GetInstancesHealthStatus.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetInstancesHealthStatus.

SYNOPSIS

   my $servicediscovery = Paws->service('ServiceDiscovery');
   my $GetInstancesHealthStatusResponse =
     $servicediscovery->GetInstancesHealthStatus(
     ServiceId => 'MyResourceId',
     Instances => [
       'MyResourceId', ...    # max: 64
     ],    # OPTIONAL
     MaxResults => 1,                # OPTIONAL
     NextToken  => 'MyNextToken',    # OPTIONAL
     );

   # Results:
   my $NextToken = $GetInstancesHealthStatusResponse->NextToken;
   my $Status    = $GetInstancesHealthStatusResponse->Status;

# Returns a L<Paws::ServiceDiscovery::GetInstancesHealthStatusResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/servicediscovery/GetInstancesHealthStatus

ATTRIBUTES

Instances => ArrayRef[Str|Undef]

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 (https://docs.aws.amazon.com/cloud-map/latest/api/API_ListInstances.html) request.

MaxResults => Int

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.

NextToken => Str

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.

REQUIRED ServiceId => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method GetInstancesHealthStatus in Paws::ServiceDiscovery

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues