Finalize Claim
Finalizes a device claim request initiated by a InitiateDeviceClaim
operation.
URI
/devices/
deviceId
/finalize-claim
HTTP methods
PUT
Operation ID: FinalizeDeviceClaim
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.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
deviceId | String | True | The unique identifier of the device. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 |
DeviceClaimResponse | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | InvalidRequestException | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResourceNotFoundException | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
409 | ResourceConflictException | 409 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
412 | PreconditionFailedException | 412 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalFailureException | 500 response |
OPTIONS
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response |
Schemas
Request bodies
{ "tags": { } }
Response bodies
{ "state": "string" }
Properties
DeviceClaimResponse
Property | Type | Required | Description |
---|---|---|---|
state | string | False | The device's final claim state. |
InternalFailureException
Property | Type | Required | Description |
---|---|---|---|
code | string | False | 500 |
message | string | False | The 500 error message returned by the web server. |
InvalidRequestException
Property | Type | Required | Description |
---|---|---|---|
code | string | False | 400 |
message | string | False | The 400 error message returned by the web server. |
PreconditionFailedException
Property | Type | Required | Description |
---|---|---|---|
code | string | False | 412 |
message | string | False | An error message explaining the error or its remedy. |
ResourceConflictException
Property | Type | Required | Description |
---|---|---|---|
code | string | False | 409 |
message | string | False | An error message explaining the error or its remedy. |
ResourceNotFoundException
Property | Type | Required | Description |
---|---|---|---|
code | string | False | 404 |
message | string | False | The requested device could not be found. |
tagsModel
Contains tag information (resource metadata key/value pairs).
Property | Type | Required | Description |
---|---|---|---|
tags | object | True | A collection of key/value pairs defining the resource tags. For example,
|
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: