AWS MediaTailor

2022/01/06 - AWS MediaTailor - 1 updated api methods

Changes  This release adds support for filler slate when updating MediaTailor channels that use the linear playback mode.

UpdateChannel (updated) Link ΒΆ
Changes (request)
{'FillerSlate': {'SourceLocationName': 'string', 'VodSourceName': 'string'}}

Updates an existing channel.

See also: AWS API Documentation

Request Syntax

client.update_channel(
    ChannelName='string',
    FillerSlate={
        'SourceLocationName': 'string',
        'VodSourceName': 'string'
    },
    Outputs=[
        {
            'DashPlaylistSettings': {
                'ManifestWindowSeconds': 123,
                'MinBufferTimeSeconds': 123,
                'MinUpdatePeriodSeconds': 123,
                'SuggestedPresentationDelaySeconds': 123
            },
            'HlsPlaylistSettings': {
                'ManifestWindowSeconds': 123
            },
            'ManifestName': 'string',
            'SourceGroup': 'string'
        },
    ]
)
type ChannelName

string

param ChannelName

[REQUIRED]

The identifier for the channel you are working on.

type FillerSlate

dict

param FillerSlate

The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.

  • SourceLocationName (string) --

    The name of the source location where the slate VOD source is stored.

  • VodSourceName (string) --

    The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

type Outputs

list

param Outputs

[REQUIRED]

The channel's output properties.

  • (dict) --

    The output configuration for this channel.

    • DashPlaylistSettings (dict) --

      DASH manifest configuration parameters.

      • ManifestWindowSeconds (integer) --

        The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

      • MinBufferTimeSeconds (integer) --

        Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

      • MinUpdatePeriodSeconds (integer) --

        Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

      • SuggestedPresentationDelaySeconds (integer) --

        Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

    • HlsPlaylistSettings (dict) --

      HLS playlist configuration parameters.

      • ManifestWindowSeconds (integer) --

        The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

    • ManifestName (string) -- [REQUIRED]

      The name of the manifest for the channel. The name appears in the PlaybackUrl.

    • SourceGroup (string) -- [REQUIRED]

      A string used to match which HttpPackageConfiguration is used for each VodSource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'ChannelName': 'string',
    'ChannelState': 'RUNNING'|'STOPPED',
    'CreationTime': datetime(2015, 1, 1),
    'FillerSlate': {
        'SourceLocationName': 'string',
        'VodSourceName': 'string'
    },
    'LastModifiedTime': datetime(2015, 1, 1),
    'Outputs': [
        {
            'DashPlaylistSettings': {
                'ManifestWindowSeconds': 123,
                'MinBufferTimeSeconds': 123,
                'MinUpdatePeriodSeconds': 123,
                'SuggestedPresentationDelaySeconds': 123
            },
            'HlsPlaylistSettings': {
                'ManifestWindowSeconds': 123
            },
            'ManifestName': 'string',
            'PlaybackUrl': 'string',
            'SourceGroup': 'string'
        },
    ],
    'PlaybackMode': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    Success.

    • Arn (string) --

      The ARN of the channel.

    • ChannelName (string) --

      The name of the channel.

    • ChannelState (string) --

      Indicates whether the channel is in a running state or not.

    • CreationTime (datetime) --

      The timestamp of when the channel was created.

    • FillerSlate (dict) --

      Contains information about the slate used to fill gaps between programs in the schedule.

      • SourceLocationName (string) --

        The name of the source location where the slate VOD source is stored.

      • VodSourceName (string) --

        The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

    • LastModifiedTime (datetime) --

      The timestamp of when the channel was last modified.

    • Outputs (list) --

      The channel's output properties.

      • (dict) --

        This response includes only the "property" : "type" property.

        • DashPlaylistSettings (dict) --

          DASH manifest configuration settings.

          • ManifestWindowSeconds (integer) --

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

          • MinBufferTimeSeconds (integer) --

            Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • MinUpdatePeriodSeconds (integer) --

            Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • SuggestedPresentationDelaySeconds (integer) --

            Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • HlsPlaylistSettings (dict) --

          HLS manifest configuration settings.

          • ManifestWindowSeconds (integer) --

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • ManifestName (string) --

          The name of the manifest for the channel that will appear in the channel output's playback URL.

        • PlaybackUrl (string) --

          The URL used for playback by content players.

        • SourceGroup (string) --

          A string used to associate a package configuration source group with a channel output.

    • PlaybackMode (string) --

      The channel's playback mode.

    • Tags (dict) --

      The tags assigned to the channel.

      • (string) --

        • (string) --