AmazonECSClient.ListTasks Method (ListTasksRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to ListTasksAsync.

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

Syntax

public virtual ListTasksResponse ListTasks(
         ListTasksRequest request
)

Parameters

request: Type: Amazon.ECS.Model.ListTasksRequest

Container for the necessary parameters to execute the ListTasks service method.

Return Value

Type: ListTasksResponse

The response from the ListTasks service method, as returned by ECS.

Exceptions

Exception	Condition
ClientException	These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
ClusterNotFoundException	The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
InvalidParameterException	The specified parameter isn't valid. Review the available parameters for the API request.
ServerException	These errors are usually caused by a server issue.
ServiceNotFoundException	The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.

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 Framework:
Supported in: 4.5, 4.0, 3.5

AmazonECSClient.ListTasks (ListTasksRequest)

Method