2024/03/18 - AWS MediaTailor - 8 updated api methods
Changes This release adds support to allow customers to show different content within a channel depending on metadata associated with the viewer.
{'Audiences': ['string']}
Creates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
See also: AWS API Documentation
Request Syntax
client.create_channel(
Audiences=[
'string',
],
ChannelName='string',
FillerSlate={
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
Outputs=[
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'SourceGroup': 'string'
},
],
PlaybackMode='LOOP'|'LINEAR',
Tags={
'string': 'string'
},
Tier='BASIC'|'STANDARD',
TimeShiftConfiguration={
'MaxTimeDelaySeconds': 123
}
)
list
The list of audiences defined in channel.
(string) --
string
[REQUIRED]
The name of the channel.
dict
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .
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.
list
[REQUIRED]
The channel's output properties.
(dict) --
The output configuration for this channel.
DashPlaylistSettings (dict) --
DASH manifest configuration parameters.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS playlist configuration parameters.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) -- [REQUIRED]
The name of the manifest for the channel. The name appears in the PlaybackUrl .
SourceGroup (string) -- [REQUIRED]
A string used to match which HttpPackageConfiguration is used for each VodSource .
string
[REQUIRED]
The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the schedule.
LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
dict
The tags to assign to the channel. 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) --
string
The tier of the channel.
dict
The time-shifted viewing configuration you want to associate to the channel.
MaxTimeDelaySeconds (integer) -- [REQUIRED]
The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
dict
Response Syntax
{
'Arn': 'string',
'Audiences': [
'string',
],
'ChannelName': 'string',
'ChannelState': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string',
'TimeShiftConfiguration': {
'MaxTimeDelaySeconds': 123
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) to assign to the channel.
Audiences (list) --
The list of audiences defined in channel.
(string) --
ChannelName (string) --
The name to assign to the channel.
ChannelState (string) --
Indicates whether the channel is in a running state or not.
CreationTime (datetime) --
The timestamp of when the channel was created.
FillerSlate (dict) --
Contains information about the slate used to fill gaps between programs in the schedule.
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.
LastModifiedTime (datetime) --
The timestamp of when the channel was last modified.
Outputs (list) --
The output properties to assign to the channel.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The playback mode to assign to the channel.
Tags (dict) --
The tags to assign to the channel. 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) --
Tier (string) --
The tier of the channel.
TimeShiftConfiguration (dict) --
The time-shifted viewing configuration assigned to the channel.
MaxTimeDelaySeconds (integer) --
The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
{'AudienceMedia': [{'AlternateMedia': [{'AdBreaks': [{'AdBreakMetadata': [{'Key': 'string',
'Value': 'string'}],
'MessageType': 'SPLICE_INSERT '
'| '
'TIME_SIGNAL',
'OffsetMillis': 'long',
'Slate': {'SourceLocationName': 'string',
'VodSourceName': 'string'},
'SpliceInsertMessage': {'AvailNum': 'integer',
'AvailsExpected': 'integer',
'SpliceEventId': 'integer',
'UniqueProgramId': 'integer'},
'TimeSignalMessage': {'SegmentationDescriptors': [{'SegmentNum': 'integer',
'SegmentationEventId': 'integer',
'SegmentationTypeId': 'integer',
'SegmentationUpid': 'string',
'SegmentationUpidType': 'integer',
'SegmentsExpected': 'integer',
'SubSegmentNum': 'integer',
'SubSegmentsExpected': 'integer'}]}}],
'ClipRange': {'EndOffsetMillis': 'long',
'StartOffsetMillis': 'long'},
'DurationMillis': 'long',
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 'long',
'SourceLocationName': 'string',
'VodSourceName': 'string'}],
'Audience': 'string'}],
'ScheduleConfiguration': {'ClipRange': {'StartOffsetMillis': 'long'}}}
Response {'AudienceMedia': [{'AlternateMedia': [{'AdBreaks': [{'AdBreakMetadata': [{'Key': 'string',
'Value': 'string'}],
'MessageType': 'SPLICE_INSERT '
'| '
'TIME_SIGNAL',
'OffsetMillis': 'long',
'Slate': {'SourceLocationName': 'string',
'VodSourceName': 'string'},
'SpliceInsertMessage': {'AvailNum': 'integer',
'AvailsExpected': 'integer',
'SpliceEventId': 'integer',
'UniqueProgramId': 'integer'},
'TimeSignalMessage': {'SegmentationDescriptors': [{'SegmentNum': 'integer',
'SegmentationEventId': 'integer',
'SegmentationTypeId': 'integer',
'SegmentationUpid': 'string',
'SegmentationUpidType': 'integer',
'SegmentsExpected': 'integer',
'SubSegmentNum': 'integer',
'SubSegmentsExpected': 'integer'}]}}],
'ClipRange': {'EndOffsetMillis': 'long',
'StartOffsetMillis': 'long'},
'DurationMillis': 'long',
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 'long',
'SourceLocationName': 'string',
'VodSourceName': 'string'}],
'Audience': 'string'}],
'ClipRange': {'StartOffsetMillis': 'long'}}
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=[
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
AudienceMedia=[
{
'AlternateMedia': [
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 123,
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'Audience': 'string'
},
],
ChannelName='string',
LiveSourceName='string',
ProgramName='string',
ScheduleConfiguration={
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'Transition': {
'DurationMillis': 123,
'RelativePosition': 'BEFORE_PROGRAM'|'AFTER_PROGRAM',
'RelativeProgram': 'string',
'ScheduledStartTimeMillis': 123,
'Type': 'string'
}
},
SourceLocationName='string',
VodSourceName='string'
)
list
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
list
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
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.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
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.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) --
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) --
The name of the source location for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
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.
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.
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 .
string
[REQUIRED]
The name of the source location.
string
The name that's used to refer to a VOD source.
dict
Response Syntax
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'Arn': 'string',
'AudienceMedia': [
{
'AlternateMedia': [
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 123,
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'Audience': 'string'
},
],
'ChannelName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'CreationTime': datetime(2015, 1, 1),
'DurationMillis': 123,
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
Arn (string) --
The ARN to assign to the program.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
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.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
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.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) --
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) --
The name of the source location for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
ChannelName (string) --
The name to assign to the channel 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.
CreationTime (datetime) --
The time the program was created.
DurationMillis (integer) --
The duration of the live program in milliseconds.
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.
{'Audiences': ['string']}
Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelName='string'
)
string
[REQUIRED]
The name of the channel.
dict
Response Syntax
{
'Arn': 'string',
'Audiences': [
'string',
],
'ChannelName': 'string',
'ChannelState': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LogConfiguration': {
'LogTypes': [
'AS_RUN',
]
},
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string',
'TimeShiftConfiguration': {
'MaxTimeDelaySeconds': 123
}
}
Response Structure
(dict) --
Arn (string) --
The ARN of the channel.
Audiences (list) --
The list of audiences defined in channel.
(string) --
ChannelName (string) --
The name of the channel.
ChannelState (string) --
Indicates whether the channel is in a running state or not.
CreationTime (datetime) --
The timestamp of when the channel was created.
FillerSlate (dict) --
Contains information about the slate used to fill gaps between programs in the schedule.
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.
LastModifiedTime (datetime) --
The timestamp of when the channel was last modified.
LogConfiguration (dict) --
The log configuration for the channel.
LogTypes (list) --
The log types.
(string) --
Outputs (list) --
The channel's output properties.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The channel's playback mode.
Tags (dict) --
The tags assigned to the channel. 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) --
Tier (string) --
The channel's tier.
TimeShiftConfiguration (dict) --
The time-shifted viewing configuration for the channel.
MaxTimeDelaySeconds (integer) --
The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
{'AudienceMedia': [{'AlternateMedia': [{'AdBreaks': [{'AdBreakMetadata': [{'Key': 'string',
'Value': 'string'}],
'MessageType': 'SPLICE_INSERT '
'| '
'TIME_SIGNAL',
'OffsetMillis': 'long',
'Slate': {'SourceLocationName': 'string',
'VodSourceName': 'string'},
'SpliceInsertMessage': {'AvailNum': 'integer',
'AvailsExpected': 'integer',
'SpliceEventId': 'integer',
'UniqueProgramId': 'integer'},
'TimeSignalMessage': {'SegmentationDescriptors': [{'SegmentNum': 'integer',
'SegmentationEventId': 'integer',
'SegmentationTypeId': 'integer',
'SegmentationUpid': 'string',
'SegmentationUpidType': 'integer',
'SegmentsExpected': 'integer',
'SubSegmentNum': 'integer',
'SubSegmentsExpected': 'integer'}]}}],
'ClipRange': {'EndOffsetMillis': 'long',
'StartOffsetMillis': 'long'},
'DurationMillis': 'long',
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 'long',
'SourceLocationName': 'string',
'VodSourceName': 'string'}],
'Audience': 'string'}],
'ClipRange': {'StartOffsetMillis': 'long'}}
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': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'Arn': 'string',
'AudienceMedia': [
{
'AlternateMedia': [
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 123,
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'Audience': 'string'
},
],
'ChannelName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'CreationTime': datetime(2015, 1, 1),
'DurationMillis': 123,
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
Arn (string) --
The ARN of the program.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
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.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
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.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) --
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) --
The name of the source location for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
ChannelName (string) --
The name of the channel that the program belongs to.
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.
CreationTime (datetime) --
The timestamp of when the program was created.
DurationMillis (integer) --
The duration of the live program in milliseconds.
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.
{'Audience': 'string'}
Response {'Items': {'Audiences': ['string'], 'ScheduleEntryType': {'ALTERNATE_MEDIA'}}}
Retrieves information about your channel's schedule.
See also: AWS API Documentation
Request Syntax
client.get_channel_schedule(
Audience='string',
ChannelName='string',
DurationMinutes='string',
MaxResults=123,
NextToken='string'
)
string
The single audience for GetChannelScheduleRequest.
string
[REQUIRED]
The name of the channel associated with this Channel Schedule.
string
The duration in minutes of the channel schedule.
integer
The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
string
(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
dict
Response Syntax
{
'Items': [
{
'ApproximateDurationSeconds': 123,
'ApproximateStartTime': datetime(2015, 1, 1),
'Arn': 'string',
'Audiences': [
'string',
],
'ChannelName': 'string',
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduleAdBreaks': [
{
'ApproximateDurationSeconds': 123,
'ApproximateStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'ScheduleEntryType': 'PROGRAM'|'FILLER_SLATE'|'ALTERNATE_MEDIA',
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A list of schedule entries for the channel.
(dict) --
The properties for a schedule.
ApproximateDurationSeconds (integer) --
The approximate duration of this program, in seconds.
ApproximateStartTime (datetime) --
The approximate time that the program will start playing.
Arn (string) --
The ARN of the program.
Audiences (list) --
The list of audiences defined in ScheduleEntry.
(string) --
ChannelName (string) --
The name of the channel that uses this schedule.
LiveSourceName (string) --
The name of the live source used for the program.
ProgramName (string) --
The name of the program.
ScheduleAdBreaks (list) --
The schedule's ad break properties.
(dict) --
The schedule's ad break properties.
ApproximateDurationSeconds (integer) --
The approximate duration of the ad break, in seconds.
ApproximateStartTime (datetime) --
The approximate time that the ad will start playing.
SourceLocationName (string) --
The name of the source location containing the VOD source used for the ad break.
VodSourceName (string) --
The name of the VOD source used for the ad break.
ScheduleEntryType (string) --
The type of schedule entry.
SourceLocationName (string) --
The name of the source location.
VodSourceName (string) --
The name of the VOD source.
NextToken (string) --
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
{'Items': {'Audiences': ['string']}}
Retrieves information about the channels that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
client.list_channels(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.
string
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'Audiences': [
'string',
],
'ChannelName': 'string',
'ChannelState': 'string',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LogConfiguration': {
'LogTypes': [
'AS_RUN',
]
},
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A list of channels that are associated with this account.
(dict) --
The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
Arn (string) --
The ARN of the channel.
Audiences (list) --
The list of audiences defined in channel.
(string) --
ChannelName (string) --
The name of the channel.
ChannelState (string) --
Returns the state whether the channel is running or not.
CreationTime (datetime) --
The timestamp of when the channel was created.
FillerSlate (dict) --
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .
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.
LastModifiedTime (datetime) --
The timestamp of when the channel was last modified.
LogConfiguration (dict) --
The log configuration.
LogTypes (list) --
The log types.
(string) --
Outputs (list) --
The channel's output properties.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
Tags (dict) --
The tags to assign to the channel. 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) --
Tier (string) --
The tier for this channel. STANDARD tier channels can contain live programs.
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.
{'Audiences': ['string']}
Updates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
See also: AWS API Documentation
Request Syntax
client.update_channel(
Audiences=[
'string',
],
ChannelName='string',
FillerSlate={
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
Outputs=[
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'SourceGroup': 'string'
},
],
TimeShiftConfiguration={
'MaxTimeDelaySeconds': 123
}
)
list
The list of audiences defined in channel.
(string) --
string
[REQUIRED]
The name of the channel.
dict
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .
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.
list
[REQUIRED]
The channel's output properties.
(dict) --
The output configuration for this channel.
DashPlaylistSettings (dict) --
DASH manifest configuration parameters.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS playlist configuration parameters.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) -- [REQUIRED]
The name of the manifest for the channel. The name appears in the PlaybackUrl .
SourceGroup (string) -- [REQUIRED]
A string used to match which HttpPackageConfiguration is used for each VodSource .
dict
The time-shifted viewing configuration you want to associate to the channel.
MaxTimeDelaySeconds (integer) -- [REQUIRED]
The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
dict
Response Syntax
{
'Arn': 'string',
'Audiences': [
'string',
],
'ChannelName': 'string',
'ChannelState': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'AdMarkupType': [
'DATERANGE'|'SCTE35_ENHANCED',
],
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string',
'TimeShiftConfiguration': {
'MaxTimeDelaySeconds': 123
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the channel.
Audiences (list) --
The list of audiences defined in channel.
(string) --
ChannelName (string) --
The name of the channel.
ChannelState (string) --
Returns the state whether the channel is running or not.
CreationTime (datetime) --
The timestamp of when the channel was created.
FillerSlate (dict) --
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .
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.
LastModifiedTime (datetime) --
The timestamp that indicates when the channel was last modified.
Outputs (list) --
The channel's output properties.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
AdMarkupType (list) --
Determines the type of SCTE 35 tags to use in ad markup. Specify DATERANGE to use DATERANGE tags (for live or VOD content). Specify SCTE35_ENHANCED to use EXT-X-CUE-OUT and EXT-X-CUE-IN tags (for VOD content only).
(string) --
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
Tags (dict) --
The tags to assign to the channel. 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) --
Tier (string) --
The tier associated with this Channel.
TimeShiftConfiguration (dict) --
The time-shifted viewing configuration for the channel.
MaxTimeDelaySeconds (integer) --
The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours).
{'AudienceMedia': [{'AlternateMedia': [{'AdBreaks': [{'AdBreakMetadata': [{'Key': 'string',
'Value': 'string'}],
'MessageType': 'SPLICE_INSERT '
'| '
'TIME_SIGNAL',
'OffsetMillis': 'long',
'Slate': {'SourceLocationName': 'string',
'VodSourceName': 'string'},
'SpliceInsertMessage': {'AvailNum': 'integer',
'AvailsExpected': 'integer',
'SpliceEventId': 'integer',
'UniqueProgramId': 'integer'},
'TimeSignalMessage': {'SegmentationDescriptors': [{'SegmentNum': 'integer',
'SegmentationEventId': 'integer',
'SegmentationTypeId': 'integer',
'SegmentationUpid': 'string',
'SegmentationUpidType': 'integer',
'SegmentsExpected': 'integer',
'SubSegmentNum': 'integer',
'SubSegmentsExpected': 'integer'}]}}],
'ClipRange': {'EndOffsetMillis': 'long',
'StartOffsetMillis': 'long'},
'DurationMillis': 'long',
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 'long',
'SourceLocationName': 'string',
'VodSourceName': 'string'}],
'Audience': 'string'}],
'ScheduleConfiguration': {'ClipRange': {'StartOffsetMillis': 'long'}}}
Response {'AudienceMedia': [{'AlternateMedia': [{'AdBreaks': [{'AdBreakMetadata': [{'Key': 'string',
'Value': 'string'}],
'MessageType': 'SPLICE_INSERT '
'| '
'TIME_SIGNAL',
'OffsetMillis': 'long',
'Slate': {'SourceLocationName': 'string',
'VodSourceName': 'string'},
'SpliceInsertMessage': {'AvailNum': 'integer',
'AvailsExpected': 'integer',
'SpliceEventId': 'integer',
'UniqueProgramId': 'integer'},
'TimeSignalMessage': {'SegmentationDescriptors': [{'SegmentNum': 'integer',
'SegmentationEventId': 'integer',
'SegmentationTypeId': 'integer',
'SegmentationUpid': 'string',
'SegmentationUpidType': 'integer',
'SegmentsExpected': 'integer',
'SubSegmentNum': 'integer',
'SubSegmentsExpected': 'integer'}]}}],
'ClipRange': {'EndOffsetMillis': 'long',
'StartOffsetMillis': 'long'},
'DurationMillis': 'long',
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 'long',
'SourceLocationName': 'string',
'VodSourceName': 'string'}],
'Audience': 'string'}],
'ClipRange': {'StartOffsetMillis': 'long'}}
Updates a program within a channel.
See also: AWS API Documentation
Request Syntax
client.update_program(
AdBreaks=[
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
AudienceMedia=[
{
'AlternateMedia': [
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 123,
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'Audience': 'string'
},
],
ChannelName='string',
ProgramName='string',
ScheduleConfiguration={
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'Transition': {
'DurationMillis': 123,
'ScheduledStartTimeMillis': 123
}
}
)
list
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
list
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
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.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
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.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) --
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) --
The name of the source location for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
string
[REQUIRED]
The name of the channel for this Program.
string
[REQUIRED]
The name of the Program.
dict
[REQUIRED]
The schedule configuration settings.
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.
Transition (dict) --
Program transition configuration.
DurationMillis (integer) --
The duration of the live program in seconds.
ScheduledStartTimeMillis (integer) --
The date and time that the program is scheduled to start, in epoch milliseconds.
dict
Response Syntax
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'Arn': 'string',
'AudienceMedia': [
{
'AlternateMedia': [
{
'AdBreaks': [
{
'AdBreakMetadata': [
{
'Key': 'string',
'Value': 'string'
},
],
'MessageType': 'SPLICE_INSERT'|'TIME_SIGNAL',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
},
'TimeSignalMessage': {
'SegmentationDescriptors': [
{
'SegmentNum': 123,
'SegmentationEventId': 123,
'SegmentationTypeId': 123,
'SegmentationUpid': 'string',
'SegmentationUpidType': 123,
'SegmentsExpected': 123,
'SubSegmentNum': 123,
'SubSegmentsExpected': 123
},
]
}
},
],
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'DurationMillis': 123,
'LiveSourceName': 'string',
'ScheduledStartTimeMillis': 123,
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'Audience': 'string'
},
],
'ChannelName': 'string',
'ClipRange': {
'EndOffsetMillis': 123,
'StartOffsetMillis': 123
},
'CreationTime': datetime(2015, 1, 1),
'DurationMillis': 123,
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
}
Response Structure
(dict) --
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
Arn (string) --
The ARN to assign to the program.
AudienceMedia (list) --
The list of AudienceMedia defined in program.
(dict) --
An AudienceMedia object contains an Audience and a list of AlternateMedia.
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.
AdBreaks (list) --
Ad break configuration parameters defined in AlternateMedia.
(dict) --
Ad break configuration parameters.
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.
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.
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.
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.
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.
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).
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.
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.
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.
DurationMillis (integer) --
The duration of the alternateMedia in milliseconds.
LiveSourceName (string) --
The name of the live source for alternateMedia.
ScheduledStartTimeMillis (integer) --
The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
SourceLocationName (string) --
The name of the source location for alternateMedia.
VodSourceName (string) --
The name of the VOD source for alternateMedia.
Audience (string) --
The Audience defined in AudienceMedia.
ChannelName (string) --
The name to assign to the channel 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.
CreationTime (datetime) --
The time the program was created.
DurationMillis (integer) --
The duration of the live program in milliseconds.
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.