You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ECS::Types::ListTasksRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListTasksRequest
- Defined in:
- (unknown)
Overview
When passing ListTasksRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
cluster: "String",
container_instance: "String",
family: "String",
next_token: "String",
max_results: 1,
started_by: "String",
service_name: "String",
desired_status: "RUNNING", # accepts RUNNING, PENDING, STOPPED
launch_type: "EC2", # accepts EC2, FARGATE
}
Instance Attribute Summary collapse
-
#cluster ⇒ String
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.
-
#container_instance ⇒ String
The container instance ID or full ARN of the container instance with which to filter the
ListTasks
results. -
#desired_status ⇒ String
The task desired status with which to filter the
ListTasks
results. -
#family ⇒ String
The name of the family with which to filter the
ListTasks
results. -
#launch_type ⇒ String
The launch type for services to list.
-
#max_results ⇒ Integer
The maximum number of task results returned by
ListTasks
in paginated output. -
#next_token ⇒ String
The
nextToken
value returned from aListTasks
request indicating that more results are available to fulfill the request and further calls will be needed. -
#service_name ⇒ String
The name of the service with which to filter the
ListTasks
results. -
#started_by ⇒ String
The
startedBy
value with which to filter the task results.
Instance Attribute Details
#cluster ⇒ String
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.
#container_instance ⇒ String
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.
#desired_status ⇒ String
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
.
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
).
Possible values:
- RUNNING
- PENDING
- STOPPED
#family ⇒ String
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.
#launch_type ⇒ String
The launch type for services to list.
Possible values:
- EC2
- FARGATE
#max_results ⇒ Integer
The maximum number of task results returned by ListTasks
in paginated
output. When this parameter is used, ListTasks
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 ListTasks
request with the returned nextToken
value.
This value can be between 1 and 100. If this parameter is not used, then
ListTasks
returns up to 100 results and a nextToken
value if
applicable.
#next_token ⇒ String
The nextToken
value returned from a ListTasks
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
.
#service_name ⇒ String
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.
#started_by ⇒ String
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.