Copyright	(c) 2013-2021 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

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

Synopsis

Creating a Request

data ListTaskDefinitionFamilies Source #

See: newListTaskDefinitionFamilies smart constructor.

Constructors

ListTaskDefinitionFamilies'

Fields

status :: 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.
familyPrefix :: 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.
nextToken :: Maybe Text
The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
maxResults :: 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.

Instances

Instances details

Eq ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods (==) :: ListTaskDefinitionFamilies -> ListTaskDefinitionFamilies -> Bool # (/=) :: ListTaskDefinitionFamilies -> ListTaskDefinitionFamilies -> Bool #
Read ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods readsPrec :: Int -> ReadS ListTaskDefinitionFamilies # readList :: ReadS [ListTaskDefinitionFamilies] # readPrec :: ReadPrec ListTaskDefinitionFamilies # readListPrec :: ReadPrec [ListTaskDefinitionFamilies] #
Show ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods showsPrec :: Int -> ListTaskDefinitionFamilies -> ShowS # show :: ListTaskDefinitionFamilies -> String # showList :: [ListTaskDefinitionFamilies] -> ShowS #
Generic ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Associated Types type Rep ListTaskDefinitionFamilies :: Type -> Type # Methods from :: ListTaskDefinitionFamilies -> Rep ListTaskDefinitionFamilies x # to :: Rep ListTaskDefinitionFamilies x -> ListTaskDefinitionFamilies #
NFData ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods rnf :: ListTaskDefinitionFamilies -> () #
Hashable ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods hashWithSalt :: Int -> ListTaskDefinitionFamilies -> Int # hash :: ListTaskDefinitionFamilies -> Int #
ToJSON ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods toJSON :: ListTaskDefinitionFamilies -> Value # toEncoding :: ListTaskDefinitionFamilies -> Encoding # toJSONList :: [ListTaskDefinitionFamilies] -> Value # toEncodingList :: [ListTaskDefinitionFamilies] -> Encoding #
AWSPager ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods page :: ListTaskDefinitionFamilies -> AWSResponse ListTaskDefinitionFamilies -> Maybe ListTaskDefinitionFamilies #
AWSRequest ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Associated Types type AWSResponse ListTaskDefinitionFamilies # Methods request :: ListTaskDefinitionFamilies -> Request ListTaskDefinitionFamilies # response :: MonadResource m => Logger -> Service -> Proxy ListTaskDefinitionFamilies -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTaskDefinitionFamilies))) #
ToHeaders ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods toHeaders :: ListTaskDefinitionFamilies -> [Header] #
ToPath ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods toPath :: ListTaskDefinitionFamilies -> ByteString #
ToQuery ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods toQuery :: ListTaskDefinitionFamilies -> QueryString #
type Rep ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies type Rep ListTaskDefinitionFamilies = D1 ('MetaData "ListTaskDefinitionFamilies" "Amazonka.ECS.ListTaskDefinitionFamilies" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListTaskDefinitionFamilies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionFamilyStatus)) :: S1 ('MetaSel ('Just "familyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse ListTaskDefinitionFamilies Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies type AWSResponse ListTaskDefinitionFamilies = ListTaskDefinitionFamiliesResponse

newListTaskDefinitionFamilies :: ListTaskDefinitionFamilies Source #

Create a value of ListTaskDefinitionFamilies with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_status - 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.

$sel:familyPrefix:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_familyPrefix - 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.

$sel:nextToken:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_nextToken - The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

$sel:maxResults:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_maxResults - 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.

Request Lenses

listTaskDefinitionFamilies_status :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus) Source #

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.

listTaskDefinitionFamilies_familyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text) Source #

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.

listTaskDefinitionFamilies_nextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text) Source #

The nextToken value returned from a ListTaskDefinitionFamilies request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

listTaskDefinitionFamilies_maxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int) Source #

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

data ListTaskDefinitionFamiliesResponse Source #

See: newListTaskDefinitionFamiliesResponse smart constructor.

Constructors

ListTaskDefinitionFamiliesResponse'

Fields

families :: Maybe [Text]
The list of task definition family names that match the ListTaskDefinitionFamilies request.
nextToken :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods (==) :: ListTaskDefinitionFamiliesResponse -> ListTaskDefinitionFamiliesResponse -> Bool # (/=) :: ListTaskDefinitionFamiliesResponse -> ListTaskDefinitionFamiliesResponse -> Bool #
Read ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods readsPrec :: Int -> ReadS ListTaskDefinitionFamiliesResponse # readList :: ReadS [ListTaskDefinitionFamiliesResponse] # readPrec :: ReadPrec ListTaskDefinitionFamiliesResponse # readListPrec :: ReadPrec [ListTaskDefinitionFamiliesResponse] #
Show ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods showsPrec :: Int -> ListTaskDefinitionFamiliesResponse -> ShowS # show :: ListTaskDefinitionFamiliesResponse -> String # showList :: [ListTaskDefinitionFamiliesResponse] -> ShowS #
Generic ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Associated Types type Rep ListTaskDefinitionFamiliesResponse :: Type -> Type # Methods from :: ListTaskDefinitionFamiliesResponse -> Rep ListTaskDefinitionFamiliesResponse x # to :: Rep ListTaskDefinitionFamiliesResponse x -> ListTaskDefinitionFamiliesResponse #
NFData ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies Methods rnf :: ListTaskDefinitionFamiliesResponse -> () #
type Rep ListTaskDefinitionFamiliesResponse Source #
Instance details Defined in Amazonka.ECS.ListTaskDefinitionFamilies type Rep ListTaskDefinitionFamiliesResponse = D1 ('MetaData "ListTaskDefinitionFamiliesResponse" "Amazonka.ECS.ListTaskDefinitionFamilies" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListTaskDefinitionFamiliesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "families") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTaskDefinitionFamiliesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListTaskDefinitionFamiliesResponse'`
-> ListTaskDefinitionFamiliesResponse

Create a value of ListTaskDefinitionFamiliesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:families:ListTaskDefinitionFamiliesResponse', listTaskDefinitionFamiliesResponse_families - The list of task definition family names that match the ListTaskDefinitionFamilies request.

$sel:nextToken:ListTaskDefinitionFamilies', listTaskDefinitionFamiliesResponse_nextToken - 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.

$sel:httpStatus:ListTaskDefinitionFamiliesResponse', listTaskDefinitionFamiliesResponse_httpStatus - The response's http status code.

Response Lenses

listTaskDefinitionFamiliesResponse_families :: Lens' ListTaskDefinitionFamiliesResponse (Maybe [Text]) Source #

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

listTaskDefinitionFamiliesResponse_nextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text) Source #

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.

listTaskDefinitionFamiliesResponse_httpStatus :: Lens' ListTaskDefinitionFamiliesResponse Int Source #

The response's http status code.