Class: Aws::ECS::Types::ListTaskDefinitionFamiliesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::ListTaskDefinitionFamiliesRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ecs/types.rb
Overview
When making an API call, you may pass ListTaskDefinitionFamiliesRequest data as a 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 of `ListTaskDefinitionFamilies`.
-
#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 a previous paginated `ListTaskDefinitionFamilies` request where `maxResults` was used and the results exceeded the value of that parameter.
-
#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.
3008 3009 3010 3011 3012 3013 3014 |
# File 'lib/aws-sdk-ecs/types.rb', line 3008 class ListTaskDefinitionFamiliesRequest < Struct.new( :family_prefix, :status, :next_token, :max_results) include Aws::Structure end |
#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.
3008 3009 3010 3011 3012 3013 3014 |
# File 'lib/aws-sdk-ecs/types.rb', line 3008 class ListTaskDefinitionFamiliesRequest < Struct.new( :family_prefix, :status, :next_token, :max_results) include Aws::Structure end |
#next_token ⇒ String
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.
<note markdown=“1”> 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.
</note>
3008 3009 3010 3011 3012 3013 3014 |
# File 'lib/aws-sdk-ecs/types.rb', line 3008 class ListTaskDefinitionFamiliesRequest < Struct.new( :family_prefix, :status, :next_token, :max_results) include Aws::Structure end |
#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.
3008 3009 3010 3011 3012 3013 3014 |
# File 'lib/aws-sdk-ecs/types.rb', line 3008 class ListTaskDefinitionFamiliesRequest < Struct.new( :family_prefix, :status, :next_token, :max_results) include Aws::Structure end |