v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141311165.4 KB

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.

get/device/{deviceArn}

Path parameters

deviceArnstring required

The ARN of the device to retrieve.

Response

Success

deviceArnstring required

The ARN of the device.

deviceCapabilitiesstring required

Details about the capabilities of the device.

deviceNamestring required

The name of the device.

deviceStatus'ONLINE' | 'OFFLINE' | 'RETIRED' required

The status of the device.

deviceType'QPU' | 'SIMULATOR' required

The type of the device.

providerNamestring required

The name of the partner company for the device.