2023/05/19 - AWS Elemental MediaPackage v2 - 24 new api methods
Changes Adds support for the MediaPackage Live v2 API
Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.
See also: AWS API Documentation
Request Syntax
client.get_origin_endpoint_policy(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
dict
Response Syntax
{
'ChannelGroupName': 'string',
'ChannelName': 'string',
'OriginEndpointName': 'string',
'Policy': 'string'
}
Response Structure
(dict) --
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) --
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
Policy (string) --
The policy assigned to the origin endpoint.
Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
See also: AWS API Documentation
Request Syntax
client.list_channel_groups(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results to return in the response.
string
The pagination token from the GET list request. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'ChannelGroupName': 'string',
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The objects being returned.
(dict) --
The configuration of the channel group.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
CreatedAt (datetime) --
The date and time the channel group was created.
ModifiedAt (datetime) --
The date and time the channel group was modified.
Description (string) --
Any descriptive information that you want to add to the channel group for future identification purposes.
NextToken (string) --
The pagination token from the GET list request. Use the token to fetch the next page of results.
The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.
See also: AWS API Documentation
Request Syntax
client.create_origin_endpoint(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string',
ContainerType='TS'|'CMAF',
Segment={
'SegmentDurationSeconds': 123,
'SegmentName': 'string',
'TsUseAudioRenditionGroup': True|False,
'IncludeIframeOnlyStreams': True|False,
'TsIncludeDvbSubtitles': True|False,
'Scte': {
'ScteFilter': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
]
},
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': {
'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
'CmafEncryptionMethod': 'CENC'|'CBCS'
},
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'EncryptionContractConfiguration': {
'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
},
'ResourceId': 'string',
'DrmSystems': [
'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
],
'RoleArn': 'string',
'Url': 'string'
}
}
},
ClientToken='string',
Description='string',
StartoverWindowSeconds=123,
HlsManifests=[
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
},
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
],
LowLatencyHlsManifests=[
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
},
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
],
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.
string
[REQUIRED]
The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.
dict
The segment configuration, including the segment name, duration, and other configuration values.
SegmentDurationSeconds (integer) --
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
SegmentName (string) --
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
TsUseAudioRenditionGroup (boolean) --
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
IncludeIframeOnlyStreams (boolean) --
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
TsIncludeDvbSubtitles (boolean) --
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Scte (dict) --
The SCTE configuration options in the segment settings.
ScteFilter (list) --
The SCTE-35 message types that you want to be treated as ad markers in the output.
(string) --
Encryption (dict) --
The parameters for encrypting content.
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
EncryptionMethod (dict) -- [REQUIRED]
The encryption method to use.
TsEncryptionMethod (string) --
The encryption method to use.
CmafEncryptionMethod (string) --
The encryption method to use.
KeyRotationIntervalSeconds (integer) --
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
SpekeKeyProvider (dict) -- [REQUIRED]
The parameters for the SPEKE key provider.
EncryptionContractConfiguration (dict) -- [REQUIRED]
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
PresetSpeke20Audio (string) -- [REQUIRED]
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
PresetSpeke20Video (string) -- [REQUIRED]
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
ResourceId (string) -- [REQUIRED]
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
DrmSystems (list) -- [REQUIRED]
The DRM solution provider you're using to protect your content during distribution.
(string) --
RoleArn (string) -- [REQUIRED]
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Url (string) -- [REQUIRED]
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
string
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Enter any descriptive text that helps you to identify the origin endpoint.
integer
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
list
An HTTP live streaming (HLS) manifest configuration.
(dict) --
Create an HTTP live streaming (HLS) manifest configuration.
ManifestName (string) -- [REQUIRED]
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
list
A low-latency HLS manifest configuration.
(dict) --
Create a low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) -- [REQUIRED]
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
dict
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'ChannelGroupName': 'string',
'ChannelName': 'string',
'OriginEndpointName': 'string',
'ContainerType': 'TS'|'CMAF',
'Segment': {
'SegmentDurationSeconds': 123,
'SegmentName': 'string',
'TsUseAudioRenditionGroup': True|False,
'IncludeIframeOnlyStreams': True|False,
'TsIncludeDvbSubtitles': True|False,
'Scte': {
'ScteFilter': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
]
},
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': {
'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
'CmafEncryptionMethod': 'CENC'|'CBCS'
},
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'EncryptionContractConfiguration': {
'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
},
'ResourceId': 'string',
'DrmSystems': [
'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
],
'RoleArn': 'string',
'Url': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'StartoverWindowSeconds': 123,
'HlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'LowLatencyHlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) --
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
ContainerType (string) --
The type of container attached to this origin endpoint.
Segment (dict) --
The segment configuration, including the segment name, duration, and other configuration values.
SegmentDurationSeconds (integer) --
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
SegmentName (string) --
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
TsUseAudioRenditionGroup (boolean) --
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
IncludeIframeOnlyStreams (boolean) --
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
TsIncludeDvbSubtitles (boolean) --
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Scte (dict) --
The SCTE configuration options in the segment settings.
ScteFilter (list) --
The SCTE-35 message types that you want to be treated as ad markers in the output.
(string) --
Encryption (dict) --
The parameters for encrypting content.
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
EncryptionMethod (dict) --
The encryption method to use.
TsEncryptionMethod (string) --
The encryption method to use.
CmafEncryptionMethod (string) --
The encryption method to use.
KeyRotationIntervalSeconds (integer) --
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
SpekeKeyProvider (dict) --
The parameters for the SPEKE key provider.
EncryptionContractConfiguration (dict) --
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
PresetSpeke20Audio (string) --
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
PresetSpeke20Video (string) --
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
ResourceId (string) --
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
DrmSystems (list) --
The DRM solution provider you're using to protect your content during distribution.
(string) --
RoleArn (string) --
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Url (string) --
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
CreatedAt (datetime) --
The date and time the origin endpoint was created.
ModifiedAt (datetime) --
The date and time the origin endpoint was modified.
Description (string) --
The description for your origin endpoint.
StartoverWindowSeconds (integer) --
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
HlsManifests (list) --
An HTTP live streaming (HLS) manifest configuration.
(dict) --
Retrieve the HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
LowLatencyHlsManifests (list) --
A low-latency HLS manifest configuration.
(dict) --
Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the origin endpoint.
(string) --
(string) --
Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
See also: AWS API Documentation
Request Syntax
client.get_channel(
ChannelGroupName='string',
ChannelName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
dict
Response Syntax
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelGroupName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'IngestEndpoints': [
{
'Id': 'string',
'Url': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
CreatedAt (datetime) --
The date and time the channel was created.
ModifiedAt (datetime) --
The date and time the channel was modified.
Description (string) --
The description for your channel.
IngestEndpoints (list) --
The list of ingest endpoints.
(dict) --
The ingest domain URL where the source stream should be sent.
Id (string) --
The system-generated unique identifier for the IngestEndpoint.
Url (string) --
The ingest domain URL where the source stream should be sent.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel.
(string) --
(string) --
Delete a channel policy.
See also: AWS API Documentation
Request Syntax
client.delete_channel_policy(
ChannelGroupName='string',
ChannelName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
dict
Response Syntax
{}
Response Structure
(dict) --
Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.
See also: AWS API Documentation
Request Syntax
client.delete_channel(
ChannelGroupName='string',
ChannelName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
dict
Response Syntax
{}
Response Structure
(dict) --
Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.
Any edits you make that impact the video output may not be reflected for a few minutes.
See also: AWS API Documentation
Request Syntax
client.update_origin_endpoint(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string',
ContainerType='TS'|'CMAF',
Segment={
'SegmentDurationSeconds': 123,
'SegmentName': 'string',
'TsUseAudioRenditionGroup': True|False,
'IncludeIframeOnlyStreams': True|False,
'TsIncludeDvbSubtitles': True|False,
'Scte': {
'ScteFilter': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
]
},
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': {
'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
'CmafEncryptionMethod': 'CENC'|'CBCS'
},
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'EncryptionContractConfiguration': {
'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
},
'ResourceId': 'string',
'DrmSystems': [
'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
],
'RoleArn': 'string',
'Url': 'string'
}
}
},
Description='string',
StartoverWindowSeconds=123,
HlsManifests=[
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
},
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
],
LowLatencyHlsManifests=[
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
},
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
]
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
string
[REQUIRED]
The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
dict
The segment configuration, including the segment name, duration, and other configuration values.
SegmentDurationSeconds (integer) --
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
SegmentName (string) --
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
TsUseAudioRenditionGroup (boolean) --
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
IncludeIframeOnlyStreams (boolean) --
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
TsIncludeDvbSubtitles (boolean) --
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Scte (dict) --
The SCTE configuration options in the segment settings.
ScteFilter (list) --
The SCTE-35 message types that you want to be treated as ad markers in the output.
(string) --
Encryption (dict) --
The parameters for encrypting content.
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
EncryptionMethod (dict) -- [REQUIRED]
The encryption method to use.
TsEncryptionMethod (string) --
The encryption method to use.
CmafEncryptionMethod (string) --
The encryption method to use.
KeyRotationIntervalSeconds (integer) --
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
SpekeKeyProvider (dict) -- [REQUIRED]
The parameters for the SPEKE key provider.
EncryptionContractConfiguration (dict) -- [REQUIRED]
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
PresetSpeke20Audio (string) -- [REQUIRED]
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
PresetSpeke20Video (string) -- [REQUIRED]
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
ResourceId (string) -- [REQUIRED]
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
DrmSystems (list) -- [REQUIRED]
The DRM solution provider you're using to protect your content during distribution.
(string) --
RoleArn (string) -- [REQUIRED]
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Url (string) -- [REQUIRED]
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
string
Any descriptive information that you want to add to the origin endpoint for future identification purposes.
integer
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).
list
An HTTP live streaming (HLS) manifest configuration.
(dict) --
Create an HTTP live streaming (HLS) manifest configuration.
ManifestName (string) -- [REQUIRED]
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
list
A low-latency HLS manifest configuration.
(dict) --
Create a low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) -- [REQUIRED]
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
dict
Response Syntax
{
'Arn': 'string',
'ChannelGroupName': 'string',
'ChannelName': 'string',
'OriginEndpointName': 'string',
'ContainerType': 'TS'|'CMAF',
'Segment': {
'SegmentDurationSeconds': 123,
'SegmentName': 'string',
'TsUseAudioRenditionGroup': True|False,
'IncludeIframeOnlyStreams': True|False,
'TsIncludeDvbSubtitles': True|False,
'Scte': {
'ScteFilter': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
]
},
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': {
'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
'CmafEncryptionMethod': 'CENC'|'CBCS'
},
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'EncryptionContractConfiguration': {
'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
},
'ResourceId': 'string',
'DrmSystems': [
'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
],
'RoleArn': 'string',
'Url': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'StartoverWindowSeconds': 123,
'HlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'LowLatencyHlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The ARN associated with the resource.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) --
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
ContainerType (string) --
The type of container attached to this origin endpoint.
Segment (dict) --
The segment configuration, including the segment name, duration, and other configuration values.
SegmentDurationSeconds (integer) --
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
SegmentName (string) --
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
TsUseAudioRenditionGroup (boolean) --
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
IncludeIframeOnlyStreams (boolean) --
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
TsIncludeDvbSubtitles (boolean) --
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Scte (dict) --
The SCTE configuration options in the segment settings.
ScteFilter (list) --
The SCTE-35 message types that you want to be treated as ad markers in the output.
(string) --
Encryption (dict) --
The parameters for encrypting content.
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
EncryptionMethod (dict) --
The encryption method to use.
TsEncryptionMethod (string) --
The encryption method to use.
CmafEncryptionMethod (string) --
The encryption method to use.
KeyRotationIntervalSeconds (integer) --
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
SpekeKeyProvider (dict) --
The parameters for the SPEKE key provider.
EncryptionContractConfiguration (dict) --
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
PresetSpeke20Audio (string) --
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
PresetSpeke20Video (string) --
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
ResourceId (string) --
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
DrmSystems (list) --
The DRM solution provider you're using to protect your content during distribution.
(string) --
RoleArn (string) --
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Url (string) --
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
CreatedAt (datetime) --
The date and time the origin endpoint was created.
ModifiedAt (datetime) --
The date and time the origin endpoint was modified.
Description (string) --
The description of the origin endpoint.
StartoverWindowSeconds (integer) --
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
HlsManifests (list) --
An HTTP live streaming (HLS) manifest configuration.
(dict) --
Retrieve the HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
LowLatencyHlsManifests (list) --
A low-latency HLS manifest configuration.
(dict) --
Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the origin endpoint.
(string) --
(string) --
Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.
See also: AWS API Documentation
Request Syntax
client.put_origin_endpoint_policy(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string',
Policy='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
string
[REQUIRED]
The policy to attach to the specified origin endpoint.
dict
Response Syntax
{}
Response Structure
(dict) --
Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.
See also: AWS API Documentation
Request Syntax
client.delete_origin_endpoint(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.
See also: AWS API Documentation
Request Syntax
client.create_channel(
ChannelGroupName='string',
ChannelName='string',
ClientToken='string',
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.
string
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Enter any descriptive text that helps you to identify the channel.
dict
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
(string) --
(string) --
dict
Response Syntax
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelGroupName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'IngestEndpoints': [
{
'Id': 'string',
'Url': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
CreatedAt (datetime) --
The date and time the channel was created.
ModifiedAt (datetime) --
The date and time the channel was modified.
Description (string) --
The description for your channel.
IngestEndpoints (list) --
The list of ingest endpoints.
(dict) --
The ingest domain URL where the source stream should be sent.
Id (string) --
The system-generated unique identifier for the IngestEndpoint.
Url (string) --
The ingest domain URL where the source stream should be sent.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel.
(string) --
(string) --
Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.
Any edits you make that impact the video output may not be reflected for a few minutes.
See also: AWS API Documentation
Request Syntax
client.update_channel_group(
ChannelGroupName='string',
Description='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
Any descriptive information that you want to add to the channel group for future identification purposes.
dict
Response Syntax
{
'ChannelGroupName': 'string',
'Arn': 'string',
'EgressDomain': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
EgressDomain (string) --
The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
CreatedAt (datetime) --
The date and time the channel group was created.
ModifiedAt (datetime) --
The date and time the channel group was modified.
Description (string) --
The description for your channel group.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel group.
(string) --
(string) --
Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.
See also: AWS API Documentation
Request Syntax
client.create_channel_group(
ChannelGroupName='string',
ClientToken='string',
Description='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group.
string
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
string
Enter any descriptive text that helps you to identify the channel group.
dict
A comma-separated list of tag key:value pairs that you define. For example:
"Key1": "Value1",
"Key2": "Value2"
(string) --
(string) --
dict
Response Syntax
{
'ChannelGroupName': 'string',
'Arn': 'string',
'EgressDomain': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
EgressDomain (string) --
The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.
CreatedAt (datetime) --
The date and time the channel group was created.
ModifiedAt (datetime) --
The date and time the channel group was modified.
Description (string) --
The description for your channel group.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel group.
(string) --
(string) --
Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the MediaPackage resource that you're adding tags to.
dict
[REQUIRED]
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
(string) --
(string) --
None
Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.
Any edits you make that impact the video output may not be reflected for a few minutes.
See also: AWS API Documentation
Request Syntax
client.update_channel(
ChannelGroupName='string',
ChannelName='string',
Description='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
Any descriptive information that you want to add to the channel for future identification purposes.
dict
Response Syntax
{
'Arn': 'string',
'ChannelName': 'string',
'ChannelGroupName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'IngestEndpoints': [
{
'Id': 'string',
'Url': 'string'
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
CreatedAt (datetime) --
The date and time the channel was created.
ModifiedAt (datetime) --
The date and time the channel was modified.
Description (string) --
The description for your channel.
IngestEndpoints (list) --
The list of ingest endpoints.
(dict) --
The ingest domain URL where the source stream should be sent.
Id (string) --
The system-generated unique identifier for the IngestEndpoint.
Url (string) --
The ingest domain URL where the source stream should be sent.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel.
(string) --
(string) --
Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.
See also: AWS API Documentation
Request Syntax
client.put_channel_policy(
ChannelGroupName='string',
ChannelName='string',
Policy='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The policy to attach to the specified channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.
See also: AWS API Documentation
Request Syntax
client.get_channel_policy(
ChannelGroupName='string',
ChannelName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
dict
Response Syntax
{
'ChannelGroupName': 'string',
'ChannelName': 'string',
'Policy': 'string'
}
Response Structure
(dict) --
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
Policy (string) --
The policy assigned to the channel.
Lists the tags assigned to a resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceArn='string'
)
string
[REQUIRED]
The ARN of the CloudWatch resource that you want to view tags for.
dict
Response Syntax
{
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Tags (dict) --
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
(string) --
(string) --
Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.
See also: AWS API Documentation
Request Syntax
client.get_channel_group(
ChannelGroupName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
dict
Response Syntax
{
'ChannelGroupName': 'string',
'Arn': 'string',
'EgressDomain': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
EgressDomain (string) --
The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.
CreatedAt (datetime) --
The date and time the channel group was created.
ModifiedAt (datetime) --
The date and time the channel group was modified.
Description (string) --
The description for your channel group.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the channel group.
(string) --
(string) --
Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.
See also: AWS API Documentation
Request Syntax
client.list_origin_endpoints(
ChannelGroupName='string',
ChannelName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
integer
The maximum number of results to return in the response.
string
The pagination token from the GET list request. Use the token to fetch the next page of results.
dict
Response Syntax
{
'Items': [
{
'Arn': 'string',
'ChannelGroupName': 'string',
'ChannelName': 'string',
'OriginEndpointName': 'string',
'ContainerType': 'TS'|'CMAF',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'HlsManifests': [
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'Url': 'string'
},
],
'LowLatencyHlsManifests': [
{
'ManifestName': 'string',
'ChildManifestName': 'string',
'Url': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The objects being returned.
(dict) --
The configuration of the origin endpoint.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) --
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
ContainerType (string) --
The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.
Description (string) --
Any descriptive information that you want to add to the origin endpoint for future identification purposes.
CreatedAt (datetime) --
The date and time the origin endpoint was created.
ModifiedAt (datetime) --
The date and time the origin endpoint was modified.
HlsManifests (list) --
An HTTP live streaming (HLS) manifest configuration.
(dict) --
List the HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
LowLatencyHlsManifests (list) --
A low-latency HLS manifest configuration.
(dict) --
List the low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
NextToken (string) --
The pagination token from the GET list request. Use the token to fetch the next page of results.
Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.
See also: AWS API Documentation
Request Syntax
client.delete_channel_group(
ChannelGroupName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.
See also: AWS API Documentation
Request Syntax
client.list_channels(
ChannelGroupName='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
integer
The maximum number of results to return in the response.
string
The 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',
'ChannelGroupName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Items (list) --
The objects being returned.
(dict) --
The configuration of the channel.
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
CreatedAt (datetime) --
The date and time the channel was created.
ModifiedAt (datetime) --
The date and time the channel was modified.
Description (string) --
Any descriptive information that you want to add to the channel for future identification purposes.
NextToken (string) --
The pagination token from the GET list request.
Removes one or more tags from the specified resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the MediaPackage resource that you're removing tags from.
list
[REQUIRED]
The list of tag keys to remove from the resource.
(string) --
None
Delete an origin endpoint policy.
See also: AWS API Documentation
Request Syntax
client.delete_origin_endpoint_policy(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
dict
Response Syntax
{}
Response Structure
(dict) --
Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.
See also: AWS API Documentation
Request Syntax
client.get_origin_endpoint(
ChannelGroupName='string',
ChannelName='string',
OriginEndpointName='string'
)
string
[REQUIRED]
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
string
[REQUIRED]
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
string
[REQUIRED]
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
dict
Response Syntax
{
'Arn': 'string',
'ChannelGroupName': 'string',
'ChannelName': 'string',
'OriginEndpointName': 'string',
'ContainerType': 'TS'|'CMAF',
'Segment': {
'SegmentDurationSeconds': 123,
'SegmentName': 'string',
'TsUseAudioRenditionGroup': True|False,
'IncludeIframeOnlyStreams': True|False,
'TsIncludeDvbSubtitles': True|False,
'Scte': {
'ScteFilter': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM',
]
},
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': {
'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES',
'CmafEncryptionMethod': 'CENC'|'CBCS'
},
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'EncryptionContractConfiguration': {
'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED',
'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED'
},
'ResourceId': 'string',
'DrmSystems': [
'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE',
],
'RoleArn': 'string',
'Url': 'string'
}
}
},
'CreatedAt': datetime(2015, 1, 1),
'ModifiedAt': datetime(2015, 1, 1),
'Description': 'string',
'StartoverWindowSeconds': 123,
'HlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'LowLatencyHlsManifests': [
{
'ManifestName': 'string',
'Url': 'string',
'ChildManifestName': 'string',
'ManifestWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'ScteHls': {
'AdMarkerHls': 'DATERANGE'
}
},
],
'Tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) associated with the resource.
ChannelGroupName (string) --
The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.
ChannelName (string) --
The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.
OriginEndpointName (string) --
The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.
ContainerType (string) --
The type of container attached to this origin endpoint.
Segment (dict) --
The segment configuration, including the segment name, duration, and other configuration values.
SegmentDurationSeconds (integer) --
The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.
SegmentName (string) --
The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.
TsUseAudioRenditionGroup (boolean) --
When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.
IncludeIframeOnlyStreams (boolean) --
When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.
TsIncludeDvbSubtitles (boolean) --
By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.
Scte (dict) --
The SCTE configuration options in the segment settings.
ScteFilter (list) --
The SCTE-35 message types that you want to be treated as ad markers in the output.
(string) --
Encryption (dict) --
The parameters for encrypting content.
ConstantInitializationVector (string) --
A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
EncryptionMethod (dict) --
The encryption method to use.
TsEncryptionMethod (string) --
The encryption method to use.
CmafEncryptionMethod (string) --
The encryption method to use.
KeyRotationIntervalSeconds (integer) --
The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.
The following example setting causes the service to rotate keys every thirty minutes: 1800
SpekeKeyProvider (dict) --
The parameters for the SPEKE key provider.
EncryptionContractConfiguration (dict) --
Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.
PresetSpeke20Audio (string) --
A collection of audio encryption presets.
Value description:
PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.
PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.
PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.
SHARED - Use the same content key for all of the audio and video tracks in your stream.
UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.
PresetSpeke20Video (string) --
A collection of video encryption presets.
Value description:
PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.
PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.
PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.
PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.
SHARED - Use the same content key for all of the video and audio tracks in your stream.
UNENCRYPTED - Don't encrypt any of the video tracks in your stream.
ResourceId (string) --
The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.
The following example shows a resource ID: MovieNight20171126093045
DrmSystems (list) --
The DRM solution provider you're using to protect your content during distribution.
(string) --
RoleArn (string) --
The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.
Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess
Url (string) --
The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.
The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection
CreatedAt (datetime) --
The date and time the origin endpoint was created.
ModifiedAt (datetime) --
The date and time the origin endpoint was modified.
Description (string) --
The description for your origin endpoint.
StartoverWindowSeconds (integer) --
The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.
HlsManifests (list) --
An HTTP live streaming (HLS) manifest configuration.
(dict) --
Retrieve the HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
LowLatencyHlsManifests (list) --
A low-latency HLS manifest configuration.
(dict) --
Retrieve the low-latency HTTP live streaming (HLS) manifest configuration.
ManifestName (string) --
A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
Url (string) --
The egress domain URL for stream delivery from MediaPackage.
ChildManifestName (string) --
A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.
ManifestWindowSeconds (integer) --
The total duration (in seconds) of the manifest's content.
ProgramDateTimeIntervalSeconds (integer) --
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
ScteHls (dict) --
The SCTE configuration.
AdMarkerHls (string) --
Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.
Value description:
DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.
Tags (dict) --
The comma-separated list of tag key:value pairs assigned to the origin endpoint.
(string) --
(string) --