servicediscovery_list_instances: Lists summary information about the instances that you...

Description Usage Arguments Value Request syntax Examples

View source: R/servicediscovery_operations.R

Description

Lists summary information about the instances that you registered by using a specified service.

Usage

1
servicediscovery_list_instances(ServiceId, NextToken, MaxResults)

Arguments

ServiceId

[required] The ID of the service that you want to list instances for.

NextToken

For the first list_instances request, omit this value.

If more than MaxResults instances match the specified criteria, you can submit another list_instances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

MaxResults

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

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
list(
  Instances = list(
    list(
      Id = "string",
      Attributes = list(
        "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
5
svc$list_instances(
  ServiceId = "string",
  NextToken = "string",
  MaxResults = 123
)

Examples

1
2
3
4
5
6
7
## Not run: 
# Example: List service instances
svc$list_instances(
  ServiceId = "srv-qzpwvt2tfqcegapy"
)

## End(Not run)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.