Class: Aws::ECS::Types::ListTasksRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListTasksRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
When making an API call, you may pass ListTasksRequest data as a 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 a previous paginated `ListTasks` request where `maxResults` was used and the results exceeded the value of that parameter.
-
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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`.
<note markdown=“1”> 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`).
</note>
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#launch_type ⇒ String
The launch type for services to list.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#next_token ⇒ String
The ‘nextToken` value returned from a previous paginated `ListTasks` request where `maxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `nextToken` value.
<note markdown=“1”> 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.
</note>
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |
#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.
3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 |
# File 'lib/aws-sdk-ecs/types.rb', line 3920 class ListTasksRequest < Struct.new( :cluster, :container_instance, :family, :next_token, :max_results, :started_by, :service_name, :desired_status, :launch_type) include Aws::Structure end |