MediaLive / Paginator / ListInputDeviceTransfers

ListInputDeviceTransfers#

class MediaLive.Paginator.ListInputDeviceTransfers#
paginator = client.get_paginator('list_input_device_transfers')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from MediaLive.Client.list_input_device_transfers().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TransferType='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • TransferType (string) – [REQUIRED] Placeholder documentation for __string

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.