URI HTTP methods Schemas Properties See also

Devices

Represents a collection of claimed devices.

URI

/devices

HTTP methods

GET

Operation ID: ListDevices

Lists the 1-Click compatible devices associated with your AWS account.

Query parameters
Name	Type	Required	Description
`deviceType`	String	False	The type of the device, such as "button".
`nextToken`	String	False	The token to retrieve the next set of results.
`maxResults`	String	False	The maximum number of results to return per request. If not set, a default value of 100 is used.

Responses
Status code	Response model	Description
`200`	`ListDevicesResponse`	200 response
`400`	`InvalidRequestException`	400 response
`416`	`RangeNotSatisfiableException`	416 response
`500`	`InternalFailureException`	500 response

OPTIONS

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Response bodies


{
  "devices": [
    {
      "remainingLife": number,
      "attributes": {
      },
      "type": "string",
      "arn": "string",
      "deviceId": "string",
      "enabled": boolean
    }
  ],
  "nextToken": "string"
}


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


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


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

Properties

DeviceAttributes

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

Property	Type	Required	Description
`*`	string	False

DeviceDescription

Property	Type	Required	Description
`arn`	string	False	The ARN of the device.
`attributes`	DeviceAttributes	False	An array of zero or more elements of `DeviceAttribute` objects providing user specified device attributes.
`deviceId`	string	False	The unique identifier of the device.
`enabled`	boolean	False	A Boolean value indicating whether or not the device is enabled.
`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.
`type`	string	False	The type of the device, such as "button".

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.

ListDevicesResponse

Property	Type	Required	Description
`devices`	Array of type DeviceDescription	False	A list of devices.
`nextToken`	string	False	The token to retrieve the next set of results.

RangeNotSatisfiableException

Property	Type	Required	Description
`code`	string	False	416
`message`	string	False	The requested number of results specified by `nextToken` cannot be satisfied.