GetDevice
Retrieves the devices available in Amazon Braket.
Request Syntax
GET /device/deviceArn HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- deviceArn
-
The ARN of the device to retrieve.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"deviceArn": "string",
"deviceCapabilities": "string",
"deviceName": "string",
"deviceStatus": "string",
"deviceType": "string",
"providerName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- deviceArn
-
The ARN of the device.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- deviceCapabilities
-
Details about the capabilities of the device.
Type: String
- deviceName
-
The name of the device.
Type: String
- deviceStatus
-
The status of the device.
Type: String
Valid Values:
ONLINE | OFFLINE - deviceType
-
The type of the device.
Type: String
Valid Values:
QPU | SIMULATOR - providerName
-
The name of the partner company for the device.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
The request processing has failed because of an unknown error, exception, or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling rate limit is met.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
