Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
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.
Synopsis
- data ListTaskDefinitions = ListTaskDefinitions' {}
- newListTaskDefinitions :: ListTaskDefinitions
- listTaskDefinitions_familyPrefix :: Lens' ListTaskDefinitions (Maybe Text)
- listTaskDefinitions_maxResults :: Lens' ListTaskDefinitions (Maybe Int)
- listTaskDefinitions_nextToken :: Lens' ListTaskDefinitions (Maybe Text)
- listTaskDefinitions_sort :: Lens' ListTaskDefinitions (Maybe SortOrder)
- listTaskDefinitions_status :: Lens' ListTaskDefinitions (Maybe TaskDefinitionStatus)
- data ListTaskDefinitionsResponse = ListTaskDefinitionsResponse' {
- nextToken :: Maybe Text
- taskDefinitionArns :: Maybe [Text]
- httpStatus :: Int
- newListTaskDefinitionsResponse :: Int -> ListTaskDefinitionsResponse
- listTaskDefinitionsResponse_nextToken :: Lens' ListTaskDefinitionsResponse (Maybe Text)
- listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text])
- listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int
Creating a Request
data ListTaskDefinitions Source #
See: newListTaskDefinitions
smart constructor.
ListTaskDefinitions' | |
|
Instances
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: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) Source #
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) Source #
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) 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 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) Source #
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 Source #
See: newListTaskDefinitionsResponse
smart constructor.
ListTaskDefinitionsResponse' | |
|
Instances
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:
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) 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.
listTaskDefinitionsResponse_taskDefinitionArns :: Lens' ListTaskDefinitionsResponse (Maybe [Text]) Source #
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions
request.
listTaskDefinitionsResponse_httpStatus :: Lens' ListTaskDefinitionsResponse Int Source #
The response's http status code.