InputDeviceTransfers - AWS Elemental MediaLive API Reference

InputDeviceTransfers

URI

/prod/inputDeviceTransfers

HTTP methods

GET

Operation ID: ListInputDeviceTransfers

Query parameters
NameTypeRequiredDescription
transferTypeStringTrue
nextTokenStringFalse
maxResultsStringFalse
Responses
Status codeResponse modelDescription
200ListInputDeviceTransfersResultModel

200 response

400InvalidRequest

400 response

403AccessDenied

403 response

422ValidationError

422 response

429LimitExceeded

429 response

500InternalServiceError

500 response

502BadGatewayException

502 response

504GatewayTimeoutException

504 response

Schemas

Response bodies

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

Properties

AccessDenied

PropertyTypeRequiredDescription
message

string

False

BadGatewayException

PropertyTypeRequiredDescription
message

string

False

GatewayTimeoutException

PropertyTypeRequiredDescription
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

PropertyTypeRequiredDescription
message

string

False

InvalidRequest

PropertyTypeRequiredDescription
message

string

False

LimitExceeded

PropertyTypeRequiredDescription
message

string

False

ListInputDeviceTransfersResultModel

The list of input devices in the transferred state. The recipient hasn't yet accepted or rejected the transfer.

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
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

InputDeviceTransferType

False

The type (direction) of the input device transfer.

ValidationError

PropertyTypeRequiredDescription
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:

ListInputDeviceTransfers