Skip to content

SearchEntitiesRequest

Source code in docs_src/capo_iotthingsgraph/types/search_entities_request.py 
17
18
19
20
21
22
23
24
25
26
27
class SearchEntitiesRequest(TypedDict, closed=True):
    entity_types: "capo_iotthingsgraph.types.entity_types.EntityTypes"
    """<p>The entity types for which to search.</p>"""
    filters: NotRequired["capo_iotthingsgraph.types.entity_filters.EntityFilters"]
    """<p>Optional filter to apply to the search. Valid filters are <code>NAME</code> <code>NAMESPACE</code>, <code>SEMANTIC_TYPE_PATH</code> and <code>REFERENCED_ENTITY_ID</code>. <code>REFERENCED_ENTITY_ID</code> 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.</p> <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>"""
    next_token: NotRequired["capo_iotthingsgraph.types.next_token.NextToken"]
    """<p>The string that specifies the next page of results. Use this when you're paginating results.</p>"""
    max_results: NotRequired["capo_iotthingsgraph.types.max_results.MaxResults"]
    """<p>The maximum number of results to return in the response.</p>"""
    namespace_version: NotRequired["capo_iotthingsgraph.types.version.Version"]
    """<p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>"""

entity_types instance-attribute 

entity_types: EntityTypes

The entity types for which to search.

filters instance-attribute 

filters: NotRequired[EntityFilters]

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.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of results to return in the response.

namespace_version instance-attribute 

namespace_version: NotRequired[Version]

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

next_token instance-attribute 

next_token: NotRequired[NextToken]

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