2022/04/21 - AWS MediaTailor - 5 new 7 updated api methods
Changes This release introduces tiered channels and adds support for live sources. Customers using a STANDARD channel can now create programs using live sources.
Deletes a specific live source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.delete_live_source(
LiveSourceName='string',
SourceLocationName='string'
)
string
[REQUIRED]
The identifier for the live source you are working on.
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
lists all the live sources in a source location.
See also: AWS API Documentation
Request Syntax
client.list_live_sources(
MaxResults=123,
NextToken='string',
SourceLocationName='string'
)
integer
Upper bound on number of records to return. The maximum number of results is 100.
string
Pagination token from the GET list request. Use the token to fetch the next page of results.
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'HttpPackageConfigurations': [
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
Lists the live sources.
(dict) --
Live source configuration parameters.
Arn (string) --
The ARN for the live source.
CreationTime (datetime) --
The timestamp that indicates when the live source was created.
HttpPackageConfigurations (list) --
The HTTP package configurations for the live source.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) --
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) --
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) --
The streaming protocol for this package configuration. Supported values are HLS and DASH.
LastModifiedTime (datetime) --
The timestamp that indicates when the live source was last modified.
LiveSourceName (string) --
The name that's used to refer to a live source.
SourceLocationName (string) --
The name of the source location.
Tags (dict) --
The tags assigned to the live source.
(string) --
(string) --
NextToken (string) --
Pagination token from the list request. Use the token to fetch the next page of results.
Updates a specific live source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.update_live_source(
HttpPackageConfigurations=[
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
LiveSourceName='string',
SourceLocationName='string'
)
list
[REQUIRED]
A list of HTTP package configurations for the live source on this account.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) -- [REQUIRED]
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) -- [REQUIRED]
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) -- [REQUIRED]
The streaming protocol for this package configuration. Supported values are HLS and DASH.
string
[REQUIRED]
The identifier for the live source you are working on.
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'HttpPackageConfigurations': [
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the live source.
CreationTime (datetime) --
The timestamp that indicates when the live source was created.
HttpPackageConfigurations (list) --
The HTTP package configurations.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) --
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) --
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) --
The streaming protocol for this package configuration. Supported values are HLS and DASH.
LastModifiedTime (datetime) --
The timestamp that indicates when the live source was modified.
LiveSourceName (string) --
The name of the live source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the live source.
(string) --
(string) --
Provides details about a specific live source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.describe_live_source(
LiveSourceName='string',
SourceLocationName='string'
)
string
[REQUIRED]
The identifier for the live source you are working on.
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'HttpPackageConfigurations': [
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the live source.
CreationTime (datetime) --
The timestamp that indicates when the live source was created.
HttpPackageConfigurations (list) --
The HTTP package configurations.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) --
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) --
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) --
The streaming protocol for this package configuration. Supported values are HLS and DASH.
LastModifiedTime (datetime) --
The timestamp that indicates when the live source was modified.
LiveSourceName (string) --
The name of the live source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the live source.
(string) --
(string) --
Creates name for a specific live source in a source location.
See also: AWS API Documentation
Request Syntax
client.create_live_source(
HttpPackageConfigurations=[
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
LiveSourceName='string',
SourceLocationName='string',
Tags={
'string': 'string'
}
)
list
[REQUIRED]
A list of HTTP package configuration parameters for this live source.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) -- [REQUIRED]
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) -- [REQUIRED]
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) -- [REQUIRED]
The streaming protocol for this package configuration. Supported values are HLS and DASH.
string
[REQUIRED]
The identifier for the live source you are working on.
string
[REQUIRED]
The identifier for the source location you are working on.
dict
The tags to assign to the live source.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'HttpPackageConfigurations': [
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
'LastModifiedTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the live source.
CreationTime (datetime) --
The timestamp that indicates when the live source was created.
HttpPackageConfigurations (list) --
The HTTP package configurations.
(dict) --
The HTTP package configuration properties for the requested VOD source.
Path (string) --
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup (string) --
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type (string) --
The streaming protocol for this package configuration. Supported values are HLS and DASH.
LastModifiedTime (datetime) --
The timestamp that indicates when the live source was modified.
LiveSourceName (string) --
The name of the live source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the live source.
(string) --
(string) --
{'Tier': 'BASIC | STANDARD'}
Response {'Tier': 'string'}
Creates a channel.
See also: AWS API Documentation
Request Syntax
client.create_channel(
ChannelName='string',
FillerSlate={
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
Outputs=[
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'SourceGroup': 'string'
},
],
PlaybackMode='LOOP'|'LINEAR',
Tags={
'string': 'string'
},
Tier='BASIC'|'STANDARD'
)
string
[REQUIRED]
The identifier for the channel you are working on.
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.
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.
(string) --
(string) --
string
The tier of the channel.
dict
Response Syntax
{
'Arn': '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': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the channel.
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.
Outputs (list) --
The channel's output properties.
(dict) --
This response includes only the "property" : "type" property.
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.
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.
(string) --
(string) --
Tier (string) --
The channel's tier.
{'LiveSourceName': 'string',
'ScheduleConfiguration': {'Transition': {'DurationMillis': 'long'}}}
Response {'LiveSourceName': 'string'}
Creates a program.
See also: AWS API Documentation
Request Syntax
client.create_program(
AdBreaks=[
{
'MessageType': 'SPLICE_INSERT',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
}
},
],
ChannelName='string',
LiveSourceName='string',
ProgramName='string',
ScheduleConfiguration={
'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.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
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.
string
[REQUIRED]
The identifier for the channel you are working on.
string
The name of the LiveSource for this Program.
string
[REQUIRED]
The identifier for the program you are working on.
dict
[REQUIRED]
The schedule configuration settings.
Transition (dict) -- [REQUIRED]
Program transition configurations.
DurationMillis (integer) --
The duration of the live program in seconds.
RelativePosition (string) -- [REQUIRED]
The position where this program will be inserted relative to the RelativePosition.
RelativeProgram (string) --
The name of the program that this program will be inserted next to, as defined by RelativePosition.
ScheduledStartTimeMillis (integer) --
The date and time that the program is scheduled to start, in epoch milliseconds.
Type (string) -- [REQUIRED]
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
string
[REQUIRED]
The name of the source location.
string
The name that's used to refer to a VOD source.
dict
Response Syntax
{
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
}
},
],
'Arn': 'string',
'ChannelName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
}
Response Structure
(dict) --
Success.
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
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.
Arn (string) --
The ARN of the program.
ChannelName (string) --
The name of the channel that the program belongs to.
CreationTime (datetime) --
The timestamp of when the program was created.
LiveSourceName (string) --
The name of the LiveSource for this Program.
ProgramName (string) --
The name of the program.
ScheduledStartTime (datetime) --
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
SourceLocationName (string) --
The source location name.
VodSourceName (string) --
The name that's used to refer to a VOD source.
{'Tier': 'string'}
Describes the properties of a specific channel.
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{
'Arn': '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': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the channel.
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.
Outputs (list) --
The channel's output properties.
(dict) --
This response includes only the "property" : "type" property.
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.
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.
(string) --
(string) --
Tier (string) --
The channel's tier.
{'LiveSourceName': 'string'}
Retrieves the properties of the requested program.
See also: AWS API Documentation
Request Syntax
client.describe_program(
ChannelName='string',
ProgramName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
string
[REQUIRED]
The identifier for the program you are working on.
dict
Response Syntax
{
'AdBreaks': [
{
'MessageType': 'SPLICE_INSERT',
'OffsetMillis': 123,
'Slate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'SpliceInsertMessage': {
'AvailNum': 123,
'AvailsExpected': 123,
'SpliceEventId': 123,
'UniqueProgramId': 123
}
},
],
'Arn': 'string',
'ChannelName': 'string',
'CreationTime': datetime(2015, 1, 1),
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduledStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
}
Response Structure
(dict) --
Success.
AdBreaks (list) --
The ad break configuration settings.
(dict) --
Ad break configuration parameters.
MessageType (string) --
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
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.
Arn (string) --
The ARN of the program.
ChannelName (string) --
The name of the channel that the program belongs to.
CreationTime (datetime) --
The timestamp of when the program was created.
LiveSourceName (string) --
The name of the LiveSource for this Program.
ProgramName (string) --
The name of the program.
ScheduledStartTime (datetime) --
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
SourceLocationName (string) --
The source location name.
VodSourceName (string) --
The name that's used to refer to a VOD source.
{'Items': {'LiveSourceName': 'string'}}
Retrieves information about your channel's schedule.
See also: AWS API Documentation
Request Syntax
client.get_channel_schedule(
ChannelName='string',
DurationMinutes='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
string
The schedule duration in minutes. The maximum duration is 4320 minutes (three days).
integer
Upper bound on number of records to return. The maximum number of results is 100.
string
Pagination token from the GET list request. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'ApproximateDurationSeconds': 123,
'ApproximateStartTime': datetime(2015, 1, 1),
'Arn': 'string',
'ChannelName': 'string',
'LiveSourceName': 'string',
'ProgramName': 'string',
'ScheduleAdBreaks': [
{
'ApproximateDurationSeconds': 123,
'ApproximateStartTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'ScheduleEntryType': 'PROGRAM'|'FILLER_SLATE',
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
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.
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.
Valid values: PROGRAM or FILLER_SLATE.
SourceLocationName (string) --
The name of the source location.
VodSourceName (string) --
The name of the VOD source.
NextToken (string) --
Pagination token from the GET list request. Use the token to fetch the next page of results.
{'Items': {'Tier': 'string'}}
Retrieves a list of channels that are associated with this account.
See also: AWS API Documentation
Request Syntax
client.list_channels(
MaxResults=123,
NextToken='string'
)
integer
Upper bound on number of records to return. The maximum number of results is 100.
string
Pagination token from the GET list request. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelState': 'string',
'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': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
A list of channels that are associated with this account.
(dict) --
The configuration parameters for a channel.
Arn (string) --
The ARN of the channel.
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.
Outputs (list) --
The channel's output properties.
(dict) --
This response includes only the "property" : "type" property.
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.
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.
(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.
{'Tier': 'string'}
Updates an existing channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelName='string',
FillerSlate={
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
Outputs=[
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'SourceGroup': 'string'
},
]
)
string
[REQUIRED]
The identifier for the channel you are working on.
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.
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
Response Syntax
{
'Arn': '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': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the channel.
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.
Outputs (list) --
The channel's output properties.
(dict) --
This response includes only the "property" : "type" property.
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.
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.
(string) --
(string) --
Tier (string) --
The channel's tier.