Table of Contents
MediaPackage.
Client
¶A low-level client representing AWS Elemental MediaPackage AWS Elemental MediaPackage:
import boto3
client = boto3.client('mediapackage')
These are the available methods:
can_paginate()
close()
configure_logs()
create_channel()
create_harvest_job()
create_origin_endpoint()
delete_channel()
delete_origin_endpoint()
describe_channel()
describe_harvest_job()
describe_origin_endpoint()
get_paginator()
get_waiter()
list_channels()
list_harvest_jobs()
list_origin_endpoints()
list_tags_for_resource()
rotate_channel_credentials()
rotate_ingest_endpoint_credentials()
tag_resource()
untag_resource()
update_channel()
update_origin_endpoint()
can_paginate
(operation_name)¶Check if an operation can be paginated.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.True
if the operation can be paginated,
False
otherwise.close
()¶Closes underlying endpoint connections.
configure_logs
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
create_channel
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
create_harvest_job
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
create_origin_endpoint
(**kwargs)¶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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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'
},
],
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
delete_channel
(**kwargs)¶Deletes an existing Channel.
See also: AWS API Documentation
Request Syntax
response = client.delete_channel(
Id='string'
)
{}
Response Structure
Exceptions
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
delete_origin_endpoint
(**kwargs)¶Deletes an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.delete_origin_endpoint(
Id='string'
)
{}
Response Structure
Exceptions
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
describe_channel
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
describe_harvest_job
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
describe_origin_endpoint
(**kwargs)¶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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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'
},
],
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
get_paginator
(operation_name)¶Create a paginator for an operation.
create_foo
, and you'd normally invoke the
operation as client.create_foo(**kwargs)
, if the
create_foo
operation can be paginated, you can use the
call client.get_paginator("create_foo")
.client.can_paginate
method to
check if an operation is pageable.get_waiter
(waiter_name)¶Returns an object that can wait for some condition.
list_channels
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
list_harvest_jobs
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
list_origin_endpoints
(**kwargs)¶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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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'
},
],
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string'
)
{
'Tags': {
'string': 'string'
}
}
Response Structure
rotate_channel_credentials
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
rotate_ingest_endpoint_credentials
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
tag_resource
(**kwargs)¶See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
None
untag_resource
(**kwargs)¶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
update_channel
(**kwargs)¶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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
update_origin_endpoint
(**kwargs)¶Updates an existing OriginEndpoint.
See also: AWS API Documentation
Request Syntax
response = client.update_origin_endpoint(
Authorization={
'CdnIdentifierSecret': 'string',
'SecretsRoleArn': 'string'
},
CmafPackage={
'Encryption': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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'
},
],
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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
MediaPackage.Client.exceptions.UnprocessableEntityException
MediaPackage.Client.exceptions.InternalServerErrorException
MediaPackage.Client.exceptions.ForbiddenException
MediaPackage.Client.exceptions.NotFoundException
MediaPackage.Client.exceptions.ServiceUnavailableException
MediaPackage.Client.exceptions.TooManyRequestsException
The available paginators are:
MediaPackage.Paginator.ListChannels
MediaPackage.Paginator.ListHarvestJobs
MediaPackage.Paginator.ListOriginEndpoints
MediaPackage.Paginator.
ListChannels
¶paginator = client.get_paginator('list_channels')
paginate
(**kwargs)¶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
MediaPackage.Paginator.
ListHarvestJobs
¶paginator = client.get_paginator('list_harvest_jobs')
paginate
(**kwargs)¶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
MediaPackage.Paginator.
ListOriginEndpoints
¶paginator = client.get_paginator('list_origin_endpoints')
paginate
(**kwargs)¶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': {
'ConstantInitializationVector': 'string',
'EncryptionMethod': 'SAMPLE_AES'|'AES_CTR',
'KeyRotationIntervalSeconds': 123,
'SpekeKeyProvider': {
'CertificateArn': 'string',
'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',
'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',
'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'
},
],
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeIframeOnlyStream': True|False,
'ManifestLayout': 'FULL'|'COMPACT',
'ManifestWindowSeconds': 123,
'MinBufferTimeSeconds': 123,
'MinUpdatePeriodSeconds': 123,
'PeriodTriggers': [
'ADS',
],
'Profile': 'NONE'|'HBBTV_1_5'|'HYBRIDCAST'|'DVB_DASH_2014',
'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'|'HTTP-XSDATE',
'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',
'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',
'RoleArn': 'string',
'SystemIds': [
'string',
],
'Url': 'string'
}
},
'IncludeDvbSubtitles': True|False,
'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',
'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',
'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