Braket / Client / search_devices

search_devices

Braket.Client.search_devices(**kwargs)

Searches for devices using the specified filters.

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (list) –

  [REQUIRED]

  The filter values to use to search for a device.

  • (dict) –

    The filter to use for searching devices.

    • name (string) – [REQUIRED]

      The name to use to filter results.

    • values (list) – [REQUIRED]

      The values to use to filter results.

      • (string) –

• maxResults (integer) – The maximum number of results to return in the response.

• nextToken (string) – A token used for pagination of results returned in the response. Use the token returned from the previous request continue results where the previous request ended.

Return type:

dict

Returns:

Response Syntax

{
    'devices': [
        {
            'deviceArn': 'string',
            'deviceName': 'string',
            'deviceStatus': 'ONLINE'|'OFFLINE'|'RETIRED',
            'deviceType': 'QPU'|'SIMULATOR',
            'providerName': 'string'
        },
    ],
    '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.

      • deviceStatus (string) –

        The status of the device.

      • deviceType (string) –

        The type of the device.

      • providerName (string) –

        The provider 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 results where the previous request ended.

Exceptions

• Braket.Client.exceptions.AccessDeniedException

• Braket.Client.exceptions.ThrottlingException

• Braket.Client.exceptions.InternalServiceException

• Braket.Client.exceptions.ValidationException