AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListTasks operation. Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

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

C#
public class ListTasksRequest : AmazonECSRequest
         IAmazonWebServiceRequest

The ListTasksRequest type exposes the following members

Constructors

NameDescription
Public Method ListTasksRequest()

Properties

NameTypeDescription
Public Property Cluster System.String

Gets and sets the property Cluster.

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.

Public Property ContainerInstance System.String

Gets and sets the property ContainerInstance.

The container instance ID or full Amazon Resource Name (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.

Public Property DesiredStatus Amazon.ECS.DesiredStatus

Gets and sets the property DesiredStatus.

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that ECS has set the desired status to STOPPED, which 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 ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this will not return any results because ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

Public Property Family System.String

Gets and sets the property Family.

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.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

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.

Public Property NextToken System.String

Gets and sets the property NextToken.

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. This value is null when there are no more results to return.

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.

Public Property ServiceName System.String

Gets and sets the property ServiceName.

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.

Public Property StartedBy System.String

Gets and sets the property StartedBy.

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.

Examples

This example lists all of the tasks in a cluster.

To list the tasks in a cluster


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

List 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 response = client.ListTasks(new ListTasksRequest 
{
    Cluster = "default",
    ContainerInstance = "f6bbb147-5370-4ace-8c73-c7181ded911f"
});

List taskArns = response.TaskArns;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms