prefetch_schedules

Creates, updates, deletes, gets or lists a prefetch_schedules resource.

Overview

Name	prefetch_schedules
Type	Resource
Id	aws.mediatailor.prefetch_schedules

Fields

The following fields are returned by SELECT queries:

get_prefetch_schedule

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the prefetch schedule.
consumption	object	For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.
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.
playback_configuration_name	string	The name of the playback configuration to create the prefetch schedule for.
recurring_prefetch_configuration	object	The configuration that defines how MediaTailor performs recurring prefetch.
retrieval	object	A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
schedule_type	string	The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event. (SINGLE, RECURRING)
stream_id	string	An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
tags	object	The tags assigned to the prefetch schedule. 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.

list_prefetch_schedules

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the prefetch schedule.
consumption	object	For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.
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.
playback_configuration_name	string	The name of the playback configuration to create the prefetch schedule for.
recurring_prefetch_configuration	object	The configuration that defines how MediaTailor performs recurring prefetch.
retrieval	object	A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
schedule_type	string	The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event. For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor. (SINGLE, RECURRING)
stream_id	string	An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
tags	object	The tags assigned to the prefetch schedule. 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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_prefetch_schedule	select	name, playback_configuration_name, region		Retrieves a prefetch schedule for a playback configuration. 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.
list_prefetch_schedules	select	playback_configuration_name, region		Lists the prefetch schedules for a playback configuration.
create_prefetch_schedule	insert	name, playback_configuration_name, region		Creates a prefetch schedule for a playback configuration. 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.
delete_prefetch_schedule	delete	name, playback_configuration_name, region		Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
playback_configuration_name	string	The name of the playback configuration for this prefetch schedule.
region	string	AWS region (default: us-east-1)

SELECT examples

get_prefetch_schedule

Retrieves a prefetch schedule for a playback configuration. 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.

SELECT
arn,
consumption,
name,
playback_configuration_name,
recurring_prefetch_configuration,
retrieval,
schedule_type,
stream_id,
tags
FROM aws.mediatailor.prefetch_schedules
WHERE name = '{{ name }}' -- required
AND playback_configuration_name = '{{ playback_configuration_name }}' -- required
AND region = '{{ region }}' -- required
;

list_prefetch_schedules

Lists the prefetch schedules for a playback configuration.

SELECT
arn,
consumption,
name,
playback_configuration_name,
recurring_prefetch_configuration,
retrieval,
schedule_type,
stream_id,
tags
FROM aws.mediatailor.prefetch_schedules
WHERE playback_configuration_name = '{{ playback_configuration_name }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_prefetch_schedule

Creates a prefetch schedule for a playback configuration. 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.

INSERT INTO aws.mediatailor.prefetch_schedules (
Consumption,
Retrieval,
RecurringPrefetchConfiguration,
ScheduleType,
StreamId,
Tags,
name,
playback_configuration_name,
region
)
SELECT 
'{{ Consumption }}',
'{{ Retrieval }}',
'{{ RecurringPrefetchConfiguration }}',
'{{ ScheduleType }}',
'{{ StreamId }}',
'{{ Tags }}',
'{{ name }}',
'{{ playback_configuration_name }}',
'{{ region }}'
RETURNING
arn,
consumption,
name,
playback_configuration_name,
recurring_prefetch_configuration,
retrieval,
schedule_type,
stream_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: prefetch_schedules
props:
  - name: name
    value: "{{ name }}"
    description: Required parameter for the prefetch_schedules resource.
  - name: playback_configuration_name
    value: "{{ playback_configuration_name }}"
    description: Required parameter for the prefetch_schedules resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the prefetch_schedules resource.
  - name: Consumption
    description: |
      For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.
    value:
      AvailMatchingCriteria:
        - DynamicVariable: "{{ DynamicVariable }}"
          Operator: "{{ Operator }}"
      EndTime: "{{ EndTime }}"
      StartTime: "{{ StartTime }}"
  - name: Retrieval
    description: |
      A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
    value:
      DynamicVariables: "{{ DynamicVariables }}"
      EndTime: "{{ EndTime }}"
      StartTime: "{{ StartTime }}"
      TrafficShapingType: "{{ TrafficShapingType }}"
      TrafficShapingRetrievalWindow:
        RetrievalWindowDurationSeconds: {{ RetrievalWindowDurationSeconds }}
      TrafficShapingTpsConfiguration:
        PeakTps: {{ PeakTps }}
        PeakConcurrentUsers: {{ PeakConcurrentUsers }}
  - name: RecurringPrefetchConfiguration
    description: |
      The configuration that defines how MediaTailor performs recurring prefetch.
    value:
      StartTime: "{{ StartTime }}"
      EndTime: "{{ EndTime }}"
      RecurringConsumption:
        RetrievedAdExpirationSeconds: {{ RetrievedAdExpirationSeconds }}
        AvailMatchingCriteria:
          - DynamicVariable: "{{ DynamicVariable }}"
            Operator: "{{ Operator }}"
      RecurringRetrieval:
        DynamicVariables: "{{ DynamicVariables }}"
        DelayAfterAvailEndSeconds: {{ DelayAfterAvailEndSeconds }}
        TrafficShapingType: "{{ TrafficShapingType }}"
        TrafficShapingRetrievalWindow:
          RetrievalWindowDurationSeconds: {{ RetrievalWindowDurationSeconds }}
        TrafficShapingTpsConfiguration:
          PeakTps: {{ PeakTps }}
          PeakConcurrentUsers: {{ PeakConcurrentUsers }}
  - name: ScheduleType
    value: "{{ ScheduleType }}"
    valid_values: ['SINGLE', 'RECURRING']
  - name: StreamId
    value: "{{ StreamId }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_prefetch_schedule

Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

DELETE FROM aws.mediatailor.prefetch_schedules
WHERE name = '{{ name }}' --required
AND playback_configuration_name = '{{ playback_configuration_name }}' --required
AND region = '{{ region }}' --required
;