amazonka-ecs-1.6.1: Amazon EC2 Container Service SDK.

Copyright (c) 2013-2018 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

Description

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.

This operation returns paginated results.

Synopsis

# Creating a Request

Creates a value of ListTasks with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltDesiredStatus - 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 , 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 Amazon ECS has set the desired status to RUNNING .
• ltCluster - 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.
• ltFamily - 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.
• ltNextToken - 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.
• ltStartedBy - 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.
• ltServiceName - 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.
• ltLaunchType - The launch type for services you want to list.
• ltContainerInstance - 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.
• ltMaxResults - 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.

See: listTasks smart constructor.

Instances

# Request Lenses

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 , 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 Amazon ECS has set the desired status to RUNNING .

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.

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.

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.

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.

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.

The launch type for services you want to list.

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.

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.

# Destructuring the Response

Arguments

 :: Int ltrsResponseStatus -> ListTasksResponse

Creates a value of ListTasksResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltrsNextToken - The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
• ltrsTaskARNs - The list of task ARN entries for the ListTasks request.
• ltrsResponseStatus - -- | The response status code.

See: listTasksResponse smart constructor.

Instances
The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
The list of task ARN entries for the ListTasks request.