Network.AWS.ECS.ListTaskDefinitions

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

This operation returns paginated results.

Creating a Request

listTaskDefinitions :: ListTaskDefinitions

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

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

• ltdStatus - The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE , you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
• ltdFamilyPrefix - The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.
• ltdNextToken - The nextToken value returned from a previous paginated ListTaskDefinitions 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.
• ltdSort - The order in which to sort the results. Valid values are ASC and DESC . By default (ASC ), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.
• ltdMaxResults - The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

data ListTaskDefinitions

See: listTaskDefinitions smart constructor.

Instances

Eq ListTaskDefinitions

Methods

(==) :: ListTaskDefinitions -> ListTaskDefinitions -> Bool

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

Data ListTaskDefinitions

Methods

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

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

toConstr :: ListTaskDefinitions -> Constr

dataTypeOf :: ListTaskDefinitions -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListTaskDefinitions

Methods

readsPrec :: Int -> ReadS ListTaskDefinitions

readList :: ReadS [ListTaskDefinitions]

readPrec :: ReadPrec ListTaskDefinitions

readListPrec :: ReadPrec [ListTaskDefinitions]

Show ListTaskDefinitions

Methods

showsPrec :: Int -> ListTaskDefinitions -> ShowS

show :: ListTaskDefinitions -> String

showList :: [ListTaskDefinitions] -> ShowS

Generic ListTaskDefinitions

Associated Types

type Rep ListTaskDefinitions :: * -> *

Methods

from :: ListTaskDefinitions -> Rep ListTaskDefinitions x

to :: Rep ListTaskDefinitions x -> ListTaskDefinitions

Hashable ListTaskDefinitions

Methods

hashWithSalt :: Int -> ListTaskDefinitions -> Int

hash :: ListTaskDefinitions -> Int

ToJSON ListTaskDefinitions

Methods

toJSON :: ListTaskDefinitions -> Value

toEncoding :: ListTaskDefinitions -> Encoding

toJSONList :: [ListTaskDefinitions] -> Value

toEncodingList :: [ListTaskDefinitions] -> Encoding

NFData ListTaskDefinitions

Methods

rnf :: ListTaskDefinitions -> ()

AWSPager ListTaskDefinitions

Methods

page :: ListTaskDefinitions -> Rs ListTaskDefinitions -> Maybe ListTaskDefinitions

AWSRequest ListTaskDefinitions

Associated Types

type Rs ListTaskDefinitions :: *

Methods

request :: ListTaskDefinitions -> Request ListTaskDefinitions

response :: MonadResource m => Logger -> Service -> Proxy * ListTaskDefinitions -> ClientResponse -> m (Response ListTaskDefinitions)

ToPath ListTaskDefinitions

Methods

toPath :: ListTaskDefinitions -> ByteString

ToHeaders ListTaskDefinitions

Methods

toHeaders :: ListTaskDefinitions -> [Header]

ToQuery ListTaskDefinitions

Methods

toQuery :: ListTaskDefinitions -> QueryString

type Rep ListTaskDefinitions

type Rep ListTaskDefinitions = D1 (MetaData "ListTaskDefinitions" "Network.AWS.ECS.ListTaskDefinitions" "amazonka-ecs-1.4.5-DjgJB2IQNRjDmlzh0CCqbS" False) (C1 (MetaCons "ListTaskDefinitions'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ltdStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TaskDefinitionStatus))) (S1 (MetaSel (Just Symbol "_ltdFamilyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ltdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ltdSort") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SortOrder))) (S1 (MetaSel (Just Symbol "_ltdMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))))

type Rs ListTaskDefinitions

type Rs ListTaskDefinitions = ListTaskDefinitionsResponse

Request Lenses

ltdStatus :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE , you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

ltdFamilyPrefix :: Lens' ListTaskDefinitions (Maybe Text)

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

ltdNextToken :: Lens' ListTaskDefinitions (Maybe Text)

The nextToken value returned from a previous paginated ListTaskDefinitions 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.

ltdSort :: Lens' ListTaskDefinitions (Maybe SortOrder)

The order in which to sort the results. Valid values are ASC and DESC . By default (ASC ), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

ltdMaxResults :: Lens' ListTaskDefinitions (Maybe Int)

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Destructuring the Response

listTaskDefinitionsResponse

Arguments

:: Int

ltdrsResponseStatus

-> ListTaskDefinitionsResponse

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

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

• ltdrsTaskDefinitionARNs - The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.
• ltdrsNextToken - The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions 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.
• ltdrsResponseStatus - -- | The response status code.

data ListTaskDefinitionsResponse

See: listTaskDefinitionsResponse smart constructor.

Instances

Eq ListTaskDefinitionsResponse

Methods

(==) :: ListTaskDefinitionsResponse -> ListTaskDefinitionsResponse -> Bool

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

Data ListTaskDefinitionsResponse

Methods

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

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

toConstr :: ListTaskDefinitionsResponse -> Constr

dataTypeOf :: ListTaskDefinitionsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ListTaskDefinitionsResponse

Methods

readsPrec :: Int -> ReadS ListTaskDefinitionsResponse

readList :: ReadS [ListTaskDefinitionsResponse]

readPrec :: ReadPrec ListTaskDefinitionsResponse

readListPrec :: ReadPrec [ListTaskDefinitionsResponse]

Show ListTaskDefinitionsResponse

Methods

showsPrec :: Int -> ListTaskDefinitionsResponse -> ShowS

show :: ListTaskDefinitionsResponse -> String

showList :: [ListTaskDefinitionsResponse] -> ShowS

Generic ListTaskDefinitionsResponse

Associated Types

type Rep ListTaskDefinitionsResponse :: * -> *

Methods

from :: ListTaskDefinitionsResponse -> Rep ListTaskDefinitionsResponse x

to :: Rep ListTaskDefinitionsResponse x -> ListTaskDefinitionsResponse

NFData ListTaskDefinitionsResponse

Methods

rnf :: ListTaskDefinitionsResponse -> ()

type Rep ListTaskDefinitionsResponse

type Rep ListTaskDefinitionsResponse = D1 (MetaData "ListTaskDefinitionsResponse" "Network.AWS.ECS.ListTaskDefinitions" "amazonka-ecs-1.4.5-DjgJB2IQNRjDmlzh0CCqbS" False) (C1 (MetaCons "ListTaskDefinitionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ltdrsTaskDefinitionARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_ltdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ltdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

ltdrsTaskDefinitionARNs :: Lens' ListTaskDefinitionsResponse [Text]

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

ltdrsNextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text)

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions 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.

ltdrsResponseStatus :: Lens' ListTaskDefinitionsResponse Int

• - | The response status code.