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