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

*********************
SearchSystemInstances
*********************



.. py:class:: IoTThingsGraph.Paginator.SearchSystemInstances

  ::

    
    paginator = client.get_paginator('search_system_instances')

  
  

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

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

    .. 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/SearchSystemInstances>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'name': 'SYSTEM_TEMPLATE_ID'|'STATUS'|'GREENGRASS_GROUP_NAME',
                  'value': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: list
    :param filters: 

      Optional filter to apply to the search. Valid filters are ``SYSTEM_TEMPLATE_ID``, ``STATUS``, and ``GREENGRASS_GROUP_NAME``.

       

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

      

    
      - *(dict) --* 

        An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.

        

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

          The name of the search filter field.

          

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

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

          

        
          - *(string) --* 

          
      
      
  
    :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**

      
      ::

        {
            'summaries': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'status': 'NOT_DEPLOYED'|'BOOTSTRAP'|'DEPLOY_IN_PROGRESS'|'DEPLOYED_IN_TARGET'|'UNDEPLOY_IN_PROGRESS'|'FAILED'|'PENDING_DELETE'|'DELETED_IN_TARGET',
                    'target': 'GREENGRASS'|'CLOUD',
                    'greengrassGroupName': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'greengrassGroupId': 'string',
                    'greengrassGroupVersionId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **summaries** *(list) --* 

          An array of objects that contain summary data abour the system instances in the result set.

          
          

          - *(dict) --* 

            An object that contains summary information about a system instance.

            
            

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

              The ID of the system instance.

              
            

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

              The ARN of the system instance.

              
            

            - **status** *(string) --* 

              The status of the system instance.

              
            

            - **target** *(string) --* 

              The target of the system instance.

              
            

            - **greengrassGroupName** *(string) --* 

              The ID of the Greengrass group where the system instance is deployed.

              
            

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

              The date when the system instance was created.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time when the system instance was last updated.

              
            

            - **greengrassGroupId** *(string) --* 

              The ID of the Greengrass group where the system instance is deployed.

              
            

            - **greengrassGroupVersionId** *(string) --* 

              The version of the Greengrass group where the system instance is deployed.

              
        
      
        

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

          A token to resume pagination.

          
    