[ aws . braket ]



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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--device-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--device-arn (string)

The ARN of the device to retrieve.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


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.