Class InitiateDeviceClaimCommandProtected

Given a device ID, initiates a claim request for the associated device.

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { IoT1ClickDevicesServiceClient, InitiateDeviceClaimCommand } from "@aws-sdk/client-iot-1click-devices-service"; // ES Modules import
// const { IoT1ClickDevicesServiceClient, InitiateDeviceClaimCommand } = require("@aws-sdk/client-iot-1click-devices-service"); // CommonJS import
const client = new IoT1ClickDevicesServiceClient(config);
const input = { // InitiateDeviceClaimRequest
  DeviceId: "STRING_VALUE", // required
};
const command = new InitiateDeviceClaimCommand(input);
const response = await client.send(command);
// { // InitiateDeviceClaimResponse
//   State: "STRING_VALUE",
// };

Param

InitiateDeviceClaimCommandInput

Returns

InitiateDeviceClaimCommandOutput

See

• InitiateDeviceClaimCommandInput for command's input shape.
• InitiateDeviceClaimCommandOutput for command's response shape.
• config for IoT1ClickDevicesServiceClient's config shape.

Throws

InternalFailureException (server fault)

Throws

InvalidRequestException (client fault)

Throws

ResourceConflictException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

IoT1ClickDevicesServiceServiceException

Base exception class for all service exceptions from IoT1ClickDevicesService service.