initiate_device_claim

IoT1ClickDevicesService.Client.initiate_device_claim(**kwargs)

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

Request Syntax

response = client.initiate_device_claim(
    DeviceId='string'
)

Parameters

DeviceId (string) --

[REQUIRED]

The unique identifier of the device.

Return type

dict

Returns

Response Syntax

{
    'State': 'string'
}

Response Structure

• (dict) --

  200 response

  • State (string) --

    The device's final claim state.

Exceptions

• IoT1ClickDevicesService.Client.exceptions.ResourceNotFoundException
• IoT1ClickDevicesService.Client.exceptions.InvalidRequestException
• IoT1ClickDevicesService.Client.exceptions.InternalFailureException
• IoT1ClickDevicesService.Client.exceptions.ResourceConflictException