2021/03/12 - AWS MediaTailor - 25 new 1 updated api methods
Changes MediaTailor channel assembly is a new manifest-only service that allows you to assemble linear streams using your existing VOD content.
Retrieves information about a channel's IAM policy.
See also: AWS API Documentation
Request Syntax
client.get_channel_policy(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{
'Policy': 'string'
}
Response Structure
(dict) --
Success.
Policy (string) --
The IAM policy for the channel.
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',
'ProgramName': 'string',
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
An array 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.
ProgramName (string) --
The name of the program.
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.
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',
ProgramName='string',
ScheduleConfiguration={
'Transition': {
'RelativePosition': 'BEFORE_PROGRAM'|'AFTER_PROGRAM',
'RelativeProgram': 'string',
'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
[REQUIRED]
The identifier for the program you are working on.
dict
[REQUIRED]
The schedule configuration settings.
Transition (dict) -- [REQUIRED]
Program transition configurations.
RelativePosition (string) -- [REQUIRED]
The position where this program will be inserted relative to the RelativeProgram. Possible values are: AFTER_PROGRAM, and BEFORE_PROGRAM.
RelativeProgram (string) --
The name of the program that this program will be inserted next to, as defined by RelativePosition.
Type (string) -- [REQUIRED]
When the program should be played. RELATIVE means that programs will be played back-to-back.
string
[REQUIRED]
The name of the source location.
string
[REQUIRED]
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),
'ProgramName': 'string',
'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.
ProgramName (string) --
The name of the program.
SourceLocationName (string) --
The source location name.
VodSourceName (string) --
The name that's used to refer to a VOD source.
Retrieves a list of programs on a specific channel.
See also: AWS API Documentation
Request Syntax
client.list_programs(
ChannelName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
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': [
{
'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),
'LastModifiedTime': datetime(2015, 1, 1),
'ProgramName': 'string',
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
An array containing the programs for a channel.
(dict) --
Program configuration parameters.
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.
LastModifiedTime (datetime) --
The timestamp of when the program was last modified.
ProgramName (string) --
The name of the program.
SourceLocationName (string) --
The name of the source location.
VodSourceName (string) --
The name that's used to refer to a VOD source.
NextToken (string) --
Pagination token from the list request. Use the token to fetch the next page of results.
Creates an IAM policy for the channel.
See also: AWS API Documentation
Request Syntax
client.put_channel_policy(
ChannelName='string',
Policy='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
string
[REQUIRED]
Adds an IAM role that determines the permissions of your channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Provides details about a specific VOD source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.describe_vod_source(
SourceLocationName='string',
VodSourceName='string'
)
string
[REQUIRED]
The identifier for the source location you are working on.
string
[REQUIRED]
The identifier for the VOD source 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),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
},
'VodSourceName': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the VOD source.
CreationTime (datetime) --
The timestamp that indicates when the VOD 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 ARN for the VOD source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the VOD source.
(string) --
(string) --
VodSourceName (string) --
The name of the VOD source.
Updates an existing channel.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelName='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.
list
[REQUIRED]
The channel's output properties.
(dict) --
The ouput 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),
'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'
}
}
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.
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 for this channel. The only supported value is LOOP.
Tags (dict) --
The tags assigned to the channel.
(string) --
(string) --
Updates a specific VOD source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.update_vod_source(
HttpPackageConfigurations=[
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
SourceLocationName='string',
VodSourceName='string'
)
list
[REQUIRED]
An array of HTTP package configurations for the VOD 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 source location you are working on.
string
[REQUIRED]
The identifier for the VOD source 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),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
},
'VodSourceName': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the VOD source.
CreationTime (datetime) --
The timestamp that indicates when the VOD 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 ARN for the VOD source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the VOD source.
(string) --
(string) --
VodSourceName (string) --
The name of the VOD source.
Creates name for a specific VOD source in a source location.
See also: AWS API Documentation
Request Syntax
client.create_vod_source(
HttpPackageConfigurations=[
{
'Path': 'string',
'SourceGroup': 'string',
'Type': 'DASH'|'HLS'
},
],
SourceLocationName='string',
Tags={
'string': 'string'
},
VodSourceName='string'
)
list
[REQUIRED]
An array of HTTP package configuration parameters for this VOD 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 source location you are working on.
dict
The tags to assign to the VOD source.
(string) --
(string) --
string
[REQUIRED]
The identifier for the VOD source 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),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
},
'VodSourceName': 'string'
}
Response Structure
(dict) --
Success.
Arn (string) --
The ARN of the VOD source.
CreationTime (datetime) --
The timestamp that indicates when the VOD 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 ARN for the VOD source.
SourceLocationName (string) --
The name of the source location associated with the VOD source.
Tags (dict) --
The tags assigned to the VOD source.
(string) --
(string) --
VodSourceName (string) --
The name of the VOD source.
Lists all the VOD sources in a source location.
See also: AWS API Documentation
Request Syntax
client.list_vod_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),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
},
'VodSourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
Lists the VOD sources.
(dict) --
VOD source configuration parameters.
Arn (string) --
The ARN for the VOD source.
CreationTime (datetime) --
The timestamp that indicates when the VOD source was created.
HttpPackageConfigurations (list) --
The HTTP package configurations for the VOD 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 VOD source was last modified.
SourceLocationName (string) --
The name of the source location that the VOD source is associated with.
Tags (dict) --
The tags assigned to the VOD source.
(string) --
(string) --
VodSourceName (string) --
The name of the VOD source.
NextToken (string) --
Pagination token from the list request. Use the token to fetch the next page of results.
Deletes a specific program on a specific channel.
See also: AWS API Documentation
Request Syntax
client.delete_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
{}
Response Structure
(dict) --
Success.
Deletes a channel's IAM policy.
See also: AWS API Documentation
Request Syntax
client.delete_channel_policy(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
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),
'ProgramName': 'string',
'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.
ProgramName (string) --
The name of the program.
SourceLocationName (string) --
The source location name.
VodSourceName (string) --
The name that's used to refer to a VOD source.
Deletes a channel. You must stop the channel before it can be deleted.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Deletes a specific VOD source in a specific source location.
See also: AWS API Documentation
Request Syntax
client.delete_vod_source(
SourceLocationName='string',
VodSourceName='string'
)
string
[REQUIRED]
The identifier for the source location you are working on.
string
[REQUIRED]
The identifier for the VOD source you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Updates a source location on a specific channel.
See also: AWS API Documentation
Request Syntax
client.update_source_location(
AccessConfiguration={
'AccessType': 'S3_SIGV4'
},
DefaultSegmentDeliveryConfiguration={
'BaseUrl': 'string'
},
HttpConfiguration={
'BaseUrl': 'string'
},
SourceLocationName='string'
)
dict
Access configuration parameters. Configures the type of authentication used to access content from your source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
dict
The optional configuration for the host server that serves segments.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
dict
[REQUIRED]
The HTTP configuration for the source location.
BaseUrl (string) -- [REQUIRED]
The base URL for the source location host server. This string must include the protocol, such as https:// .
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{
'AccessConfiguration': {
'AccessType': 'S3_SIGV4'
},
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DefaultSegmentDeliveryConfiguration': {
'BaseUrl': 'string'
},
'HttpConfiguration': {
'BaseUrl': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
AccessConfiguration (dict) --
The access configuration for the source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
Arn (string) --
The ARN of the source location.
CreationTime (datetime) --
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration (dict) --
The default segment delivery configuration settings.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
HttpConfiguration (dict) --
The HTTP package configuration settings for the source location.
BaseUrl (string) --
The base URL for the source location host server. This string must include the protocol, such as https:// .
LastModifiedTime (datetime) --
The timestamp that indicates when the source location was last modified.
SourceLocationName (string) --
The name of the source location.
Tags (dict) --
The tags assigned to the source location.
(string) --
(string) --
Creates a channel.
See also: AWS API Documentation
Request Syntax
client.create_channel(
ChannelName='string',
Outputs=[
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'SourceGroup': 'string'
},
],
PlaybackMode='LOOP',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The identifier for the channel you are working on.
list
[REQUIRED]
The channel's output properties.
(dict) --
The ouput 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 for this channel. The only supported value is LOOP.
dict
The tags to assign to the channel.
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelState': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'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'
}
}
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.
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 for this channel. The only supported value is LOOP.
Tags (dict) --
The tags assigned to the channel.
(string) --
(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),
'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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
An array 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.
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. Possible values: ONCE or LOOP.
Tags (dict) --
The tags to assign to the channel.
(string) --
(string) --
NextToken (string) --
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
Stops a specific channel.
See also: AWS API Documentation
Request Syntax
client.stop_channel(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Retrieves the properties of the requested source location.
See also: AWS API Documentation
Request Syntax
client.describe_source_location(
SourceLocationName='string'
)
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{
'AccessConfiguration': {
'AccessType': 'S3_SIGV4'
},
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DefaultSegmentDeliveryConfiguration': {
'BaseUrl': 'string'
},
'HttpConfiguration': {
'BaseUrl': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
AccessConfiguration (dict) --
The access configuration for the source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
Arn (string) --
The ARN of the source location.
CreationTime (datetime) --
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration (dict) --
The default segment delivery configuration settings.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
HttpConfiguration (dict) --
The HTTP package configuration settings for the source location.
BaseUrl (string) --
The base URL for the source location host server. This string must include the protocol, such as https:// .
LastModifiedTime (datetime) --
The timestamp that indicates when the source location was last modified.
SourceLocationName (string) --
The name of the source location.
Tags (dict) --
The tags assigned to the source location.
(string) --
(string) --
Creates a source location on a specific channel.
See also: AWS API Documentation
Request Syntax
client.create_source_location(
AccessConfiguration={
'AccessType': 'S3_SIGV4'
},
DefaultSegmentDeliveryConfiguration={
'BaseUrl': 'string'
},
HttpConfiguration={
'BaseUrl': 'string'
},
SourceLocationName='string',
Tags={
'string': 'string'
}
)
dict
Access configuration parameters. Configures the type of authentication used to access content from your source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
dict
The optional configuration for the server that serves segments.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
dict
[REQUIRED]
The source's HTTP package configurations.
BaseUrl (string) -- [REQUIRED]
The base URL for the source location host server. This string must include the protocol, such as https:// .
string
[REQUIRED]
The identifier for the source location you are working on.
dict
The tags to assign to the source location.
(string) --
(string) --
dict
Response Syntax
{
'AccessConfiguration': {
'AccessType': 'S3_SIGV4'
},
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DefaultSegmentDeliveryConfiguration': {
'BaseUrl': 'string'
},
'HttpConfiguration': {
'BaseUrl': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Success.
AccessConfiguration (dict) --
The access configuration for the source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
Arn (string) --
The ARN of the source location.
CreationTime (datetime) --
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration (dict) --
The default segment delivery configuration settings.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
HttpConfiguration (dict) --
The HTTP package configuration settings for the source location.
BaseUrl (string) --
The base URL for the source location host server. This string must include the protocol, such as https:// .
LastModifiedTime (datetime) --
The timestamp that indicates when the source location was last modified.
SourceLocationName (string) --
The name of the source location.
Tags (dict) --
The tags assigned to the source location.
(string) --
(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),
'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'
}
}
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.
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 for this channel. The only supported value is LOOP.
Tags (dict) --
The tags assigned to the channel.
(string) --
(string) --
Deletes a source location on a specific channel.
See also: AWS API Documentation
Request Syntax
client.delete_source_location(
SourceLocationName='string'
)
string
[REQUIRED]
The identifier for the source location you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Starts a specific channel.
See also: AWS API Documentation
Request Syntax
client.start_channel(
ChannelName='string'
)
string
[REQUIRED]
The identifier for the channel you are working on.
dict
Response Syntax
{}
Response Structure
(dict) --
Success.
Retrieves a list of source locations.
See also: AWS API Documentation
Request Syntax
client.list_source_locations(
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': [
{
'AccessConfiguration': {
'AccessType': 'S3_SIGV4'
},
'Arn': 'string',
'CreationTime': datetime(2015, 1, 1),
'DefaultSegmentDeliveryConfiguration': {
'BaseUrl': 'string'
},
'HttpConfiguration': {
'BaseUrl': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'SourceLocationName': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
An array of source locations.
(dict) --
This response includes only the "type" : "object" property.
AccessConfiguration (dict) --
The access configuration for the source location.
AccessType (string) --
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
Arn (string) --
The ARN of the SourceLocation.
CreationTime (datetime) --
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration (dict) --
The default segment delivery configuration.
BaseUrl (string) --
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https:// .
HttpConfiguration (dict) --
The HTTP configuration for the source location.
BaseUrl (string) --
The base URL for the source location host server. This string must include the protocol, such as https:// .
LastModifiedTime (datetime) --
The timestamp that indicates when the source location was last modified.
SourceLocationName (string) --
The name of the source location.
Tags (dict) --
The tags assigned to the source location.
(string) --
(string) --
NextToken (string) --
Pagination token from the list request. Use the token to fetch the next page of results.
{'Items': {'LivePreRollConfiguration': {'AdDecisionServerUrl': 'string',
'MaxDurationSeconds': 'integer'}}}
Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.
See also: AWS API Documentation
Request Syntax
client.list_playback_configurations(
MaxResults=123,
NextToken='string'
)
integer
Maximum number of records to return.
string
Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'AdDecisionServerUrl': 'string',
'AvailSuppression': {
'Mode': 'OFF'|'BEHIND_LIVE_EDGE',
'Value': 'string'
},
'Bumper': {
'EndUrl': 'string',
'StartUrl': 'string'
},
'CdnConfiguration': {
'AdSegmentUrlPrefix': 'string',
'ContentSegmentUrlPrefix': 'string'
},
'ConfigurationAliases': {
'string': {
'string': 'string'
}
},
'DashConfiguration': {
'ManifestEndpointPrefix': 'string',
'MpdLocation': 'string',
'OriginManifestType': 'SINGLE_PERIOD'|'MULTI_PERIOD'
},
'HlsConfiguration': {
'ManifestEndpointPrefix': 'string'
},
'LivePreRollConfiguration': {
'AdDecisionServerUrl': 'string',
'MaxDurationSeconds': 123
},
'ManifestProcessingRules': {
'AdMarkerPassthrough': {
'Enabled': True|False
}
},
'Name': 'string',
'PersonalizationThresholdSeconds': 123,
'PlaybackConfigurationArn': 'string',
'PlaybackEndpointPrefix': 'string',
'SessionInitializationEndpointPrefix': 'string',
'SlateAdUrl': 'string',
'Tags': {
'string': 'string'
},
'TranscodeProfileName': 'string',
'VideoContentSourceUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Success.
Items (list) --
Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.
(dict) --
Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor .
AdDecisionServerUrl (string) --
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
AvailSuppression (dict) --
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression .
Mode (string) --
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
Value (string) --
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
Bumper (dict) --
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers .
EndUrl (string) --
The URL for the end bumper asset.
StartUrl (string) --
The URL for the start bumper asset.
CdnConfiguration (dict) --
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
AdSegmentUrlPrefix (string) --
A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
ContentSegmentUrlPrefix (string) --
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
ConfigurationAliases (dict) --
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables .
(string) --
The dynamic variable that has aliases.
(dict) --
Map of aliases to the value to be used at request time.
(string) --
(string) --
DashConfiguration (dict) --
The configuration for a DASH source.
ManifestEndpointPrefix (string) --
The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
MpdLocation (string) --
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
OriginManifestType (string) --
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
HlsConfiguration (dict) --
The configuration for HLS content.
ManifestEndpointPrefix (string) --
The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
LivePreRollConfiguration (dict) --
The configuration for pre-roll ad insertion.
AdDecisionServerUrl (string) --
The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
MaxDurationSeconds (integer) -- The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
ManifestProcessingRules (dict) --
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
AdMarkerPassthrough (dict) --
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
Enabled (boolean) --
Enables ad marker passthrough for your configuration.
Name (string) --
The identifier for the playback configuration.
PersonalizationThresholdSeconds (integer) --
Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor .
PlaybackConfigurationArn (string) --
The Amazon Resource Name (ARN) for the playback configuration.
PlaybackEndpointPrefix (string) --
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
SessionInitializationEndpointPrefix (string) --
The URL that the player uses to initialize a session that uses client-side reporting.
SlateAdUrl (string) --
The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
Tags (dict) --
The tags to assign to the playback configuration.
(string) --
(string) --
TranscodeProfileName (string) --
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
VideoContentSourceUrl (string) --
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
NextToken (string) --
Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.