finalize_device_claim

IoT1ClickDevicesService.Client.finalize_device_claim(**kwargs)

Given a device ID, finalizes the 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.finalize_device_claim(
    DeviceId='string',
    Tags={
        'string': 'string'
    }
)

Parameters

• DeviceId (string) --

  [REQUIRED]

  The unique identifier of the device.

• Tags (dict) --

  A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.

  • (string) --
    • (string) --

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.PreconditionFailedException
• IoT1ClickDevicesService.Client.exceptions.ResourceConflictException