Class: Aws::ECS::Types::ListTaskDefinitionsRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass ListTaskDefinitionsRequest data as a hash:

{
  family_prefix: "String",
  status: "ACTIVE", # accepts ACTIVE, INACTIVE
  sort: "ASC", # accepts ASC, DESC
  next_token: "String",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


3797
3798
3799
3800
3801
3802
3803
3804
 
# File 'lib/aws-sdk-ecs/types.rb', line 3797

class ListTaskDefinitionsRequest < Struct.new(
  :family_prefix,
  :status,
  :sort,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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.

Returns:

  • (Integer) 


3797
3798
3799
3800
3801
3802
3803
3804
 
# File 'lib/aws-sdk-ecs/types.rb', line 3797

class ListTaskDefinitionsRequest < Struct.new(
  :family_prefix,
  :status,
  :sort,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

The ‘nextToken` value returned from a previous paginated `ListTaskDefinitions` 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>

Returns:

  • (String) 


3797
3798
3799
3800
3801
3802
3803
3804
 
# File 'lib/aws-sdk-ecs/types.rb', line 3797

class ListTaskDefinitionsRequest < Struct.new(
  :family_prefix,
  :status,
  :sort,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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.

Returns:

  • (String) 


3797
3798
3799
3800
3801
3802
3803
3804
 
# File 'lib/aws-sdk-ecs/types.rb', line 3797

class ListTaskDefinitionsRequest < Struct.new(
  :family_prefix,
  :status,
  :sort,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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.

Returns:

  • (String) 


3797
3798
3799
3800
3801
3802
3803
3804
 
# File 'lib/aws-sdk-ecs/types.rb', line 3797

class ListTaskDefinitionsRequest < Struct.new(
  :family_prefix,
  :status,
  :sort,
  :next_token,
  :max_results)
  include Aws::Structure
end