Device State
Represents the device's state.
URI
/devices/
deviceId
/state
HTTP methods
PUT
Operation ID: UpdateDeviceState
Using a Boolean value (true
or false
), this operation
enables or disables the device given a device ID.
Name | Type | Required | Description |
---|---|---|---|
deviceId | String | True | The unique identifier of the device. |
Status code | Response model | Description |
---|---|---|
200 |
Empty | 200 response |
400 | InvalidRequestException | 400 response |
404 | ResourceNotFoundException | 404 response |
500 | InternalFailureException | 500 response |
OPTIONS
Status code | Response model | Description |
---|---|---|
200 | None | 200 response |
Schemas
Request bodies
{ "enabled": boolean }
Response bodies
{ }
Properties
Empty
On success, an empty object is returned.
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. |
UpdateDeviceStateRequest
Property | Type | Required | Description |
---|---|---|---|
enabled | boolean | False | If |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: