libZSservicesZSamazonka-ecsZSamazonka-ecs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECS.ListTaskDefinitions

Description

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.

Synopsis

Creating a Request

data ListTaskDefinitions Source #

See: newListTaskDefinitions smart constructor.

Constructors

ListTaskDefinitions' 

Fields

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

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

  • nextToken :: Maybe Text

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

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

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

Instances

Instances details
Eq ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Read ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Show ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Generic ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type Rep ListTaskDefinitions :: Type -> Type #

NFData ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

rnf :: ListTaskDefinitions -> () #

Hashable ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

ToJSON ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

AWSPager ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

AWSRequest ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type AWSResponse ListTaskDefinitions #

ToHeaders ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

ToPath ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

ToQuery ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitions = D1 ('MetaData "ListTaskDefinitions" "Amazonka.ECS.ListTaskDefinitions" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListTaskDefinitions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionStatus)) :*: S1 ('MetaSel ('Just "familyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))
type AWSResponse ListTaskDefinitions Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

newListTaskDefinitions :: ListTaskDefinitions Source #

Create a value of ListTaskDefinitions 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:ListTaskDefinitions', listTaskDefinitions_status - 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.

$sel:familyPrefix:ListTaskDefinitions', listTaskDefinitions_familyPrefix - 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.

$sel:nextToken:ListTaskDefinitions', listTaskDefinitions_nextToken - The nextToken value returned from a ListTaskDefinitions 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:sort:ListTaskDefinitions', listTaskDefinitions_sort - 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.

$sel:maxResults:ListTaskDefinitions', listTaskDefinitions_maxResults - 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.

Request Lenses

listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus) Source #

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.

listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text) Source #

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.

listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (Maybe Text) Source #

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

listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder) Source #

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.

listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int) Source #

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

data ListTaskDefinitionsResponse Source #

See: newListTaskDefinitionsResponse smart constructor.

Constructors

ListTaskDefinitionsResponse' 

Fields

  • taskDefinitionArns :: Maybe [Text]

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

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Read ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Show ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Generic ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type Rep ListTaskDefinitionsResponse :: Type -> Type #

NFData ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitionsResponse Source # 
Instance details

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitionsResponse = D1 ('MetaData "ListTaskDefinitionsResponse" "Amazonka.ECS.ListTaskDefinitions" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "ListTaskDefinitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskDefinitionArns") '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))))

newListTaskDefinitionsResponse Source #

Create a value of ListTaskDefinitionsResponse 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:taskDefinitionArns:ListTaskDefinitionsResponse', listTaskDefinitionsResponse_taskDefinitionArns - The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

$sel:nextToken:ListTaskDefinitions', listTaskDefinitionsResponse_nextToken - 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.

$sel:httpStatus:ListTaskDefinitionsResponse', listTaskDefinitionsResponse_httpStatus - The response's http status code.

Response Lenses

listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text]) Source #

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

listTaskDefinitionsResponse_nextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text) Source #

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.