ecs_list_tasks {aws.ecx}

List Tasks

Description

List Tasks

Usage

ecs_list_tasks(
  maxResults = NULL,
  nextToken = NULL,
  cluster = NULL,
  containerInstance = NULL,
  family = NULL,
  startedBy = NULL,
  serviceName = NULL,
  desiredStatus = NULL,
  launchType = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

maxResults

Character. Pagination limit[optional]

nextToken

Characters. The token for the next page of results[optional]

cluster

Character. The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.

containerInstance

Character. The container instance ID or full ARN of the container instance with which to filter the ListTasks...

family

Character. The name of the family with which to filter the ListTasks results.

startedBy

Character. The startedBy value with which to filter the task results.

serviceName

Character. The name of the service with which to filter the ListTasks results.

desiredStatus

Character. The task desired status with which to filter the ListTasks results.

launchType

Character. The launch type for services to list.

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

maxResults

Pagination limit

cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

containerInstance

The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

family

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

startedBy

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

serviceName

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

desiredStatus

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task\'s lastStatus may have a value of PENDING).

launchType

The launch type for services to list.