MediaTailor / Paginator / GetChannelSchedule

GetChannelSchedule#

class MediaTailor.Paginator.GetChannelSchedule#

paginator = client.get_paginator('get_channel_schedule')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from MediaTailor.Client.get_channel_schedule().

Request Syntax

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

Parameters:

Audience (string) – The single audience for GetChannelScheduleRequest.
ChannelName (string) –
[REQUIRED]

The name of the channel associated with this Channel Schedule.
DurationMinutes (string) – The duration in minutes of the channel schedule.
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

{
    'Items': [
        {
            'ApproximateDurationSeconds': 123,
            'ApproximateStartTime': datetime(2015, 1, 1),
            'Arn': 'string',
            'Audiences': [
                'string',
            ],
            'ChannelName': 'string',
            'LiveSourceName': 'string',
            'ProgramName': 'string',
            'ScheduleAdBreaks': [
                {
                    'ApproximateDurationSeconds': 123,
                    'ApproximateStartTime': datetime(2015, 1, 1),
                    'SourceLocationName': 'string',
                    'VodSourceName': 'string'
                },
            ],
            'ScheduleEntryType': 'PROGRAM'|'FILLER_SLATE'|'ALTERNATE_MEDIA',
            'SourceLocationName': 'string',
            'VodSourceName': 'string'
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  A list of schedule entries for the channel.
  - (dict) –
    
    The properties for a schedule.
    - ApproximateDurationSeconds (integer) –
      
      The approximate duration of this program, in seconds.
    - ApproximateStartTime (datetime) –
      
      The approximate time that the program will start playing.
    - Arn (string) –
      
      The ARN of the program.
    - Audiences (list) –
      
      The list of audiences defined in ScheduleEntry.
      - (string) –
    - ChannelName (string) –
      
      The name of the channel that uses this schedule.
    - LiveSourceName (string) –
      
      The name of the live source used for the program.
    - ProgramName (string) –
      
      The name of the program.
    - ScheduleAdBreaks (list) –
      
      The schedule’s ad break properties.
      - (dict) –
        
        The schedule’s ad break properties.
        
        ApproximateDurationSeconds (integer) –
        
        The approximate duration of the ad break, in seconds.
        
        ApproximateStartTime (datetime) –
        
        The approximate time that the ad will start playing.
        
        SourceLocationName (string) –
        
        The name of the source location containing the VOD source used for the ad break.
        
        VodSourceName (string) –
        
        The name of the VOD source used for the ad break.
    - ScheduleEntryType (string) –
      
      The type of schedule entry.
    - SourceLocationName (string) –
      
      The name of the source location.
    - VodSourceName (string) –
      
      The name of the VOD source.