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.

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.

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 - 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.

data ListTasks

See: listTasks smart constructor.

Instances

Eq ListTasks

Methods

(==) :: ListTasks -> ListTasks -> Bool

(/=) :: ListTasks -> ListTasks -> Bool

Data ListTasks

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTasks -> c ListTasks

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTasks

toConstr :: ListTasks -> Constr

dataTypeOf :: ListTasks -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTasks)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTasks)

gmapT :: (forall b. Data b => b -> b) -> ListTasks -> ListTasks

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTasks -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTasks -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTasks -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTasks -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTasks -> m ListTasks

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTasks -> m ListTasks

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTasks -> m ListTasks

Read ListTasks

Methods

readsPrec :: Int -> ReadS ListTasks

readList :: ReadS [ListTasks]

readPrec :: ReadPrec ListTasks

readListPrec :: ReadPrec [ListTasks]

Show ListTasks

Methods

showsPrec :: Int -> ListTasks -> ShowS

show :: ListTasks -> String

showList :: [ListTasks] -> ShowS

Generic ListTasks

Associated Types

type Rep ListTasks :: * -> *

Methods

from :: ListTasks -> Rep ListTasks x

to :: Rep ListTasks x -> ListTasks

Hashable ListTasks

Methods

hashWithSalt :: Int -> ListTasks -> Int

hash :: ListTasks -> Int

ToJSON ListTasks

Methods

toJSON :: ListTasks -> Value

toEncoding :: ListTasks -> Encoding

toJSONList :: [ListTasks] -> Value

toEncodingList :: [ListTasks] -> Encoding

NFData ListTasks

Methods

rnf :: ListTasks -> ()

AWSPager ListTasks

Methods

page :: ListTasks -> Rs ListTasks -> Maybe ListTasks

AWSRequest ListTasks

Associated Types

type Rs ListTasks :: *

Methods

request :: ListTasks -> Request ListTasks

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ListTasks -> ClientResponse -> m (Response ListTasks)

ToHeaders ListTasks

Methods

toHeaders :: ListTasks -> [Header]

ToPath ListTasks

Methods

toPath :: ListTasks -> ByteString

ToQuery ListTasks

Methods

toQuery :: ListTasks -> QueryString

type Rep ListTasks

type Rep ListTasks = D1 * (MetaData "ListTasks" "Network.AWS.ECS.ListTasks" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "ListTasks'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ltDesiredStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DesiredStatus))) (S1 * (MetaSel (Just Symbol "_ltCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltFamily") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ltNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_ltStartedBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ltServiceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltLaunchType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe LaunchType))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltContainerInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_ltMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Int))))))))

type Rs ListTasks

type Rs ListTasks = ListTasksResponse

Request Lenses

ltDesiredStatus :: Lens' ListTasks (Maybe DesiredStatus)

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 :: 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.

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.

ltLaunchType :: Lens' ListTasks (Maybe LaunchType)

The launch type for services you want to list.

ltContainerInstance :: Lens' ListTasks (Maybe Text)

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 :: 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 - 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.

data ListTasksResponse

See: listTasksResponse smart constructor.

Instances

Eq ListTasksResponse

Methods

(==) :: ListTasksResponse -> ListTasksResponse -> Bool

(/=) :: ListTasksResponse -> ListTasksResponse -> Bool

Data ListTasksResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTasksResponse -> c ListTasksResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTasksResponse

toConstr :: ListTasksResponse -> Constr

dataTypeOf :: ListTasksResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ListTasksResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTasksResponse)

gmapT :: (forall b. Data b => b -> b) -> ListTasksResponse -> ListTasksResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTasksResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTasksResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListTasksResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTasksResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTasksResponse -> m ListTasksResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTasksResponse -> m ListTasksResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTasksResponse -> m ListTasksResponse

Read ListTasksResponse

Methods

readsPrec :: Int -> ReadS ListTasksResponse

readList :: ReadS [ListTasksResponse]

readPrec :: ReadPrec ListTasksResponse

readListPrec :: ReadPrec [ListTasksResponse]

Show ListTasksResponse

Methods

showsPrec :: Int -> ListTasksResponse -> ShowS

show :: ListTasksResponse -> String

showList :: [ListTasksResponse] -> ShowS

Generic ListTasksResponse

Associated Types

type Rep ListTasksResponse :: * -> *

Methods

from :: ListTasksResponse -> Rep ListTasksResponse x

to :: Rep ListTasksResponse x -> ListTasksResponse

NFData ListTasksResponse

Methods

rnf :: ListTasksResponse -> ()

type Rep ListTasksResponse

type Rep ListTasksResponse = D1 * (MetaData "ListTasksResponse" "Network.AWS.ECS.ListTasks" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "ListTasksResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_ltrsTaskARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_ltrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

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 ARN entries for the ListTasks request.

ltrsResponseStatus :: Lens' ListTasksResponse Int

• - | The response status code.