---
name: aws-iot-1-click-devices-service
description: "AWS IoT 1-Click Devices Service API skill. Use when working with AWS IoT 1-Click Devices Service for claims, devices, tags. Covers 13 endpoints."
version: 1.0.0
generator: lapsh
---

# AWS IoT 1-Click Devices Service
API version: 2018-05-14

## Auth
AWS SigV4

## Base URL
Not specified.

## Setup
1. Configure auth: AWS SigV4
2. GET /devices -- lists the 1-click compatible devices associated with your aws account.
3. POST /devices/{deviceId}/methods -- create first method

## Endpoints
13 endpoints across 3 groups. See references/api-spec.lap for full details.

### Claims
| Method | Path | Description |
|--------|------|-------------|
| PUT | /claims/{claimCode} | Adds 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). |

### Devices
| Method | Path | Description |
|--------|------|-------------|
| GET | /devices/{deviceId} | Given a device ID, returns a DescribeDeviceResponse object describing the
 details of the device. |
| PUT | /devices/{deviceId}/finalize-claim | Given a device ID, finalizes the claim request for the associated device.
 Claiming a device consists of initiating a claim, then publishing a device event,
 and finalizing the claim. For a device of type button, a device event can
 be published by simply clicking the device. |
| GET | /devices/{deviceId}/methods | Given a device ID, returns the invokable methods associated with the device. |
| PUT | /devices/{deviceId}/initiate-claim | Given a device ID, initiates a claim request for the associated device.
 Claiming a device consists of initiating a claim, then publishing a device event,
 and finalizing the claim. For a device of type button, a device event can
 be published by simply clicking the device. |
| POST | /devices/{deviceId}/methods | Given a device ID, issues a request to invoke a named device method (with possible
 parameters). See the "Example POST" code snippet below. |
| GET | /devices/{deviceId}/events | Using a device ID, returns a DeviceEventsResponse object containing an
 array of events for the device. |
| GET | /devices | Lists the 1-Click compatible devices associated with your AWS account. |
| PUT | /devices/{deviceId}/unclaim | Disassociates a device from your AWS account using its device ID. |
| PUT | /devices/{deviceId}/state | Using a Boolean value (true or false), this operation
 enables or disables the device given a device ID. |

### Tags
| Method | Path | Description |
|--------|------|-------------|
| GET | /tags/{resource-arn} | Lists the tags associated with the specified resource ARN. |
| POST | /tags/{resource-arn} | Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per
 resource. |
| DELETE | /tags/{resource-arn} | Using tag keys, deletes the tags (key/value pairs) associated with the specified
 resource ARN. |

## Common Questions
Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Update a claim?" -> PUT /claims/{claimCode}
- "Get device details?" -> GET /devices/{deviceId}
- "List all methods?" -> GET /devices/{deviceId}/methods
- "Create a method?" -> POST /devices/{deviceId}/methods
- "List all events?" -> GET /devices/{deviceId}/events
- "List all devices?" -> GET /devices
- "Get tag details?" -> GET /tags/{resource-arn}
- "Delete a tag?" -> DELETE /tags/{resource-arn}
- "How to authenticate?" -> See Auth section above

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints return the modified resource on success

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)