Braket

2026/11/18 - Braket - 2 updated api methods

Changes  Supporting a new PAUSED device status and a DeviceStatusReason.

GetDevice (updated) Link ¶
Changes (response)
{'deviceStatus': {'PAUSED'},
 'deviceStatusReason': {'estimatedEndAt': 'timestamp',
                        'reason': 'OUTSIDE_AVAILABILITY_WINDOW | MAINTENANCE | '
                                  'RESERVATION',
                        'startedAt': 'timestamp',
                        'updatedAt': 'timestamp'}}

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',
    'deviceName': 'string',
    'providerName': 'string',
    'deviceType': 'QPU'|'SIMULATOR',
    'deviceStatus': 'ONLINE'|'OFFLINE'|'RETIRED'|'PAUSED',
    'deviceStatusReason': {
        'reason': 'OUTSIDE_AVAILABILITY_WINDOW'|'MAINTENANCE'|'RESERVATION',
        'startedAt': datetime(2015, 1, 1),
        'estimatedEndAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    },
    'deviceCapabilities': 'string',
    'deviceQueueInfo': [
        {
            'queue': 'QUANTUM_TASKS_QUEUE'|'JOBS_QUEUE',
            'queueSize': 'string',
            'queuePriority': 'Normal'|'Priority'
        },
    ]
}

Response Structure

  • (dict) --

    • deviceArn (string) --

      The ARN of the device.

    • deviceName (string) --

      The name of the device.

    • providerName (string) --

      The name of the partner company for the device.

    • deviceType (string) --

      The type of the device.

    • deviceStatus (string) --

      The status of the device.

    • deviceStatusReason (dict) --

      The reason for the current status of the device, including status reason codes and timestamps.

      • reason (string) --

        The reason code for the current status of the device.

      • startedAt (datetime) --

        The time at which the device status reason started.

      • estimatedEndAt (datetime) --

        The estimated time at which the current status reason will end.

      • updatedAt (datetime) --

        The time of the most recent update to the device status reason.

    • deviceCapabilities (string) --

      Details about the capabilities of the device.

    • deviceQueueInfo (list) --

      The number of quantum tasks and hybrid jobs currently queued on the device.

      • (dict) --

        Information about quantum tasks and hybrid jobs queued on a device.

        • queue (string) --

          The name of the queue.

        • queueSize (string) --

          The number of hybrid jobs or quantum tasks in the queue for a given device.

        • queuePriority (string) --

          Optional. Specifies the priority of the queue. Quantum tasks in a priority queue are processed before the quantum tasks in a normal queue.

SearchDevices (updated) Link ¶
Changes (response)
{'devices': {'deviceStatus': {'PAUSED'}}}

Searches for devices using the specified filters.

See also: AWS API Documentation

Request Syntax

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'|'PAUSED'
        },
    ],
    '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.