AWS Elemental MediaLive

2020/09/15 - AWS Elemental MediaLive - 11 updated api methods

Changes  Update medialive client to latest version

CreateInput (updated) Link ¶
Changes (request, response)
Request 
{'Type': {'AWS_CDI'}}
Response 
{'Input': {'Type': {'AWS_CDI'}}}

Create an input

See also: AWS API Documentation

Request Syntax

client.create_input(
    Destinations=[
        {
            'StreamName': 'string'
        },
    ],
    InputDevices=[
        {
            'Id': 'string'
        },
    ],
    InputSecurityGroups=[
        'string',
    ],
    MediaConnectFlows=[
        {
            'FlowArn': 'string'
        },
    ],
    Name='string',
    RequestId='string',
    RoleArn='string',
    Sources=[
        {
            'PasswordParam': 'string',
            'Url': 'string',
            'Username': 'string'
        },
    ],
    Tags={
        'string': 'string'
    },
    Type='UDP_PUSH'|'RTP_PUSH'|'RTMP_PUSH'|'RTMP_PULL'|'URL_PULL'|'MP4_FILE'|'MEDIACONNECT'|'INPUT_DEVICE'|'AWS_CDI',
    Vpc={
        'SecurityGroupIds': [
            'string',
        ],
        'SubnetIds': [
            'string',
        ]
    }
)
type Destinations:

list

param Destinations:

Destination settings for PUSH type inputs.

  • (dict) -- Endpoint settings for a PUSH type input.

    • StreamName (string) -- A unique name for the location the RTMP stream is being pushed to.

type InputDevices:

list

param InputDevices:

Settings for the devices.

  • (dict) -- Settings for an input device.

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

type InputSecurityGroups:

list

param InputSecurityGroups:

A list of security groups referenced by IDs to attach to the input.

  • (string) -- Placeholder documentation for __string

type MediaConnectFlows:

list

param MediaConnectFlows:

A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

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

    • FlowArn (string) -- The ARN of the MediaConnect Flow that you want to use as a source.

type Name:

string

param Name:

Name of the input.

type RequestId:

string

param RequestId:

Unique identifier of the request to ensure the request is handled exactly once in case of retries.This field is autopopulated if not provided.

type RoleArn:

string

param RoleArn:

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

type Sources:

list

param Sources:

The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

  • (dict) -- Settings for 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.

type Tags:

dict

param Tags:

A collection of key-value pairs.

  • (string) -- Placeholder documentation for __string

    • (string) -- Placeholder documentation for __string

type Type:

string

param Type:

Placeholder documentation for InputType

type Vpc:

dict

param Vpc:

Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property.

  • SecurityGroupIds (list) -- A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. Requires subnetIds. If none are specified then the VPC default security group will be used.

    • (string) -- Placeholder documentation for __string

  • SubnetIds (list) -- [REQUIRED] A list of 2 VPC subnet IDs from the same VPC. Subnet IDs must be mapped to two unique availability zones (AZ).

    • (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Input': {
        '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'
            },
        ],
        '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'
    }
}

Response Structure

  • (dict) -- Successfully created the input.

    • Input (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.

      • 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 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) -- Placeholder documentation for InputType

DeleteReservation (updated) Link ¶
Changes (response) 
{'ResourceSpecification': {'Codec': {'LINK'}}}

Delete an expired reservation.

See also: AWS API Documentation

Request Syntax

client.delete_reservation(
    ReservationId='string'
)
type ReservationId:

string

param ReservationId:

[REQUIRED] Unique reservation ID, e.g. '1234567'

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Count': 123,
    'CurrencyCode': 'string',
    'Duration': 123,
    'DurationUnits': 'MONTHS',
    'End': 'string',
    'FixedPrice': 123.0,
    'Name': 'string',
    'OfferingDescription': 'string',
    'OfferingId': 'string',
    'OfferingType': 'NO_UPFRONT',
    'Region': 'string',
    'ReservationId': 'string',
    'ResourceSpecification': {
        'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
        'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
        'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
        'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
        'Resolution': 'SD'|'HD'|'FHD'|'UHD',
        'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
        'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
        'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
    },
    'Start': 'string',
    'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'UsagePrice': 123.0
}

Response Structure

  • (dict) -- Deleted reservation

    • Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

    • Count (integer) -- Number of reserved resources

    • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

    • Duration (integer) -- Lease duration, e.g. '12'

    • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

    • End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

    • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

    • Name (string) -- User specified reservation name

    • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

    • OfferingId (string) -- Unique offering ID, e.g. '87654321'

    • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

    • Region (string) -- AWS region, e.g. 'us-west-2'

    • ReservationId (string) -- Unique reservation ID, e.g. '1234567'

    • ResourceSpecification (dict) -- Resource configuration details

      • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

      • Codec (string) -- Codec, e.g. 'AVC'

      • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

      • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

      • Resolution (string) -- Resolution, e.g. 'HD'

      • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

      • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

      • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

    • Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

    • State (string) -- Current state of reservation, e.g. 'ACTIVE'

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

      • (string) -- Placeholder documentation for __string

        • (string) -- Placeholder documentation for __string

    • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

DescribeInput (updated) Link ¶
Changes (response) 
{'Type': {'AWS_CDI'}}

Produces details about an input

See also: AWS API Documentation

Request Syntax

client.describe_input(
    InputId='string'
)
type InputId:

string

param InputId:

[REQUIRED] Unique ID of the input

rtype:

dict

returns:

Response Syntax

{
    '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'
        },
    ],
    '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'
}

Response Structure

  • (dict) -- Input details

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

    • 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 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) -- Placeholder documentation for InputType

DescribeOffering (updated) Link ¶
Changes (response) 
{'ResourceSpecification': {'Codec': {'LINK'}}}

Get details for an offering.

See also: AWS API Documentation

Request Syntax

client.describe_offering(
    OfferingId='string'
)
type OfferingId:

string

param OfferingId:

[REQUIRED] Unique offering ID, e.g. '87654321'

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CurrencyCode': 'string',
    'Duration': 123,
    'DurationUnits': 'MONTHS',
    'FixedPrice': 123.0,
    'OfferingDescription': 'string',
    'OfferingId': 'string',
    'OfferingType': 'NO_UPFRONT',
    'Region': 'string',
    'ResourceSpecification': {
        'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
        'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
        'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
        'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
        'Resolution': 'SD'|'HD'|'FHD'|'UHD',
        'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
        'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
        'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
    },
    'UsagePrice': 123.0
}

Response Structure

  • (dict) -- Offering details

    • Arn (string) -- Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'

    • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

    • Duration (integer) -- Lease duration, e.g. '12'

    • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

    • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

    • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

    • OfferingId (string) -- Unique offering ID, e.g. '87654321'

    • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

    • Region (string) -- AWS region, e.g. 'us-west-2'

    • ResourceSpecification (dict) -- Resource configuration details

      • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

      • Codec (string) -- Codec, e.g. 'AVC'

      • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

      • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

      • Resolution (string) -- Resolution, e.g. 'HD'

      • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

      • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

      • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

    • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

DescribeReservation (updated) Link ¶
Changes (response) 
{'ResourceSpecification': {'Codec': {'LINK'}}}

Get details for a reservation.

See also: AWS API Documentation

Request Syntax

client.describe_reservation(
    ReservationId='string'
)
type ReservationId:

string

param ReservationId:

