Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot1click-devices ]

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--claim-code (string)

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

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

Examples

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.