AWS IoT 1-Click
Devices API Reference

Claim Code

A code is a value used to claim one or more devices.

URI

/claims/ claimCode

HTTP Methods

PUT

Operation ID: ClaimDevicesByClaimCode

Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).

Path Parameters

Name Type Required Description
claimCode String True

The claim code, starting with "C-", as provided by the device manufacturer.

Responses

Status Code Response Model Description
200 ClaimDevicesByClaimCodeResponse

200 response

400 InvalidRequestException

400 response

403 ForbiddenException

403 response

500 InternalFailureException

500 response

See Also

OPTIONS

Responses

Status Code Response Model Description
200 None

200 response

Schemas

Response Bodies

Example ClaimDevicesByClaimCodeResponse

{ "total": integer, "claimCode": "string" }

Example InvalidRequestException

{ "code": "string", "message": "string" }

Example ForbiddenException

{ "code": "string", "message": "string" }

Example InternalFailureException

{ "code": "string", "message": "string" }

Properties

ClaimDevicesByClaimCodeResponse

Property Type Required Description
total

integer

Format: int32

False

The total number of devices associated with the claim code that has been processed in the claim request.

claimCode

string

False

The claim code provided by the device manufacturer.

See Also

ForbiddenException

Property Type Required Description
code

string

False

403

message

string

False

The 403 error message returned by the web server.

See Also

InternalFailureException

Property Type Required Description
code

string

False

500

message

string

False

The 500 error message returned by the web server.

See Also

InvalidRequestException

Property Type Required Description
code

string

False

400

message

string

False

The 400 error message returned by the web server.

See Also