Braket

{'deviceStatus': {'ONLINE', 'OFFLINE'}, 'deviceType': {'SIMULATOR', 'QPU'}}

Retrieves the devices available in Amazon Braket.

See also: AWS API Documentation

Request Syntax

client.get_device(
    deviceArn='string'
)

type deviceArn:

string

param deviceArn:

[REQUIRED]

The ARN of the device to retrieve.

rtype:

dict

returns:

Response Syntax

{
    'deviceArn': 'string',
    'deviceCapabilities': 'string',
    'deviceName': 'string',
    'deviceStatus': 'OFFLINE'|'ONLINE',
    'deviceType': 'QPU'|'SIMULATOR',
    'providerName': 'string'
}

Response Structure

• (dict) --

  • deviceArn (string) --

    The ARN of the device.

  • deviceCapabilities (string) --

    Details about the capabilities 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 name of the partner company for the device.

{'devices': {'deviceStatus': {'ONLINE', 'OFFLINE'},
             'deviceType': {'SIMULATOR', 'QPU'}}}

Searches for devices using the specified filters.

See also: AWS API Documentation

Request Syntax

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

type filters:

list

param filters:

[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) --

type maxResults:

integer

param maxResults:

The maximum number of results to return in the response.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'devices': [
        {
            'deviceArn': 'string',
            'deviceName': 'string',
            'deviceStatus': 'OFFLINE'|'ONLINE',
            '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.