[REQUIRED] Unique reservation ID, e.g. '1234567'

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'Count': 123,
    'CurrencyCode': 'string',
    'Duration': 123,
    'DurationUnits': 'MONTHS',
    'End': 'string',
    'FixedPrice': 123.0,
    'Name': 'string',
    'OfferingDescription': 'string',
    'OfferingId': 'string',
    'OfferingType': 'NO_UPFRONT',
    'Region': 'string',
    'ReservationId': 'string',
    'ResourceSpecification': {
        'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
        'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
        'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
        'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
        'Resolution': 'SD'|'HD'|'FHD'|'UHD',
        'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
        'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
        'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
    },
    'Start': 'string',
    'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
    'Tags': {
        'string': 'string'
    },
    'UsagePrice': 123.0
}

Response Structure

  • (dict) -- Reservation details

    • Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

    • Count (integer) -- Number of reserved resources

    • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

    • Duration (integer) -- Lease duration, e.g. '12'

    • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

    • End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

    • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

    • Name (string) -- User specified reservation name

    • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

    • OfferingId (string) -- Unique offering ID, e.g. '87654321'

    • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

    • Region (string) -- AWS region, e.g. 'us-west-2'

    • ReservationId (string) -- Unique reservation ID, e.g. '1234567'

    • ResourceSpecification (dict) -- Resource configuration details

      • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

      • Codec (string) -- Codec, e.g. 'AVC'

      • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

      • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

      • Resolution (string) -- Resolution, e.g. 'HD'

      • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

      • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

      • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

    • Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

    • State (string) -- Current state of reservation, e.g. 'ACTIVE'

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

      • (string) -- Placeholder documentation for __string

        • (string) -- Placeholder documentation for __string

    • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

ListInputs (updated) Link ¶
Changes (response) 
{'Inputs': {'Type': {'AWS_CDI'}}}

Produces list of inputs that have been created

See also: AWS API Documentation

Request Syntax

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

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

Placeholder documentation for __string

rtype:

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'
                },
            ],
            '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'
        },
    ],
    'NextToken': 'string'
}

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.

        • 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 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) -- Placeholder documentation for InputType

    • NextToken (string) -- Placeholder documentation for __string

ListOfferings (updated) Link ¶
Changes (response) 
{'Offerings': {'ResourceSpecification': {'Codec': {'LINK'}}}}

List offerings available for purchase.

See also: AWS API Documentation

Request Syntax

client.list_offerings(
    ChannelClass='string',
    ChannelConfiguration='string',
    Codec='string',
    Duration='string',
    MaxResults=123,
    MaximumBitrate='string',
    MaximumFramerate='string',
    NextToken='string',
    Resolution='string',
    ResourceType='string',
    SpecialFeature='string',
    VideoQuality='string'
)
type ChannelClass:

string

param ChannelClass:

Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

type ChannelConfiguration:

string

param ChannelConfiguration:

Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)

type Codec:

string

param Codec:

Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'

type Duration:

string

param Duration:

Filter by offering duration, e.g. '12'

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type MaximumBitrate:

string

param MaximumBitrate:

Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

type MaximumFramerate:

string

param MaximumFramerate:

Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

type NextToken:

string

param NextToken:

Placeholder documentation for __string

type Resolution:

string

param Resolution:

Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'

type ResourceType:

string

param ResourceType:

Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

type SpecialFeature:

string

param SpecialFeature:

Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

type VideoQuality:

string

param VideoQuality:

Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Offerings': [
        {
            'Arn': 'string',
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'FixedPrice': 123.0,
            'OfferingDescription': 'string',
            'OfferingId': 'string',
            'OfferingType': 'NO_UPFRONT',
            'Region': 'string',
            'ResourceSpecification': {
                'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
                'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
                'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
                'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
                'Resolution': 'SD'|'HD'|'FHD'|'UHD',
                'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
                'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
                'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
            },
            'UsagePrice': 123.0
        },
    ]
}

