:doc:`IoTThingsGraph <../../iotthingsgraph>` / Paginator / SearchEntities

**************
SearchEntities
**************



.. py:class:: IoTThingsGraph.Paginator.SearchEntities

  ::

    
    paginator = client.get_paginator('search_entities')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTThingsGraph.Client.search_entities`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph-2018-09-06/SearchEntities>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          entityTypes=[
              'DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM',
          ],
          filters=[
              {
                  'name': 'NAME'|'NAMESPACE'|'SEMANTIC_TYPE_PATH'|'REFERENCED_ENTITY_ID',
                  'value': [
                      'string',
                  ]
              },
          ],
          namespaceVersion=123,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type entityTypes: list
    :param entityTypes: **[REQUIRED]** 

      The entity types for which to search.

      

    
      - *(string) --* 

      
  
    :type filters: list
    :param 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.

      

    
      - *(dict) --* 

        An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a ``NAMESPACE`` and a ``REFERENCED_ENTITY_ID`` filter searches for entities in the specified namespace that use the entity specified by the value of ``REFERENCED_ENTITY_ID``.

        

      
        - **name** *(string) --* 

          The name of the entity search filter field. ``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.

          

        
        - **value** *(list) --* 

          An array of string values for the search filter field. Multiple values function as AND criteria in the search.

          

        
          - *(string) --* 

          
      
      
  
    :type namespaceVersion: integer
    :param namespaceVersion: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'descriptions': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'type': 'DEVICE'|'SERVICE'|'DEVICE_MODEL'|'CAPABILITY'|'STATE'|'ACTION'|'EVENT'|'PROPERTY'|'MAPPING'|'ENUM',
                    'createdAt': datetime(2015, 1, 1),
                    'definition': {
                        'language': 'GRAPHQL',
                        'text': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **descriptions** *(list) --* 

          An array of descriptions for each entity returned in the search result.

          
          

          - *(dict) --* 

            Describes the properties of an entity.

            
            

            - **id** *(string) --* 

              The entity ID.

              
            

            - **arn** *(string) --* 

              The entity ARN.

              
            

            - **type** *(string) --* 

              The entity type.

              
            

            - **createdAt** *(datetime) --* 

              The time at which the entity was created.

              
            

            - **definition** *(dict) --* 

              The definition document of the entity.

              
              

              - **language** *(string) --* 

                The language used to define the entity. ``GRAPHQL`` is the only valid value.

                
              

              - **text** *(string) --* 

                The GraphQL text that defines the entity.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    