Description Usage Arguments Value maxResults cluster containerInstance family startedBy serviceName desiredStatus launchType
List Tasks
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 | 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()
)
|
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 |
family |
Character. The name of the family with which to filter the |
startedBy |
Character. The |
serviceName |
Character. The name of the service with which to filter the |
desiredStatus |
Character. The task desired status with which to filter the |
launchType |
Character. The launch type for services to list. |
simplify |
Logical. Whether to simplify the result and handle |
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 |
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. |
A list object or a character vector
Pagination limit
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.
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.
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.
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.
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.
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
).
The launch type for services to list.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.