Menu
Alexa For Business
Alexa for Business API (API Version 2017-11-09)

GetDevice

Gets the details of a device by device ARN.

Request Syntax

{
   "DeviceArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DeviceArn

The ARN of the device for which to request details. Required.

Type: String

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: No

Response Syntax

{
   "Device": { 
      "DeviceArn": "string",
      "DeviceName": "string",
      "DeviceSerialNumber": "string",
      "DeviceStatus": "string",
      "DeviceType": "string",
      "MacAddress": "string",
      "RoomArn": "string",
      "SoftwareVersion": "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.

Device

The details of the device requested. Required.

Type: Device object

Errors

For information about the errors that are common to all actions, see Common Errors.

NotFoundException

The resource is not found. HTTP Status Code: 400

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: