AWS IoT 1-Click Devices Service
Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Describes all of the AWS IoT 1-Click device-related API operations for the service.
Also provides sample requests, responses, and errors for the supported web services
protocols.
Endpoints 13
- PUTClaimDevicesByClaimCode
/claims/:claimCodeAdds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s). - GETDescribeDevice
/devices/:deviceIdGiven a device ID, returns a DescribeDeviceResponse object describing the details of the device. - PUTFinalizeDeviceClaim
/devices/:deviceId/finalize-claim<p>Given a device ID, finalizes the claim request for the associated device.</p><note> <p>Claiming a device consists of initiating a claim, then publishing a… - GETGetDeviceMethods
/devices/:deviceId/methodsGiven a device ID, returns the invokable methods associated with the device. - POSTInvokeDeviceMethod
/devices/:deviceId/methodsGiven a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below. - PUTInitiateDeviceClaim
/devices/:deviceId/initiate-claim<p>Given a device ID, initiates a claim request for the associated device.</p><note> <p>Claiming a device consists of initiating a claim, then publishing a… - GETListDeviceEvents
/devices/:deviceId/events#fromTimeStamp&toTimeStamp?fromTimeStamp=2024-01-01T00:00:00Z&maxResults=1&nextToken=string&toTimeStamp=2024-01-01T00:00:00ZUsing a device ID, returns a DeviceEventsResponse object containing an array of events for the device. - GETListDevices
/devices?deviceType=string&maxResults=1&nextToken=stringLists the 1-Click compatible devices associated with your AWS account. - GETListTagsForResource
/tags/:resource-arnLists the tags associated with the specified resource ARN. - POSTTagResource
/tags/:resource-arnAdds or updates the tags associated with the resource ARN. See <a… - PUTUnclaimDevice
/devices/:deviceId/unclaimDisassociates a device from your AWS account using its device ID. - DELETEUntagResource
/tags/:resource-arn#tagKeys?tagKeys=stringUsing tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. - PUTUpdateDeviceState
/devices/:deviceId/stateUsing a Boolean value (true or false), this operation enables or disables the device given a device ID.
API details
- Base URL
http://devices.iot1click.{region}.amazonaws.comhttps://devices.iot1click.{region}.amazonaws.comhttp://devices.iot1click.{region}.amazonaws.com.cnhttps://devices.iot1click.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 13 operations on 11 pathsGET 5PUT 5POST 2DELETE 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2018-05-14 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the AWS IoT 1-Click Devices Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT 1-Click Devices Service collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “ClaimDevicesByClaimCode” (PUT /claims/:claimCode), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS IoT 1-Click Devices Service?
Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web… It is listed under IoT & devices and has 13 endpoints.
Who publishes the AWS IoT 1-Click Devices Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS IoT 1-Click Devices Service?
Its description lists 4 base URLs: http://devices.iot1click.{region}.amazonaws.com, https://devices.iot1click.{region}.amazonaws.com, http://devices.iot1click.{region}.amazonaws.com.cn, https://devices.iot1click.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the AWS IoT 1-Click Devices Service?
With an API key in the Authorization header.
How many endpoints does the AWS IoT 1-Click Devices Service have?
13 operations on 11 paths (5 GET, 5 PUT, 2 POST, 1 DELETE).
Is forking the AWS IoT 1-Click Devices Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.