MediaLive / Paginator / ListInputs

ListInputs

class MediaLive.Paginator.ListInputs

paginator = client.get_paginator('list_inputs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'Inputs': [
        {
            'Arn': 'string',
            'AttachedChannels': [
                'string',
            ],
            'Destinations': [
                {
                    'Ip': 'string',
                    'Port': 'string',
                    'Url': 'string',
                    'Vpc': {
                        'AvailabilityZone': 'string',
                        'NetworkInterfaceId': 'string'
                    }
                },
            ],
            'Id': 'string',
            'InputClass': 'STANDARD'|'SINGLE_PIPELINE',
            'InputDevices': [
                {
                    'Id': 'string'
                },
            ],
            'InputPartnerIds': [
                'string',
            ],
            'InputSourceType': 'STATIC'|'DYNAMIC',
            'MediaConnectFlows': [
                {
                    'FlowArn': 'string'
                },
            ],
            'Name': 'string',
            'RoleArn': 'string',
            'SecurityGroups': [
                'string',
            ],
            'Sources': [
                {
                    'PasswordParam': 'string',
                    'Url': 'string',
                    'Username': 'string'
                },
            ],
            'State': 'CREATING'|'DETACHED'|'ATTACHED'|'DELETING'|'DELETED',
            'Tags': {
                'string': 'string'
            },
            'Type': 'UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'|'INPUT_DEVICE'|'AWS_CDI'|'TS_FILE'
        },
    ],

}

Response Structure

• (dict) – An array of inputs

  • Inputs (list) – Placeholder documentation for __listOfInput

    • (dict) – Placeholder documentation for Input

      • Arn (string) – The Unique ARN of the input (generated, immutable).

      • AttachedChannels (list) – A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).

        • (string) – Placeholder documentation for __string

      • Destinations (list) – A list of the destinations of the input (PUSH-type).

        • (dict) – The settings for a PUSH type input.

          • Ip (string) – The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.

          • Port (string) – The port number for the input.

          • Url (string) – This represents the endpoint that the customer stream will be pushed to.

          • Vpc (dict) – The properties for a VPC type input destination.

            • AvailabilityZone (string) – The availability zone of the Input destination.

            • NetworkInterfaceId (string) – The network interface ID of the Input destination in the VPC.

      • Id (string) – The generated ID of the input (unique for user account, immutable).

      • InputClass (string) – STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.

      • InputDevices (list) – Settings for the input devices.

        • (dict) – Settings for an input device.

          • Id (string) – The unique ID for the device.

      • InputPartnerIds (list) – A list of IDs for all Inputs which are partners of this one.

        • (string) – Placeholder documentation for __string

      • InputSourceType (string) – Certain pull input sources can be dynamic, meaning that they can have their URL’s dynamically changes during input switch actions. Presently, this functionality only works with MP4_FILE and TS_FILE inputs.

      • MediaConnectFlows (list) – A list of MediaConnect Flows for this input.

        • (dict) – The settings for a MediaConnect Flow.

          • FlowArn (string) – The unique ARN of the MediaConnect Flow being used as a source.

      • Name (string) – The user-assigned name (This is a mutable value).

      • RoleArn (string) – The Amazon Resource Name (ARN) of the role this input assumes during and after creation.

      • SecurityGroups (list) – A list of IDs for all the Input Security Groups attached to the input.

        • (string) – Placeholder documentation for __string

      • Sources (list) – A list of the sources of the input (PULL-type).

        • (dict) – The settings for a PULL type input.

          • PasswordParam (string) – The key used to extract the password from EC2 Parameter store.

          • Url (string) – This represents the customer’s source URL where stream is pulled from.

          • Username (string) – The username for the input source.

      • State (string) – Placeholder documentation for InputState

      • Tags (dict) – A collection of key-value pairs.

        • (string) – Placeholder documentation for __string

          • (string) – Placeholder documentation for __string

      • Type (string) – The different types of inputs that AWS Elemental MediaLive supports.