aws iot1click-devices

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

Subcommands

NameDescription
claim-devices-by-claim-codeAdds 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)
describe-deviceGiven a device ID, returns a DescribeDeviceResponse object describing the details of the device
finalize-device-claimGiven 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-device-methodsGiven a device ID, returns the invocable methods associated with the device
initiate-device-claimGiven 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
invoke-device-methodGiven a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below
list-device-eventsUsing a device ID, returns a DeviceEventsResponse object containing an array of events for the device
list-devicesLists the 1-Click compatible devices associated with your AWS account
list-tags-for-resourceLists the tags associated with the specified resource ARN
tag-resourceAdds 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
unclaim-deviceDisassociates a device from your AWS account using its device ID
untag-resourceUsing tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN
update-device-stateUsing a Boolean value (true or false), this operation enables or disables the device given a device ID