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

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $servicediscovery = Paws->service('ServiceDiscovery');
my $DiscoverInstancesResponse = $servicediscovery->DiscoverInstances(
  NamespaceName      => 'MyNamespaceName',
  ServiceName        => 'MyServiceName',
  HealthStatus       => 'HEALTHY',           # OPTIONAL
  MaxResults         => 1,                   # OPTIONAL
  OptionalParameters => {
    'MyAttrKey' => 'MyAttrValue',    # key: max: 255, value: max: 1024
  },    # OPTIONAL
  QueryParameters => {
    'MyAttrKey' => 'MyAttrValue',    # key: max: 255, value: max: 1024
  },    # OPTIONAL
);

# Results:
my $Instances = $DiscoverInstancesResponse->Instances;

# Returns a L<Paws::ServiceDiscovery::DiscoverInstancesResponse> 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/DiscoverInstances

ATTRIBUTES

HealthStatus => Str

The health status of the instances that you want to discover. This parameter is ignored for services that don't have a health check configured, and all instances are returned.

HEALTHY

Returns healthy instances.

UNHEALTHY

Returns unhealthy instances.

ALL

Returns all instances.

HEALTHY_OR_ELSE_ALL

Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.

Valid values are: "HEALTHY", "UNHEALTHY", "ALL", "HEALTHY_OR_ELSE_ALL"

MaxResults => Int

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

REQUIRED NamespaceName => Str

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

OptionalParameters => Paws::ServiceDiscovery::Attributes

Opportunistic filters to scope the results based on custom attributes. If there are instances that match both the filters specified in both the QueryParameters parameter and this parameter, all of these instances are returned. Otherwise, the filters are ignored, and only instances that match the filters that are specified in the QueryParameters parameter are returned.

QueryParameters => Paws::ServiceDiscovery::Attributes

Filters to scope the results based on custom attributes for the instance (for example, {version=v1, az=1a}). Only instances that match all the specified key-value pairs are returned.

REQUIRED ServiceName => Str

The name of the service that you specified when you registered the instance.

SEE ALSO

This class forms part of Paws, documenting arguments for method DiscoverInstances 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