:doc:`Braket <../../braket>` / Paginator / SearchDevices

*************
SearchDevices
*************



.. py:class:: Braket.Paginator.SearchDevices

  ::

    
    paginator = client.get_paginator('search_devices')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Braket.Client.search_devices`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/braket-2019-09-01/SearchDevices>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'name': 'string',
                  'values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: list
    :param filters: **[REQUIRED]** 

      Array of SearchDevicesFilter objects to use when searching for devices.

      

    
      - *(dict) --* 

        The filter used to search for devices.

        

      
        - **name** *(string) --* **[REQUIRED]** 

          The name of the device parameter to filter based on. Only ``deviceArn`` filter name is currently supported.

          

        
        - **values** *(list) --* **[REQUIRED]** 

          The values used to filter devices based on the filter name.

          

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

      
      ::

        {
            'devices': [
                {
                    'deviceArn': 'string',
                    'deviceName': 'string',
                    'providerName': 'string',
                    'deviceType': 'QPU'|'SIMULATOR',
                    'deviceStatus': 'ONLINE'|'OFFLINE'|'RETIRED'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **devices** *(list) --* 

          An array of ``DeviceSummary`` objects for devices that match the specified filter values.

          
          

          - *(dict) --* 

            Includes information about the device.

            
            

            - **deviceArn** *(string) --* 

              The ARN of the device.

              
            

            - **deviceName** *(string) --* 

              The name of the device.

              
            

            - **providerName** *(string) --* 

              The provider of the device.

              
            

            - **deviceType** *(string) --* 

              The type of the device.

              
            

            - **deviceStatus** *(string) --* 

              The status of the device.

              
        
      
        

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

          A token to resume pagination.

          
    