Class: Aws::ECS::Types::ListAttributesRequest

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 ListAttributesRequest data as a hash:

{
  cluster: "String",
  target_type: "container-instance", # required, accepts container-instance
  attribute_name: "String",
  attribute_value: "String",
  next_token: "String",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

The name of the attribute with which to filter the results.

Returns:

  • (String) 


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end

#attribute_value ⇒ String

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Returns:

  • (String) 


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end

#cluster ⇒ String

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String) 


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of cluster results returned by ‘ListAttributes` in paginated output. When this parameter is used, `ListAttributes` 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 `ListAttributes` request with the returned `nextToken` value. This value can be between 1 and 100. If this parameter is not used, then `ListAttributes` returns up to 100 results and a `nextToken` value if applicable.

Returns:

  • (Integer) 


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_token ⇒ String

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


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end

#target_type ⇒ String

The type of the target with which to list attributes.

Returns:

  • (String) 


2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/aws-sdk-ecs/types.rb', line 2614

class ListAttributesRequest < Struct.new(
  :cluster,
  :target_type,
  :attribute_name,
  :attribute_value,
  :next_token,
  :max_results)
  include Aws::Structure
end