You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ECS::Types::ListTaskDefinitionFamiliesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListTaskDefinitionFamiliesRequest
- Defined in:
- (unknown)
Overview
When passing ListTaskDefinitionFamiliesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
family_prefix: "String",
status: "ACTIVE", # accepts ACTIVE, INACTIVE, ALL
next_token: "String",
max_results: 1,
}
Instance Attribute Summary collapse
-
#family_prefix ⇒ String
The
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. -
#max_results ⇒ Integer
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies
in paginated output. -
#next_token ⇒ String
The
nextToken
value returned from aListTaskDefinitionFamilies
request indicating that more results are available to fulfill the request and further calls will be needed. -
#status ⇒ String
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results.
Instance Attribute Details
#family_prefix ⇒ String
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.
#max_results ⇒ Integer
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.
#next_token ⇒ String
The nextToken
value returned from a ListTaskDefinitionFamilies
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
.
#status ⇒ String
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.
Possible values:
- ACTIVE
- INACTIVE
- ALL