ListTasksRequest Class | AWS SDK for .NET V3

Container for the parameters to the ListTasks operation. 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.

Recently stopped tasks might appear in the returned results.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ECS.AmazonECSRequest
      Amazon.ECS.Model.ListTasksRequest

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

public class ListTasksRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListTasksRequest type exposes the following members

Constructors

	Name	Description
	ListTasksRequest()

Properties

Name	Type	Description
Cluster	System.String	Gets and sets the property Cluster. The short name or full Amazon Resource Name (ARN) of the cluster to use when filtering the `ListTasks` results. If you do not specify a cluster, the default cluster is assumed.
ContainerInstance	System.String	Gets and sets the property ContainerInstance. The container instance ID or full ARN of the container instance to use when filtering the `ListTasks` results. Specifying a `containerInstance` limits the results to tasks that belong to that container instance.
DesiredStatus	Amazon.ECS.DesiredStatus	Gets and sets the property DesiredStatus. The task desired status to use when filtering 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 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`).
Family	System.String	Gets and sets the property Family. The name of the task definition family to use when filtering the `ListTasks` results. Specifying a `family` limits the results to tasks that belong to that family.
LaunchType	Amazon.ECS.LaunchType	Gets and sets the property LaunchType. The launch type to use when filtering the `ListTasks` results.
MaxResults	System.Int32	Gets and sets the property MaxResults. The maximum number of task results that `ListTasks` returned 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 isn't used, then `ListTasks` returns up to 100 results and a `nextToken` value if applicable.
NextToken	System.String	Gets and sets the property NextToken. 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'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.
ServiceName	System.String	Gets and sets the property ServiceName. The name of the service to use when filtering the `ListTasks` results. Specifying a `serviceName` limits the results to tasks that belong to that service.
StartedBy	System.String	Gets and sets the property 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.

Examples

This example lists all of the tasks in a cluster.

To list the tasks in a cluster


var client = new AmazonECSClient();
var response = client.ListTasks(new ListTasksRequest 
{
    Cluster = "default"
});

List<string> taskArns = response.TaskArns;

This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.

To list the tasks on a particular container instance


var client = new AmazonECSClient();
var response = client.ListTasks(new ListTasksRequest 
{
    Cluster = "default",
    ContainerInstance = "f6bbb147-5370-4ace-8c73-c7181ded911f"
});

List<string> taskArns = response.TaskArns;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5