MediaTailor / Paginator / ListPrefetchSchedules

ListPrefetchSchedules#

class MediaTailor.Paginator.ListPrefetchSchedules#

paginator = client.get_paginator('list_prefetch_schedules')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    PlaybackConfigurationName='string',
    StreamId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PlaybackConfigurationName (string) –
[REQUIRED]

Retrieves the prefetch schedule(s) for a specific playback configuration.
StreamId (string) – An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
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': [
        {
            'Arn': 'string',
            'Consumption': {
                'AvailMatchingCriteria': [
                    {
                        'DynamicVariable': 'string',
                        'Operator': 'EQUALS'
                    },
                ],
                'EndTime': datetime(2015, 1, 1),
                'StartTime': datetime(2015, 1, 1)
            },
            'Name': 'string',
            'PlaybackConfigurationName': 'string',
            'Retrieval': {
                'DynamicVariables': {
                    'string': 'string'
                },
                'EndTime': datetime(2015, 1, 1),
                'StartTime': datetime(2015, 1, 1)
            },
            'StreamId': 'string'
        },
    ],

}

Response Structure

(dict) –
- Items (list) –
  
  Lists the prefetch schedules. An empty Items list doesn’t mean there aren’t more items to fetch, just that that page was empty.
  - (dict) –
    
    A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of the prefetch schedule.
    - Consumption (dict) –
      
      Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
      - AvailMatchingCriteria (list) –
        
        If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
        
        (dict) –
        
        MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
        
        As an example, let’s say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
        
        You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
        
        DynamicVariable (string) –
        
        The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
        
        You can include up to 100 dynamic variables.
        
        Operator (string) –
        
        For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
      - EndTime (datetime) –
        
        The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you’d like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
      - StartTime (datetime) –
        
        The time when prefetched ads are considered for use in an ad break. If you don’t specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
    - Name (string) –
      
      The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
    - PlaybackConfigurationName (string) –
      
      The name of the playback configuration to create the prefetch schedule for.
    - Retrieval (dict) –
      
      A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
      - DynamicVariables (dict) –
        
        The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
        
        You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
        
        (string) –
        
        (string) –
      - EndTime (datetime) –
        
        The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
      - StartTime (datetime) –
        
        The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
    - StreamId (string) –
      
      An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.