MediaTailor / Client / update_channel

update_channel#

MediaTailor.Client.update_channel(**kwargs)#

Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

Request Syntax

response = client.update_channel(
    Audiences=[
        'string',
    ],
    ChannelName='string',
    FillerSlate={
        'SourceLocationName': 'string',
        'VodSourceName': 'string'
    },
    Outputs=[
        {
            'DashPlaylistSettings': {
                'ManifestWindowSeconds': 123,
                'MinBufferTimeSeconds': 123,
                'MinUpdatePeriodSeconds': 123,
                'SuggestedPresentationDelaySeconds': 123
            },
            'HlsPlaylistSettings': {
                'AdMarkupType': [
                    'DATERANGE'|'SCTE35_ENHANCED',
                ],
                'ManifestWindowSeconds': 123
            },
            'ManifestName': 'string',
            'SourceGroup': 'string'
        },
    ],
    TimeShiftConfiguration={
        'MaxTimeDelaySeconds': 123
    }
)

Parameters:

Audiences (list) –
The list of audiences defined in channel.
- (string) –
ChannelName (string) –
[REQUIRED]

The name of the channel.
FillerSlate (dict) –
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.
Outputs (list) –
[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.
    - AdMarkupType (list) –
      
      Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
      - (string) –
    - 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.
TimeShiftConfiguration (dict) –
The time-shifted viewing configuration you want to associate to the channel.
- MaxTimeDelaySeconds (integer) – [REQUIRED]
  
  The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Audiences': [
        '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': {
                'AdMarkupType': [
                    'DATERANGE'|'SCTE35_ENHANCED',
                ],
                'ManifestWindowSeconds': 123
            },
            'ManifestName': 'string',
            'PlaybackUrl': 'string',
            'SourceGroup': 'string'
        },
    ],
    'PlaybackMode': 'string',
    'Tags': {
        'string': 'string'
    },
    'Tier': 'string',
    'TimeShiftConfiguration': {
        'MaxTimeDelaySeconds': 123
    }
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) associated with the channel.
- Audiences (list) –
  
  The list of audiences defined in channel.
  - (string) –
- ChannelName (string) –
  
  The name of the channel.
- ChannelState (string) –
  
  Returns the state whether the channel is running or not.
- CreationTime (datetime) –
  
  The timestamp of when the channel was created.
- FillerSlate (dict) –
  
  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.
- LastModifiedTime (datetime) –
  
  The timestamp that indicates when the channel was last modified.
- Outputs (list) –
  
  The channel’s output properties.
  - (dict) –
    
    The output item response.
    - 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.
      - AdMarkupType (list) –
        
        Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
        
        (string) –
      - 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 type of playback mode for this channel.
  
  LINEAR - Programs play back-to-back only once.
  
  LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
- Tags (dict) –
  
  The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
  - (string) –
    - (string) –
- Tier (string) –
  
  The tier associated with this Channel.
- TimeShiftConfiguration (dict) –
  
  The time-shifted viewing configuration for the channel.
  - MaxTimeDelaySeconds (integer) –
    
    The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).