MediaTailor / Client / get_channel_schedule

get_channel_schedule#

MediaTailor.Client.get_channel_schedule(**kwargs)#

Retrieves information about your channel’s schedule.

Request Syntax

response = client.get_channel_schedule(
    ChannelName='string',
    DurationMinutes='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ChannelName (string) –
[REQUIRED]

The name of the channel associated with this Channel Schedule.
DurationMinutes (string) – The duration in minutes of the channel schedule.
MaxResults (integer) – The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
NextToken (string) –
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.

For the first GetChannelScheduleRequest request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

If the previous response didn’t include a NextToken element, there are no more channel schedules to get.

Return type:

dict

Returns:

Response Syntax

{
    'Items': [
        {
            'ApproximateDurationSeconds': 123,
            'ApproximateStartTime': datetime(2015, 1, 1),
            'Arn': 'string',
            'ChannelName': 'string',
            'LiveSourceName': 'string',
            'ProgramName': 'string',
            'ScheduleAdBreaks': [
                {
                    'ApproximateDurationSeconds': 123,
                    'ApproximateStartTime': datetime(2015, 1, 1),
                    'SourceLocationName': 'string',
                    'VodSourceName': 'string'
                },
            ],
            'ScheduleEntryType': 'PROGRAM'|'FILLER_SLATE',
            'SourceLocationName': 'string',
            'VodSourceName': 'string'
        },
    ],
    'NextToken': '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.
    - 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.
- NextToken (string) –
  
  Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.