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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::ListTaskDefinitionsRequest

Defined in:

gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #family_prefix ⇒ String

  The full family name to filter the ListTaskDefinitions results with.

• #max_results ⇒ Integer

  The maximum number of task definition results that ListTaskDefinitions returned in paginated output.

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

• #sort ⇒ String

  The order to sort the results in.

• #status ⇒ String

  The task definition status to filter the ListTaskDefinitions results with.

Instance Attribute Details

#family_prefix ⇒ String

The full family name to filter the ListTaskDefinitions results with. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6292

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

#max_results ⇒ Integer

The maximum number of task definition results that ListTaskDefinitions returned 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 isn't used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Returns:

• (Integer)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6292

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

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

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.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6292

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

#sort ⇒ String

The order to sort the results in. 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. This is so that the newest task definitions in a family are listed first.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6292

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

#status ⇒ String

The task definition status to filter the ListTaskDefinitions results with. 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)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6292

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