AWS IoT 1-Click
Devices API Reference

Device

Represents a device given the device's ID.

URI

/devices/deviceId

HTTP Methods

GET

Operation ID: DescribeDevice

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Path Parameters

Name Type Required Description
deviceId String True

The unique identifier of the device.

Responses

Status Code Response Model Description
200 DescribeDeviceResponse

200 response

400 InvalidRequestException

400 response

404 ResourceNotFoundException

404 response

500 InternalFailureException

500 response

OPTIONS

Responses

Status Code Response Model Description
200 None

200 response

Schemas

Response Bodies

Example DescribeDeviceResponse

{ "deviceDescription": { "remainingLife": number, "attributes": { }, "type": "string", "arn": "string", "deviceId": "string", "enabled": boolean } }

Example InvalidRequestException

{ "code": "string", "message": "string" }

Example ResourceNotFoundException

{ "code": "string", "message": "string" }

Example InternalFailureException

{ "code": "string", "message": "string" }

Properties

DescribeDeviceResponse

Property Type Required Description
deviceDescription

DeviceDescription

False

Device details.

DeviceAttributes

DeviceAttributes is a string-to-string map specified by the user.

Property Type Required Description

*

string

False

DeviceDescription

Property Type Required Description
remainingLife

number

Minimum: 0.0

Maximum: 100.0

False

A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

attributes

DeviceAttributes

False

An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

type

string

False

The type of the device, such as "button".

arn

string

False

The ARN of the device.

deviceId

string

False

The unique identifier of the device.

enabled

boolean

False

A Boolean value indicating whether or not the device is enabled.

InternalFailureException

Property Type Required Description
code

string

False

500

message

string

False

The 500 error message returned by the web server.

InvalidRequestException

Property Type Required Description
code

string

False

400

message

string

False

The 400 error message returned by the web server.

ResourceNotFoundException

Property Type Required Description
code

string

False

404

message

string

False

The requested device could not be found.

See Also

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

DescribeDevice