Braket / Client / get_device

get_device#

Braket.Client.get_device(**kwargs)#

Retrieves the devices available in Amazon Braket.

Note

For backwards compatibility with older versions of BraketSchemas, OpenQASM information is omitted from GetDevice API calls. To get this information the user-agent needs to present a recent version of the BraketSchemas (1.8.0 or later). The Braket SDK automatically reports this for you. If you do not see OpenQASM results in the GetDevice response when using a Braket SDK, you may need to set AWS_EXECUTION_ENV environment variable to configure user-agent. See the code examples provided below for how to do this for the AWS CLI, Boto3, and the Go, Java, and JavaScript/TypeScript SDKs.

See also: AWS API Documentation

Request Syntax

response = client.get_device(
    deviceArn='string'
)
Parameters:

deviceArn (string) –

[REQUIRED]

The ARN of the device to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'deviceArn': 'string',
    'deviceCapabilities': 'string',
    'deviceName': 'string',
    'deviceQueueInfo': [
        {
            'queue': 'QUANTUM_TASKS_QUEUE'|'JOBS_QUEUE',
            'queuePriority': 'Normal'|'Priority',
            'queueSize': 'string'
        },
    ],
    'deviceStatus': 'ONLINE'|'OFFLINE'|'RETIRED',
    '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.

    • deviceQueueInfo (list) –

      List of information about tasks and jobs queued on a device.

      • (dict) –

        Information about tasks and jobs queued on a device.

        • queue (string) –

          The name of the queue.

        • queuePriority (string) –

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

        • queueSize (string) –

          The number of jobs or tasks in the queue for a given 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.

Exceptions

  • Braket.Client.exceptions.ResourceNotFoundException

  • Braket.Client.exceptions.AccessDeniedException

  • Braket.Client.exceptions.ThrottlingException

  • Braket.Client.exceptions.InternalServiceException

  • Braket.Client.exceptions.ValidationException