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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

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

Returns:

  • (String)


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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

#attribute_valueString

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

Returns:

  • (String)


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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

#clusterString

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)


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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

#max_resultsInteger

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)


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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

#next_tokenString

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


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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

#target_typeString

The type of the target with which to list attributes.

Returns:

  • (String)


5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 5324

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