Class: Aws::IoTThingsGraph::Types::SearchThingsRequest

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

Overview

Note:

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

{
  entity_id: "Urn", # required
  next_token: "NextToken",
  max_results: 1,
  namespace_version: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_idString

The ID of the entity to which the things are associated.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Returns:

  • (String)


1548
1549
1550
1551
1552
1553
1554
1555
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1548

class SearchThingsRequest < Struct.new(
  :entity_id,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in the response.

Returns:

  • (Integer)


1548
1549
1550
1551
1552
1553
1554
1555
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1548

class SearchThingsRequest < Struct.new(
  :entity_id,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_versionInteger

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Returns:

  • (Integer)


1548
1549
1550
1551
1552
1553
1554
1555
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1548

class SearchThingsRequest < Struct.new(
  :entity_id,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The string that specifies the next page of results. Use this when you're paginating results.

Returns:

  • (String)


1548
1549
1550
1551
1552
1553
1554
1555
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1548

class SearchThingsRequest < Struct.new(
  :entity_id,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end