InputDeviceTransfers - AWS Elemental MediaLive API Reference

InputDeviceTransfers

URI

/prod/inputDeviceTransfers

HTTP Methods

GET

Operation ID: ListInputDeviceTransfers

List input devices that are currently being transferred. List input devices that you are transferring from your AWS account or input devices that another AWS account is transferring to you.

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

Example ListInputDeviceTransfersResultModel

{ "inputDeviceTransfers": [ { "id": "string", "transferType": enum, "message": "string", "targetCustomerId": "string" } ], "nextToken": "string" }

Example InvalidRequest

{ "message": "string" }

Example AccessDenied

{ "message": "string" }

Example ValidationError

{ "errorMessage": "string", "elementPath": "string" }

Example LimitExceeded

{ "message": "string" }

Example InternalServiceError

{ "message": "string" }

Example BadGatewayException

{ "message": "string" }

Example GatewayTimeoutException

{ "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.

transferType

InputDeviceTransferType

False

The type (direction) of the input device transfer.

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.

ValidationError

Property Type Required Description
errorMessage

string

False

The error message.

elementPath

string

False

Path to the source of the error.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

ListInputDeviceTransfers