Class: Aws::IoT::Types::ListThingsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  next_token: "NextToken",
  max_results: 1,
  attribute_name: "AttributeName",
  attribute_value: "AttributeValue",
  thing_type_name: "ThingTypeName",
  use_prefix_attribute_value: false,
}

The input for the ListThings operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The attribute name used to search for things.

Returns:

  • (String)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_valueString

The attribute value used to search for things.

Returns:

  • (String)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in this operation.

Returns:

  • (Integer)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

  • (String)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#thing_type_nameString

The name of the thing type used to search for things.

Returns:

  • (String)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end

#use_prefix_attribute_valueBoolean

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

Returns:

  • (Boolean)


13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 13384

class ListThingsRequest < Struct.new(
  :next_token,
  :max_results,
  :attribute_name,
  :attribute_value,
  :thing_type_name,
  :use_prefix_attribute_value)
  SENSITIVE = []
  include Aws::Structure
end