Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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 <value>]
[--generate-cli-skeleton <value>]

Options

--device-id (string)

The unique identifier of the device.

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

Output

State -> (string)

The device's final claim state.