List Services

ecs_list_services

R Documentation

Returns a list of services

Description

Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

Usage

ecs_list_services(cluster, nextToken, maxResults, launchType,
  schedulingStrategy)

Arguments

cluster

The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the list_services results. If you do not specify a cluster, the default cluster is assumed.

nextToken

The nextToken value returned from a list_services request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is 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 service results that list_services returned in paginated output. When this parameter is used, list_services 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_services request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then list_services returns up to 10 results and a nextToken value if applicable.

launchType

The launch type to use when filtering the list_services results.

schedulingStrategy

The scheduling strategy to use when filtering the list_services results.

Value

A list with the following syntax:

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

Request syntax

svc$list_services(
  cluster = "string",
  nextToken = "string",
  maxResults = 123,
  launchType = "EC2"|"FARGATE"|"EXTERNAL",
  schedulingStrategy = "REPLICA"|"DAEMON"
)

Examples

## Not run: 
# This example lists the services running in the default cluster for an
# account.
svc$list_services()

## End(Not run)