[ aws . iot1click-devices ]
Given a device ID, finalizes the 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.
finalize-device-claim
--device-id <value>
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--device-id (string)
The unique identifier of the device.
--tags (map)
A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies .
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. 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.
To finalize a claim request for an AWS IoT 1-Click device using a device ID
The following finalize-device-claim example finalizes a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code).
aws iot1click-devices finalize-device-claim \
--device-id G030PM0123456789
Output:
{
"State": "CLAIMED"
}
For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.