[ aws . servicediscovery ]

discover-instances

Description

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  discover-instances
--namespace-name <value>
--service-name <value>
[--max-results <value>]
[--query-parameters <value>]
[--health-status <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--namespace-name (string)

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

--service-name (string)

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

--max-results (integer)

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

--query-parameters (map)

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--health-status (string)

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

Possible values:

• HEALTHY

• UNHEALTHY

• ALL

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Instances -> (list)

A complex type that contains one HttpInstanceSummary for each registered instance.

(structure)

In a response to a DiscoverInstances request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

InstanceId -> (string)

The ID of an instance that matches the values that you specified in the request.

NamespaceName -> (string)

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

ServiceName -> (string)

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

HealthStatus -> (string)

If you configured health checking in the service, the current health status of the service instance.

Attributes -> (map)

If you included any attributes when you registered the instance, the values of those attributes.

key -> (string)

value -> (string)