2023/01/27 - AWS MediaTailor - 1 new 2 updated api methods
Changes This release introduces the As Run logging type, along with API and documentation updates.
Configures Amazon CloudWatch log settings for a channel.
See also: AWS API Documentation
Request Syntax
client.configure_logs_for_channel(
ChannelName='string',
LogTypes=[
'AS_RUN',
]
)
string
[REQUIRED]
The name of the channel.
list
[REQUIRED]
The types of logs to collect.
(string) --
dict
Response Syntax
{
'ChannelName': 'string',
'LogTypes': [
'AS_RUN',
]
}
Response Structure
(dict) --
ChannelName (string) --
The name of the channel.
LogTypes (list) --
The types of logs collected.
(string) --
{'LogConfiguration': {'LogTypes': ['AS_RUN']}}
Describes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
See also: AWS API Documentation
Request Syntax
client.describe_channel(
ChannelName='string'
)
string
[REQUIRED]
The name of the channel.
dict
Response Syntax
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelState': 'RUNNING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LogConfiguration': {
'LogTypes': [
'AS_RUN',
]
},
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
}
Response Structure
(dict) --
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.
LogConfiguration (dict) --
The log configuration for the channel.
LogTypes (list) --
The log types.
(string) --
Outputs (list) --
The channel's output properties.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The channel's playback mode.
Tags (dict) --
The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .
(string) --
(string) --
Tier (string) --
The channel's tier.
{'Items': {'LogConfiguration': {'LogTypes': ['AS_RUN']}}}
Retrieves information about the channels that are associated with the current AWS account.
See also: AWS API Documentation
Request Syntax
client.list_channels(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, use the value of NextToken in the response to get the next page of results.
string
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelState': 'string',
'CreationTime': datetime(2015, 1, 1),
'FillerSlate': {
'SourceLocationName': 'string',
'VodSourceName': 'string'
},
'LastModifiedTime': datetime(2015, 1, 1),
'LogConfiguration': {
'LogTypes': [
'AS_RUN',
]
},
'Outputs': [
{
'DashPlaylistSettings': {
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'SuggestedPresentationDelaySeconds': 123
},
'HlsPlaylistSettings': {
'ManifestWindowSeconds': 123
},
'ManifestName': 'string',
'PlaybackUrl': 'string',
'SourceGroup': 'string'
},
],
'PlaybackMode': 'string',
'Tags': {
'string': 'string'
},
'Tier': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
A list of channels that are associated with this account.
(dict) --
The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
Arn (string) --
The ARN of the channel.
ChannelName (string) --
The name of the channel.
ChannelState (string) --
Returns the state whether the channel is running or not.
CreationTime (datetime) --
The timestamp of when the channel was created.
FillerSlate (dict) --
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode . MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode .
SourceLocationName (string) --
The name of the source location where the slate VOD source is stored.
VodSourceName (string) --
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
LastModifiedTime (datetime) --
The timestamp of when the channel was last modified.
LogConfiguration (dict) --
The log configuration.
LogTypes (list) --
The log types.
(string) --
Outputs (list) --
The channel's output properties.
(dict) --
The output item response.
DashPlaylistSettings (dict) --
DASH manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
MinBufferTimeSeconds (integer) --
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
MinUpdatePeriodSeconds (integer) --
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
SuggestedPresentationDelaySeconds (integer) --
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
HlsPlaylistSettings (dict) --
HLS manifest configuration settings.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
ManifestName (string) --
The name of the manifest for the channel that will appear in the channel output's playback URL.
PlaybackUrl (string) --
The URL used for playback by content players.
SourceGroup (string) --
A string used to associate a package configuration source group with a channel output.
PlaybackMode (string) --
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
Tags (dict) --
The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .
(string) --
(string) --
Tier (string) --
The tier for this channel. STANDARD tier channels can contain live programs.
NextToken (string) --
Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.