mediapackagev2 ************** Client ====== class mediapackagev2.Client A low-level client representing AWS Elemental MediaPackage v2 (mediapackagev2) Note: This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2.The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like "v2", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources.If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference. This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols. We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide. import boto3 client = boto3.client('mediapackagev2') These are the available methods: * can_paginate * cancel_harvest_job * close * create_channel * create_channel_group * create_harvest_job * create_origin_endpoint * delete_channel * delete_channel_group * delete_channel_policy * delete_origin_endpoint * delete_origin_endpoint_policy * get_channel * get_channel_group * get_channel_policy * get_harvest_job * get_origin_endpoint * get_origin_endpoint_policy * get_paginator * get_waiter * list_channel_groups * list_channels * list_harvest_jobs * list_origin_endpoints * list_tags_for_resource * put_channel_policy * put_origin_endpoint_policy * reset_channel_state * reset_origin_endpoint_state * tag_resource * untag_resource * update_channel * update_channel_group * update_origin_endpoint Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListChannelGroups * ListChannels * ListHarvestJobs * ListOriginEndpoints Waiters ======= Waiters are available on a client instance via the "get_waiter" method. For more detailed instructions and examples on the usage or waiters, see the waiters user guide. The available waiters are: * HarvestJobFinished mediapackagev2 / Waiter / HarvestJobFinished HarvestJobFinished ****************** class mediapackagev2.Waiter.HarvestJobFinished waiter = client.get_waiter('harvest_job_finished') wait(**kwargs) Polls "mediapackagev2.Client.get_harvest_job()" every 2 seconds until a successful state is reached. An error is raised after 60 failed checks. See also: AWS API Documentation **Request Syntax** waiter.wait( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', HarvestJobName='string', WaiterConfig={ 'Delay': 123, 'MaxAttempts': 123 } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group containing the channel associated with the harvest job. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel associated with the harvest job. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name of the origin endpoint associated with the harvest job. * **HarvestJobName** (*string*) -- **[REQUIRED]** The name of the harvest job to retrieve. * **WaiterConfig** (*dict*) -- A dictionary that provides parameters to control waiting behavior. * **Delay** *(integer) --* The amount of time in seconds to wait between attempts. Default: 2 * **MaxAttempts** *(integer) --* The maximum number of attempts to be made. Default: 60 Returns: None mediapackagev2 / Paginator / ListHarvestJobs ListHarvestJobs *************** class mediapackagev2.Paginator.ListHarvestJobs paginator = client.get_paginator('list_harvest_jobs') paginate(**kwargs) Creates an iterator that will paginate through responses from "mediapackagev2.Client.list_harvest_jobs()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', Status='QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned. * **ChannelName** (*string*) -- The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned. * **OriginEndpointName** (*string*) -- The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned. * **Status** (*string*) -- The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Destination': { 'S3Destination': { 'BucketName': 'string', 'DestinationPath': 'string' } }, 'HarvestJobName': 'string', 'HarvestedManifests': { 'HlsManifests': [ { 'ManifestName': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string' }, ] }, 'Description': 'string', 'ScheduleConfiguration': { 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', 'ErrorMessage': 'string', 'ETag': 'string' }, ], } **Response Structure** * *(dict) --* The response object containing the list of harvest jobs that match the specified criteria. * **Items** *(list) --* An array of harvest job objects that match the specified criteria. * *(dict) --* Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket. * **ChannelGroupName** *(string) --* The name of the channel group containing the channel associated with this harvest job. * **ChannelName** *(string) --* The name of the channel associated with this harvest job. * **OriginEndpointName** *(string) --* The name of the origin endpoint associated with this harvest job. * **Destination** *(dict) --* The S3 destination where the harvested content will be placed. * **S3Destination** *(dict) --* The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket. * **BucketName** *(string) --* The name of an S3 bucket within which harvested content will be exported. * **DestinationPath** *(string) --* The path within the specified S3 bucket where the harvested content will be placed. * **HarvestJobName** *(string) --* The name of the harvest job. * **HarvestedManifests** *(dict) --* A list of manifests that are being or have been harvested. * **HlsManifests** *(list) --* A list of harvested HLS manifests. * *(dict) --* Information about a harvested HLS manifest. * **ManifestName** *(string) --* The name of the harvested HLS manifest. * **DashManifests** *(list) --* A list of harvested DASH manifests. * *(dict) --* Information about a harvested DASH manifest. * **ManifestName** *(string) --* The name of the harvested DASH manifest. * **LowLatencyHlsManifests** *(list) --* A list of harvested Low-Latency HLS manifests. * *(dict) --* Information about a harvested Low-Latency HLS manifest. * **ManifestName** *(string) --* The name of the harvested Low-Latency HLS manifest. * **Description** *(string) --* An optional description of the harvest job. * **ScheduleConfiguration** *(dict) --* The configuration for when the harvest job is scheduled to run. * **StartTime** *(datetime) --* The start time for the harvest job. * **EndTime** *(datetime) --* The end time for the harvest job. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the harvest job. * **CreatedAt** *(datetime) --* The date and time when the harvest job was created. * **ModifiedAt** *(datetime) --* The date and time when the harvest job was last modified. * **Status** *(string) --* The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED). * **ErrorMessage** *(string) --* An error message if the harvest job encountered any issues. * **ETag** *(string) --* The current version of the harvest job. Used for concurrency control. mediapackagev2 / Paginator / ListOriginEndpoints ListOriginEndpoints ******************* class mediapackagev2.Paginator.ListOriginEndpoints paginator = client.get_paginator('list_origin_endpoints') paginate(**kwargs) Creates an iterator that will paginate through responses from "mediapackagev2.Client.list_origin_endpoints()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChannelGroupName='string', ChannelName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'ContainerType': 'TS'|'CMAF'|'ISM', 'Description': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'HlsManifests': [ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'Url': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'Url': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string', 'Url': 'string' }, ], 'MssManifests': [ { 'ManifestName': 'string', 'Url': 'string' }, ], 'ForceEndpointErrorConfiguration': { 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] } }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the origin endpoint. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** *(string) --* The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. * **Description** *(string) --* Any descriptive information that you want to add to the origin endpoint for future identification purposes. * **CreatedAt** *(datetime) --* The date and time the origin endpoint was created. * **ModifiedAt** *(datetime) --* The date and time the origin endpoint was modified. * **HlsManifests** *(list) --* An HTTP live streaming (HLS) manifest configuration. * *(dict) --* List the HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **LowLatencyHlsManifests** *(list) --* A low-latency HLS manifest configuration. * *(dict) --* List the low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **DashManifests** *(list) --* A DASH manifest configuration. * *(dict) --* List the DASH manifest configuration. * **ManifestName** *(string) --* A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **MssManifests** *(list) --* A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. Each configuration represents a different MSS streaming option available from this endpoint. * *(dict) --* Summary information about a Microsoft Smooth Streaming (MSS) manifest configuration. This provides key details about the MSS manifest without including all configuration parameters. * **ManifestName** *(string) --* The name of the MSS manifest configuration. * **Url** *(string) --* The URL for accessing the MSS manifest. * **ForceEndpointErrorConfiguration** *(dict) --* The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* mediapackagev2 / Paginator / ListChannelGroups ListChannelGroups ***************** class mediapackagev2.Paginator.ListChannelGroups paginator = client.get_paginator('list_channel_groups') paginate(**kwargs) Creates an iterator that will paginate through responses from "mediapackagev2.Client.list_channel_groups()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ChannelGroupName': 'string', 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **CreatedAt** *(datetime) --* The date and time the channel group was created. * **ModifiedAt** *(datetime) --* The date and time the channel group was modified. * **Description** *(string) --* Any descriptive information that you want to add to the channel group for future identification purposes. mediapackagev2 / Paginator / ListChannels ListChannels ************ class mediapackagev2.Paginator.ListChannels paginator = client.get_paginator('list_channels') paginate(**kwargs) Creates an iterator that will paginate through responses from "mediapackagev2.Client.list_channels()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( ChannelGroupName='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* 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. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'ChannelName': 'string', 'ChannelGroupName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'InputType': 'HLS'|'CMAF' }, ], } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the channel. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **CreatedAt** *(datetime) --* The date and time the channel was created. * **ModifiedAt** *(datetime) --* The date and time the channel was modified. * **Description** *(string) --* Any descriptive information that you want to add to the channel for future identification purposes. * **InputType** *(string) --* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). mediapackagev2 / Client / update_origin_endpoint update_origin_endpoint ********************** mediapackagev2.Client.update_origin_endpoint(**kwargs) Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint. Any edits you make that impact the video output may not be reflected for a few minutes. See also: AWS API Documentation **Request Syntax** response = client.update_origin_endpoint( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', ContainerType='TS'|'CMAF'|'ISM', Segment={ 'SegmentDurationSeconds': 123, 'SegmentName': 'string', 'TsUseAudioRenditionGroup': True|False, 'IncludeIframeOnlyStreams': True|False, 'TsIncludeDvbSubtitles': True|False, 'Scte': { 'ScteFilter': [ 'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM', ] }, 'Encryption': { 'ConstantInitializationVector': 'string', 'EncryptionMethod': { 'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES', 'CmafEncryptionMethod': 'CENC'|'CBCS', 'IsmEncryptionMethod': 'CENC' }, 'KeyRotationIntervalSeconds': 123, 'CmafExcludeSegmentDrmMetadata': True|False, 'SpekeKeyProvider': { 'EncryptionContractConfiguration': { 'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED', 'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED' }, 'ResourceId': 'string', 'DrmSystems': [ 'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE'|'IRDETO', ], 'RoleArn': 'string', 'Url': 'string' } } }, Description='string', StartoverWindowSeconds=123, HlsManifests=[ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'UrlEncodeChildManifest': True|False }, ], LowLatencyHlsManifests=[ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'UrlEncodeChildManifest': True|False }, ], DashManifests=[ { 'ManifestName': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'MinUpdatePeriodSeconds': 123, 'MinBufferTimeSeconds': 123, 'SuggestedPresentationDelaySeconds': 123, 'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE', 'PeriodTriggers': [ 'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE', ], 'ScteDash': { 'AdMarkerDash': 'BINARY'|'XML' }, 'DrmSignaling': 'INDIVIDUAL'|'REFERENCED', 'UtcTiming': { 'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT', 'TimingSource': 'string' }, 'Profiles': [ 'DVB_DASH', ], 'BaseUrls': [ { 'Url': 'string', 'ServiceLocation': 'string', 'DvbPriority': 123, 'DvbWeight': 123 }, ], 'ProgramInformation': { 'Title': 'string', 'Source': 'string', 'Copyright': 'string', 'LanguageCode': 'string', 'MoreInformationUrl': 'string' }, 'DvbSettings': { 'FontDownload': { 'Url': 'string', 'MimeType': 'string', 'FontFamily': 'string' }, 'ErrorMetrics': [ { 'ReportingUrl': 'string', 'Probability': 123 }, ] }, 'Compactness': 'STANDARD'|'NONE', 'SubtitleConfiguration': { 'TtmlConfiguration': { 'TtmlProfile': 'IMSC_1'|'EBU_TT_D_101' } } }, ], MssManifests=[ { 'ManifestName': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'ManifestLayout': 'FULL'|'COMPACT' }, ], ForceEndpointErrorConfiguration={ 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] }, ETag='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** (*string*) -- **[REQUIRED]** The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. * **Segment** (*dict*) -- The segment configuration, including the segment name, duration, and other configuration values. * **SegmentDurationSeconds** *(integer) --* The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration. * **SegmentName** *(string) --* The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name. * **TsUseAudioRenditionGroup** *(boolean) --* When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. * **IncludeIframeOnlyStreams** *(boolean) --* When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind. * **TsIncludeDvbSubtitles** *(boolean) --* By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output. * **Scte** *(dict) --* The SCTE configuration options in the segment settings. * **ScteFilter** *(list) --* The SCTE-35 message types that you want to be treated as ad markers in the output. * *(string) --* * **Encryption** *(dict) --* The parameters for encrypting content. * **ConstantInitializationVector** *(string) --* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). * **EncryptionMethod** *(dict) --* **[REQUIRED]** The encryption method to use. * **TsEncryptionMethod** *(string) --* The encryption method to use. * **CmafEncryptionMethod** *(string) --* The encryption method to use. * **IsmEncryptionMethod** *(string) --* The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players. * **KeyRotationIntervalSeconds** *(integer) --* The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated. The following example setting causes the service to rotate keys every thirty minutes: "1800" * **CmafExcludeSegmentDrmMetadata** *(boolean) --* Excludes SEIG and SGPD boxes from segment metadata in CMAF containers. When set to "true", MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes. Important considerations: * This setting only affects CMAF container formats * Key rotation can still be handled through media playlist signaling * PSSH and TENC boxes remain unaffected * Default behavior is preserved when this setting is disabled Valid values: "true" | "false" Default: "false" * **SpekeKeyProvider** *(dict) --* **[REQUIRED]** The parameters for the SPEKE key provider. * **EncryptionContractConfiguration** *(dict) --* **[REQUIRED]** Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use. * **PresetSpeke20Audio** *(string) --* **[REQUIRED]** A collection of audio encryption presets. Value description: * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. * SHARED - Use the same content key for all of the audio and video tracks in your stream. * UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. * **PresetSpeke20Video** *(string) --* **[REQUIRED]** A collection of video encryption presets. Value description: * PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * SHARED - Use the same content key for all of the video and audio tracks in your stream. * UNENCRYPTED - Don't encrypt any of the video tracks in your stream. * **ResourceId** *(string) --* **[REQUIRED]** The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID: "MovieNight20171126093045" * **DrmSystems** *(list) --* **[REQUIRED]** The DRM solution provider you're using to protect your content during distribution. * *(string) --* * **RoleArn** *(string) --* **[REQUIRED]** The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format: "arn:aws:iam::{accountID}:role/{name}". The following example shows a role ARN: "arn:aws:iam::444455556666:role/SpekeAccess" * **Url** *(string) --* **[REQUIRED]** The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://. The following example shows a URL: "https://1wm2dx1f33 .execute-api.us- west-2.amazonaws.com/SpekeSample/copyProtection" * **Description** (*string*) -- Any descriptive information that you want to add to the origin endpoint for future identification purposes. * **StartoverWindowSeconds** (*integer*) -- The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days). * **HlsManifests** (*list*) -- An HTTP live streaming (HLS) manifest configuration. * *(dict) --* Create an HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* **[REQUIRED]** Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **LowLatencyHlsManifests** (*list*) -- A low-latency HLS manifest configuration. * *(dict) --* Create a low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* **[REQUIRED]** Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **DashManifests** (*list*) -- A DASH manifest configuration. * *(dict) --* Create a DASH manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **MinUpdatePeriodSeconds** *(integer) --* Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * **MinBufferTimeSeconds** *(integer) --* Minimum amount of content (in seconds) that a player must keep available in the buffer. * **SuggestedPresentationDelaySeconds** *(integer) --* The amount of time (in seconds) that the player should be from the end of the manifest. * **SegmentTemplateFormat** *(string) --* Determines the type of variable used in the "media" URL of the "SegmentTemplate" tag in the manifest. Also specifies if segment timeline information is included in "SegmentTimeline" or "SegmentTemplate". Value description: * "NUMBER_WITH_TIMELINE" - The "$Number$" variable is used in the "media" URL. The value of this variable is the sequential number of the segment. A full "SegmentTimeline" object is presented in each "SegmentTemplate". * **PeriodTriggers** *(list) --* A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type "ADS" to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi- period DASH in AWS Elemental MediaPackage. * *(string) --* * **ScteDash** *(dict) --* The SCTE configuration. * **AdMarkerDash** *(string) --* Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: * "Binary" - The SCTE-35 marker is expressed as a hex- string (Base64 string) rather than full XML. * "XML" - The SCTE marker is expressed fully in XML. * **DrmSignaling** *(string) --* Determines how the DASH manifest signals the DRM content. * **UtcTiming** *(dict) --* Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). * **TimingMode** *(string) --* The UTC timing mode. * **TimingSource** *(string) --* The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. * **Profiles** *(list) --* The profile that the output is compliant with. * *(string) --* * **BaseUrls** *(list) --* The base URLs to use for retrieving segments. * *(dict) --* The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli- CDN workflows. * **Url** *(string) --* **[REQUIRED]** A source location for segments. * **ServiceLocation** *(string) --* The name of the source location. * **DvbPriority** *(integer) --* For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority. * **DvbWeight** *(integer) --* For use with DVB-DASH profiles only. The weighting for source locations that have the same priority. * **ProgramInformation** *(dict) --* Details about the content that you want MediaPackage to pass through in the manifest to the playback device. * **Title** *(string) --* The title for the manifest. * **Source** *(string) --* Information about the content provider. * **Copyright** *(string) --* A copyright statement about the content. * **LanguageCode** *(string) --* The language code for this manifest. * **MoreInformationUrl** *(string) --* An absolute URL that contains more information about this content. * **DvbSettings** *(dict) --* For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest. * **FontDownload** *(dict) --* Subtitle font settings. * **Url** *(string) --* The URL for downloading fonts for subtitles. * **MimeType** *(string) --* The "mimeType" of the resource that's at the font download URL. For information about font MIME types, see the MPEG- DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document. * **FontFamily** *(string) --* The "fontFamily" name for subtitles, as described in EBU-TT-D Subtitling Distribution Format. * **ErrorMetrics** *(list) --* Playback device error reporting settings. * *(dict) --* For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest. * **ReportingUrl** *(string) --* **[REQUIRED]** The URL where playback devices send error reports. * **Probability** *(integer) --* The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session. * **Compactness** *(string) --* The layout of the DASH manifest that MediaPackage produces. "STANDARD" indicates a default manifest, which is compacted. "NONE" indicates a full manifest. For information about compactness, see DASH manifest compactness in the *Elemental MediaPackage v2 User Guide*. * **SubtitleConfiguration** *(dict) --* The configuration for DASH subtitles. * **TtmlConfiguration** *(dict) --* Settings for TTML subtitles. * **TtmlProfile** *(string) --* **[REQUIRED]** The profile that MediaPackage uses when signaling subtitles in the manifest. "IMSC" is the default profile. "EBU-TT-D" produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU- TT-D Subtitling Distribution Format. * **MssManifests** (*list*) -- A list of Microsoft Smooth Streaming (MSS) manifest configurations to update for the origin endpoint. This replaces the existing MSS manifest configurations. * *(dict) --* Configuration parameters for creating a Microsoft Smooth Streaming (MSS) manifest. MSS is a streaming media format developed by Microsoft that delivers adaptive bitrate streaming content to compatible players and devices. * **ManifestName** *(string) --* **[REQUIRED]** A short string that's appended to the endpoint URL to create a unique path to this MSS manifest. The manifest name must be unique within the origin endpoint and can contain letters, numbers, hyphens, and underscores. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest window. This determines how much content is available in the manifest at any given time. The manifest window slides forward as new segments become available, maintaining a consistent duration of content. The minimum value is 30 seconds. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **ManifestLayout** *(string) --* Determines the layout format of the MSS manifest. This controls how the manifest is structured and presented to client players, affecting compatibility with different MSS-compatible devices and applications. * **ForceEndpointErrorConfiguration** (*dict*) -- The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **ETag** (*string*) -- The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'ContainerType': 'TS'|'CMAF'|'ISM', 'Segment': { 'SegmentDurationSeconds': 123, 'SegmentName': 'string', 'TsUseAudioRenditionGroup': True|False, 'IncludeIframeOnlyStreams': True|False, 'TsIncludeDvbSubtitles': True|False, 'Scte': { 'ScteFilter': [ 'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM', ] }, 'Encryption': { 'ConstantInitializationVector': 'string', 'EncryptionMethod': { 'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES', 'CmafEncryptionMethod': 'CENC'|'CBCS', 'IsmEncryptionMethod': 'CENC' }, 'KeyRotationIntervalSeconds': 123, 'CmafExcludeSegmentDrmMetadata': True|False, 'SpekeKeyProvider': { 'EncryptionContractConfiguration': { 'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED', 'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED' }, 'ResourceId': 'string', 'DrmSystems': [ 'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE'|'IRDETO', ], 'RoleArn': 'string', 'Url': 'string' } } }, 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'StartoverWindowSeconds': 123, 'HlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'MssManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'ManifestWindowSeconds': 123, 'ManifestLayout': 'FULL'|'COMPACT' }, ], 'ForceEndpointErrorConfiguration': { 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] }, 'ETag': 'string', 'Tags': { 'string': 'string' }, 'DashManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'MinUpdatePeriodSeconds': 123, 'MinBufferTimeSeconds': 123, 'SuggestedPresentationDelaySeconds': 123, 'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE', 'PeriodTriggers': [ 'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE', ], 'ScteDash': { 'AdMarkerDash': 'BINARY'|'XML' }, 'DrmSignaling': 'INDIVIDUAL'|'REFERENCED', 'UtcTiming': { 'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT', 'TimingSource': 'string' }, 'Profiles': [ 'DVB_DASH', ], 'BaseUrls': [ { 'Url': 'string', 'ServiceLocation': 'string', 'DvbPriority': 123, 'DvbWeight': 123 }, ], 'ProgramInformation': { 'Title': 'string', 'Source': 'string', 'Copyright': 'string', 'LanguageCode': 'string', 'MoreInformationUrl': 'string' }, 'DvbSettings': { 'FontDownload': { 'Url': 'string', 'MimeType': 'string', 'FontFamily': 'string' }, 'ErrorMetrics': [ { 'ReportingUrl': 'string', 'Probability': 123 }, ] }, 'Compactness': 'STANDARD'|'NONE', 'SubtitleConfiguration': { 'TtmlConfiguration': { 'TtmlProfile': 'IMSC_1'|'EBU_TT_D_101' } } }, ] } **Response Structure** * *(dict) --* * **Arn** *(string) --* The ARN associated with the resource. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** *(string) --* The type of container attached to this origin endpoint. * **Segment** *(dict) --* The segment configuration, including the segment name, duration, and other configuration values. * **SegmentDurationSeconds** *(integer) --* The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration. * **SegmentName** *(string) --* The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name. * **TsUseAudioRenditionGroup** *(boolean) --* When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. * **IncludeIframeOnlyStreams** *(boolean) --* When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind. * **TsIncludeDvbSubtitles** *(boolean) --* By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output. * **Scte** *(dict) --* The SCTE configuration options in the segment settings. * **ScteFilter** *(list) --* The SCTE-35 message types that you want to be treated as ad markers in the output. * *(string) --* * **Encryption** *(dict) --* The parameters for encrypting content. * **ConstantInitializationVector** *(string) --* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). * **EncryptionMethod** *(dict) --* The encryption method to use. * **TsEncryptionMethod** *(string) --* The encryption method to use. * **CmafEncryptionMethod** *(string) --* The encryption method to use. * **IsmEncryptionMethod** *(string) --* The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players. * **KeyRotationIntervalSeconds** *(integer) --* The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated. The following example setting causes the service to rotate keys every thirty minutes: "1800" * **CmafExcludeSegmentDrmMetadata** *(boolean) --* Excludes SEIG and SGPD boxes from segment metadata in CMAF containers. When set to "true", MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes. Important considerations: * This setting only affects CMAF container formats * Key rotation can still be handled through media playlist signaling * PSSH and TENC boxes remain unaffected * Default behavior is preserved when this setting is disabled Valid values: "true" | "false" Default: "false" * **SpekeKeyProvider** *(dict) --* The parameters for the SPEKE key provider. * **EncryptionContractConfiguration** *(dict) --* Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use. * **PresetSpeke20Audio** *(string) --* A collection of audio encryption presets. Value description: * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. * SHARED - Use the same content key for all of the audio and video tracks in your stream. * UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. * **PresetSpeke20Video** *(string) --* A collection of video encryption presets. Value description: * PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * SHARED - Use the same content key for all of the video and audio tracks in your stream. * UNENCRYPTED - Don't encrypt any of the video tracks in your stream. * **ResourceId** *(string) --* The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID: "MovieNight20171126093045" * **DrmSystems** *(list) --* The DRM solution provider you're using to protect your content during distribution. * *(string) --* * **RoleArn** *(string) --* The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format: "arn:aws:iam::{accountID}:role/{name}". The following example shows a role ARN: "arn:aws:iam::444455556666:role/SpekeAccess" * **Url** *(string) --* The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://. The following example shows a URL: "https://1wm2dx1f33 .execute-api.us- west-2.amazonaws.com/SpekeSample/copyProtection" * **CreatedAt** *(datetime) --* The date and time the origin endpoint was created. * **ModifiedAt** *(datetime) --* The date and time the origin endpoint was modified. * **Description** *(string) --* The description of the origin endpoint. * **StartoverWindowSeconds** *(integer) --* The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. * **HlsManifests** *(list) --* An HTTP live streaming (HLS) manifest configuration. * *(dict) --* Retrieve the HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **LowLatencyHlsManifests** *(list) --* A low-latency HLS manifest configuration. * *(dict) --* Retrieve the low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **MssManifests** *(list) --* The updated Microsoft Smooth Streaming (MSS) manifest configurations for this origin endpoint. * *(dict) --* Configuration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered. * **ManifestName** *(string) --* The name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest. * **Url** *(string) --* The complete URL for accessing the MSS manifest. Client players use this URL to retrieve the manifest and begin streaming the Microsoft Smooth Streaming content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **ManifestWindowSeconds** *(integer) --* The duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time. * **ManifestLayout** *(string) --* The layout format of the MSS manifest, which determines how the manifest is structured for client compatibility. * **ForceEndpointErrorConfiguration** *(dict) --* The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the origin endpoint. * *(string) --* * *(string) --* * **DashManifests** *(list) --* A DASH manifest configuration. * *(dict) --* Retrieve the DASH manifest configuration. * **ManifestName** *(string) --* A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **MinUpdatePeriodSeconds** *(integer) --* Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * **MinBufferTimeSeconds** *(integer) --* Minimum amount of content (in seconds) that a player must keep available in the buffer. * **SuggestedPresentationDelaySeconds** *(integer) --* The amount of time (in seconds) that the player should be from the end of the manifest. * **SegmentTemplateFormat** *(string) --* Determines the type of variable used in the "media" URL of the "SegmentTemplate" tag in the manifest. Also specifies if segment timeline information is included in "SegmentTimeline" or "SegmentTemplate". Value description: * "NUMBER_WITH_TIMELINE" - The "$Number$" variable is used in the "media" URL. The value of this variable is the sequential number of the segment. A full "SegmentTimeline" object is presented in each "SegmentTemplate". * **PeriodTriggers** *(list) --* A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage. * *(string) --* * **ScteDash** *(dict) --* The SCTE configuration. * **AdMarkerDash** *(string) --* Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: * "Binary" - The SCTE-35 marker is expressed as a hex- string (Base64 string) rather than full XML. * "XML" - The SCTE marker is expressed fully in XML. * **DrmSignaling** *(string) --* Determines how the DASH manifest signals the DRM content. * **UtcTiming** *(dict) --* Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). * **TimingMode** *(string) --* The UTC timing mode. * **TimingSource** *(string) --* The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. * **Profiles** *(list) --* The profile that the output is compliant with. * *(string) --* * **BaseUrls** *(list) --* The base URL to use for retrieving segments. * *(dict) --* The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows. * **Url** *(string) --* A source location for segments. * **ServiceLocation** *(string) --* The name of the source location. * **DvbPriority** *(integer) --* For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority. * **DvbWeight** *(integer) --* For use with DVB-DASH profiles only. The weighting for source locations that have the same priority. * **ProgramInformation** *(dict) --* Details about the content that you want MediaPackage to pass through in the manifest to the playback device. * **Title** *(string) --* The title for the manifest. * **Source** *(string) --* Information about the content provider. * **Copyright** *(string) --* A copyright statement about the content. * **LanguageCode** *(string) --* The language code for this manifest. * **MoreInformationUrl** *(string) --* An absolute URL that contains more information about this content. * **DvbSettings** *(dict) --* For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest. * **FontDownload** *(dict) --* Subtitle font settings. * **Url** *(string) --* The URL for downloading fonts for subtitles. * **MimeType** *(string) --* The "mimeType" of the resource that's at the font download URL. For information about font MIME types, see the MPEG- DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document. * **FontFamily** *(string) --* The "fontFamily" name for subtitles, as described in EBU-TT-D Subtitling Distribution Format. * **ErrorMetrics** *(list) --* Playback device error reporting settings. * *(dict) --* For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest. * **ReportingUrl** *(string) --* The URL where playback devices send error reports. * **Probability** *(integer) --* The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session. * **Compactness** *(string) --* The layout of the DASH manifest that MediaPackage produces. "STANDARD" indicates a default manifest, which is compacted. "NONE" indicates a full manifest. * **SubtitleConfiguration** *(dict) --* The configuration for DASH subtitles. * **TtmlConfiguration** *(dict) --* Settings for TTML subtitles. * **TtmlProfile** *(string) --* The profile that MediaPackage uses when signaling subtitles in the manifest. "IMSC" is the default profile. "EBU-TT-D" produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" * "mediapackagev2.Client.exceptions.ServiceQuotaExceededException" mediapackagev2 / Client / get_paginator get_paginator ************* mediapackagev2.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. mediapackagev2 / Client / update_channel_group update_channel_group ******************** mediapackagev2.Client.update_channel_group(**kwargs) Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group. Any edits you make that impact the video output may not be reflected for a few minutes. See also: AWS API Documentation **Request Syntax** response = client.update_channel_group( ChannelGroupName='string', ETag='string', Description='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ETag** (*string*) -- The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected. * **Description** (*string*) -- Any descriptive information that you want to add to the channel group for future identification purposes. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'Arn': 'string', 'EgressDomain': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **EgressDomain** *(string) --* The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device. * **CreatedAt** *(datetime) --* The date and time the channel group was created. * **ModifiedAt** *(datetime) --* The date and time the channel group was modified. * **Description** *(string) --* The description for your channel group. * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel group. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / delete_channel_policy delete_channel_policy ********************* mediapackagev2.Client.delete_channel_policy(**kwargs) Delete a channel policy. See also: AWS API Documentation **Request Syntax** response = client.delete_channel_policy( ChannelGroupName='string', ChannelName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / put_origin_endpoint_policy put_origin_endpoint_policy ************************** mediapackagev2.Client.put_origin_endpoint_policy(**kwargs) Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request. See also: AWS API Documentation **Request Syntax** response = client.put_origin_endpoint_policy( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', Policy='string', CdnAuthConfiguration={ 'CdnIdentifierSecretArns': [ 'string', ], 'SecretsRoleArn': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **Policy** (*string*) -- **[REQUIRED]** The policy to attach to the specified origin endpoint. * **CdnAuthConfiguration** (*dict*) -- The settings for using authorization headers between the MediaPackage endpoint and your CDN. For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide. * **CdnIdentifierSecretArns** *(list) --* **[REQUIRED]** The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint. * *(string) --* * **SecretsRoleArn** *(string) --* **[REQUIRED]** The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and KMS for CDN authorization. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / list_channels list_channels ************* mediapackagev2.Client.list_channels(**kwargs) Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.list_channels( ChannelGroupName='string', MaxResults=123, NextToken='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. * **NextToken** (*string*) -- The pagination token from the GET list request. Use the token to fetch the next page of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'ChannelName': 'string', 'ChannelGroupName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'InputType': 'HLS'|'CMAF' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the channel. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **CreatedAt** *(datetime) --* The date and time the channel was created. * **ModifiedAt** *(datetime) --* The date and time the channel was modified. * **Description** *(string) --* Any descriptive information that you want to add to the channel for future identification purposes. * **InputType** *(string) --* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). * **NextToken** *(string) --* The pagination token from the GET list request. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / can_paginate can_paginate ************ mediapackagev2.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "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")". Returns: "True" if the operation can be paginated, "False" otherwise. mediapackagev2 / Client / delete_channel_group delete_channel_group ******************** mediapackagev2.Client.delete_channel_group(**kwargs) Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it. See also: AWS API Documentation **Request Syntax** response = client.delete_channel_group( ChannelGroupName='string' ) Parameters: **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / put_channel_policy put_channel_policy ****************** mediapackagev2.Client.put_channel_policy(**kwargs) Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request. See also: AWS API Documentation **Request Syntax** response = client.put_channel_policy( ChannelGroupName='string', ChannelName='string', Policy='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **Policy** (*string*) -- **[REQUIRED]** The policy to attach to the specified channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / get_origin_endpoint get_origin_endpoint ******************* mediapackagev2.Client.get_origin_endpoint(**kwargs) Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using. See also: AWS API Documentation **Request Syntax** response = client.get_origin_endpoint( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'ContainerType': 'TS'|'CMAF'|'ISM', 'Segment': { 'SegmentDurationSeconds': 123, 'SegmentName': 'string', 'TsUseAudioRenditionGroup': True|False, 'IncludeIframeOnlyStreams': True|False, 'TsIncludeDvbSubtitles': True|False, 'Scte': { 'ScteFilter': [ 'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM', ] }, 'Encryption': { 'ConstantInitializationVector': 'string', 'EncryptionMethod': { 'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES', 'CmafEncryptionMethod': 'CENC'|'CBCS', 'IsmEncryptionMethod': 'CENC' }, 'KeyRotationIntervalSeconds': 123, 'CmafExcludeSegmentDrmMetadata': True|False, 'SpekeKeyProvider': { 'EncryptionContractConfiguration': { 'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED', 'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED' }, 'ResourceId': 'string', 'DrmSystems': [ 'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE'|'IRDETO', ], 'RoleArn': 'string', 'Url': 'string' } } }, 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'ResetAt': datetime(2015, 1, 1), 'Description': 'string', 'StartoverWindowSeconds': 123, 'HlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'DashManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'MinUpdatePeriodSeconds': 123, 'MinBufferTimeSeconds': 123, 'SuggestedPresentationDelaySeconds': 123, 'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE', 'PeriodTriggers': [ 'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE', ], 'ScteDash': { 'AdMarkerDash': 'BINARY'|'XML' }, 'DrmSignaling': 'INDIVIDUAL'|'REFERENCED', 'UtcTiming': { 'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT', 'TimingSource': 'string' }, 'Profiles': [ 'DVB_DASH', ], 'BaseUrls': [ { 'Url': 'string', 'ServiceLocation': 'string', 'DvbPriority': 123, 'DvbWeight': 123 }, ], 'ProgramInformation': { 'Title': 'string', 'Source': 'string', 'Copyright': 'string', 'LanguageCode': 'string', 'MoreInformationUrl': 'string' }, 'DvbSettings': { 'FontDownload': { 'Url': 'string', 'MimeType': 'string', 'FontFamily': 'string' }, 'ErrorMetrics': [ { 'ReportingUrl': 'string', 'Probability': 123 }, ] }, 'Compactness': 'STANDARD'|'NONE', 'SubtitleConfiguration': { 'TtmlConfiguration': { 'TtmlProfile': 'IMSC_1'|'EBU_TT_D_101' } } }, ], 'MssManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'ManifestWindowSeconds': 123, 'ManifestLayout': 'FULL'|'COMPACT' }, ], 'ForceEndpointErrorConfiguration': { 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] }, 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** *(string) --* The type of container attached to this origin endpoint. * **Segment** *(dict) --* The segment configuration, including the segment name, duration, and other configuration values. * **SegmentDurationSeconds** *(integer) --* The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration. * **SegmentName** *(string) --* The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name. * **TsUseAudioRenditionGroup** *(boolean) --* When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. * **IncludeIframeOnlyStreams** *(boolean) --* When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind. * **TsIncludeDvbSubtitles** *(boolean) --* By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output. * **Scte** *(dict) --* The SCTE configuration options in the segment settings. * **ScteFilter** *(list) --* The SCTE-35 message types that you want to be treated as ad markers in the output. * *(string) --* * **Encryption** *(dict) --* The parameters for encrypting content. * **ConstantInitializationVector** *(string) --* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). * **EncryptionMethod** *(dict) --* The encryption method to use. * **TsEncryptionMethod** *(string) --* The encryption method to use. * **CmafEncryptionMethod** *(string) --* The encryption method to use. * **IsmEncryptionMethod** *(string) --* The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players. * **KeyRotationIntervalSeconds** *(integer) --* The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated. The following example setting causes the service to rotate keys every thirty minutes: "1800" * **CmafExcludeSegmentDrmMetadata** *(boolean) --* Excludes SEIG and SGPD boxes from segment metadata in CMAF containers. When set to "true", MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes. Important considerations: * This setting only affects CMAF container formats * Key rotation can still be handled through media playlist signaling * PSSH and TENC boxes remain unaffected * Default behavior is preserved when this setting is disabled Valid values: "true" | "false" Default: "false" * **SpekeKeyProvider** *(dict) --* The parameters for the SPEKE key provider. * **EncryptionContractConfiguration** *(dict) --* Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use. * **PresetSpeke20Audio** *(string) --* A collection of audio encryption presets. Value description: * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. * SHARED - Use the same content key for all of the audio and video tracks in your stream. * UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. * **PresetSpeke20Video** *(string) --* A collection of video encryption presets. Value description: * PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * SHARED - Use the same content key for all of the video and audio tracks in your stream. * UNENCRYPTED - Don't encrypt any of the video tracks in your stream. * **ResourceId** *(string) --* The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID: "MovieNight20171126093045" * **DrmSystems** *(list) --* The DRM solution provider you're using to protect your content during distribution. * *(string) --* * **RoleArn** *(string) --* The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format: "arn:aws:iam::{accountID}:role/{name}". The following example shows a role ARN: "arn:aws:iam::444455556666:role/SpekeAccess" * **Url** *(string) --* The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://. The following example shows a URL: "https://1wm2dx1f33 .execute-api.us- west-2.amazonaws.com/SpekeSample/copyProtection" * **CreatedAt** *(datetime) --* The date and time the origin endpoint was created. * **ModifiedAt** *(datetime) --* The date and time the origin endpoint was modified. * **ResetAt** *(datetime) --* The time that the origin endpoint was last reset. * **Description** *(string) --* The description for your origin endpoint. * **StartoverWindowSeconds** *(integer) --* The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. * **HlsManifests** *(list) --* An HTTP live streaming (HLS) manifest configuration. * *(dict) --* Retrieve the HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **LowLatencyHlsManifests** *(list) --* A low-latency HLS manifest configuration. * *(dict) --* Retrieve the low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **DashManifests** *(list) --* A DASH manifest configuration. * *(dict) --* Retrieve the DASH manifest configuration. * **ManifestName** *(string) --* A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **MinUpdatePeriodSeconds** *(integer) --* Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * **MinBufferTimeSeconds** *(integer) --* Minimum amount of content (in seconds) that a player must keep available in the buffer. * **SuggestedPresentationDelaySeconds** *(integer) --* The amount of time (in seconds) that the player should be from the end of the manifest. * **SegmentTemplateFormat** *(string) --* Determines the type of variable used in the "media" URL of the "SegmentTemplate" tag in the manifest. Also specifies if segment timeline information is included in "SegmentTimeline" or "SegmentTemplate". Value description: * "NUMBER_WITH_TIMELINE" - The "$Number$" variable is used in the "media" URL. The value of this variable is the sequential number of the segment. A full "SegmentTimeline" object is presented in each "SegmentTemplate". * **PeriodTriggers** *(list) --* A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage. * *(string) --* * **ScteDash** *(dict) --* The SCTE configuration. * **AdMarkerDash** *(string) --* Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: * "Binary" - The SCTE-35 marker is expressed as a hex- string (Base64 string) rather than full XML. * "XML" - The SCTE marker is expressed fully in XML. * **DrmSignaling** *(string) --* Determines how the DASH manifest signals the DRM content. * **UtcTiming** *(dict) --* Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). * **TimingMode** *(string) --* The UTC timing mode. * **TimingSource** *(string) --* The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. * **Profiles** *(list) --* The profile that the output is compliant with. * *(string) --* * **BaseUrls** *(list) --* The base URL to use for retrieving segments. * *(dict) --* The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows. * **Url** *(string) --* A source location for segments. * **ServiceLocation** *(string) --* The name of the source location. * **DvbPriority** *(integer) --* For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority. * **DvbWeight** *(integer) --* For use with DVB-DASH profiles only. The weighting for source locations that have the same priority. * **ProgramInformation** *(dict) --* Details about the content that you want MediaPackage to pass through in the manifest to the playback device. * **Title** *(string) --* The title for the manifest. * **Source** *(string) --* Information about the content provider. * **Copyright** *(string) --* A copyright statement about the content. * **LanguageCode** *(string) --* The language code for this manifest. * **MoreInformationUrl** *(string) --* An absolute URL that contains more information about this content. * **DvbSettings** *(dict) --* For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest. * **FontDownload** *(dict) --* Subtitle font settings. * **Url** *(string) --* The URL for downloading fonts for subtitles. * **MimeType** *(string) --* The "mimeType" of the resource that's at the font download URL. For information about font MIME types, see the MPEG- DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document. * **FontFamily** *(string) --* The "fontFamily" name for subtitles, as described in EBU-TT-D Subtitling Distribution Format. * **ErrorMetrics** *(list) --* Playback device error reporting settings. * *(dict) --* For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest. * **ReportingUrl** *(string) --* The URL where playback devices send error reports. * **Probability** *(integer) --* The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session. * **Compactness** *(string) --* The layout of the DASH manifest that MediaPackage produces. "STANDARD" indicates a default manifest, which is compacted. "NONE" indicates a full manifest. * **SubtitleConfiguration** *(dict) --* The configuration for DASH subtitles. * **TtmlConfiguration** *(dict) --* Settings for TTML subtitles. * **TtmlProfile** *(string) --* The profile that MediaPackage uses when signaling subtitles in the manifest. "IMSC" is the default profile. "EBU-TT-D" produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format. * **MssManifests** *(list) --* The Microsoft Smooth Streaming (MSS) manifest configurations associated with this origin endpoint. * *(dict) --* Configuration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered. * **ManifestName** *(string) --* The name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest. * **Url** *(string) --* The complete URL for accessing the MSS manifest. Client players use this URL to retrieve the manifest and begin streaming the Microsoft Smooth Streaming content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **ManifestWindowSeconds** *(integer) --* The duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time. * **ManifestLayout** *(string) --* The layout format of the MSS manifest, which determines how the manifest is structured for client compatibility. * **ForceEndpointErrorConfiguration** *(dict) --* The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the origin endpoint. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / create_origin_endpoint create_origin_endpoint ********************** mediapackagev2.Client.create_origin_endpoint(**kwargs) The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request. See also: AWS API Documentation **Request Syntax** response = client.create_origin_endpoint( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', ContainerType='TS'|'CMAF'|'ISM', Segment={ 'SegmentDurationSeconds': 123, 'SegmentName': 'string', 'TsUseAudioRenditionGroup': True|False, 'IncludeIframeOnlyStreams': True|False, 'TsIncludeDvbSubtitles': True|False, 'Scte': { 'ScteFilter': [ 'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM', ] }, 'Encryption': { 'ConstantInitializationVector': 'string', 'EncryptionMethod': { 'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES', 'CmafEncryptionMethod': 'CENC'|'CBCS', 'IsmEncryptionMethod': 'CENC' }, 'KeyRotationIntervalSeconds': 123, 'CmafExcludeSegmentDrmMetadata': True|False, 'SpekeKeyProvider': { 'EncryptionContractConfiguration': { 'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED', 'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED' }, 'ResourceId': 'string', 'DrmSystems': [ 'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE'|'IRDETO', ], 'RoleArn': 'string', 'Url': 'string' } } }, ClientToken='string', Description='string', StartoverWindowSeconds=123, HlsManifests=[ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'UrlEncodeChildManifest': True|False }, ], LowLatencyHlsManifests=[ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'UrlEncodeChildManifest': True|False }, ], DashManifests=[ { 'ManifestName': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'MinUpdatePeriodSeconds': 123, 'MinBufferTimeSeconds': 123, 'SuggestedPresentationDelaySeconds': 123, 'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE', 'PeriodTriggers': [ 'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE', ], 'ScteDash': { 'AdMarkerDash': 'BINARY'|'XML' }, 'DrmSignaling': 'INDIVIDUAL'|'REFERENCED', 'UtcTiming': { 'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT', 'TimingSource': 'string' }, 'Profiles': [ 'DVB_DASH', ], 'BaseUrls': [ { 'Url': 'string', 'ServiceLocation': 'string', 'DvbPriority': 123, 'DvbWeight': 123 }, ], 'ProgramInformation': { 'Title': 'string', 'Source': 'string', 'Copyright': 'string', 'LanguageCode': 'string', 'MoreInformationUrl': 'string' }, 'DvbSettings': { 'FontDownload': { 'Url': 'string', 'MimeType': 'string', 'FontFamily': 'string' }, 'ErrorMetrics': [ { 'ReportingUrl': 'string', 'Probability': 123 }, ] }, 'Compactness': 'STANDARD'|'NONE', 'SubtitleConfiguration': { 'TtmlConfiguration': { 'TtmlProfile': 'IMSC_1'|'EBU_TT_D_101' } } }, ], MssManifests=[ { 'ManifestName': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'ManifestLayout': 'FULL'|'COMPACT' }, ], ForceEndpointErrorConfiguration={ 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] }, Tags={ 'string': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint. * **ContainerType** (*string*) -- **[REQUIRED]** The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint. * **Segment** (*dict*) -- The segment configuration, including the segment name, duration, and other configuration values. * **SegmentDurationSeconds** *(integer) --* The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration. * **SegmentName** *(string) --* The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name. * **TsUseAudioRenditionGroup** *(boolean) --* When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. * **IncludeIframeOnlyStreams** *(boolean) --* When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind. * **TsIncludeDvbSubtitles** *(boolean) --* By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output. * **Scte** *(dict) --* The SCTE configuration options in the segment settings. * **ScteFilter** *(list) --* The SCTE-35 message types that you want to be treated as ad markers in the output. * *(string) --* * **Encryption** *(dict) --* The parameters for encrypting content. * **ConstantInitializationVector** *(string) --* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). * **EncryptionMethod** *(dict) --* **[REQUIRED]** The encryption method to use. * **TsEncryptionMethod** *(string) --* The encryption method to use. * **CmafEncryptionMethod** *(string) --* The encryption method to use. * **IsmEncryptionMethod** *(string) --* The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players. * **KeyRotationIntervalSeconds** *(integer) --* The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated. The following example setting causes the service to rotate keys every thirty minutes: "1800" * **CmafExcludeSegmentDrmMetadata** *(boolean) --* Excludes SEIG and SGPD boxes from segment metadata in CMAF containers. When set to "true", MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes. Important considerations: * This setting only affects CMAF container formats * Key rotation can still be handled through media playlist signaling * PSSH and TENC boxes remain unaffected * Default behavior is preserved when this setting is disabled Valid values: "true" | "false" Default: "false" * **SpekeKeyProvider** *(dict) --* **[REQUIRED]** The parameters for the SPEKE key provider. * **EncryptionContractConfiguration** *(dict) --* **[REQUIRED]** Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use. * **PresetSpeke20Audio** *(string) --* **[REQUIRED]** A collection of audio encryption presets. Value description: * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. * SHARED - Use the same content key for all of the audio and video tracks in your stream. * UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. * **PresetSpeke20Video** *(string) --* **[REQUIRED]** A collection of video encryption presets. Value description: * PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * SHARED - Use the same content key for all of the video and audio tracks in your stream. * UNENCRYPTED - Don't encrypt any of the video tracks in your stream. * **ResourceId** *(string) --* **[REQUIRED]** The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID: "MovieNight20171126093045" * **DrmSystems** *(list) --* **[REQUIRED]** The DRM solution provider you're using to protect your content during distribution. * *(string) --* * **RoleArn** *(string) --* **[REQUIRED]** The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format: "arn:aws:iam::{accountID}:role/{name}". The following example shows a role ARN: "arn:aws:iam::444455556666:role/SpekeAccess" * **Url** *(string) --* **[REQUIRED]** The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://. The following example shows a URL: "https://1wm2dx1f33 .execute-api.us- west-2.amazonaws.com/SpekeSample/copyProtection" * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **Description** (*string*) -- Enter any descriptive text that helps you to identify the origin endpoint. * **StartoverWindowSeconds** (*integer*) -- The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days). * **HlsManifests** (*list*) -- An HTTP live streaming (HLS) manifest configuration. * *(dict) --* Create an HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* **[REQUIRED]** Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **LowLatencyHlsManifests** (*list*) -- A low-latency HLS manifest configuration. * *(dict) --* Create a low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* **[REQUIRED]** Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **DashManifests** (*list*) -- A DASH manifest configuration. * *(dict) --* Create a DASH manifest configuration. * **ManifestName** *(string) --* **[REQUIRED]** A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **MinUpdatePeriodSeconds** *(integer) --* Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * **MinBufferTimeSeconds** *(integer) --* Minimum amount of content (in seconds) that a player must keep available in the buffer. * **SuggestedPresentationDelaySeconds** *(integer) --* The amount of time (in seconds) that the player should be from the end of the manifest. * **SegmentTemplateFormat** *(string) --* Determines the type of variable used in the "media" URL of the "SegmentTemplate" tag in the manifest. Also specifies if segment timeline information is included in "SegmentTimeline" or "SegmentTemplate". Value description: * "NUMBER_WITH_TIMELINE" - The "$Number$" variable is used in the "media" URL. The value of this variable is the sequential number of the segment. A full "SegmentTimeline" object is presented in each "SegmentTemplate". * **PeriodTriggers** *(list) --* A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type "ADS" to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi- period DASH in AWS Elemental MediaPackage. * *(string) --* * **ScteDash** *(dict) --* The SCTE configuration. * **AdMarkerDash** *(string) --* Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: * "Binary" - The SCTE-35 marker is expressed as a hex- string (Base64 string) rather than full XML. * "XML" - The SCTE marker is expressed fully in XML. * **DrmSignaling** *(string) --* Determines how the DASH manifest signals the DRM content. * **UtcTiming** *(dict) --* Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). * **TimingMode** *(string) --* The UTC timing mode. * **TimingSource** *(string) --* The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. * **Profiles** *(list) --* The profile that the output is compliant with. * *(string) --* * **BaseUrls** *(list) --* The base URLs to use for retrieving segments. * *(dict) --* The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli- CDN workflows. * **Url** *(string) --* **[REQUIRED]** A source location for segments. * **ServiceLocation** *(string) --* The name of the source location. * **DvbPriority** *(integer) --* For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority. * **DvbWeight** *(integer) --* For use with DVB-DASH profiles only. The weighting for source locations that have the same priority. * **ProgramInformation** *(dict) --* Details about the content that you want MediaPackage to pass through in the manifest to the playback device. * **Title** *(string) --* The title for the manifest. * **Source** *(string) --* Information about the content provider. * **Copyright** *(string) --* A copyright statement about the content. * **LanguageCode** *(string) --* The language code for this manifest. * **MoreInformationUrl** *(string) --* An absolute URL that contains more information about this content. * **DvbSettings** *(dict) --* For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest. * **FontDownload** *(dict) --* Subtitle font settings. * **Url** *(string) --* The URL for downloading fonts for subtitles. * **MimeType** *(string) --* The "mimeType" of the resource that's at the font download URL. For information about font MIME types, see the MPEG- DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document. * **FontFamily** *(string) --* The "fontFamily" name for subtitles, as described in EBU-TT-D Subtitling Distribution Format. * **ErrorMetrics** *(list) --* Playback device error reporting settings. * *(dict) --* For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest. * **ReportingUrl** *(string) --* **[REQUIRED]** The URL where playback devices send error reports. * **Probability** *(integer) --* The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session. * **Compactness** *(string) --* The layout of the DASH manifest that MediaPackage produces. "STANDARD" indicates a default manifest, which is compacted. "NONE" indicates a full manifest. For information about compactness, see DASH manifest compactness in the *Elemental MediaPackage v2 User Guide*. * **SubtitleConfiguration** *(dict) --* The configuration for DASH subtitles. * **TtmlConfiguration** *(dict) --* Settings for TTML subtitles. * **TtmlProfile** *(string) --* **[REQUIRED]** The profile that MediaPackage uses when signaling subtitles in the manifest. "IMSC" is the default profile. "EBU-TT-D" produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU- TT-D Subtitling Distribution Format. * **MssManifests** (*list*) -- A list of Microsoft Smooth Streaming (MSS) manifest configurations for the origin endpoint. You can configure multiple MSS manifests to provide different streaming experiences or to support different client requirements. * *(dict) --* Configuration parameters for creating a Microsoft Smooth Streaming (MSS) manifest. MSS is a streaming media format developed by Microsoft that delivers adaptive bitrate streaming content to compatible players and devices. * **ManifestName** *(string) --* **[REQUIRED]** A short string that's appended to the endpoint URL to create a unique path to this MSS manifest. The manifest name must be unique within the origin endpoint and can contain letters, numbers, hyphens, and underscores. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest window. This determines how much content is available in the manifest at any given time. The manifest window slides forward as new segments become available, maintaining a consistent duration of content. The minimum value is 30 seconds. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **ManifestLayout** *(string) --* Determines the layout format of the MSS manifest. This controls how the manifest is structured and presented to client players, affecting compatibility with different MSS-compatible devices and applications. * **ForceEndpointErrorConfiguration** (*dict*) -- The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **Tags** (*dict*) -- A comma-separated list of tag key:value pairs that you define. For example: ""Key1": "Value1"," ""Key2": "Value2"" * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'ContainerType': 'TS'|'CMAF'|'ISM', 'Segment': { 'SegmentDurationSeconds': 123, 'SegmentName': 'string', 'TsUseAudioRenditionGroup': True|False, 'IncludeIframeOnlyStreams': True|False, 'TsIncludeDvbSubtitles': True|False, 'Scte': { 'ScteFilter': [ 'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY'|'PROGRAM', ] }, 'Encryption': { 'ConstantInitializationVector': 'string', 'EncryptionMethod': { 'TsEncryptionMethod': 'AES_128'|'SAMPLE_AES', 'CmafEncryptionMethod': 'CENC'|'CBCS', 'IsmEncryptionMethod': 'CENC' }, 'KeyRotationIntervalSeconds': 123, 'CmafExcludeSegmentDrmMetadata': True|False, 'SpekeKeyProvider': { 'EncryptionContractConfiguration': { 'PresetSpeke20Audio': 'PRESET_AUDIO_1'|'PRESET_AUDIO_2'|'PRESET_AUDIO_3'|'SHARED'|'UNENCRYPTED', 'PresetSpeke20Video': 'PRESET_VIDEO_1'|'PRESET_VIDEO_2'|'PRESET_VIDEO_3'|'PRESET_VIDEO_4'|'PRESET_VIDEO_5'|'PRESET_VIDEO_6'|'PRESET_VIDEO_7'|'PRESET_VIDEO_8'|'SHARED'|'UNENCRYPTED' }, 'ResourceId': 'string', 'DrmSystems': [ 'CLEAR_KEY_AES_128'|'FAIRPLAY'|'PLAYREADY'|'WIDEVINE'|'IRDETO', ], 'RoleArn': 'string', 'Url': 'string' } } }, 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'StartoverWindowSeconds': 123, 'HlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ChildManifestName': 'string', 'ManifestWindowSeconds': 123, 'ProgramDateTimeIntervalSeconds': 123, 'ScteHls': { 'AdMarkerHls': 'DATERANGE' }, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'StartTag': { 'TimeOffset': ..., 'Precise': True|False }, 'UrlEncodeChildManifest': True|False }, ], 'DashManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'ManifestWindowSeconds': 123, 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'MinUpdatePeriodSeconds': 123, 'MinBufferTimeSeconds': 123, 'SuggestedPresentationDelaySeconds': 123, 'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE', 'PeriodTriggers': [ 'AVAILS'|'DRM_KEY_ROTATION'|'SOURCE_CHANGES'|'SOURCE_DISRUPTIONS'|'NONE', ], 'ScteDash': { 'AdMarkerDash': 'BINARY'|'XML' }, 'DrmSignaling': 'INDIVIDUAL'|'REFERENCED', 'UtcTiming': { 'TimingMode': 'HTTP_HEAD'|'HTTP_ISO'|'HTTP_XSDATE'|'UTC_DIRECT', 'TimingSource': 'string' }, 'Profiles': [ 'DVB_DASH', ], 'BaseUrls': [ { 'Url': 'string', 'ServiceLocation': 'string', 'DvbPriority': 123, 'DvbWeight': 123 }, ], 'ProgramInformation': { 'Title': 'string', 'Source': 'string', 'Copyright': 'string', 'LanguageCode': 'string', 'MoreInformationUrl': 'string' }, 'DvbSettings': { 'FontDownload': { 'Url': 'string', 'MimeType': 'string', 'FontFamily': 'string' }, 'ErrorMetrics': [ { 'ReportingUrl': 'string', 'Probability': 123 }, ] }, 'Compactness': 'STANDARD'|'NONE', 'SubtitleConfiguration': { 'TtmlConfiguration': { 'TtmlProfile': 'IMSC_1'|'EBU_TT_D_101' } } }, ], 'MssManifests': [ { 'ManifestName': 'string', 'Url': 'string', 'FilterConfiguration': { 'ManifestFilter': 'string', 'Start': datetime(2015, 1, 1), 'End': datetime(2015, 1, 1), 'TimeDelaySeconds': 123, 'ClipStartTime': datetime(2015, 1, 1) }, 'ManifestWindowSeconds': 123, 'ManifestLayout': 'FULL'|'COMPACT' }, ], 'ForceEndpointErrorConfiguration': { 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] }, 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** *(string) --* The type of container attached to this origin endpoint. * **Segment** *(dict) --* The segment configuration, including the segment name, duration, and other configuration values. * **SegmentDurationSeconds** *(integer) --* The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration. * **SegmentName** *(string) --* The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name. * **TsUseAudioRenditionGroup** *(boolean) --* When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. * **IncludeIframeOnlyStreams** *(boolean) --* When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind. * **TsIncludeDvbSubtitles** *(boolean) --* By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output. * **Scte** *(dict) --* The SCTE configuration options in the segment settings. * **ScteFilter** *(list) --* The SCTE-35 message types that you want to be treated as ad markers in the output. * *(string) --* * **Encryption** *(dict) --* The parameters for encrypting content. * **ConstantInitializationVector** *(string) --* A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). * **EncryptionMethod** *(dict) --* The encryption method to use. * **TsEncryptionMethod** *(string) --* The encryption method to use. * **CmafEncryptionMethod** *(string) --* The encryption method to use. * **IsmEncryptionMethod** *(string) --* The encryption method used for Microsoft Smooth Streaming (MSS) content. This specifies how the MSS segments are encrypted to protect the content during delivery to client players. * **KeyRotationIntervalSeconds** *(integer) --* The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated. The following example setting causes the service to rotate keys every thirty minutes: "1800" * **CmafExcludeSegmentDrmMetadata** *(boolean) --* Excludes SEIG and SGPD boxes from segment metadata in CMAF containers. When set to "true", MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes. Important considerations: * This setting only affects CMAF container formats * Key rotation can still be handled through media playlist signaling * PSSH and TENC boxes remain unaffected * Default behavior is preserved when this setting is disabled Valid values: "true" | "false" Default: "false" * **SpekeKeyProvider** *(dict) --* The parameters for the SPEKE key provider. * **EncryptionContractConfiguration** *(dict) --* Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use. * **PresetSpeke20Audio** *(string) --* A collection of audio encryption presets. Value description: * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream. * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks. * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels. * SHARED - Use the same content key for all of the audio and video tracks in your stream. * UNENCRYPTED - Don't encrypt any of the audio tracks in your stream. * **PresetSpeke20Video** *(string) --* A collection of video encryption presets. Value description: * PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream. * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks. * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks. * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks. * SHARED - Use the same content key for all of the video and audio tracks in your stream. * UNENCRYPTED - Don't encrypt any of the video tracks in your stream. * **ResourceId** *(string) --* The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID. The following example shows a resource ID: "MovieNight20171126093045" * **DrmSystems** *(list) --* The DRM solution provider you're using to protect your content during distribution. * *(string) --* * **RoleArn** *(string) --* The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider. Valid format: "arn:aws:iam::{accountID}:role/{name}". The following example shows a role ARN: "arn:aws:iam::444455556666:role/SpekeAccess" * **Url** *(string) --* The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://. The following example shows a URL: "https://1wm2dx1f33 .execute-api.us- west-2.amazonaws.com/SpekeSample/copyProtection" * **CreatedAt** *(datetime) --* The date and time the origin endpoint was created. * **ModifiedAt** *(datetime) --* The date and time the origin endpoint was modified. * **Description** *(string) --* The description for your origin endpoint. * **StartoverWindowSeconds** *(integer) --* The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. * **HlsManifests** *(list) --* An HTTP live streaming (HLS) manifest configuration. * *(dict) --* Retrieve the HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **LowLatencyHlsManifests** *(list) --* A low-latency HLS manifest configuration. * *(dict) --* Retrieve the low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **ProgramDateTimeIntervalSeconds** *(integer) --* Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output. * **ScteHls** *(dict) --* The SCTE configuration. * **AdMarkerHls** *(string) --* Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers. Value description: * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **StartTag** *(dict) --* To insert an EXT-X-START tag in your HLS playlist, specify a StartTag configuration object with a valid TimeOffset. When you do, you can also optionally specify whether to include a PRECISE value in the EXT-X-START tag. * **TimeOffset** *(float) --* Specify the value for TIME-OFFSET within your EXT-X-START tag. Enter a signed floating point value which, if positive, must be less than the configured manifest duration minus three times the configured segment target duration. If negative, the absolute value must be larger than three times the configured segment target duration, and the absolute value must be smaller than the configured manifest duration. * **Precise** *(boolean) --* Specify the value for PRECISE within your EXT-X-START tag. Leave blank, or choose false, to use the default value NO. Choose yes to use the value YES. * **UrlEncodeChildManifest** *(boolean) --* When enabled, MediaPackage URL-encodes the query string for API requests for LL-HLS child manifests to comply with Amazon Web Services Signature Version 4 (SigV4) signature signing protocol. For more information, see Amazon Web Services Signature Version 4 for API requests in *Identity and Access Management User Guide*. * **DashManifests** *(list) --* A DASH manifest configuration. * *(dict) --* Retrieve the DASH manifest configuration. * **ManifestName** *(string) --* A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **ManifestWindowSeconds** *(integer) --* The total duration (in seconds) of the manifest's content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **MinUpdatePeriodSeconds** *(integer) --* Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. * **MinBufferTimeSeconds** *(integer) --* Minimum amount of content (in seconds) that a player must keep available in the buffer. * **SuggestedPresentationDelaySeconds** *(integer) --* The amount of time (in seconds) that the player should be from the end of the manifest. * **SegmentTemplateFormat** *(string) --* Determines the type of variable used in the "media" URL of the "SegmentTemplate" tag in the manifest. Also specifies if segment timeline information is included in "SegmentTimeline" or "SegmentTemplate". Value description: * "NUMBER_WITH_TIMELINE" - The "$Number$" variable is used in the "media" URL. The value of this variable is the sequential number of the segment. A full "SegmentTimeline" object is presented in each "SegmentTemplate". * **PeriodTriggers** *(list) --* A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage. * *(string) --* * **ScteDash** *(dict) --* The SCTE configuration. * **AdMarkerDash** *(string) --* Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Value description: * "Binary" - The SCTE-35 marker is expressed as a hex- string (Base64 string) rather than full XML. * "XML" - The SCTE marker is expressed fully in XML. * **DrmSignaling** *(string) --* Determines how the DASH manifest signals the DRM content. * **UtcTiming** *(dict) --* Determines the type of UTC timing included in the DASH Media Presentation Description (MPD). * **TimingMode** *(string) --* The UTC timing mode. * **TimingSource** *(string) --* The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time. * **Profiles** *(list) --* The profile that the output is compliant with. * *(string) --* * **BaseUrls** *(list) --* The base URL to use for retrieving segments. * *(dict) --* The base URLs to use for retrieving segments. You can specify multiple locations and indicate the priority and weight for when each should be used, for use in mutli-CDN workflows. * **Url** *(string) --* A source location for segments. * **ServiceLocation** *(string) --* The name of the source location. * **DvbPriority** *(integer) --* For use with DVB-DASH profiles only. The priority of this location for servings segments. The lower the number, the higher the priority. * **DvbWeight** *(integer) --* For use with DVB-DASH profiles only. The weighting for source locations that have the same priority. * **ProgramInformation** *(dict) --* Details about the content that you want MediaPackage to pass through in the manifest to the playback device. * **Title** *(string) --* The title for the manifest. * **Source** *(string) --* Information about the content provider. * **Copyright** *(string) --* A copyright statement about the content. * **LanguageCode** *(string) --* The language code for this manifest. * **MoreInformationUrl** *(string) --* An absolute URL that contains more information about this content. * **DvbSettings** *(dict) --* For endpoints that use the DVB-DASH profile only. The font download and error reporting information that you want MediaPackage to pass through to the manifest. * **FontDownload** *(dict) --* Subtitle font settings. * **Url** *(string) --* The URL for downloading fonts for subtitles. * **MimeType** *(string) --* The "mimeType" of the resource that's at the font download URL. For information about font MIME types, see the MPEG- DASH Profile for Transport of ISO BMFF Based DVB Services over IP Based Networks document. * **FontFamily** *(string) --* The "fontFamily" name for subtitles, as described in EBU-TT-D Subtitling Distribution Format. * **ErrorMetrics** *(list) --* Playback device error reporting settings. * *(dict) --* For use with DVB-DASH profiles only. The settings for error reporting from the playback device that you want Elemental MediaPackage to pass through to the manifest. * **ReportingUrl** *(string) --* The URL where playback devices send error reports. * **Probability** *(integer) --* The number of playback devices per 1000 that will send error reports to the reporting URL. This represents the probability that a playback device will be a reporting player for this session. * **Compactness** *(string) --* The layout of the DASH manifest that MediaPackage produces. "STANDARD" indicates a default manifest, which is compacted. "NONE" indicates a full manifest. * **SubtitleConfiguration** *(dict) --* The configuration for DASH subtitles. * **TtmlConfiguration** *(dict) --* Settings for TTML subtitles. * **TtmlProfile** *(string) --* The profile that MediaPackage uses when signaling subtitles in the manifest. "IMSC" is the default profile. "EBU-TT-D" produces subtitles that are compliant with the EBU-TT-D TTML profile. MediaPackage passes through subtitle styles to the manifest. For more information about EBU-TT-D subtitles, see EBU-TT-D Subtitling Distribution Format. * **MssManifests** *(list) --* The Microsoft Smooth Streaming (MSS) manifest configurations that were created for this origin endpoint. * *(dict) --* Configuration details for a Microsoft Smooth Streaming (MSS) manifest associated with an origin endpoint. This includes all the settings and properties that define how the MSS content is packaged and delivered. * **ManifestName** *(string) --* The name of the MSS manifest. This name is appended to the origin endpoint URL to create the unique path for accessing this specific MSS manifest. * **Url** *(string) --* The complete URL for accessing the MSS manifest. Client players use this URL to retrieve the manifest and begin streaming the Microsoft Smooth Streaming content. * **FilterConfiguration** *(dict) --* Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest. * **ManifestFilter** *(string) --* Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL. * **Start** *(datetime) --* Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL. * **End** *(datetime) --* Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL. * **TimeDelaySeconds** *(integer) --* Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL. * **ClipStartTime** *(datetime) --* Optionally specify the clip start time for all of your manifest egress requests. When you include clip start time, note that you cannot use clip start time query parameters for this manifest's endpoint URL. * **ManifestWindowSeconds** *(integer) --* The duration (in seconds) of the manifest window. This represents the total amount of content available in the manifest at any given time. * **ManifestLayout** *(string) --* The layout format of the MSS manifest, which determines how the manifest is structured for client compatibility. * **ForceEndpointErrorConfiguration** *(dict) --* The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the origin endpoint. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" * "mediapackagev2.Client.exceptions.ServiceQuotaExceededException" mediapackagev2 / Client / get_channel get_channel *********** mediapackagev2.Client.get_channel(**kwargs) Retrieves the specified channel that's configured in AWS Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.get_channel( ChannelGroupName='string', ChannelName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelName': 'string', 'ChannelGroupName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'ResetAt': datetime(2015, 1, 1), 'Description': 'string', 'IngestEndpoints': [ { 'Id': 'string', 'Url': 'string' }, ], 'InputType': 'HLS'|'CMAF', 'ETag': 'string', 'Tags': { 'string': 'string' }, 'InputSwitchConfiguration': { 'MQCSInputSwitching': True|False, 'PreferredInput': 123 }, 'OutputHeaderConfiguration': { 'PublishMQCS': True|False } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **CreatedAt** *(datetime) --* The date and time the channel was created. * **ModifiedAt** *(datetime) --* The date and time the channel was modified. * **ResetAt** *(datetime) --* The time that the channel was last reset. * **Description** *(string) --* The description for your channel. * **IngestEndpoints** *(list) --* The list of ingest endpoints. * *(dict) --* The ingest domain URL where the source stream should be sent. * **Id** *(string) --* The system-generated unique identifier for the IngestEndpoint. * **Url** *(string) --* The ingest domain URL where the source stream should be sent. * **InputType** *(string) --* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel. * *(string) --* * *(string) --* * **InputSwitchConfiguration** *(dict) --* The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when "InputType" is "CMAF". * **MQCSInputSwitching** *(boolean) --* When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when "InputType" is "CMAF". * **PreferredInput** *(integer) --* For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select "1" to prefer the first ingest endpoint, or "2" to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal. * **OutputHeaderConfiguration** *(dict) --* The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **PublishMQCS** *(boolean) --* When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when "InputType" is "CMAF". **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / list_tags_for_resource list_tags_for_resource ********************** mediapackagev2.Client.list_tags_for_resource(**kwargs) Lists the tags assigned to a resource. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( ResourceArn='string' ) Parameters: **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the CloudWatch resource that you want to view tags for. Return type: dict Returns: **Response Syntax** { 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **Tags** *(dict) --* Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / untag_resource untag_resource ************** mediapackagev2.Client.untag_resource(**kwargs) Removes one or more tags from the specified resource. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( ResourceArn='string', TagKeys=[ 'string', ] ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the MediaPackage resource that you're removing tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The list of tag keys to remove from the resource. * *(string) --* Returns: None **Exceptions** * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / delete_origin_endpoint_policy delete_origin_endpoint_policy ***************************** mediapackagev2.Client.delete_origin_endpoint_policy(**kwargs) Delete an origin endpoint policy. See also: AWS API Documentation **Request Syntax** response = client.delete_origin_endpoint_policy( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / delete_origin_endpoint delete_origin_endpoint ********************** mediapackagev2.Client.delete_origin_endpoint(**kwargs) Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel. See also: AWS API Documentation **Request Syntax** response = client.delete_origin_endpoint( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / get_waiter get_waiter ********** mediapackagev2.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" mediapackagev2 / Client / get_channel_group get_channel_group ***************** mediapackagev2.Client.get_channel_group(**kwargs) Retrieves the specified channel group that's configured in AWS Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.get_channel_group( ChannelGroupName='string' ) Parameters: **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'Arn': 'string', 'EgressDomain': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **EgressDomain** *(string) --* The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device. * **CreatedAt** *(datetime) --* The date and time the channel group was created. * **ModifiedAt** *(datetime) --* The date and time the channel group was modified. * **Description** *(string) --* The description for your channel group. * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel group. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / reset_channel_state reset_channel_state ******************* mediapackagev2.Client.reset_channel_state(**kwargs) Resetting the channel can help to clear errors from misconfigurations in the encoder. A reset refreshes the ingest stream and removes previous content. Be sure to stop the encoder before you reset the channel, and wait at least 30 seconds before you restart the encoder. See also: AWS API Documentation **Request Syntax** response = client.reset_channel_state( ChannelGroupName='string', ChannelName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group that contains the channel that you are resetting. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel that you are resetting. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'Arn': 'string', 'ResetAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name of the channel group that contains the channel that you just reset. * **ChannelName** *(string) --* The name of the channel that you just reset. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the channel that you just reset. * **ResetAt** *(datetime) --* The time that the channel was last reset. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / list_channel_groups list_channel_groups ******************* mediapackagev2.Client.list_channel_groups(**kwargs) Retrieves all channel groups that are configured in Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.list_channel_groups( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- The maximum number of results to return in the response. * **NextToken** (*string*) -- The pagination token from the GET list request. Use the token to fetch the next page of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ChannelGroupName': 'string', 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **CreatedAt** *(datetime) --* The date and time the channel group was created. * **ModifiedAt** *(datetime) --* The date and time the channel group was modified. * **Description** *(string) --* Any descriptive information that you want to add to the channel group for future identification purposes. * **NextToken** *(string) --* The pagination token from the GET list request. Use the token to fetch the next page of results. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / create_channel_group create_channel_group ******************** mediapackagev2.Client.create_channel_group(**kwargs) Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request. See also: AWS API Documentation **Request Syntax** response = client.create_channel_group( ChannelGroupName='string', ClientToken='string', Description='string', Tags={ 'string': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **Description** (*string*) -- Enter any descriptive text that helps you to identify the channel group. * **Tags** (*dict*) -- A comma-separated list of tag key:value pairs that you define. For example: ""Key1": "Value1"," ""Key2": "Value2"" * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'Arn': 'string', 'EgressDomain': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'ETag': 'string', 'Description': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **EgressDomain** *(string) --* The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device. * **CreatedAt** *(datetime) --* The date and time the channel group was created. * **ModifiedAt** *(datetime) --* The date and time the channel group was modified. * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Description** *(string) --* The description for your channel group. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel group. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" * "mediapackagev2.Client.exceptions.ServiceQuotaExceededException" mediapackagev2 / Client / create_channel create_channel ************** mediapackagev2.Client.create_channel(**kwargs) Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups. See also: AWS API Documentation **Request Syntax** response = client.create_channel( ChannelGroupName='string', ChannelName='string', ClientToken='string', InputType='HLS'|'CMAF', Description='string', InputSwitchConfiguration={ 'MQCSInputSwitching': True|False, 'PreferredInput': 123 }, OutputHeaderConfiguration={ 'PublishMQCS': True|False }, Tags={ 'string': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel. * **ClientToken** (*string*) -- A unique, case-sensitive token that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **InputType** (*string*) -- The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). * **Description** (*string*) -- Enter any descriptive text that helps you to identify the channel. * **InputSwitchConfiguration** (*dict*) -- The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when "InputType" is "CMAF". * **MQCSInputSwitching** *(boolean) --* When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when "InputType" is "CMAF". * **PreferredInput** *(integer) --* For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select "1" to prefer the first ingest endpoint, or "2" to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal. * **OutputHeaderConfiguration** (*dict*) -- The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **PublishMQCS** *(boolean) --* When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **Tags** (*dict*) -- A comma-separated list of tag key:value pairs that you define. For example: ""Key1": "Value1"," ""Key2": "Value2"" * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelName': 'string', 'ChannelGroupName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'IngestEndpoints': [ { 'Id': 'string', 'Url': 'string' }, ], 'InputType': 'HLS'|'CMAF', 'ETag': 'string', 'Tags': { 'string': 'string' }, 'InputSwitchConfiguration': { 'MQCSInputSwitching': True|False, 'PreferredInput': 123 }, 'OutputHeaderConfiguration': { 'PublishMQCS': True|False } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **CreatedAt** *(datetime) --* The date and time the channel was created. * **ModifiedAt** *(datetime) --* The date and time the channel was modified. * **Description** *(string) --* The description for your channel. * **IngestEndpoints** *(list) --* The list of ingest endpoints. * *(dict) --* The ingest domain URL where the source stream should be sent. * **Id** *(string) --* The system-generated unique identifier for the IngestEndpoint. * **Url** *(string) --* The ingest domain URL where the source stream should be sent. * **InputType** *(string) --* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel. * *(string) --* * *(string) --* * **InputSwitchConfiguration** *(dict) --* The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when "InputType" is "CMAF". * **MQCSInputSwitching** *(boolean) --* When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when "InputType" is "CMAF". * **PreferredInput** *(integer) --* For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select "1" to prefer the first ingest endpoint, or "2" to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal. * **OutputHeaderConfiguration** *(dict) --* The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **PublishMQCS** *(boolean) --* When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when "InputType" is "CMAF". **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" * "mediapackagev2.Client.exceptions.ServiceQuotaExceededException" mediapackagev2 / Client / delete_channel delete_channel ************** mediapackagev2.Client.delete_channel(**kwargs) Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel. See also: AWS API Documentation **Request Syntax** response = client.delete_channel( ChannelGroupName='string', ChannelName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / list_origin_endpoints list_origin_endpoints ********************* mediapackagev2.Client.list_origin_endpoints(**kwargs) Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.list_origin_endpoints( ChannelGroupName='string', ChannelName='string', MaxResults=123, NextToken='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **MaxResults** (*integer*) -- The maximum number of results to return in the response. * **NextToken** (*string*) -- The pagination token from the GET list request. Use the token to fetch the next page of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'Arn': 'string', 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'ContainerType': 'TS'|'CMAF'|'ISM', 'Description': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'HlsManifests': [ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'Url': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string', 'ChildManifestName': 'string', 'Url': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string', 'Url': 'string' }, ], 'MssManifests': [ { 'ManifestName': 'string', 'Url': 'string' }, ], 'ForceEndpointErrorConfiguration': { 'EndpointErrorConditions': [ 'STALE_MANIFEST'|'INCOMPLETE_MANIFEST'|'MISSING_DRM_KEY'|'SLATE_INPUT', ] } }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **Items** *(list) --* The objects being returned. * *(dict) --* The configuration of the origin endpoint. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **ContainerType** *(string) --* The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. * **Description** *(string) --* Any descriptive information that you want to add to the origin endpoint for future identification purposes. * **CreatedAt** *(datetime) --* The date and time the origin endpoint was created. * **ModifiedAt** *(datetime) --* The date and time the origin endpoint was modified. * **HlsManifests** *(list) --* An HTTP live streaming (HLS) manifest configuration. * *(dict) --* List the HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **LowLatencyHlsManifests** *(list) --* A low-latency HLS manifest configuration. * *(dict) --* List the low-latency HTTP live streaming (HLS) manifest configuration. * **ManifestName** *(string) --* A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **ChildManifestName** *(string) --* A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **DashManifests** *(list) --* A DASH manifest configuration. * *(dict) --* List the DASH manifest configuration. * **ManifestName** *(string) --* A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. * **Url** *(string) --* The egress domain URL for stream delivery from MediaPackage. * **MssManifests** *(list) --* A list of Microsoft Smooth Streaming (MSS) manifest configurations associated with the origin endpoint. Each configuration represents a different MSS streaming option available from this endpoint. * *(dict) --* Summary information about a Microsoft Smooth Streaming (MSS) manifest configuration. This provides key details about the MSS manifest without including all configuration parameters. * **ManifestName** *(string) --* The name of the MSS manifest configuration. * **Url** *(string) --* The URL for accessing the MSS manifest. * **ForceEndpointErrorConfiguration** *(dict) --* The failover settings for the endpoint. * **EndpointErrorConditions** *(list) --* The failover conditions for the endpoint. The options are: * "STALE_MANIFEST" - The manifest stalled and there are no new segments or parts. * "INCOMPLETE_MANIFEST" - There is a gap in the manifest. * "MISSING_DRM_KEY" - Key rotation is enabled but we're unable to fetch the key for the current key period. * "SLATE_INPUT" - The segments which contain slate content are considered to be missing content. * *(string) --* * **NextToken** *(string) --* The pagination token from the GET list request. Use the token to fetch the next page of results. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / list_harvest_jobs list_harvest_jobs ***************** mediapackagev2.Client.list_harvest_jobs(**kwargs) Retrieves a list of harvest jobs that match the specified criteria. See also: AWS API Documentation **Request Syntax** response = client.list_harvest_jobs( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', Status='QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', MaxResults=123, NextToken='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group to filter the harvest jobs by. If specified, only harvest jobs associated with channels in this group will be returned. * **ChannelName** (*string*) -- The name of the channel to filter the harvest jobs by. If specified, only harvest jobs associated with this channel will be returned. * **OriginEndpointName** (*string*) -- The name of the origin endpoint to filter the harvest jobs by. If specified, only harvest jobs associated with this origin endpoint will be returned. * **Status** (*string*) -- The status to filter the harvest jobs by. If specified, only harvest jobs with this status will be returned. * **MaxResults** (*integer*) -- The maximum number of harvest jobs to return in a single request. If not specified, a default value will be used. * **NextToken** (*string*) -- A token used for pagination. Provide this value in subsequent requests to retrieve the next set of results. Return type: dict Returns: **Response Syntax** { 'Items': [ { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Destination': { 'S3Destination': { 'BucketName': 'string', 'DestinationPath': 'string' } }, 'HarvestJobName': 'string', 'HarvestedManifests': { 'HlsManifests': [ { 'ManifestName': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string' }, ] }, 'Description': 'string', 'ScheduleConfiguration': { 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', 'ErrorMessage': 'string', 'ETag': 'string' }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* The response object containing the list of harvest jobs that match the specified criteria. * **Items** *(list) --* An array of harvest job objects that match the specified criteria. * *(dict) --* Represents a harvest job resource in MediaPackage v2, which is used to export content from an origin endpoint to an S3 bucket. * **ChannelGroupName** *(string) --* The name of the channel group containing the channel associated with this harvest job. * **ChannelName** *(string) --* The name of the channel associated with this harvest job. * **OriginEndpointName** *(string) --* The name of the origin endpoint associated with this harvest job. * **Destination** *(dict) --* The S3 destination where the harvested content will be placed. * **S3Destination** *(dict) --* The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket. * **BucketName** *(string) --* The name of an S3 bucket within which harvested content will be exported. * **DestinationPath** *(string) --* The path within the specified S3 bucket where the harvested content will be placed. * **HarvestJobName** *(string) --* The name of the harvest job. * **HarvestedManifests** *(dict) --* A list of manifests that are being or have been harvested. * **HlsManifests** *(list) --* A list of harvested HLS manifests. * *(dict) --* Information about a harvested HLS manifest. * **ManifestName** *(string) --* The name of the harvested HLS manifest. * **DashManifests** *(list) --* A list of harvested DASH manifests. * *(dict) --* Information about a harvested DASH manifest. * **ManifestName** *(string) --* The name of the harvested DASH manifest. * **LowLatencyHlsManifests** *(list) --* A list of harvested Low-Latency HLS manifests. * *(dict) --* Information about a harvested Low-Latency HLS manifest. * **ManifestName** *(string) --* The name of the harvested Low-Latency HLS manifest. * **Description** *(string) --* An optional description of the harvest job. * **ScheduleConfiguration** *(dict) --* The configuration for when the harvest job is scheduled to run. * **StartTime** *(datetime) --* The start time for the harvest job. * **EndTime** *(datetime) --* The end time for the harvest job. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the harvest job. * **CreatedAt** *(datetime) --* The date and time when the harvest job was created. * **ModifiedAt** *(datetime) --* The date and time when the harvest job was last modified. * **Status** *(string) --* The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED). * **ErrorMessage** *(string) --* An error message if the harvest job encountered any issues. * **ETag** *(string) --* The current version of the harvest job. Used for concurrency control. * **NextToken** *(string) --* A token used for pagination. Include this value in subsequent requests to retrieve the next set of results. If null, there are no more results to retrieve. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / reset_origin_endpoint_state reset_origin_endpoint_state *************************** mediapackagev2.Client.reset_origin_endpoint_state(**kwargs) Resetting the origin endpoint can help to resolve unexpected behavior and other content packaging issues. It also helps to preserve special events when you don't want the previous content to be available for viewing. A reset clears out all previous content from the origin endpoint. MediaPackage might return old content from this endpoint in the first 30 seconds after the endpoint reset. For best results, when possible, wait 30 seconds from endpoint reset to send playback requests to this endpoint. See also: AWS API Documentation **Request Syntax** response = client.reset_origin_endpoint_state( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group that contains the channel with the origin endpoint that you are resetting. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel with the origin endpoint that you are resetting. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name of the origin endpoint that you are resetting. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Arn': 'string', 'ResetAt': datetime(2015, 1, 1) } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name of the channel group that contains the channel with the origin endpoint that you just reset. * **ChannelName** *(string) --* The name of the channel with the origin endpoint that you just reset. * **OriginEndpointName** *(string) --* The name of the origin endpoint that you just reset. * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the endpoint that you just reset. * **ResetAt** *(datetime) --* The time that the origin endpoint was last reset. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / close close ***** mediapackagev2.Client.close() Closes underlying endpoint connections. mediapackagev2 / Client / create_harvest_job create_harvest_job ****************** mediapackagev2.Client.create_harvest_job(**kwargs) Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket. See also: AWS API Documentation **Request Syntax** response = client.create_harvest_job( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', Description='string', HarvestedManifests={ 'HlsManifests': [ { 'ManifestName': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string' }, ] }, ScheduleConfiguration={ 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, Destination={ 'S3Destination': { 'BucketName': 'string', 'DestinationPath': 'string' } }, ClientToken='string', HarvestJobName='string', Tags={ 'string': 'string' } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group containing the channel from which to harvest content. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel from which to harvest content. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name of the origin endpoint from which to harvest content. * **Description** (*string*) -- An optional description for the harvest job. * **HarvestedManifests** (*dict*) -- **[REQUIRED]** A list of manifests to be harvested. * **HlsManifests** *(list) --* A list of harvested HLS manifests. * *(dict) --* Information about a harvested HLS manifest. * **ManifestName** *(string) --* **[REQUIRED]** The name of the harvested HLS manifest. * **DashManifests** *(list) --* A list of harvested DASH manifests. * *(dict) --* Information about a harvested DASH manifest. * **ManifestName** *(string) --* **[REQUIRED]** The name of the harvested DASH manifest. * **LowLatencyHlsManifests** *(list) --* A list of harvested Low-Latency HLS manifests. * *(dict) --* Information about a harvested Low-Latency HLS manifest. * **ManifestName** *(string) --* **[REQUIRED]** The name of the harvested Low-Latency HLS manifest. * **ScheduleConfiguration** (*dict*) -- **[REQUIRED]** The configuration for when the harvest job should run, including start and end times. * **StartTime** *(datetime) --* **[REQUIRED]** The start time for the harvest job. * **EndTime** *(datetime) --* **[REQUIRED]** The end time for the harvest job. * **Destination** (*dict*) -- **[REQUIRED]** The S3 destination where the harvested content will be placed. * **S3Destination** *(dict) --* **[REQUIRED]** The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket. * **BucketName** *(string) --* **[REQUIRED]** The name of an S3 bucket within which harvested content will be exported. * **DestinationPath** *(string) --* **[REQUIRED]** The path within the specified S3 bucket where the harvested content will be placed. * **ClientToken** (*string*) -- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This field is autopopulated if not provided. * **HarvestJobName** (*string*) -- A name for the harvest job. This name must be unique within the channel. * **Tags** (*dict*) -- A collection of tags associated with the harvest job. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Destination': { 'S3Destination': { 'BucketName': 'string', 'DestinationPath': 'string' } }, 'HarvestJobName': 'string', 'HarvestedManifests': { 'HlsManifests': [ { 'ManifestName': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string' }, ] }, 'Description': 'string', 'ScheduleConfiguration': { 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', 'ErrorMessage': 'string', 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* The response object returned after creating a harvest job. * **ChannelGroupName** *(string) --* The name of the channel group containing the channel from which content is being harvested. * **ChannelName** *(string) --* The name of the channel from which content is being harvested. * **OriginEndpointName** *(string) --* The name of the origin endpoint from which content is being harvested. * **Destination** *(dict) --* The S3 destination where the harvested content will be placed. * **S3Destination** *(dict) --* The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket. * **BucketName** *(string) --* The name of an S3 bucket within which harvested content will be exported. * **DestinationPath** *(string) --* The path within the specified S3 bucket where the harvested content will be placed. * **HarvestJobName** *(string) --* The name of the created harvest job. * **HarvestedManifests** *(dict) --* A list of manifests that will be harvested. * **HlsManifests** *(list) --* A list of harvested HLS manifests. * *(dict) --* Information about a harvested HLS manifest. * **ManifestName** *(string) --* The name of the harvested HLS manifest. * **DashManifests** *(list) --* A list of harvested DASH manifests. * *(dict) --* Information about a harvested DASH manifest. * **ManifestName** *(string) --* The name of the harvested DASH manifest. * **LowLatencyHlsManifests** *(list) --* A list of harvested Low-Latency HLS manifests. * *(dict) --* Information about a harvested Low-Latency HLS manifest. * **ManifestName** *(string) --* The name of the harvested Low-Latency HLS manifest. * **Description** *(string) --* The description of the harvest job, if provided. * **ScheduleConfiguration** *(dict) --* The configuration for when the harvest job will run, including start and end times. * **StartTime** *(datetime) --* The start time for the harvest job. * **EndTime** *(datetime) --* The end time for the harvest job. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the created harvest job. * **CreatedAt** *(datetime) --* The date and time the harvest job was created. * **ModifiedAt** *(datetime) --* The date and time the harvest job was last modified. * **Status** *(string) --* The current status of the harvest job (e.g., CREATED, IN_PROGRESS, ABORTED, COMPLETED, FAILED). * **ErrorMessage** *(string) --* An error message if the harvest job creation failed. * **ETag** *(string) --* The current version of the harvest job. Used for concurrency control. * **Tags** *(dict) --* A collection of tags associated with the harvest job. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" * "mediapackagev2.Client.exceptions.ServiceQuotaExceededException" mediapackagev2 / Client / cancel_harvest_job cancel_harvest_job ****************** mediapackagev2.Client.cancel_harvest_job(**kwargs) Cancels an in-progress harvest job. See also: AWS API Documentation **Request Syntax** response = client.cancel_harvest_job( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', HarvestJobName='string', ETag='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group containing the channel from which the harvest job is running. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel from which the harvest job is running. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name of the origin endpoint that the harvest job is harvesting from. This cannot be changed after the harvest job is submitted. * **HarvestJobName** (*string*) -- **[REQUIRED]** The name of the harvest job to cancel. This name must be unique within the channel and cannot be changed after the harvest job is submitted. * **ETag** (*string*) -- The current Entity Tag (ETag) associated with the harvest job. Used for concurrency control. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / tag_resource tag_resource ************ mediapackagev2.Client.tag_resource(**kwargs) Assigns one of more tags (key-value pairs) to the specified MediaPackage resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( ResourceArn='string', Tags={ 'string': 'string' } ) Parameters: * **ResourceArn** (*string*) -- **[REQUIRED]** The ARN of the MediaPackage resource that you're adding tags to. * **Tags** (*dict*) -- **[REQUIRED]** Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. * *(string) --* * *(string) --* Returns: None **Exceptions** * "mediapackagev2.Client.exceptions.ValidationException" mediapackagev2 / Client / get_harvest_job get_harvest_job *************** mediapackagev2.Client.get_harvest_job(**kwargs) Retrieves the details of a specific harvest job. See also: AWS API Documentation **Request Syntax** response = client.get_harvest_job( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string', HarvestJobName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name of the channel group containing the channel associated with the harvest job. * **ChannelName** (*string*) -- **[REQUIRED]** The name of the channel associated with the harvest job. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name of the origin endpoint associated with the harvest job. * **HarvestJobName** (*string*) -- **[REQUIRED]** The name of the harvest job to retrieve. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Destination': { 'S3Destination': { 'BucketName': 'string', 'DestinationPath': 'string' } }, 'HarvestJobName': 'string', 'HarvestedManifests': { 'HlsManifests': [ { 'ManifestName': 'string' }, ], 'DashManifests': [ { 'ManifestName': 'string' }, ], 'LowLatencyHlsManifests': [ { 'ManifestName': 'string' }, ] }, 'Description': 'string', 'ScheduleConfiguration': { 'StartTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1) }, 'Arn': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Status': 'QUEUED'|'IN_PROGRESS'|'CANCELLED'|'COMPLETED'|'FAILED', 'ErrorMessage': 'string', 'ETag': 'string', 'Tags': { 'string': 'string' } } **Response Structure** * *(dict) --* The response object containing the details of the requested harvest job. * **ChannelGroupName** *(string) --* The name of the channel group containing the channel associated with the harvest job. * **ChannelName** *(string) --* The name of the channel associated with the harvest job. * **OriginEndpointName** *(string) --* The name of the origin endpoint associated with the harvest job. * **Destination** *(dict) --* The S3 destination where the harvested content is being placed. * **S3Destination** *(dict) --* The configuration for exporting harvested content to an S3 bucket. This includes details such as the bucket name and destination path within the bucket. * **BucketName** *(string) --* The name of an S3 bucket within which harvested content will be exported. * **DestinationPath** *(string) --* The path within the specified S3 bucket where the harvested content will be placed. * **HarvestJobName** *(string) --* The name of the harvest job. * **HarvestedManifests** *(dict) --* A list of manifests that are being or have been harvested. * **HlsManifests** *(list) --* A list of harvested HLS manifests. * *(dict) --* Information about a harvested HLS manifest. * **ManifestName** *(string) --* The name of the harvested HLS manifest. * **DashManifests** *(list) --* A list of harvested DASH manifests. * *(dict) --* Information about a harvested DASH manifest. * **ManifestName** *(string) --* The name of the harvested DASH manifest. * **LowLatencyHlsManifests** *(list) --* A list of harvested Low-Latency HLS manifests. * *(dict) --* Information about a harvested Low-Latency HLS manifest. * **ManifestName** *(string) --* The name of the harvested Low-Latency HLS manifest. * **Description** *(string) --* The description of the harvest job, if provided. * **ScheduleConfiguration** *(dict) --* The configuration for when the harvest job is scheduled to run, including start and end times. * **StartTime** *(datetime) --* The start time for the harvest job. * **EndTime** *(datetime) --* The end time for the harvest job. * **Arn** *(string) --* The Amazon Resource Name (ARN) of the harvest job. * **CreatedAt** *(datetime) --* The date and time when the harvest job was created. * **ModifiedAt** *(datetime) --* The date and time when the harvest job was last modified. * **Status** *(string) --* The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED). * **ErrorMessage** *(string) --* An error message if the harvest job encountered any issues. * **ETag** *(string) --* The current version of the harvest job. Used for concurrency control. * **Tags** *(dict) --* A collection of tags associated with the harvest job. * *(string) --* * *(string) --* **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / update_channel update_channel ************** mediapackagev2.Client.update_channel(**kwargs) Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details. Any edits you make that impact the video output may not be reflected for a few minutes. See also: AWS API Documentation **Request Syntax** response = client.update_channel( ChannelGroupName='string', ChannelName='string', ETag='string', Description='string', InputSwitchConfiguration={ 'MQCSInputSwitching': True|False, 'PreferredInput': 123 }, OutputHeaderConfiguration={ 'PublishMQCS': True|False } ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ETag** (*string*) -- The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected. * **Description** (*string*) -- Any descriptive information that you want to add to the channel for future identification purposes. * **InputSwitchConfiguration** (*dict*) -- The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when "InputType" is "CMAF". * **MQCSInputSwitching** *(boolean) --* When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when "InputType" is "CMAF". * **PreferredInput** *(integer) --* For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select "1" to prefer the first ingest endpoint, or "2" to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal. * **OutputHeaderConfiguration** (*dict*) -- The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **PublishMQCS** *(boolean) --* When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when "InputType" is "CMAF". Return type: dict Returns: **Response Syntax** { 'Arn': 'string', 'ChannelName': 'string', 'ChannelGroupName': 'string', 'CreatedAt': datetime(2015, 1, 1), 'ModifiedAt': datetime(2015, 1, 1), 'Description': 'string', 'IngestEndpoints': [ { 'Id': 'string', 'Url': 'string' }, ], 'InputType': 'HLS'|'CMAF', 'ETag': 'string', 'Tags': { 'string': 'string' }, 'InputSwitchConfiguration': { 'MQCSInputSwitching': True|False, 'PreferredInput': 123 }, 'OutputHeaderConfiguration': { 'PublishMQCS': True|False } } **Response Structure** * *(dict) --* * **Arn** *(string) --* The Amazon Resource Name (ARN) associated with the resource. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **CreatedAt** *(datetime) --* The date and time the channel was created. * **ModifiedAt** *(datetime) --* The date and time the channel was modified. * **Description** *(string) --* The description for your channel. * **IngestEndpoints** *(list) --* The list of ingest endpoints. * *(dict) --* The ingest domain URL where the source stream should be sent. * **Id** *(string) --* The system-generated unique identifier for the IngestEndpoint. * **Url** *(string) --* The ingest domain URL where the source stream should be sent. * **InputType** *(string) --* The input type will be an immutable field which will be used to define whether the channel will allow CMAF ingest or HLS ingest. If unprovided, it will default to HLS to preserve current behavior. The allowed values are: * "HLS" - The HLS streaming specification (which defines M3U8 manifests and TS segments). * "CMAF" - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests). * **ETag** *(string) --* The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource. * **Tags** *(dict) --* The comma-separated list of tag key:value pairs assigned to the channel. * *(string) --* * *(string) --* * **InputSwitchConfiguration** *(dict) --* The configuration for input switching based on the media quality confidence score (MQCS) as provided from AWS Elemental MediaLive. This setting is valid only when "InputType" is "CMAF". * **MQCSInputSwitching** *(boolean) --* When true, AWS Elemental MediaPackage performs input switching based on the MQCS. Default is true. This setting is valid only when "InputType" is "CMAF". * **PreferredInput** *(integer) --* For CMAF inputs, indicates which input MediaPackage should prefer when both inputs have equal MQCS scores. Select "1" to prefer the first ingest endpoint, or "2" to prefer the second ingest endpoint. If you don't specify a preferred input, MediaPackage uses its default switching behavior when MQCS scores are equal. * **OutputHeaderConfiguration** *(dict) --* The settings for what common media server data (CMSD) headers AWS Elemental MediaPackage includes in responses to the CDN. This setting is valid only when "InputType" is "CMAF". * **PublishMQCS** *(boolean) --* When true, AWS Elemental MediaPackage includes the MQCS in responses to the CDN. This setting is valid only when "InputType" is "CMAF". **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.ConflictException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / get_origin_endpoint_policy get_origin_endpoint_policy ************************** mediapackagev2.Client.get_origin_endpoint_policy(**kwargs) Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage. See also: AWS API Documentation **Request Syntax** response = client.get_origin_endpoint_policy( ChannelGroupName='string', ChannelName='string', OriginEndpointName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** (*string*) -- **[REQUIRED]** The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'OriginEndpointName': 'string', 'Policy': 'string', 'CdnAuthConfiguration': { 'CdnIdentifierSecretArns': [ 'string', ], 'SecretsRoleArn': 'string' } } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **OriginEndpointName** *(string) --* The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel. * **Policy** *(string) --* The policy assigned to the origin endpoint. * **CdnAuthConfiguration** *(dict) --* The settings for using authorization headers between the MediaPackage endpoint and your CDN. For information about CDN authorization, see CDN authorization in Elemental MediaPackage in the MediaPackage user guide. * **CdnIdentifierSecretArns** *(list) --* The ARN for the secret in Secrets Manager that your CDN uses for authorization to access the endpoint. * *(string) --* * **SecretsRoleArn** *(string) --* The ARN for the IAM role that gives MediaPackage read access to Secrets Manager and KMS for CDN authorization. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException" mediapackagev2 / Client / get_channel_policy get_channel_policy ****************** mediapackagev2.Client.get_channel_policy(**kwargs) Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. See also: AWS API Documentation **Request Syntax** response = client.get_channel_policy( ChannelGroupName='string', ChannelName='string' ) Parameters: * **ChannelGroupName** (*string*) -- **[REQUIRED]** The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** (*string*) -- **[REQUIRED]** The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. Return type: dict Returns: **Response Syntax** { 'ChannelGroupName': 'string', 'ChannelName': 'string', 'Policy': 'string' } **Response Structure** * *(dict) --* * **ChannelGroupName** *(string) --* The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. * **ChannelName** *(string) --* The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. * **Policy** *(string) --* The policy assigned to the channel. **Exceptions** * "mediapackagev2.Client.exceptions.ThrottlingException" * "mediapackagev2.Client.exceptions.InternalServerException" * "mediapackagev2.Client.exceptions.AccessDeniedException" * "mediapackagev2.Client.exceptions.ValidationException" * "mediapackagev2.Client.exceptions.ResourceNotFoundException"