2026/04/06 - AWS MediaTailor - 6 updated api methods
Changes This change adds support for Tagging the resource types Programs and Prefetch Schedules
{'Tags': {'string': 'string'}}
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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 123
}
}
},
ScheduleType='SINGLE'|'RECURRING',
StreamId='string',
Tags={
'string': '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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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
The tags to assign 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.
(string) --
(string) --
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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 123
}
}
},
'ScheduleType': 'SINGLE'|'RECURRING',
'StreamId': 'string',
'Tags': {
'string': '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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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.
Tags (dict) --
The tags to assign 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.
(string) --
(string) --
{'Tags': {'string': 'string'}}
Creates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
See also: AWS API Documentation
Request Syntax
client.create_program(
AdBreaks=[
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ChannelName='string',
LiveSourceName='string',
ProgramName='string',
ScheduleConfiguration={
'Transition': {
'DurationMillis': 123,
'RelativePosition': 'BEFORE_PROGRAM'|'AFTER_PROGRAM',
'RelativeProgram': 'string',
'ScheduledStartTimeMillis': 123,
'Type': 'string'
},
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
}
},
SourceLocationName='string',
VodSourceName='string',
AudienceMedia=[
{
'Audience': 'string',
'AlternateMedia': [
{
'SourceLocationName': 'string',
'LiveSourceName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'ScheduledStartTimeMillis': 123,
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DurationMillis': 123
},
]
},
],
Tags={
'string': 'string'
}
)
list
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) -- [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
string
[REQUIRED]
The name of the channel for this Program.
string
The name of the LiveSource for this Program.
string
[REQUIRED]
The name of the Program.
dict
[REQUIRED]
The schedule configuration settings.
Transition (dict) -- [REQUIRED]
Program transition configurations.
DurationMillis (integer) --
The duration of the live program in seconds.
RelativePosition (string) -- [REQUIRED]
The position where this program will be inserted relative to the RelativePosition.
RelativeProgram (string) --
The name of the program that this program will be inserted next to, as defined by RelativePosition.
ScheduledStartTimeMillis (integer) --
The date and time that the program is scheduled to start, in epoch milliseconds.
Type (string) -- [REQUIRED]
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
ClipRange (dict) --
Program clip range configuration.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
string
[REQUIRED]
The name of the source location.
string
The name that's used to refer to a VOD source.
list
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
AlternateMedia (list) --
The list of AlternateMedia defined in AudienceMedia.
(dict) --
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
SourceLocationName (string) --
The name of the source location for alternateMedia.
LiveSourceName (string) --
The name of the live source for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
ClipRange (dict) --
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) -- [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
dict
The tags to assign to the program. 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.
(string) --
(string) --
dict
Response Syntax
{
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Arn': 'string',
'ChannelName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'AudienceMedia': [
{
'Audience': 'string',
'AlternateMedia': [
{
'SourceLocationName': 'string',
'LiveSourceName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'ScheduledStartTimeMillis': 123,
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DurationMillis': 123
},
]
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
Arn (string) --
The ARN to assign to the program.
ChannelName (string) --
The name to assign to the channel for this program.
CreationTime (datetime) --
The time the program was created.
LiveSourceName (string) --
The name of the LiveSource for this Program.
ProgramName (string) --
The name to assign to this program.
ScheduledStartTime (datetime) --
The scheduled start time for this Program.
SourceLocationName (string) --
The name to assign to the source location for this program.
VodSourceName (string) --
The name that's used to refer to a VOD source.
ClipRange (dict) --
The clip range configuration settings.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
DurationMillis (integer) --
The duration of the live program in milliseconds.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
AlternateMedia (list) --
The list of AlternateMedia defined in AudienceMedia.
(dict) --
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
SourceLocationName (string) --
The name of the source location for alternateMedia.
LiveSourceName (string) --
The name of the live source for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
ClipRange (dict) --
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
Tags (dict) --
The tags to assign to the program. 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.
(string) --
(string) --
{'Tags': {'string': 'string'}}
Describes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide.
See also: AWS API Documentation
Request Syntax
client.describe_program(
ChannelName='string',
ProgramName='string'
)
string
[REQUIRED]
The name of the channel associated with this Program.
string
[REQUIRED]
The name of the program.
dict
Response Syntax
{
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Arn': 'string',
'ChannelName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'AudienceMedia': [
{
'Audience': 'string',
'AlternateMedia': [
{
'SourceLocationName': 'string',
'LiveSourceName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'ScheduledStartTimeMillis': 123,
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DurationMillis': 123
},
]
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
Arn (string) --
The ARN of the program.
ChannelName (string) --
The name of the channel that the program belongs to.
CreationTime (datetime) --
The timestamp of when the program was created.
LiveSourceName (string) --
The name of the LiveSource for this Program.
ProgramName (string) --
The name of the program.
ScheduledStartTime (datetime) --
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
SourceLocationName (string) --
The source location name.
VodSourceName (string) --
The name that's used to refer to a VOD source.
ClipRange (dict) --
The clip range configuration settings.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
DurationMillis (integer) --
The duration of the live program in milliseconds.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
AlternateMedia (list) --
The list of AlternateMedia defined in AudienceMedia.
(dict) --
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
SourceLocationName (string) --
The name of the source location for alternateMedia.
LiveSourceName (string) --
The name of the live source for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
ClipRange (dict) --
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
Tags (dict) --
The tags assigned to the program. 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.
(string) --
(string) --
{'Tags': {'string': 'string'}}
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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 123
}
}
},
'StreamId': 'string',
'Tags': {
'string': '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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
StreamId (string) --
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
Tags (dict) --
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.
(string) --
(string) --
{'Items': {'Tags': {'string': 'string'}}}
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.
The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
string
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
For the first ListPrefetchSchedules request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.
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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 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'|'TPS',
'TrafficShapingRetrievalWindow': {
'RetrievalWindowDurationSeconds': 123
},
'TrafficShapingTpsConfiguration': {
'PeakTps': 123,
'PeakConcurrentUsers': 123
}
}
},
'StreamId': 'string',
'Tags': {
'string': '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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
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 the type of traffic shaping used to limit the number of requests to the ADS at one time.
TrafficShapingRetrievalWindow (dict) --
The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
RetrievalWindowDurationSeconds (integer) --
The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS.
TrafficShapingTpsConfiguration (dict) --
The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
PeakTps (integer) --
The maximum number of transactions per second (TPS) that your ad decision server (ADS) can handle. MediaTailor uses this value along with concurrent users and headroom multiplier to calculate optimal traffic distribution and prevent ADS overload.
PeakConcurrentUsers (integer) --
The expected peak number of concurrent viewers for your content. MediaTailor uses this value along with peak TPS to determine how to distribute prefetch requests across the available capacity without exceeding your ADS limits.
StreamId (string) --
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
Tags (dict) --
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.
(string) --
(string) --
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.
{'Tags': {'string': 'string'}}
Updates a program within a channel.
See also: AWS API Documentation
Request Syntax
client.update_program(
AdBreaks=[
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
ChannelName='string',
ProgramName='string',
ScheduleConfiguration={
'Transition': {
'ScheduledStartTimeMillis': 123,
'DurationMillis': 123
},
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
}
},
AudienceMedia=[
{
'Audience': 'string',
'AlternateMedia': [
{
'SourceLocationName': 'string',
'LiveSourceName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'ScheduledStartTimeMillis': 123,
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DurationMillis': 123
},
]
},
]
)
list
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) -- [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
string
[REQUIRED]
The name of the channel for this Program.
string
[REQUIRED]
The name of the Program.
dict
[REQUIRED]
The schedule configuration settings.
Transition (dict) --
Program transition configuration.
ScheduledStartTimeMillis (integer) --
The date and time that the program is scheduled to start, in epoch milliseconds.
DurationMillis (integer) --
The duration of the live program in seconds.
ClipRange (dict) --
Program clip range configuration.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
list
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
AlternateMedia (list) --
The list of AlternateMedia defined in AudienceMedia.
(dict) --
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
SourceLocationName (string) --
The name of the source location for alternateMedia.
LiveSourceName (string) --
The name of the live source for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
ClipRange (dict) --
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) -- [REQUIRED]
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) -- [REQUIRED]
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
dict
Response Syntax
{
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Arn': 'string',
'ChannelName': 'string',
'CreationTime': datetime(2015, 1, 1),
'ProgramName': 'string',
'SourceLocationName': 'string',
'VodSourceName': 'string',
'LiveSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'ScheduledStartTime': datetime(2015, 1, 1),
'AudienceMedia': [
{
'Audience': 'string',
'AlternateMedia': [
{
'SourceLocationName': 'string',
'LiveSourceName': 'string',
'VodSourceName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'ScheduledStartTimeMillis': 123,
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentationEventId': 123,
'SegmentationUpidType': 123,
'SegmentationUpid': 'string',
'SegmentationTypeId': 123,
'SegmentNum': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
},
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DurationMillis': 123
},
]
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
Arn (string) --
The ARN to assign to the program.
ChannelName (string) --
The name to assign to the channel for this program.
CreationTime (datetime) --
The time the program was created.
ProgramName (string) --
The name to assign to this program.
SourceLocationName (string) --
The name to assign to the source location for this program.
VodSourceName (string) --
The name that's used to refer to a VOD source.
LiveSourceName (string) --
The name of the LiveSource for this Program.
ClipRange (dict) --
The clip range configuration settings.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
DurationMillis (integer) --
The duration of the live program in milliseconds.
ScheduledStartTime (datetime) --
The scheduled start time for this Program.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
AlternateMedia (list) --
The list of AlternateMedia defined in AudienceMedia.
(dict) --
A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
SourceLocationName (string) --
The name of the source location for alternateMedia.
LiveSourceName (string) --
The name of the live source for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
ClipRange (dict) --
Clip range configuration for the VOD source associated with the program.
EndOffsetMillis (integer) --
The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
StartOffsetMillis (integer) --
The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
OffsetMillis (integer) --
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
Slate (dict) --
Ad break slate configuration.
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SpliceInsertMessage (dict) --
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
AvailNum (integer) --
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
AvailsExpected (integer) --
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
SpliceEventId (integer) --
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
UniqueProgramId (integer) --
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
TimeSignalMessage (dict) --
Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
SegmentationDescriptors (list) --
The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
(dict) --
The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
SegmentationEventId (integer) --
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationUpidType (integer) --
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentationUpid (string) --
The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationTypeId (integer) --
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentNum (integer) --
The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentsExpected (integer) --
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum (integer) --
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected (integer) --
The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
AdBreakMetadata (list) --
Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSET``tag for ``SCTE35_ENHANCED output.
(dict) --
For SCTE35_ENHANCED output, defines a key and corresponding value. MediaTailor generates these pairs within the ``EXT-X-ASSET``tag.
Key (string) --
For SCTE35_ENHANCED output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a key, you must also specify a corresponding value.
Value (string) --
For SCTE35_ENHANCED output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the ``EXT-X-ASSET``tag. If you specify a value, you must also specify a corresponding key.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
Tags (dict) --
The tags assigned to the program. 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.
(string) --
(string) --