AWS Elemental MediaLive

2020/10/16 - AWS Elemental MediaLive - 5 new api methods

Changes  Update medialive client to latest version

TransferInputDevice (new) Link ¶

Start an input device transfer to another AWS account. After you make the request, the other account must accept or reject the transfer.

See also: AWS API Documentation

Request Syntax

client.transfer_input_device(
    InputDeviceId='string',
    TargetCustomerId='string',
    TransferMessage='string'
)
type InputDeviceId:

string

param InputDeviceId:

[REQUIRED] The unique ID of this input device. For example, hd-123456789abcdef.

type TargetCustomerId:

string

param TargetCustomerId:

The AWS account ID (12 digits) for the recipient of the device transfer.

type TransferMessage:

string

param TransferMessage:

An optional message for the recipient. Maximum 280 characters.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) -- The device transfer request has started.

CancelInputDeviceTransfer (new) Link ¶

Cancel an input device transfer that you have requested.

See also: AWS API Documentation

Request Syntax

client.cancel_input_device_transfer(
    InputDeviceId='string'
)
type InputDeviceId:

string

param InputDeviceId:

[REQUIRED] The unique ID of the input device to cancel. For example, hd-123456789abcdef.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) -- Your cancel request has succeeded.

ListInputDeviceTransfers (new) Link ¶

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.

See also: AWS API Documentation

Request Syntax

client.list_input_device_transfers(
    MaxResults=123,
    NextToken='string',
    TransferType='string'
)
type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

Placeholder documentation for __string

type TransferType:

string

param TransferType:

[REQUIRED] Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'InputDeviceTransfers': [
        {
            'Id': 'string',
            'Message': 'string',
            'TargetCustomerId': 'string',
            'TransferType': 'OUTGOING'|'INCOMING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- An array of input devices that are currently being transferred.

    • InputDeviceTransfers (list) -- The list of devices that you are transferring or are being transferred to you.

      • (dict) -- Details about the input device that is being transferred.

        • Id (string) -- The unique ID of the input device.

        • Message (string) -- The optional message that the sender has attached to the transfer.

        • TargetCustomerId (string) -- The AWS account ID for the recipient of the input device transfer.

        • TransferType (string) -- The type (direction) of the input device transfer.

    • NextToken (string) -- A token to get additional list results.

AcceptInputDeviceTransfer (new) Link ¶

Accept an incoming input device transfer. The ownership of the device will transfer to your AWS account.

See also: AWS API Documentation

Request Syntax

client.accept_input_device_transfer(
    InputDeviceId='string'
)
type InputDeviceId:

string

param InputDeviceId:

[REQUIRED] The unique ID of the input device to accept. For example, hd-123456789abcdef.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) -- Your request to accept this device transfer has succeeded.

RejectInputDeviceTransfer (new) Link ¶

Reject the transfer of the specified input device to your AWS account.

See also: AWS API Documentation

Request Syntax

client.reject_input_device_transfer(
    InputDeviceId='string'
)
type InputDeviceId:

string

param InputDeviceId:

[REQUIRED] The unique ID of the input device to reject. For example, hd-123456789abcdef.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) -- Your reject request has succeeded.