public static interface ListTaskDefinitionFamiliesRequest.Builder extends ECSRequest.Builder, CopyableBuilder<ListTaskDefinitionFamiliesRequest.Builder,ListTaskDefinitionFamiliesRequest>
Modifier and Type | Method and Description |
---|---|
ListTaskDefinitionFamiliesRequest.Builder |
familyPrefix(String familyPrefix)
The
familyPrefix is a string that is used to filter the results of
ListTaskDefinitionFamilies . |
ListTaskDefinitionFamiliesRequest.Builder |
maxResults(Integer maxResults)
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies in
paginated output. |
ListTaskDefinitionFamiliesRequest.Builder |
nextToken(String nextToken)
The
nextToken value returned from a previous paginated ListTaskDefinitionFamilies
request where maxResults was used and the results exceeded the value of that parameter. |
ListTaskDefinitionFamiliesRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
ListTaskDefinitionFamiliesRequest.Builder |
status(String status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies results. |
ListTaskDefinitionFamiliesRequest.Builder |
status(TaskDefinitionFamilyStatus status)
The task definition family status with which to filter the
ListTaskDefinitionFamilies results. |
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
ListTaskDefinitionFamiliesRequest.Builder familyPrefix(String familyPrefix)
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.
familyPrefix
- 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.ListTaskDefinitionFamiliesRequest.Builder status(String status)
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.
status
- 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.TaskDefinitionFamilyStatus
,
TaskDefinitionFamilyStatus
ListTaskDefinitionFamiliesRequest.Builder status(TaskDefinitionFamilyStatus status)
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.
status
- 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.TaskDefinitionFamilyStatus
,
TaskDefinitionFamilyStatus
ListTaskDefinitionFamiliesRequest.Builder nextToken(String nextToken)
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.
nextToken
- 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.
ListTaskDefinitionFamiliesRequest.Builder maxResults(Integer maxResults)
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.
maxResults
- 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.ListTaskDefinitionFamiliesRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.