ecs_list_tasks {paws.compute} | R Documentation |
Returns a list of tasks
Description
Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.
See https://www.paws-r-sdk.com/docs/ecs_list_tasks/ for full documentation.
Usage
ecs_list_tasks(
cluster = NULL,
containerInstance = NULL,
family = NULL,
nextToken = NULL,
maxResults = NULL,
startedBy = NULL,
serviceName = NULL,
desiredStatus = NULL,
launchType = NULL
)
Arguments
cluster |
The short name or full Amazon Resource Name (ARN) of the cluster to use
when filtering the list_tasks results. If you do not
specify a cluster, the default cluster is assumed.
|
containerInstance |
The container instance ID or full ARN of the container instance to use
when filtering the list_tasks results. Specifying a
containerInstance limits the results to tasks that belong to that
container instance.
|
family |
The name of the task definition family to use when filtering the
list_tasks results. Specifying a family limits the
results to tasks that belong to that family.
|
nextToken |
The nextToken value returned from a list_tasks
request indicating that more results are available to fulfill the
request and further calls will be 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 task results that list_tasks
returned in paginated output. When this parameter is used,
list_tasks 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_tasks request with the returned nextToken
value. This value can be between 1 and 100. If this parameter isn't
used, then list_tasks returns up to 100 results and
a nextToken value if applicable.
|
startedBy |
The startedBy value to filter the task results with. Specifying a
startedBy value limits the results to tasks that were started with
that value.
When you specify startedBy as the filter, it must be the only filter
that you use.
|
serviceName |
The name of the service to use when filtering the
list_tasks results. Specifying a serviceName
limits the results to tasks that belong to that service.
|
desiredStatus |
The task desired status to use when filtering the
list_tasks 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
aren't 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 doesn't 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 to use when filtering the list_tasks
results.
|
[Package
paws.compute version 0.6.1
Index]