:doc:`Braket <../../braket>` / Client / search_devices

**************
search_devices
**************



.. py:method:: Braket.Client.search_devices(**kwargs)

  

  Searches for devices using the specified filters.

  

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


  **Request Syntax**
  ::

    response = client.search_devices(
        nextToken='string',
        maxResults=123,
        filters=[
            {
                'name': 'string',
                'values': [
                    'string',
                ]
            },
        ]
    )
    
  :type nextToken: string
  :param nextToken: 

    A token used for pagination of results returned in the response. Use the token returned from the previous request to continue search where the previous request ended.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in the response.

    

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

        
    
    

  
  :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 used for pagination of results, or null if there are no additional results. Use the token value in a subsequent request to continue search where the previous request ended.

        
  
  **Exceptions**
  
  *   :py:class:`Braket.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Braket.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Braket.Client.exceptions.InternalServiceException`

  
  *   :py:class:`Braket.Client.exceptions.ValidationException`

  