Input devices: claim device
URI
/prod/claimDevice
HTTP methods
POST
Operation ID: ClaimDevice
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | InvalidRequest | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | AccessDenied | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | ResourceNotFound | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
422 | ValidationError | 422 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceeded | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServiceError | 500 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
502 | BadGatewayException | 502 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
504 | GatewayTimeoutException | 504 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Schemas
Request bodies
{ "id": "string" }
Response bodies
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "elementPath": "string", "errorMessage": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
Properties
AccessDenied
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
BadGatewayException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ClaimDeviceRequest
Request to claim an AWS Elemental device that you have purchased from a third-party vendor.
| Property | Type | Required | Description |
|---|---|---|---|
id | string | False | The id of the device you want to claim. |
GatewayTimeoutException
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
InternalServiceError
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
InvalidRequest
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
LimitExceeded
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ResourceNotFound
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ValidationError
| Property | Type | Required | Description |
|---|---|---|---|
elementPath | string | False | Path to the source of the error. |
errorMessage | string | False | The error message. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ClaimDevice
