class Aws::IoTThingsGraph::Types::SearchEntitiesRequest
@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, }
@!attribute [rw] entity_types
The entity types for which to search. @return [Array<String>]
@!attribute [rw] filters
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. @return [Array<Types::EntityFilter>]
@!attribute [rw] next_token
The string that specifies the next page of results. Use this when you're paginating results. @return [String]
@!attribute [rw] max_results
The maximum number of results to return in the response. @return [Integer]
@!attribute [rw] namespace_version
The version of the user's namespace. Defaults to the latest version of the user's namespace. @return [Integer]
Constants
- SENSITIVE