Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.ECS.ListTaskDefinitionFamilies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE . You can also filter the results with the familyPrefix parameter.

This operation returns paginated results.

Creating a Request

listTaskDefinitionFamilies :: ListTaskDefinitionFamilies #

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

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

ltdfStatus - The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE , only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE , only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.
ltdfFamilyPrefix - The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.
ltdfNextToken - The nextToken value returned from a previous paginated ListTaskDefinitionFamilies 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.
ltdfMaxResults - The maximum number of task definition family results returned by ListTaskDefinitionFamilies 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 ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

data ListTaskDefinitionFamilies #

See: listTaskDefinitionFamilies smart constructor.

Instances

Eq ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods (==) :: ListTaskDefinitionFamilies -> ListTaskDefinitionFamilies -> Bool # (/=) :: ListTaskDefinitionFamilies -> ListTaskDefinitionFamilies -> Bool #
Data ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTaskDefinitionFamilies -> c ListTaskDefinitionFamilies # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTaskDefinitionFamilies # toConstr :: ListTaskDefinitionFamilies -> Constr # dataTypeOf :: ListTaskDefinitionFamilies -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListTaskDefinitionFamilies) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTaskDefinitionFamilies) # gmapT :: (forall b. Data b => b -> b) -> ListTaskDefinitionFamilies -> ListTaskDefinitionFamilies # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTaskDefinitionFamilies -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTaskDefinitionFamilies -> r # gmapQ :: (forall d. Data d => d -> u) -> ListTaskDefinitionFamilies -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTaskDefinitionFamilies -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamilies -> m ListTaskDefinitionFamilies # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamilies -> m ListTaskDefinitionFamilies # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamilies -> m ListTaskDefinitionFamilies #
Read ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods readsPrec :: Int -> ReadS ListTaskDefinitionFamilies # readList :: ReadS [ListTaskDefinitionFamilies] # readPrec :: ReadPrec ListTaskDefinitionFamilies # readListPrec :: ReadPrec [ListTaskDefinitionFamilies] #
Show ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods showsPrec :: Int -> ListTaskDefinitionFamilies -> ShowS # show :: ListTaskDefinitionFamilies -> String # showList :: [ListTaskDefinitionFamilies] -> ShowS #
Generic ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Associated Types type Rep ListTaskDefinitionFamilies :: Type -> Type # Methods from :: ListTaskDefinitionFamilies -> Rep ListTaskDefinitionFamilies x # to :: Rep ListTaskDefinitionFamilies x -> ListTaskDefinitionFamilies #
Hashable ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods hashWithSalt :: Int -> ListTaskDefinitionFamilies -> Int # hash :: ListTaskDefinitionFamilies -> Int #
ToJSON ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods toJSON :: ListTaskDefinitionFamilies -> Value # toEncoding :: ListTaskDefinitionFamilies -> Encoding # toJSONList :: [ListTaskDefinitionFamilies] -> Value # toEncodingList :: [ListTaskDefinitionFamilies] -> Encoding #
AWSPager ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods page :: ListTaskDefinitionFamilies -> Rs ListTaskDefinitionFamilies -> Maybe ListTaskDefinitionFamilies #
AWSRequest ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Associated Types type Rs ListTaskDefinitionFamilies :: Type # Methods request :: ListTaskDefinitionFamilies -> Request ListTaskDefinitionFamilies # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListTaskDefinitionFamilies -> ClientResponse -> m (Response ListTaskDefinitionFamilies) #
ToHeaders ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods toHeaders :: ListTaskDefinitionFamilies -> [Header] #
ToPath ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods toPath :: ListTaskDefinitionFamilies -> ByteString #
ToQuery ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods toQuery :: ListTaskDefinitionFamilies -> QueryString #
NFData ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods rnf :: ListTaskDefinitionFamilies -> () #
type Rep ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies type Rep ListTaskDefinitionFamilies = D1 (MetaData "ListTaskDefinitionFamilies" "Network.AWS.ECS.ListTaskDefinitionFamilies" "amazonka-ecs-1.6.1-L1UdJla9EUcK0wHkUmqs0y" False) (C1 (MetaCons "ListTaskDefinitionFamilies'" PrefixI True) ((S1 (MetaSel (Just "_ltdfStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TaskDefinitionFamilyStatus)) :: S1 (MetaSel (Just "_ltdfFamilyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ltdfNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ltdfMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))))
type Rs ListTaskDefinitionFamilies #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies type Rs ListTaskDefinitionFamilies = ListTaskDefinitionFamiliesResponse

Request Lenses

ltdfStatus :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus) #

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE , only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE , only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

ltdfFamilyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text) #

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies . If you specify a familyPrefix , only task definition family names that begin with the familyPrefix string are returned.

ltdfNextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text) #

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

ltdfMaxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int) #

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

Destructuring the Response

listTaskDefinitionFamiliesResponse #

Arguments

:: Int	`ltdfrsResponseStatus`
-> ListTaskDefinitionFamiliesResponse

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

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

ltdfrsFamilies - The list of task definition family names that match the ListTaskDefinitionFamilies request.
ltdfrsNextToken - The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies 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.
ltdfrsResponseStatus - -- | The response status code.

data ListTaskDefinitionFamiliesResponse #

See: listTaskDefinitionFamiliesResponse smart constructor.

Instances

Eq ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods (==) :: ListTaskDefinitionFamiliesResponse -> ListTaskDefinitionFamiliesResponse -> Bool # (/=) :: ListTaskDefinitionFamiliesResponse -> ListTaskDefinitionFamiliesResponse -> Bool #
Data ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListTaskDefinitionFamiliesResponse -> c ListTaskDefinitionFamiliesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListTaskDefinitionFamiliesResponse # toConstr :: ListTaskDefinitionFamiliesResponse -> Constr # dataTypeOf :: ListTaskDefinitionFamiliesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListTaskDefinitionFamiliesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListTaskDefinitionFamiliesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListTaskDefinitionFamiliesResponse -> ListTaskDefinitionFamiliesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListTaskDefinitionFamiliesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListTaskDefinitionFamiliesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListTaskDefinitionFamiliesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListTaskDefinitionFamiliesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamiliesResponse -> m ListTaskDefinitionFamiliesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamiliesResponse -> m ListTaskDefinitionFamiliesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListTaskDefinitionFamiliesResponse -> m ListTaskDefinitionFamiliesResponse #
Read ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods readsPrec :: Int -> ReadS ListTaskDefinitionFamiliesResponse # readList :: ReadS [ListTaskDefinitionFamiliesResponse] # readPrec :: ReadPrec ListTaskDefinitionFamiliesResponse # readListPrec :: ReadPrec [ListTaskDefinitionFamiliesResponse] #
Show ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods showsPrec :: Int -> ListTaskDefinitionFamiliesResponse -> ShowS # show :: ListTaskDefinitionFamiliesResponse -> String # showList :: [ListTaskDefinitionFamiliesResponse] -> ShowS #
Generic ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Associated Types type Rep ListTaskDefinitionFamiliesResponse :: Type -> Type # Methods from :: ListTaskDefinitionFamiliesResponse -> Rep ListTaskDefinitionFamiliesResponse x # to :: Rep ListTaskDefinitionFamiliesResponse x -> ListTaskDefinitionFamiliesResponse #
NFData ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies Methods rnf :: ListTaskDefinitionFamiliesResponse -> () #
type Rep ListTaskDefinitionFamiliesResponse #
Instance details Defined in Network.AWS.ECS.ListTaskDefinitionFamilies type Rep ListTaskDefinitionFamiliesResponse = D1 (MetaData "ListTaskDefinitionFamiliesResponse" "Network.AWS.ECS.ListTaskDefinitionFamilies" "amazonka-ecs-1.6.1-L1UdJla9EUcK0wHkUmqs0y" False) (C1 (MetaCons "ListTaskDefinitionFamiliesResponse'" PrefixI True) (S1 (MetaSel (Just "_ltdfrsFamilies") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 (MetaSel (Just "_ltdfrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_ltdfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

ltdfrsFamilies :: Lens' ListTaskDefinitionFamiliesResponse [Text] #

The list of task definition family names that match the ListTaskDefinitionFamilies request.

ltdfrsNextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text) #

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

ltdfrsResponseStatus :: Lens' ListTaskDefinitionFamiliesResponse Int #

- | The response status code.