Input devices: transfer device
URI
/prod/inputDevices/inputDeviceId/transfer
HTTP methods
POST
Operation ID: TransferInputDevice
| Name | Type | Required | Description |
|---|---|---|---|
inputDeviceId | String | True |
| Status code | Response model | Description |
|---|---|---|
200 | None | 200 response |
400 | InvalidRequest | 400 response |
403 | AccessDenied | 403 response |
404 | ResourceNotFound | 404 response |
409 | ResourceConflict | 409 response |
422 | ValidationError | 422 response |
429 | LimitExceeded | 429 response |
500 | InternalServiceError | 500 response |
502 | BadGatewayException | 502 response |
504 | GatewayTimeoutException | 504 response |
Schemas
Request bodies
{ "targetCustomerId": "string", "targetRegion": "string", "transferMessage": "string" }
Response bodies
{ "message": "string" }
{ "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 |
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 |
ResourceConflict
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
ResourceNotFound
| Property | Type | Required | Description |
|---|---|---|---|
message | string | False |
TransferInputDevice
The transfer details of the input device.
| Property | Type | Required | Description |
|---|---|---|---|
targetCustomerId | string | False | The AWS account ID (12 digits) for the recipient of the device transfer. |
targetRegion | string | False | The target AWS Region to transfer the device. |
transferMessage | string | False | An optional message for the recipient. Maximum 280 characters. |
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:
TransferInputDevice