Response Structure

  • (dict) -- List of offerings

    • NextToken (string) -- Token to retrieve the next page of results

    • Offerings (list) -- List of offerings

      • (dict) -- Reserved resources available for purchase

        • Arn (string) -- Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'

        • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

        • Duration (integer) -- Lease duration, e.g. '12'

        • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

        • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

        • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

        • OfferingId (string) -- Unique offering ID, e.g. '87654321'

        • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

        • Region (string) -- AWS region, e.g. 'us-west-2'

        • ResourceSpecification (dict) -- Resource configuration details

          • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

          • Codec (string) -- Codec, e.g. 'AVC'

          • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

          • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

          • Resolution (string) -- Resolution, e.g. 'HD'

          • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

          • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

          • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

        • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

ListReservations (updated) Link ¶
Changes (response) 
{'Reservations': {'ResourceSpecification': {'Codec': {'LINK'}}}}

List purchased reservations.

See also: AWS API Documentation

Request Syntax

client.list_reservations(
    ChannelClass='string',
    Codec='string',
    MaxResults=123,
    MaximumBitrate='string',
    MaximumFramerate='string',
    NextToken='string',
    Resolution='string',
    ResourceType='string',
    SpecialFeature='string',
    VideoQuality='string'
)
type ChannelClass:

string

param ChannelClass:

Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'

type Codec:

string

param Codec:

Filter by codec, 'AVC', 'HEVC', 'MPEG2', 'AUDIO', or 'LINK'

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type MaximumBitrate:

string

param MaximumBitrate:

Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'

type MaximumFramerate:

string

param MaximumFramerate:

Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'

type NextToken:

string

param NextToken:

Placeholder documentation for __string

type Resolution:

string

param Resolution:

Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'

type ResourceType:

string

param ResourceType:

Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

type SpecialFeature:

string

param SpecialFeature:

Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'

type VideoQuality:

string

param VideoQuality:

Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'Reservations': [
        {
            'Arn': 'string',
            'Count': 123,
            'CurrencyCode': 'string',
            'Duration': 123,
            'DurationUnits': 'MONTHS',
            'End': 'string',
            'FixedPrice': 123.0,
            'Name': 'string',
            'OfferingDescription': 'string',
            'OfferingId': 'string',
            'OfferingType': 'NO_UPFRONT',
            'Region': 'string',
            'ReservationId': 'string',
            'ResourceSpecification': {
                'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
                'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
                'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
                'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
                'Resolution': 'SD'|'HD'|'FHD'|'UHD',
                'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
                'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
                'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
            },
            'Start': 'string',
            'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
            'Tags': {
                'string': 'string'
            },
            'UsagePrice': 123.0
        },
    ]
}

Response Structure

  • (dict) -- List of reservations

    • NextToken (string) -- Token to retrieve the next page of results

    • Reservations (list) -- List of reservations

      • (dict) -- Reserved resources available to use

        • Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

        • Count (integer) -- Number of reserved resources

        • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

        • Duration (integer) -- Lease duration, e.g. '12'

        • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

        • End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

        • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

        • Name (string) -- User specified reservation name

        • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

        • OfferingId (string) -- Unique offering ID, e.g. '87654321'

        • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

        • Region (string) -- AWS region, e.g. 'us-west-2'

        • ReservationId (string) -- Unique reservation ID, e.g. '1234567'

        • ResourceSpecification (dict) -- Resource configuration details

          • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

          • Codec (string) -- Codec, e.g. 'AVC'

          • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

          • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

          • Resolution (string) -- Resolution, e.g. 'HD'

          • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

          • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

          • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

        • Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

        • State (string) -- Current state of reservation, e.g. 'ACTIVE'

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

          • (string) -- Placeholder documentation for __string

            • (string) -- Placeholder documentation for __string

        • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

PurchaseOffering (updated) Link ¶
Changes (response) 
{'Reservation': {'ResourceSpecification': {'Codec': {'LINK'}}}}

Purchase an offering and create a reservation.

See also: AWS API Documentation

Request Syntax

client.purchase_offering(
    Count=123,
    Name='string',
    OfferingId='string',
    RequestId='string',
    Start='string',
    Tags={
        'string': 'string'
    }
)
type Count:

