2025/04/21 - AWS MediaTailor - 3 updated api methods
Changes Added support for Recurring Prefetch and Traffic Shaping on both Single and Recurring Prefetch. ListPrefetchSchedules now return single prefetchs by default and can be provided scheduleType of SINGLE, RECURRING, AND ALL.
{'RecurringPrefetchConfiguration': {'EndTime': 'timestamp',
'RecurringConsumption': {'AvailMatchingCriteria': [{'DynamicVariable': 'string',
'Operator': 'EQUALS'}],
'RetrievedAdExpirationSeconds': 'integer'},
'RecurringRetrieval': {'DelayAfterAvailEndSeconds': 'integer',
'DynamicVariables': {'string': 'string'},
'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'StartTime': 'timestamp'},
'Retrieval': {'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'ScheduleType': 'SINGLE | RECURRING'}
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.
See also: AWS API Documentation
Request Syntax
client.create_prefetch_schedule(
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),
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
},
RecurringPrefetchConfiguration={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'RecurringConsumption': {
'RetrievedAdExpirationSeconds': 123,
'AvailMatchingCriteria': [
{
'DynamicVariable': 'string',
'Operator': 'EQUALS'
},
]
},
'RecurringRetrieval': {
'DynamicVariables': {
'string': 'string'
},
'DelayAfterAvailEndSeconds': 123,
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
}
},
ScheduleType='SINGLE'|'RECURRING',
StreamId='string'
)
dict
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
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) -- [REQUIRED]
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) -- [REQUIRED]
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
EndTime (datetime) -- [REQUIRED]
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 retrieves them from the ad decision server.
string
[REQUIRED]
The name to assign to the schedule request.
string
[REQUIRED]
The name to assign to the playback configuration.
dict
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
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) -- [REQUIRED]
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.
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
dict
The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
StartTime (datetime) --
The start time for the window that MediaTailor prefetches and inserts ads in a live event.
EndTime (datetime) -- [REQUIRED]
The end time for the window that MediaTailor prefetches and inserts ads in a live event.
RecurringConsumption (dict) -- [REQUIRED]
The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
RetrievedAdExpirationSeconds (integer) --
The number of seconds that an ad is available for insertion after it was prefetched.
AvailMatchingCriteria (list) --
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
(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) -- [REQUIRED]
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) -- [REQUIRED]
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
RecurringRetrieval (dict) -- [REQUIRED]
The configuration for prefetch ad retrieval from the ADS.
DynamicVariables (dict) --
The dynamic variables to use for substitution during prefetch requests to the ADS.
(string) --
(string) --
DelayAfterAvailEndSeconds (integer) --
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
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.
string
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
dict
Response Syntax
{
'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),
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
},
'RecurringPrefetchConfiguration': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'RecurringConsumption': {
'RetrievedAdExpirationSeconds': 123,
'AvailMatchingCriteria': [
{
'DynamicVariable': 'string',
'Operator': 'EQUALS'
},
]
},
'RecurringRetrieval': {
'DynamicVariables': {
'string': 'string'
},
'DelayAfterAvailEndSeconds': 123,
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
}
},
'ScheduleType': 'SINGLE'|'RECURRING',
'StreamId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN to assign to the prefetch schedule.
Consumption (dict) --
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
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 retrieves them from the ad decision server.
Name (string) --
The name to assign to the prefetch schedule.
PlaybackConfigurationName (string) --
The name to assign to the playback configuration.
Retrieval (dict) --
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
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.
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
RecurringPrefetchConfiguration (dict) --
The configuration that defines how MediaTailor performs recurring prefetch.
StartTime (datetime) --
The start time for the window that MediaTailor prefetches and inserts ads in a live event.
EndTime (datetime) --
The end time for the window that MediaTailor prefetches and inserts ads in a live event.
RecurringConsumption (dict) --
The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
RetrievedAdExpirationSeconds (integer) --
The number of seconds that an ad is available for insertion after it was prefetched.
AvailMatchingCriteria (list) --
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
(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.
RecurringRetrieval (dict) --
The configuration for prefetch ad retrieval from the ADS.
DynamicVariables (dict) --
The dynamic variables to use for substitution during prefetch requests to the ADS.
(string) --
(string) --
DelayAfterAvailEndSeconds (integer) --
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
ScheduleType (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.
StreamId (string) --
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
{'RecurringPrefetchConfiguration': {'EndTime': 'timestamp',
'RecurringConsumption': {'AvailMatchingCriteria': [{'DynamicVariable': 'string',
'Operator': 'EQUALS'}],
'RetrievedAdExpirationSeconds': 'integer'},
'RecurringRetrieval': {'DelayAfterAvailEndSeconds': 'integer',
'DynamicVariables': {'string': 'string'},
'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'StartTime': 'timestamp'},
'Retrieval': {'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'ScheduleType': 'SINGLE | RECURRING'}
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.
See also: AWS API Documentation
Request Syntax
client.get_prefetch_schedule(
Name='string',
PlaybackConfigurationName='string'
)
string
[REQUIRED]
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
string
[REQUIRED]
Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
dict
Response Syntax
{
'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),
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
},
'ScheduleType': 'SINGLE'|'RECURRING',
'RecurringPrefetchConfiguration': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'RecurringConsumption': {
'RetrievedAdExpirationSeconds': 123,
'AvailMatchingCriteria': [
{
'DynamicVariable': 'string',
'Operator': 'EQUALS'
},
]
},
'RecurringRetrieval': {
'DynamicVariables': {
'string': 'string'
},
'DelayAfterAvailEndSeconds': 123,
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
}
},
'StreamId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the prefetch schedule.
Consumption (dict) --
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
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 retrieves 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.
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
ScheduleType (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.
RecurringPrefetchConfiguration (dict) --
The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
StartTime (datetime) --
The start time for the window that MediaTailor prefetches and inserts ads in a live event.
EndTime (datetime) --
The end time for the window that MediaTailor prefetches and inserts ads in a live event.
RecurringConsumption (dict) --
The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
RetrievedAdExpirationSeconds (integer) --
The number of seconds that an ad is available for insertion after it was prefetched.
AvailMatchingCriteria (list) --
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
(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.
RecurringRetrieval (dict) --
The configuration for prefetch ad retrieval from the ADS.
DynamicVariables (dict) --
The dynamic variables to use for substitution during prefetch requests to the ADS.
(string) --
(string) --
DelayAfterAvailEndSeconds (integer) --
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
StreamId (string) --
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
{'ScheduleType': 'SINGLE | RECURRING | ALL'}
Response {'Items': {'RecurringPrefetchConfiguration': {'EndTime': 'timestamp',
'RecurringConsumption': {'AvailMatchingCriteria': [{'DynamicVariable': 'string',
'Operator': 'EQUALS'}],
'RetrievedAdExpirationSeconds': 'integer'},
'RecurringRetrieval': {'DelayAfterAvailEndSeconds': 'integer',
'DynamicVariables': {'string': 'string'},
'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'StartTime': 'timestamp'},
'Retrieval': {'TrafficShapingRetrievalWindow': {'RetrievalWindowDurationSeconds': 'integer'},
'TrafficShapingType': 'RETRIEVAL_WINDOW'},
'ScheduleType': 'SINGLE | RECURRING'}}
Lists the prefetch schedules for a playback configuration.
See also: AWS API Documentation
Request Syntax
client.list_prefetch_schedules(
MaxResults=123,
NextToken='string',
PlaybackConfigurationName='string',
ScheduleType='SINGLE'|'RECURRING'|'ALL',
StreamId='string'
)
integer
The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
string
(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest 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 prefetch schedules to get.
string
[REQUIRED]
Retrieves the prefetch schedule(s) for a specific playback configuration.
string
The type of prefetch schedules that you want to list. SINGLE indicates that you want to list the configured single prefetch schedules. RECURRING indicates that you want to list the configured recurring prefetch schedules. ALL indicates that you want to list all configured prefetch schedules.
string
An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
dict
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),
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
},
'ScheduleType': 'SINGLE'|'RECURRING',
'RecurringPrefetchConfiguration': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'RecurringConsumption': {
'RetrievedAdExpirationSeconds': 123,
'AvailMatchingCriteria': [
{
'DynamicVariable': 'string',
'Operator': 'EQUALS'
},
]
},
'RecurringRetrieval': {
'DynamicVariables': {
'string': 'string'
},
'DelayAfterAvailEndSeconds': 123,
'TrafficShapingType': 'RETRIEVAL_WINDOW',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
}
}
},
'StreamId': 'string'
},
],
'NextToken': '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 for single prefetch schedules. 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 retrieves 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.
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
ScheduleType (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.
RecurringPrefetchConfiguration (dict) --
The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.
StartTime (datetime) --
The start time for the window that MediaTailor prefetches and inserts ads in a live event.
EndTime (datetime) --
The end time for the window that MediaTailor prefetches and inserts ads in a live event.
RecurringConsumption (dict) --
The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.
RetrievedAdExpirationSeconds (integer) --
The number of seconds that an ad is available for insertion after it was prefetched.
AvailMatchingCriteria (list) --
The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.
(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.
RecurringRetrieval (dict) --
The configuration for prefetch ad retrieval from the ADS.
DynamicVariables (dict) --
The dynamic variables to use for substitution during prefetch requests to the ADS.
(string) --
(string) --
DelayAfterAvailEndSeconds (integer) --
The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
TrafficShapingType (string) --
Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
StreamId (string) --
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
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.