paws.networking (version 0.1.11)

servicediscovery_discover_instances: Discovers registered instances for a specified namespace and service

Description

Discovers registered instances for a specified namespace and service. You can use discover_instances to discover instances for any type of namespace. For public and private DNS namespaces, you can also use DNS queries to discover instances.

Usage

servicediscovery_discover_instances(NamespaceName, ServiceName,
  MaxResults, QueryParameters, OptionalParameters, HealthStatus)

Arguments

NamespaceName

[required] The name of the namespace that you specified when you registered the instance.

ServiceName

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

MaxResults

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

QueryParameters

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 will be returned.

OptionalParameters

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, they are returned. Otherwise, these filters are ignored and only instances that match the filters specified in the QueryParameters parameter are returned.

HealthStatus

The health status of the instances that you want to discover.

Value

A list with the following syntax:

list(
  Instances = list(
    list(
      InstanceId = "string",
      NamespaceName = "string",
      ServiceName = "string",
      HealthStatus = "HEALTHY"|"UNHEALTHY"|"UNKNOWN",
      Attributes = list(
        "string"
      )
    )
  )
)

Request syntax

svc$discover_instances(
  NamespaceName = "string",
  ServiceName = "string",
  MaxResults = 123,
  QueryParameters = list(
    "string"
  ),
  OptionalParameters = list(
    "string"
  ),
  HealthStatus = "HEALTHY"|"UNHEALTHY"|"ALL"
)

Examples

# NOT RUN {
# Example: Discover registered instances
svc$discover_instances(
  HealthStatus = "ALL",
  MaxResults = 10L,
  NamespaceName = "example.com",
  ServiceName = "myservice"
)
# }
# NOT RUN {
# }