Table of Contents
A low-level client representing AWS Elemental MediaPackage AWS Elemental MediaPackage:
client = session.create_client('mediapackage')
These are the available methods:
Check if an operation can be paginated.
Changes the Channel's properities to configure log subscription
See also: AWS API Documentation
Request Syntax
response = client.configure_logs(
EgressAccessLogs={
'LogGroupName': 'string'
},
Id='string',
IngressAccessLogs={
'LogGroupName': 'string'
}
)
Configure egress access logging.
Configure ingress access logging.
dict
Response Syntax
{
'Arn': 'string',
'Description': 'string',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Creates a new HarvestJob record.
See also: AWS API Documentation
Request Syntax
response = client.create_harvest_job(
EndTime='string',
Id='string',
OriginEndpointId='string',
S3Destination={
'BucketName': 'string',
'ManifestKey': 'string',
'RoleArn': 'string'
},
StartTime='string'
)
[REQUIRED] Configuration parameters for where in an S3 bucket to place the harvested content
dict
Response Syntax
{
'Arn': 'string',
'ChannelId': 'string',
'CreatedAt': 'string',
'EndTime': 'string',
'Id': 'string',
'OriginEndpointId': 'string',
'S3Destination': {
'BucketName': 'string',
'ManifestKey': 'string',
'RoleArn': 'string'
},
'StartTime': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}
Response Structure
Exceptions
Creates a new OriginEndpoint record.
See also: AWS API Documentation
Request Syntax
response = client.create_origin_endpoint(
Authorization={
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
ChannelId='string',
CmafPackage={
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
Description='string',
HlsPackage={
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
Origination='ALLOW'|'DENY',
StartoverWindowSeconds=123,
Tags={
'string': 'string'
},
TimeDelaySeconds=123,
Whitelist=[
'string',
]
)
CDN Authorization credentials
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',
'Authorization': {
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
'Origination': 'ALLOW'|'DENY',
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
Exceptions
Deletes an existing Channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
Id='string'
)
{}
Response Structure
Exceptions
Deletes an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_origin_endpoint(
Id='string'
)
{}
Response Structure
Exceptions
Gets details about a Channel.
See also: AWS API Documentation
Request Syntax
response = client.describe_channel(
Id='string'
)
{
'Arn': 'string',
'Description': 'string',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Gets details about an existing HarvestJob.
See also: AWS API Documentation
Request Syntax
response = client.describe_harvest_job(
Id='string'
)
{
'Arn': 'string',
'ChannelId': 'string',
'CreatedAt': 'string',
'EndTime': 'string',
'Id': 'string',
'OriginEndpointId': 'string',
'S3Destination': {
'BucketName': 'string',
'ManifestKey': 'string',
'RoleArn': 'string'
},
'StartTime': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}
Response Structure
Exceptions
Gets details about an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.describe_origin_endpoint(
Id='string'
)
{
'Arn': 'string',
'Authorization': {
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
'Origination': 'ALLOW'|'DENY',
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
Exceptions
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
Returns a collection of HarvestJob records.
See also: AWS API Documentation
Request Syntax
response = client.list_harvest_jobs(
IncludeChannelId='string',
IncludeStatus='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'HarvestJobs': [
{
'Arn': 'string',
'ChannelId': 'string',
'CreatedAt': 'string',
'EndTime': 'string',
'Id': 'string',
'OriginEndpointId': 'string',
'S3Destination': {
'BucketName': 'string',
'ManifestKey': 'string',
'RoleArn': 'string'
},
'StartTime': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
},
],
'NextToken': 'string'
}
Response Structure
Exceptions
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',
'Authorization': {
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
'Origination': 'ALLOW'|'DENY',
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
},
]
}
Response Structure
Exceptions
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
}
Response Structure
Exceptions
Updates an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_origin_endpoint(
Authorization={
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
CmafPackage={
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
Description='string',
HlsPackage={
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
Origination='ALLOW'|'DENY',
StartoverWindowSeconds=123,
TimeDelaySeconds=123,
Whitelist=[
'string',
]
)
CDN Authorization credentials
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',
'Authorization': {
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
'Origination': 'ALLOW'|'DENY',
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
}
Response Structure
Exceptions
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
The client is not authorized to access the requested resource.
Example
try:
...
except client.exceptions.ForbiddenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
An unexpected error occurred.
Example
try:
...
except client.exceptions.InternalServerErrorException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
The requested resource does not exist.
Example
try:
...
except client.exceptions.NotFoundException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
An unexpected error occurred.
Example
try:
...
except client.exceptions.ServiceUnavailableException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
The client has exceeded their resource or throttling limits.
Example
try:
...
except client.exceptions.TooManyRequestsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
The parameters sent in the request are not valid.
Example
try:
...
except client.exceptions.UnprocessableEntityException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
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',
'EgressAccessLogs': {
'LogGroupName': 'string'
},
'HlsIngest': {
'IngestEndpoints': [
{
'Id': 'string',
'Password': 'string',
'Url': 'string',
'Username': 'string'
},
]
},
'Id': 'string',
'IngressAccessLogs': {
'LogGroupName': 'string'
},
'Tags': {
'string': 'string'
}
},
],
}
Response Structure
paginator = client.get_paginator('list_harvest_jobs')
Creates an iterator that will paginate through responses from MediaPackage.Client.list_harvest_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
IncludeChannelId='string',
IncludeStatus='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
{
'HarvestJobs': [
{
'Arn': 'string',
'ChannelId': 'string',
'CreatedAt': 'string',
'EndTime': 'string',
'Id': 'string',
'OriginEndpointId': 'string',
'S3Destination': {
'BucketName': 'string',
'ManifestKey': 'string',
'RoleArn': 'string'
},
'StartTime': 'string',
'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
},
],
}
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',
'Authorization': {
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
'ChannelId': 'string',
'CmafPackage': {
'Encryption': {
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'ResourceId': 'string',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'HlsManifests': [
{
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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,
'UtcTiming': 'NONE'|'HTTP-HEAD'|'HTTP-ISO',
'UtcTimingUri': 'string'
},
'Description': 'string',
'HlsPackage': {
'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH'|'DATERANGE',
'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'
}
},
'Origination': 'ALLOW'|'DENY',
'StartoverWindowSeconds': 123,
'Tags': {
'string': 'string'
},
'TimeDelaySeconds': 123,
'Url': 'string',
'Whitelist': [
'string',
]
},
]
}
Response Structure