List Clusters

ecs_list_clusters

R Documentation

Returns a list of existing clusters¶

Description¶

Returns a list of existing clusters.

Usage¶

ecs_list_clusters(nextToken, maxResults)

Arguments¶

nextToken

The nextToken value returned from a list_clusters request indicating that more results are available to fulfill the request and further calls are needed. If maxResults was provided, it's possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

maxResults

The maximum number of cluster results that list_clusters returned in paginated output. When this parameter is used, list_clusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another list_clusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_clusters returns up to 100 results and a nextToken value if applicable.

Value¶

A list with the following syntax:

list(
  clusterArns = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_clusters(
  nextToken = "string",
  maxResults = 123
)

Examples¶

## Not run: 
# This example lists all of your available clusters in your default
# region.
svc$list_clusters()

## End(Not run)