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.

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.

Note:

For PCL 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

C#
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
The response from the ListTasks service method, as returned by ECS.

Exceptions

ExceptionCondition
ClientException These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.
ClusterNotFoundException The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
ServerException These errors are usually caused by a server issue.
ServiceNotFoundException The specified service could not be 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 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 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

See Also