integer

param Count:

[REQUIRED] Number of resources

type Name:

string

param Name:

Name for the new reservation

type OfferingId:

string

param OfferingId:

[REQUIRED] Offering to purchase, e.g. '87654321'

type RequestId:

string

param RequestId:

Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.This field is autopopulated if not provided.

type Start:

string

param Start:

Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.

type Tags:

dict

param Tags:

A collection of key-value pairs

  • (string) -- Placeholder documentation for __string

    • (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Reservation': {
        'Arn': 'string',
        'Count': 123,
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'End': 'string',
        'FixedPrice': 123.0,
        'Name': 'string',
        'OfferingDescription': 'string',
        'OfferingId': 'string',
        'OfferingType': 'NO_UPFRONT',
        'Region': 'string',
        'ReservationId': 'string',
        'ResourceSpecification': {
            'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
            'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
            'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
            'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
            'Resolution': 'SD'|'HD'|'FHD'|'UHD',
            'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
            'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
            'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
        },
        'Start': 'string',
        'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
        'Tags': {
            'string': 'string'
        },
        'UsagePrice': 123.0
    }
}

Response Structure

  • (dict) -- Purchased reservation

    • Reservation (dict) -- Reserved resources available to use

      • Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

      • Count (integer) -- Number of reserved resources

      • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

      • Duration (integer) -- Lease duration, e.g. '12'

      • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

      • End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

      • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

      • Name (string) -- User specified reservation name

      • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

      • OfferingId (string) -- Unique offering ID, e.g. '87654321'

      • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

      • Region (string) -- AWS region, e.g. 'us-west-2'

      • ReservationId (string) -- Unique reservation ID, e.g. '1234567'

      • ResourceSpecification (dict) -- Resource configuration details

        • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

        • Codec (string) -- Codec, e.g. 'AVC'

        • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

        • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

        • Resolution (string) -- Resolution, e.g. 'HD'

        • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

        • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

        • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

      • Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

      • State (string) -- Current state of reservation, e.g. 'ACTIVE'

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

        • (string) -- Placeholder documentation for __string

          • (string) -- Placeholder documentation for __string

      • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'

UpdateInput (updated) Link ¶
Changes (response) 
{'Input': {'Type': {'AWS_CDI'}}}

Updates an input.

See also: AWS API Documentation

Request Syntax

client.update_input(
    Destinations=[
        {
            'StreamName': 'string'
        },
    ],
    InputDevices=[
        {
            'Id': 'string'
        },
    ],
    InputId='string',
    InputSecurityGroups=[
        'string',
    ],
    MediaConnectFlows=[
        {
            'FlowArn': 'string'
        },
    ],
    Name='string',
    RoleArn='string',
    Sources=[
        {
            'PasswordParam': 'string',
            'Url': 'string',
            'Username': 'string'
        },
    ]
)
type Destinations:

list

param Destinations:

Destination settings for PUSH type inputs.

  • (dict) -- Endpoint settings for a PUSH type input.

    • StreamName (string) -- A unique name for the location the RTMP stream is being pushed to.

type InputDevices:

list

param InputDevices:

Settings for the devices.

  • (dict) -- Settings for an input device.

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

type InputId:

string

param InputId:

[REQUIRED] Unique ID of the input.

type InputSecurityGroups:

list

param InputSecurityGroups:

A list of security groups referenced by IDs to attach to the input.

  • (string) -- Placeholder documentation for __string

type MediaConnectFlows:

list

param MediaConnectFlows:

A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.

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

    • FlowArn (string) -- The ARN of the MediaConnect Flow that you want to use as a source.

type Name:

string

param Name:

Name of the input.

type RoleArn:

string

param RoleArn:

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

type Sources:

list

param Sources:

The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.

  • (dict) -- Settings for 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.

rtype:

dict

returns:

Response Syntax

{
    'Input': {
        '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'
            },
        ],
        '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'
    }
}

