Network.AWS.ECS.ListTasks

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.

This operation returns paginated results.

Creating a Request

listTasks :: ListTasks

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
• ltCluster
• ltFamily
• ltNextToken
• ltStartedBy
• ltServiceName
• ltContainerInstance
• ltMaxResults

data ListTasks

See: listTasks smart constructor.

Instances

Eq ListTasks

Data ListTasks

Read ListTasks

Show ListTasks

Generic ListTasks

ToJSON ListTasks

Hashable ListTasks

AWSPager ListTasks

AWSRequest ListTasks

ToPath ListTasks

ToHeaders ListTasks

ToQuery ListTasks

type Rep ListTasks

type Rs ListTasks = ListTasksResponse

Request Lenses

ltDesiredStatus :: Lens' ListTasks (Maybe DesiredStatus)

The task status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that are in the STOPPED status, which can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING.

ltCluster :: Lens' ListTasks (Maybe Text)

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 :: Lens' ListTasks (Maybe Text)

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 :: Lens' ListTasks (Maybe Text)

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.

ltStartedBy :: Lens' ListTasks (Maybe Text)

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 :: Lens' ListTasks (Maybe Text)

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.

ltContainerInstance :: Lens' ListTasks (Maybe Text)

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.

ltMaxResults :: Lens' ListTasks (Maybe Int)

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

listTasksResponse

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
• ltrsTaskARNs
• ltrsResponseStatus

data ListTasksResponse

See: listTasksResponse smart constructor.

Instances

Eq ListTasksResponse

Data ListTasksResponse

Read ListTasksResponse

Show ListTasksResponse

Generic ListTasksResponse

type Rep ListTasksResponse

Response Lenses

ltrsNextToken :: Lens' ListTasksResponse (Maybe Text)

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 :: Lens' ListTasksResponse [Text]

The list of task Amazon Resource Name (ARN) entries for the ListTasks request.

ltrsResponseStatus :: Lens' ListTasksResponse Int

The response status code.