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 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.
- listTaskDefinitionFamilies :: ListTaskDefinitionFamilies
- data ListTaskDefinitionFamilies
- ltdfStatus :: Lens' ListTaskDefinitionFamilies (Maybe TaskDefinitionFamilyStatus)
- ltdfFamilyPrefix :: Lens' ListTaskDefinitionFamilies (Maybe Text)
- ltdfNextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text)
- ltdfMaxResults :: Lens' ListTaskDefinitionFamilies (Maybe Int)
- listTaskDefinitionFamiliesResponse :: Int -> ListTaskDefinitionFamiliesResponse
- data ListTaskDefinitionFamiliesResponse
- ltdfrsFamilies :: Lens' ListTaskDefinitionFamiliesResponse [Text]
- ltdfrsNextToken :: Lens' ListTaskDefinitionFamiliesResponse (Maybe Text)
- ltdfrsResponseStatus :: Lens' ListTaskDefinitionFamiliesResponse Int
Creating a Request
listTaskDefinitionFamilies :: ListTaskDefinitionFamilies Source #
Creates a value of ListTaskDefinitionFamilies
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTaskDefinitionFamilies Source #
See: listTaskDefinitionFamilies
smart constructor.
Request Lenses
ltdfStatus :: 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.
ltdfFamilyPrefix :: 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.
ltdfNextToken :: Lens' ListTaskDefinitionFamilies (Maybe Text) Source #
The nextToken
value returned from a previous paginated ListTaskDefinitionFamilies
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.
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.
ltdfMaxResults :: 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
listTaskDefinitionFamiliesResponse Source #
Creates a value of ListTaskDefinitionFamiliesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data ListTaskDefinitionFamiliesResponse Source #
See: listTaskDefinitionFamiliesResponse
smart constructor.
Response Lenses
ltdfrsFamilies :: Lens' ListTaskDefinitionFamiliesResponse [Text] Source #
The list of task definition family names that match the ListTaskDefinitionFamilies
request.
ltdfrsNextToken :: 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.
ltdfrsResponseStatus :: Lens' ListTaskDefinitionFamiliesResponse Int Source #
The response status code.