Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
See: AWS API Reference for ListTasks.
This operation returns paginated results.
- listTasks :: ListTasks
- data ListTasks
- ltDesiredStatus :: Lens' ListTasks (Maybe DesiredStatus)
- ltCluster :: Lens' ListTasks (Maybe Text)
- ltFamily :: Lens' ListTasks (Maybe Text)
- ltNextToken :: Lens' ListTasks (Maybe Text)
- ltStartedBy :: Lens' ListTasks (Maybe Text)
- ltServiceName :: Lens' ListTasks (Maybe Text)
- ltContainerInstance :: Lens' ListTasks (Maybe Text)
- ltMaxResults :: Lens' ListTasks (Maybe Int)
- listTasksResponse :: Int -> ListTasksResponse
- data ListTasksResponse
- ltrsNextToken :: Lens' ListTasksResponse (Maybe Text)
- ltrsTaskARNs :: Lens' ListTasksResponse [Text]
- ltrsStatus :: Lens' ListTasksResponse Int
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:
See: listTasks
smart constructor.
Request Lenses
ltDesiredStatus :: Lens' ListTasks (Maybe DesiredStatus) Source
The task status that you want to filter the ListTasks
results with.
Specifying a desiredStatus
of STOPPED
will limit 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) Source
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks you want to list. If you do not specify a cluster, the default cluster is assumed..
ltFamily :: Lens' ListTasks (Maybe Text) Source
The name of the family that you want to filter the ListTasks
results
with. Specifying a family
will limit the results to tasks that belong
to that family.
ltNextToken :: Lens' ListTasks (Maybe Text) Source
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) Source
The startedBy
value that you want to filter the task results with.
Specifying a startedBy
value will limit the results to tasks that were
started with that value.
ltServiceName :: Lens' ListTasks (Maybe Text) Source
The name of the service that you want to filter the ListTasks
results
with. Specifying a serviceName
will limit the results to tasks that
belong to that service.
ltContainerInstance :: Lens' ListTasks (Maybe Text) Source
The container instance UUID or full Amazon Resource Name (ARN) of the
container instance that you want to filter the ListTasks
results with.
Specifying a containerInstance
will limit the results to tasks that
belong to that container instance.
ltMaxResults :: Lens' ListTasks (Maybe Int) Source
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
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:
data ListTasksResponse Source
See: listTasksResponse
smart constructor.
Response Lenses
ltrsTaskARNs :: Lens' ListTasksResponse [Text] Source
The list of task Amazon Resource Name (ARN) entries for the ListTasks
request.
ltrsStatus :: Lens' ListTasksResponse Int Source
The response status code.