Response Structure

  • (dict) -- The input update is successfully initiated.

    • Input (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.

      • 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 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) -- Placeholder documentation for InputType

UpdateReservation (updated) Link ¶
Changes (response) 
{'Reservation': {'ResourceSpecification': {'Codec': {'LINK'}}}}

Update reservation.

See also: AWS API Documentation

Request Syntax

client.update_reservation(
    Name='string',
    ReservationId='string'
)
type Name:

string

param Name:

Name of the reservation

type ReservationId:

string

param ReservationId:

[REQUIRED] Unique reservation ID, e.g. '1234567'

rtype:

dict

returns:

Response Syntax

{
    'Reservation': {
        'Arn': 'string',
        'Count': 123,
        'CurrencyCode': 'string',
        'Duration': 123,
        'DurationUnits': 'MONTHS',
        'End': 'string',
        'FixedPrice': 123.0,
        'Name': 'string',
        'OfferingDescription': 'string',
        'OfferingId': 'string',
        'OfferingType': 'NO_UPFRONT',
        'Region': 'string',
        'ReservationId': 'string',
        'ResourceSpecification': {
            'ChannelClass': 'STANDARD'|'SINGLE_PIPELINE',
            'Codec': 'MPEG2'|'AVC'|'HEVC'|'AUDIO'|'LINK',
            'MaximumBitrate': 'MAX_10_MBPS'|'MAX_20_MBPS'|'MAX_50_MBPS',
            'MaximumFramerate': 'MAX_30_FPS'|'MAX_60_FPS',
            'Resolution': 'SD'|'HD'|'FHD'|'UHD',
            'ResourceType': 'INPUT'|'OUTPUT'|'MULTIPLEX'|'CHANNEL',
            'SpecialFeature': 'ADVANCED_AUDIO'|'AUDIO_NORMALIZATION',
            'VideoQuality': 'STANDARD'|'ENHANCED'|'PREMIUM'
        },
        'Start': 'string',
        'State': 'ACTIVE'|'EXPIRED'|'CANCELED'|'DELETED',
        'Tags': {
            'string': 'string'
        },
        'UsagePrice': 123.0
    }
}

Response Structure

  • (dict) -- Updated reservation

    • Reservation (dict) -- Reserved resources available to use

      • Arn (string) -- Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'

      • Count (integer) -- Number of reserved resources

      • CurrencyCode (string) -- Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'

      • Duration (integer) -- Lease duration, e.g. '12'

      • DurationUnits (string) -- Units for duration, e.g. 'MONTHS'

      • End (string) -- Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'

      • FixedPrice (float) -- One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering

      • Name (string) -- User specified reservation name

      • OfferingDescription (string) -- Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'

      • OfferingId (string) -- Unique offering ID, e.g. '87654321'

      • OfferingType (string) -- Offering type, e.g. 'NO_UPFRONT'

      • Region (string) -- AWS region, e.g. 'us-west-2'

      • ReservationId (string) -- Unique reservation ID, e.g. '1234567'

      • ResourceSpecification (dict) -- Resource configuration details

        • ChannelClass (string) -- Channel class, e.g. 'STANDARD'

        • Codec (string) -- Codec, e.g. 'AVC'

        • MaximumBitrate (string) -- Maximum bitrate, e.g. 'MAX_20_MBPS'

        • MaximumFramerate (string) -- Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)

        • Resolution (string) -- Resolution, e.g. 'HD'

        • ResourceType (string) -- Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'

        • SpecialFeature (string) -- Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)

        • VideoQuality (string) -- Video quality, e.g. 'STANDARD' (Outputs only)

      • Start (string) -- Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'

      • State (string) -- Current state of reservation, e.g. 'ACTIVE'

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

        • (string) -- Placeholder documentation for __string

          • (string) -- Placeholder documentation for __string

      • UsagePrice (float) -- Recurring usage charge for each reserved resource, e.g. '157.0'