Class: Aws::IoTThingsGraph::Types::SearchEntitiesRequest

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

{
  entity_types: ["DEVICE"], # required, accepts DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM
  filters: [
    {
      name: "NAME", # accepts NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID
      value: ["EntityFilterValue"],
    },
  ],
  next_token: "NextToken",
  max_results: 1,
  namespace_version: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_typesArray<String>

The entity types for which to search.

Returns:

  • (Array<String>)


1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1262

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

#filtersArray<Types::EntityFilter>

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Returns:



1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1262

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :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)


1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1262

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :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)


1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1262

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :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)


1262
1263
1264
1265
1266
1267
1268
1269
1270
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 1262

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