devices

Creates, updates, deletes, gets or lists a devices resource.

Overview

Name	devices
Type	Resource
Id	aws.braket.devices

Fields

The following fields are returned by SELECT queries:

get_device

Name	Datatype	Description
device_arn	string	The ARN of the device.
device_capabilities	string	Details about the capabilities of the device.
device_name	string	The name of the device.
device_queue_info	array	The number of quantum tasks and hybrid jobs currently queued on the device.
device_status	string	The status of the device. (ONLINE, OFFLINE, RETIRED)
device_type	string	The type of the device. (QPU, SIMULATOR)
provider_name	string	The name of the partner company for the device.

search_devices

Name	Datatype	Description
device_arn	string	The ARN of the device.
device_name	string	The name of the device.
device_status	string	The status of the device. (ONLINE, OFFLINE, RETIRED)
device_type	string	The type of the device. (QPU, SIMULATOR)
provider_name	string	The provider of the device.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_device	select	device_arn, region		Retrieves the devices available in Amazon Braket. 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.
search_devices	select	region		Searches for devices using the specified filters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
device_arn	string	The ARN of the device to retrieve.
region	string	AWS region (default: us-east-1)

SELECT examples

get_device

Retrieves the devices available in Amazon Braket. 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.

SELECT
device_arn,
device_capabilities,
device_name,
device_queue_info,
device_status,
device_type,
provider_name
FROM aws.braket.devices
WHERE device_arn = '{{ device_arn }}' -- required
AND region = '{{ region }}' -- required
;

search_devices

Searches for devices using the specified filters.

SELECT
device_arn,
device_name,
device_status,
device_type,
provider_name
FROM aws.braket.devices
WHERE region = '{{ region }}' -- required
;