Table of Contents
A low-level client representing AWS Elemental MediaPackage:
import boto3
client = boto3.client('mediapackage')
These are the available methods:
Check if an operation can be paginated.
Creates a new Channel.
See also: AWS API Documentation
Request Syntax
response = client.create_channel(
Description='string',
Id='string',
Tags={
'string': 'string'
}
)
A collection of tags associated with a resource
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
Creates a new OriginEndpoint record.
See also: AWS API Documentation
Request Syntax
response = client.create_origin_endpoint(
ChannelId='string',
CmafPackage={
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
DashPackage={
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
Description='string',
HlsPackage={
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
Id='string',
ManifestName='string',
MssPackage={
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
StartoverWindowSeconds=123,
Tags={
'string': 'string'
},
TimeDelaySeconds=123,
Whitelist=[
'string',
]
)
A Common Media Application Format (CMAF) packaging configuration.
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
An HTTP Live Streaming (HLS) packaging configuration.
A Microsoft Smooth Streaming (MSS) packaging configuration.
A collection of tags associated with a resource
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
dict
Response Syntax
{
'Arn': 'string',
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'Url': 'string'
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'DashPackage': {
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
'Id': 'string',
'ManifestName': 'string',
'MssPackage': {
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
Deletes an existing Channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
Id='string'
)
{}
Response Structure
Deletes an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_origin_endpoint(
Id='string'
)
{}
Response Structure
Gets details about a Channel.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel(
Id='string'
)
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
Gets details about an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_origin_endpoint(
Id='string'
)
{
'Arn': 'string',
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'Url': 'string'
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'DashPackage': {
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
'Id': 'string',
'ManifestName': 'string',
'MssPackage': {
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Returns a collection of Channels.
See also: AWS API Documentation
Request Syntax
response = client.list_channels(
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'Channels': [
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Returns a collection of OriginEndpoint records.
See also: AWS API Documentation
Request Syntax
response = client.list_origin_endpoints(
ChannelId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'OriginEndpoints': [
{
'Arn': 'string',
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'Url': 'string'
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'DashPackage': {
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
'Id': 'string',
'ManifestName': 'string',
'MssPackage': {
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
},
]
}
Response Structure
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
{
'Tags': {
'string': 'string'
}
}
Response Structure
Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.rotate_channel_credentials(
Id='string'
)
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
See also: AWS API Documentation
Request Syntax
response = client.rotate_ingest_endpoint_credentials(
Id='string',
IngestEndpointId='string'
)
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
None
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED] The key(s) of tag to be deleted
None
Updates an existing Channel.
See also: AWS API Documentation
Request Syntax
response = client.update_channel(
Description='string',
Id='string'
)
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
}
Response Structure
Updates an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_origin_endpoint(
CmafPackage={
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
DashPackage={
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
Description='string',
HlsPackage={
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
Id='string',
ManifestName='string',
MssPackage={
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
StartoverWindowSeconds=123,
TimeDelaySeconds=123,
Whitelist=[
'string',
]
)
A Common Media Application Format (CMAF) packaging configuration.
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
An HTTP Live Streaming (HLS) packaging configuration.
A Microsoft Smooth Streaming (MSS) packaging configuration.
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
dict
Response Syntax
{
'Arn': 'string',
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'Url': 'string'
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'DashPackage': {
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
'Id': 'string',
'ManifestName': 'string',
'MssPackage': {
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_channels')
Creates an iterator that will paginate through responses from MediaPackage.Client.list_channels().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Channels': [
{
'Arn': 'string',
'Description': 'string',
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
paginator = client.get_paginator('list_origin_endpoints')
Creates an iterator that will paginate through responses from MediaPackage.Client.list_origin_endpoints().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ChannelId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OriginEndpoints': [
{
'Arn': 'string',
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'Id': 'string',
'IncludeIframeOnlyStream': True|False,
'ManifestName': 'string',
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'Url': 'string'
},
],
'SegmentDurationSeconds': 123,
'SegmentPrefix': 'string',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'DashPackage': {
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5',
'SegmentDurationSeconds': 123,
'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'SuggestedPresentationDelaySeconds': 123
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
'AdTriggers': [
'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
],
'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
'KeyRotationIntervalSeconds': 123,
'RepeatExtXKey': True|False,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'PlaylistType': 'NONE'|'EVENT'|'VOD',
'PlaylistWindowSeconds': 123,
'ProgramDateTimeIntervalSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
},
'UseAudioRenditionGroup': True|False
},
'Id': 'string',
'ManifestName': 'string',
'MssPackage': {
'Encryption': {
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'ManifestWindowSeconds': 123,
'SegmentDurationSeconds': 123,
'StreamSelection': {
'MaxVideoBitsPerSecond': 123,
'MinVideoBitsPerSecond': 123,
'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
}
},
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
},
]
}
Response Structure