[ aws . iot1click-devices ]
initiate-device-claim¶
Description¶
Given a device ID, initiates a claim request for the associated device.
Note
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.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
initiate-device-claim
--device-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--device-id (string)
The unique identifier of the device.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To initiate a claim request for an AWS IoT 1-Click device using a device ID
The following initiate-device-claim example initiates a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code).
aws iot1click-devices initiate-device-claim \
--device-id G030PM0123456789
Output:
{
"State": "CLAIM_INITIATED"
}
For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.