Input devices: input device transfers
URI
/prod/inputDeviceTransfers
HTTP methods
GET
Operation ID: ListInputDeviceTransfers
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transferType | String | True | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | ListInputDeviceTransfersResultModel | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | InvalidRequest | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
403 | AccessDenied | 403 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
422 | ValidationError | 422 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceeded | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
500 | InternalServiceError | 500 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
502 | BadGatewayException | 502 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
504 | GatewayTimeoutException | 504 response |
Schemas
Response bodies
{ "inputDeviceTransfers": [ { "id": "string", "message": "string", "targetCustomerId": "string", "transferType": enum } ], "nextToken": "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 |
InputDeviceTransferType
The type of device transfer. INCOMING for an input device that is being transferred to you, OUTGOING for an input device that you are transferring to another AWS account.
OUTGOING
INCOMING
InternalServiceError
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
InvalidRequest
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
LimitExceeded
Property | Type | Required | Description |
---|---|---|---|
message | string | False |
ListInputDeviceTransfersResultModel
The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer.
Property | Type | Required | Description |
---|---|---|---|
inputDeviceTransfers | Array of type TransferringInputDeviceSummary | False | The list of devices that you are transferring or are being transferred to you. |
nextToken | string | False | A token to get additional list results. |
TransferringInputDeviceSummary
Details about the input device that is being transferred.
Property | Type | Required | Description |
---|---|---|---|
id | string | False | The unique ID of the input device. |
message | string | False | The optional message that the sender has attached to the transfer. |
targetCustomerId | string | False | The AWS account ID for the recipient of the input device transfer. |
transferType | False | The type (direction) of the input device transfer. |
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: