Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- listTaskDefinitions :: ListTaskDefinitions
- data ListTaskDefinitions
- ltdStatus :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)
- ltdFamilyPrefix :: Lens' ListTaskDefinitions (Maybe Text)
- ltdNextToken :: Lens' ListTaskDefinitions (Maybe Text)
- ltdSort :: Lens' ListTaskDefinitions (Maybe SortOrder)
- ltdMaxResults :: Lens' ListTaskDefinitions (Maybe Int)
- listTaskDefinitionsResponse :: Int -> ListTaskDefinitionsResponse
- data ListTaskDefinitionsResponse
- ltdrsTaskDefinitionARNs :: Lens' ListTaskDefinitionsResponse [Text]
- ltdrsNextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text)
- ltdrsResponseStatus :: Lens' ListTaskDefinitionsResponse Int
Creating a Request
listTaskDefinitions :: ListTaskDefinitions Source #
Creates a value of ListTaskDefinitions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltdStatus
- The task definition status with which to filter theListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.ltdFamilyPrefix
- The full family name with which to filter theListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family.ltdNextToken
- ThenextToken
value returned from a previous paginatedListTaskDefinitions
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
when there are no more results to return.ltdSort
- The order in which to sort the results. Valid values areASC
andDESC
. 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 toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.ltdMaxResults
- The maximum number of task definition results returned byListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable.
data ListTaskDefinitions Source #
See: listTaskDefinitions
smart constructor.
Request Lenses
ltdStatus :: 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.
ltdFamilyPrefix :: 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.
ltdNextToken :: Lens' ListTaskDefinitions (Maybe Text) Source #
The nextToken
value returned from a previous paginated ListTaskDefinitions
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. This value is null
when there are no more results to return.
ltdSort :: 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.
ltdMaxResults :: 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
listTaskDefinitionsResponse Source #
Creates a value of ListTaskDefinitionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltdrsTaskDefinitionARNs
- The list of task definition Amazon Resource Name (ARN) entries for theListTaskDefinitions
request.ltdrsNextToken
- ThenextToken
value to include in a futureListTaskDefinitions
request. When the results of aListTaskDefinitions
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.ltdrsResponseStatus
- -- | The response status code.
data ListTaskDefinitionsResponse Source #
See: listTaskDefinitionsResponse
smart constructor.
Response Lenses
ltdrsTaskDefinitionARNs :: Lens' ListTaskDefinitionsResponse [Text] Source #
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
request.
ltdrsNextToken :: 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.
ltdrsResponseStatus :: Lens' ListTaskDefinitionsResponse Int Source #
- - | The response status code.