amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.ListTaskDefinitionFamilies

Description

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don't 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

  • familyPrefix :: Maybe Text

    The familyPrefix is a string that's 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.

  • maxResults :: Maybe Int

    The maximum number of task definition family results that ListTaskDefinitionFamilies returned 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 isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

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

  • status :: Maybe TaskDefinitionFamilyStatus

    The task definition family status to filter the ListTaskDefinitionFamilies results with. 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.

Instances

Instances details
ToJSON ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

ToHeaders ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

ToPath ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

ToQuery ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

AWSPager ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

AWSRequest ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Generic ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Associated Types

type Rep ListTaskDefinitionFamilies :: Type -> Type #

Read ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Show ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

NFData ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Eq ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Hashable ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

type AWSResponse ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

type Rep ListTaskDefinitionFamilies Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

type Rep ListTaskDefinitionFamilies = D1 ('MetaData "ListTaskDefinitionFamilies" "Amazonka.ECS.ListTaskDefinitionFamilies" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListTaskDefinitionFamilies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "familyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionFamilyStatus)))))

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:familyPrefix:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_familyPrefix - The familyPrefix is a string that's 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:maxResults:ListTaskDefinitionFamilies', listTaskDefinitionFamilies_maxResults - The maximum number of task definition family results that ListTaskDefinitionFamilies returned 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 isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

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.

ListTaskDefinitionFamilies, listTaskDefinitionFamilies_status - The task definition family status to filter the ListTaskDefinitionFamilies results with. 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.

Request Lenses

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

The familyPrefix is a string that's 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_maxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int) Source #

The maximum number of task definition family results that ListTaskDefinitionFamilies returned 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 isn't used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

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_status :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus) Source #

The task definition family status to filter the ListTaskDefinitionFamilies results with. 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.

Destructuring the Response

data ListTaskDefinitionFamiliesResponse Source #

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
Generic ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Associated Types

type Rep ListTaskDefinitionFamiliesResponse :: Type -> Type #

Read ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Show ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

NFData ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

Eq ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

type Rep ListTaskDefinitionFamiliesResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitionFamilies

type Rep ListTaskDefinitionFamiliesResponse = D1 ('MetaData "ListTaskDefinitionFamiliesResponse" "Amazonka.ECS.ListTaskDefinitionFamilies" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" '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 #

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.

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.