claim-devices-by-claim-code¶

Description¶

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).

Synopsis¶

  claim-devices-by-claim-code
--claim-code <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--claim-code (string)

The claim code, starting with “C-“, as provided by the device manufacturer.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To claim one or more AWS IoT 1-Click devices using a claim code

The following claim-devices-by-claim-code example claims the specified AWS IoT 1-Click device using a claim code (instead of a device ID).

aws iot1click-devices claim-devices-by-claim-code \
    --claim-code C-123EXAMPLE

Output:

{
   "Total": 9
   "ClaimCode": "C-123EXAMPLE"
}

For more information, see Using AWS IoT 1-Click with the AWS CLI in the AWS IoT 1-Click Developer Guide.

Output¶

ClaimCode -> (string)

The claim code provided by the device manufacturer.

Total -> (integer)

The total number of devices associated with the claim code that has been processed in the claim request.

Table of Contents

Feedback

User Guide