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

data ListTaskDefinitions

See: newListTaskDefinitions smart constructor.

Constructors

ListTaskDefinitions'

Fields

• familyPrefix :: Maybe Text

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

• maxResults :: Maybe Int

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

• 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 to sort the results in. 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. This is so that the newest task definitions in a family are listed first.

• status :: Maybe TaskDefinitionStatus

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

Instances

ToJSON ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

toJSON :: ListTaskDefinitions -> Value

toEncoding :: ListTaskDefinitions -> Encoding

toJSONList :: [ListTaskDefinitions] -> Value

toEncodingList :: [ListTaskDefinitions] -> Encoding

ToHeaders ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

toHeaders :: ListTaskDefinitions -> [Header]

ToPath ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

toPath :: ListTaskDefinitions -> ByteString

ToQuery ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

toQuery :: ListTaskDefinitions -> QueryString

AWSPager ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

page :: ListTaskDefinitions -> AWSResponse ListTaskDefinitions -> Maybe ListTaskDefinitions

AWSRequest ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type AWSResponse ListTaskDefinitions

Methods

request :: (Service -> Service) -> ListTaskDefinitions -> Request ListTaskDefinitions

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListTaskDefinitions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListTaskDefinitions)))

Generic ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type Rep ListTaskDefinitions :: Type -> Type

Methods

from :: ListTaskDefinitions -> Rep ListTaskDefinitions x

to :: Rep ListTaskDefinitions x -> ListTaskDefinitions

Read ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

readsPrec :: Int -> ReadS ListTaskDefinitions

readList :: ReadS [ListTaskDefinitions]

readPrec :: ReadPrec ListTaskDefinitions

readListPrec :: ReadPrec [ListTaskDefinitions]

Show ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

showsPrec :: Int -> ListTaskDefinitions -> ShowS

show :: ListTaskDefinitions -> String

showList :: [ListTaskDefinitions] -> ShowS

NFData ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

rnf :: ListTaskDefinitions -> ()

Eq ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

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

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

Hashable ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

hashWithSalt :: Int -> ListTaskDefinitions -> Int

hash :: ListTaskDefinitions -> Int

type AWSResponse ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

type AWSResponse ListTaskDefinitions = ListTaskDefinitionsResponse

type Rep ListTaskDefinitions

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitions = D1 ('MetaData "ListTaskDefinitions" "Amazonka.ECS.ListTaskDefinitions" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListTaskDefinitions'" '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 "sort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinitionStatus))))))

newListTaskDefinitions :: ListTaskDefinitions

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:familyPrefix:ListTaskDefinitions', listTaskDefinitions_familyPrefix - The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

$sel:maxResults:ListTaskDefinitions', listTaskDefinitions_maxResults - The maximum number of task definition results that ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

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 to sort the results in. 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. This is so that the newest task definitions in a family are listed first.

ListTaskDefinitions, listTaskDefinitions_status - The task definition status to filter the ListTaskDefinitions results with. 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.

Request Lenses

listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text)

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

listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int)

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

listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (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.

listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder)

The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first.

listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)

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

Destructuring the Response

data ListTaskDefinitionsResponse

See: newListTaskDefinitionsResponse smart constructor.

Constructors

ListTaskDefinitionsResponse'

Fields

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

• taskDefinitionArns :: Maybe [Text]

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

Associated Types

type Rep ListTaskDefinitionsResponse :: Type -> Type

Methods

from :: ListTaskDefinitionsResponse -> Rep ListTaskDefinitionsResponse x

to :: Rep ListTaskDefinitionsResponse x -> ListTaskDefinitionsResponse

Read ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

readsPrec :: Int -> ReadS ListTaskDefinitionsResponse

readList :: ReadS [ListTaskDefinitionsResponse]

readPrec :: ReadPrec ListTaskDefinitionsResponse

readListPrec :: ReadPrec [ListTaskDefinitionsResponse]

Show ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

showsPrec :: Int -> ListTaskDefinitionsResponse -> ShowS

show :: ListTaskDefinitionsResponse -> String

showList :: [ListTaskDefinitionsResponse] -> ShowS

NFData ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

rnf :: ListTaskDefinitionsResponse -> ()

Eq ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

Methods

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

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

type Rep ListTaskDefinitionsResponse

Defined in Amazonka.ECS.ListTaskDefinitions

type Rep ListTaskDefinitionsResponse = D1 ('MetaData "ListTaskDefinitionsResponse" "Amazonka.ECS.ListTaskDefinitions" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "ListTaskDefinitionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskDefinitionArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListTaskDefinitionsResponse

Arguments

:: Int

$sel:httpStatus:ListTaskDefinitionsResponse'

-> ListTaskDefinitionsResponse

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:

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

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

Response Lenses

listTaskDefinitionsResponse_nextToken :: 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.

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

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

listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int

The response's http status code.