MediaPackage ¶

Table of Contents

MediaPackage
- Client
- Paginators

Client ¶

class MediaPackage.Client¶

A low-level client representing AWS Elemental MediaPackage:

import boto3

client = boto3.client('mediapackage')

These are the available methods:

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.

create_channel(**kwargs)¶

Creates a new Channel.

See also: AWS API Documentation

Request Syntax

response = client.create_channel(
    Description='string',
    Id='string',
    Tags={
        'string': 'string'
    }
)

Parameters

Description (string) -- A short text description of the Channel.
Id (string) -- [REQUIRED] The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is created.
Tags (dict) --
A collection of tags associated with a resource
- (string) --
  - (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The new Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

create_harvest_job(**kwargs)¶

Creates a new HarvestJob record.

See also: AWS API Documentation

Request Syntax

response = client.create_harvest_job(
    EndTime='string',
    Id='string',
    OriginEndpointId='string',
    S3Destination={
        'BucketName': 'string',
        'ManifestKey': 'string',
        'RoleArn': 'string'
    },
    StartTime='string'
)

Parameters

EndTime (string) -- [REQUIRED] The end of the time-window which will be harvested
Id (string) -- [REQUIRED] The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted
OriginEndpointId (string) -- [REQUIRED] The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
S3Destination (dict) --
[REQUIRED] Configuration parameters for where in an S3 bucket to place the harvested content
- BucketName (string) -- [REQUIRED] The name of an S3 bucket within which harvested content will be exported
- ManifestKey (string) -- [REQUIRED] The key in the specified S3 bucket where the harvested top-level manifest will be placed.
- RoleArn (string) -- [REQUIRED] The IAM role used to write to the specified S3 bucket
StartTime (string) -- [REQUIRED] The start of the time-window which will be harvested

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'ChannelId': 'string',
    'CreatedAt': 'string',
    'EndTime': 'string',
    'Id': 'string',
    'OriginEndpointId': 'string',
    'S3Destination': {
        'BucketName': 'string',
        'ManifestKey': 'string',
        'RoleArn': 'string'
    },
    'StartTime': 'string',
    'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}

Response Structure

(dict) -- A new HarvestJob record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the HarvestJob.
- ChannelId (string) -- The ID of the Channel that the HarvestJob will harvest from.
- CreatedAt (string) -- The time the HarvestJob was submitted
- EndTime (string) -- The end of the time-window which will be harvested.
- Id (string) -- The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
- OriginEndpointId (string) -- The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
- S3Destination (dict) -- Configuration parameters for where in an S3 bucket to place the harvested content
  - BucketName (string) -- The name of an S3 bucket within which harvested content will be exported
  - ManifestKey (string) -- The key in the specified S3 bucket where the harvested top-level manifest will be placed.
  - RoleArn (string) -- The IAM role used to write to the specified S3 bucket
- StartTime (string) -- The start of the time-window which will be harvested.
- Status (string) -- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

create_origin_endpoint(**kwargs)¶

Creates a new OriginEndpoint record.

See also: AWS API Documentation

Request Syntax

response = client.create_origin_endpoint(
    ChannelId='string',
    CmafPackage={
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Id': 'string',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123
            },
        ],
        'SegmentDurationSeconds': 123,
        'SegmentPrefix': 'string',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    DashPackage={
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestLayout': 'FULL'|'COMPACT',
        'ManifestWindowSeconds': 123,
        'MinBufferTimeSeconds': 123,
        'MinUpdatePeriodSeconds': 123,
        'PeriodTriggers': [
            'ADS',
        ],
        'Profile': 'NONE'|'HBBTV_1_5',
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'SuggestedPresentationDelaySeconds': 123
    },
    Description='string',
    HlsPackage={
        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'KeyRotationIntervalSeconds': 123,
            'RepeatExtXKey': True|False,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'IncludeIframeOnlyStream': True|False,
        'PlaylistType': 'NONE'|'EVENT'|'VOD',
        'PlaylistWindowSeconds': 123,
        'ProgramDateTimeIntervalSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'UseAudioRenditionGroup': True|False
    },
    Id='string',
    ManifestName='string',
    MssPackage={
        'Encryption': {
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestWindowSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    Origination='ALLOW'|'DENY',
    StartoverWindowSeconds=123,
    Tags={
        'string': 'string'
    },
    TimeDelaySeconds=123,
    Whitelist=[
        'string',
    ]
)

Parameters

ChannelId (string) -- [REQUIRED] The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.
CmafPackage (dict) --
A Common Media Application Format (CMAF) packaging configuration.
- Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
  - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- HlsManifests (list) -- A list of HLS manifest configurations
  - (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
    - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
    - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
      - (string) --
    - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
    - Id (string) -- [REQUIRED] The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
    - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
    - ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
    - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
    - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
    - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
- SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
DashPackage (dict) --
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
- AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
  - (string) --
- AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
- Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
  - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
- ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
- MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
- MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
- PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
  - (string) --
- Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
- SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
- SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
Description (string) -- A short text description of the OriginEndpoint.
HlsPackage (dict) --
An HTTP Live Streaming (HLS) packaging configuration.
- AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
- AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
  - (string) --
- AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
- Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
  - ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
  - EncryptionMethod (string) -- The encryption method to use.
  - KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
  - RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
- PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
- PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
- ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
- UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
Id (string) -- [REQUIRED] The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.
ManifestName (string) -- A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
MssPackage (dict) --
A Microsoft Smooth Streaming (MSS) packaging configuration.
- Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
- SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
Tags (dict) --
A collection of tags associated with a resource
- (string) --
  - (string) --
TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
Whitelist (list) --
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'ChannelId': 'string',
    'CmafPackage': {
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'Id': 'string',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123,
                'Url': 'string'
            },
        ],
        'SegmentDurationSeconds': 123,
        'SegmentPrefix': 'string',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'DashPackage': {
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestLayout': 'FULL'|'COMPACT',
        'ManifestWindowSeconds': 123,
        'MinBufferTimeSeconds': 123,
        'MinUpdatePeriodSeconds': 123,
        'PeriodTriggers': [
            'ADS',
        ],
        'Profile': 'NONE'|'HBBTV_1_5',
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'SuggestedPresentationDelaySeconds': 123
    },
    'Description': 'string',
    'HlsPackage': {
        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'KeyRotationIntervalSeconds': 123,
            'RepeatExtXKey': True|False,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'IncludeIframeOnlyStream': True|False,
        'PlaylistType': 'NONE'|'EVENT'|'VOD',
        'PlaylistWindowSeconds': 123,
        'ProgramDateTimeIntervalSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'UseAudioRenditionGroup': True|False
    },
    'Id': 'string',
    'ManifestName': 'string',
    'MssPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestWindowSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'Origination': 'ALLOW'|'DENY',
    'StartoverWindowSeconds': 123,
    'Tags': {
        'string': 'string'
    },
    'TimeDelaySeconds': 123,
    'Url': 'string',
    'Whitelist': [
        'string',
    ]
}

Response Structure

(dict) -- A new OriginEndpoint record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
- ChannelId (string) -- The ID of the Channel the OriginEndpoint is associated with.
- CmafPackage (dict) -- A Common Media Application Format (CMAF) packaging configuration.
  - Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - HlsManifests (list) -- A list of HLS manifest configurations
    - (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
      - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      - Id (string) -- The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
      - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
      - ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
      - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
      - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      - Url (string) -- The URL of the packaged OriginEndpoint for consumption.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
  - ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
  - MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
  - MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
  - PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
    - (string) --
  - Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
- Description (string) -- A short text description of the OriginEndpoint.
- HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.
  - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
    - ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
    - EncryptionMethod (string) -- The encryption method to use.
    - KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
    - RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
  - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
  - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
  - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
- Id (string) -- The ID of the OriginEndpoint.
- ManifestName (string) -- A short string appended to the end of the OriginEndpoint URL.
- MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) packaging configuration.
  - Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
  - SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
- StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --
- TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
- Url (string) -- The URL of the packaged OriginEndpoint for consumption.
- Whitelist (list) -- A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
  - (string) --

delete_channel(**kwargs)¶

Deletes an existing Channel.

See also: AWS API Documentation

Request Syntax

response = client.delete_channel(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the Channel to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) -- The Channel has been deleted.

delete_origin_endpoint(**kwargs)¶

Deletes an existing OriginEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.delete_origin_endpoint(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the OriginEndpoint to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

(dict) -- The OriginEndpoint has been deleted.

describe_channel(**kwargs)¶

Gets details about a Channel.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of a Channel.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- A Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

describe_harvest_job(**kwargs)¶

Gets details about an existing HarvestJob.

See also: AWS API Documentation

Request Syntax

response = client.describe_harvest_job(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the HarvestJob.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'ChannelId': 'string',
    'CreatedAt': 'string',
    'EndTime': 'string',
    'Id': 'string',
    'OriginEndpointId': 'string',
    'S3Destination': {
        'BucketName': 'string',
        'ManifestKey': 'string',
        'RoleArn': 'string'
    },
    'StartTime': 'string',
    'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
}

Response Structure

(dict) -- An HarvestJob record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the HarvestJob.
- ChannelId (string) -- The ID of the Channel that the HarvestJob will harvest from.
- CreatedAt (string) -- The time the HarvestJob was submitted
- EndTime (string) -- The end of the time-window which will be harvested.
- Id (string) -- The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
- OriginEndpointId (string) -- The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
- S3Destination (dict) -- Configuration parameters for where in an S3 bucket to place the harvested content
  - BucketName (string) -- The name of an S3 bucket within which harvested content will be exported
  - ManifestKey (string) -- The key in the specified S3 bucket where the harvested top-level manifest will be placed.
  - RoleArn (string) -- The IAM role used to write to the specified S3 bucket
- StartTime (string) -- The start of the time-window which will be harvested.
- Status (string) -- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

describe_origin_endpoint(**kwargs)¶

Gets details about an existing OriginEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.describe_origin_endpoint(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the OriginEndpoint.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'ChannelId': 'string',
    'CmafPackage': {
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'Id': 'string',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123,
                'Url': 'string'
            },
        ],
        'SegmentDurationSeconds': 123,
        'SegmentPrefix': 'string',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'DashPackage': {
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestLayout': 'FULL'|'COMPACT',
        'ManifestWindowSeconds': 123,
        'MinBufferTimeSeconds': 123,
        'MinUpdatePeriodSeconds': 123,
        'PeriodTriggers': [
            'ADS',
        ],
        'Profile': 'NONE'|'HBBTV_1_5',
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'SuggestedPresentationDelaySeconds': 123
    },
    'Description': 'string',
    'HlsPackage': {
        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'KeyRotationIntervalSeconds': 123,
            'RepeatExtXKey': True|False,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'IncludeIframeOnlyStream': True|False,
        'PlaylistType': 'NONE'|'EVENT'|'VOD',
        'PlaylistWindowSeconds': 123,
        'ProgramDateTimeIntervalSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'UseAudioRenditionGroup': True|False
    },
    'Id': 'string',
    'ManifestName': 'string',
    'MssPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestWindowSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'Origination': 'ALLOW'|'DENY',
    'StartoverWindowSeconds': 123,
    'Tags': {
        'string': 'string'
    },
    'TimeDelaySeconds': 123,
    'Url': 'string',
    'Whitelist': [
        'string',
    ]
}

Response Structure

(dict) -- An OriginEndpoint record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
- ChannelId (string) -- The ID of the Channel the OriginEndpoint is associated with.
- CmafPackage (dict) -- A Common Media Application Format (CMAF) packaging configuration.
  - Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - HlsManifests (list) -- A list of HLS manifest configurations
    - (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
      - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      - Id (string) -- The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
      - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
      - ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
      - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
      - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      - Url (string) -- The URL of the packaged OriginEndpoint for consumption.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
  - ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
  - MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
  - MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
  - PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
    - (string) --
  - Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
- Description (string) -- A short text description of the OriginEndpoint.
- HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.
  - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
    - ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
    - EncryptionMethod (string) -- The encryption method to use.
    - KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
    - RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
  - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
  - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
  - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
- Id (string) -- The ID of the OriginEndpoint.
- ManifestName (string) -- A short string appended to the end of the OriginEndpoint URL.
- MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) packaging configuration.
  - Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
  - SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
- StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --
- TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
- Url (string) -- The URL of the packaged OriginEndpoint for consumption.
- Whitelist (list) -- A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
  - (string) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶

Generate a presigned url given a client, its method, and arguments

Parameters

ClientMethod (string) -- The client method to presign for
Params (dict) -- The parameters normally passed to ClientMethod.
ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.

Returns

The presigned url

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: L{botocore.paginate.Paginator}
Returns: A paginator object.

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

list_channels(**kwargs)¶

Returns a collection of Channels.

See also: AWS API Documentation

Request Syntax

response = client.list_channels(
    MaxResults=123,
    NextToken='string'
)

Parameters

MaxResults (integer) -- Upper bound on number of records to return.
NextToken (string) -- A token used to resume pagination from the end of a previous request.

Return type

dict

Returns

Response Syntax

{
    'Channels': [
        {
            'Arn': 'string',
            'Description': 'string',
            'HlsIngest': {
                'IngestEndpoints': [
                    {
                        'Id': 'string',
                        'Password': 'string',
                        'Url': 'string',
                        'Username': 'string'
                    },
                ]
            },
            'Id': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- A collection of Channel records.
- Channels (list) -- A list of Channel records.
  - (dict) -- A Channel resource configuration.
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
    - Description (string) -- A short text description of the Channel.
    - HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
      - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
        
        (dict) -- An endpoint for ingesting source content for a Channel.
        
        Id (string) -- The system generated unique identifier for the IngestEndpoint
        
        Password (string) -- The system generated password for ingest authentication.
        
        Url (string) -- The ingest URL to which the source stream should be sent.
        
        Username (string) -- The system generated username for ingest authentication.
    - Id (string) -- The ID of the Channel.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --
- NextToken (string) -- A token that can be used to resume pagination from the end of the collection.

list_harvest_jobs(**kwargs)¶

Returns a collection of HarvestJob records.

See also: AWS API Documentation

Request Syntax

response = client.list_harvest_jobs(
    IncludeChannelId='string',
    IncludeStatus='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

IncludeChannelId (string) -- When specified, the request will return only HarvestJobs associated with the given Channel ID.
IncludeStatus (string) -- When specified, the request will return only HarvestJobs in the given status.
MaxResults (integer) -- The upper bound on the number of records to return.
NextToken (string) -- A token used to resume pagination from the end of a previous request.

Return type

dict

Returns

Response Syntax

{
    'HarvestJobs': [
        {
            'Arn': 'string',
            'ChannelId': 'string',
            'CreatedAt': 'string',
            'EndTime': 'string',
            'Id': 'string',
            'OriginEndpointId': 'string',
            'S3Destination': {
                'BucketName': 'string',
                'ManifestKey': 'string',
                'RoleArn': 'string'
            },
            'StartTime': 'string',
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- A collection of HarvestJob records.
- HarvestJobs (list) -- A list of HarvestJob records.
  - (dict) -- A HarvestJob resource configuration
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the HarvestJob.
    - ChannelId (string) -- The ID of the Channel that the HarvestJob will harvest from.
    - CreatedAt (string) -- The time the HarvestJob was submitted
    - EndTime (string) -- The end of the time-window which will be harvested.
    - Id (string) -- The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
    - OriginEndpointId (string) -- The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
    - S3Destination (dict) -- Configuration parameters for where in an S3 bucket to place the harvested content
      - BucketName (string) -- The name of an S3 bucket within which harvested content will be exported
      - ManifestKey (string) -- The key in the specified S3 bucket where the harvested top-level manifest will be placed.
      - RoleArn (string) -- The IAM role used to write to the specified S3 bucket
    - StartTime (string) -- The start of the time-window which will be harvested.
    - Status (string) -- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.
- NextToken (string) -- A token that can be used to resume pagination from the end of the collection.

list_origin_endpoints(**kwargs)¶

Returns a collection of OriginEndpoint records.

See also: AWS API Documentation

Request Syntax

response = client.list_origin_endpoints(
    ChannelId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

ChannelId (string) -- When specified, the request will return only OriginEndpoints associated with the given Channel ID.
MaxResults (integer) -- The upper bound on the number of records to return.
NextToken (string) -- A token used to resume pagination from the end of a previous request.

Return type

dict

Returns

Response Syntax

{
    'NextToken': 'string',
    'OriginEndpoints': [
        {
            'Arn': 'string',
            'ChannelId': 'string',
            'CmafPackage': {
                'Encryption': {
                    'KeyRotationIntervalSeconds': 123,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'HlsManifests': [
                    {
                        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                        'Id': 'string',
                        'IncludeIframeOnlyStream': True|False,
                        'ManifestName': 'string',
                        'PlaylistType': 'NONE'|'EVENT'|'VOD',
                        'PlaylistWindowSeconds': 123,
                        'ProgramDateTimeIntervalSeconds': 123,
                        'Url': 'string'
                    },
                ],
                'SegmentDurationSeconds': 123,
                'SegmentPrefix': 'string',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
            'DashPackage': {
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Encryption': {
                    'KeyRotationIntervalSeconds': 123,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'ManifestLayout': 'FULL'|'COMPACT',
                'ManifestWindowSeconds': 123,
                'MinBufferTimeSeconds': 123,
                'MinUpdatePeriodSeconds': 123,
                'PeriodTriggers': [
                    'ADS',
                ],
                'Profile': 'NONE'|'HBBTV_1_5',
                'SegmentDurationSeconds': 123,
                'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                },
                'SuggestedPresentationDelaySeconds': 123
            },
            'Description': 'string',
            'HlsPackage': {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Encryption': {
                    'ConstantInitializationVector': 'string',
                    'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
                    'KeyRotationIntervalSeconds': 123,
                    'RepeatExtXKey': True|False,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'IncludeIframeOnlyStream': True|False,
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123,
                'SegmentDurationSeconds': 123,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                },
                'UseAudioRenditionGroup': True|False
            },
            'Id': 'string',
            'ManifestName': 'string',
            'MssPackage': {
                'Encryption': {
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'ManifestWindowSeconds': 123,
                'SegmentDurationSeconds': 123,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
            'Origination': 'ALLOW'|'DENY',
            'StartoverWindowSeconds': 123,
            'Tags': {
                'string': 'string'
            },
            'TimeDelaySeconds': 123,
            'Url': 'string',
            'Whitelist': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) -- A collection of OriginEndpoint records.
- NextToken (string) -- A token that can be used to resume pagination from the end of the collection.
- OriginEndpoints (list) -- A list of OriginEndpoint records.
  - (dict) -- An OriginEndpoint resource configuration.
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
    - ChannelId (string) -- The ID of the Channel the OriginEndpoint is associated with.
    - CmafPackage (dict) -- A Common Media Application Format (CMAF) packaging configuration.
      - Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
        
        KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - HlsManifests (list) -- A list of HLS manifest configurations
        
        (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
        
        AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
        
        Id (string) -- The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
        
        IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
        
        ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
        
        PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
        
        PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
        
        ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
        
        Url (string) -- The URL of the packaged OriginEndpoint for consumption.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      - SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
    - DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
        
        (string) --
      - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
      - Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        
        KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
      - ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
      - MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
      - MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
      - PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
        
        (string) --
      - Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      - SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
      - SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
    - Description (string) -- A short text description of the OriginEndpoint.
    - HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.
      - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
        
        (string) --
      - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
      - Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
        
        ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
        
        EncryptionMethod (string) -- The encryption method to use.
        
        KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
        
        RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
      - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
      - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
      - UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
    - Id (string) -- The ID of the OriginEndpoint.
    - ManifestName (string) -- A short string appended to the end of the OriginEndpoint URL.
    - MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) packaging configuration.
      - Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
      - SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
    - Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
    - StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --
    - TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
    - Url (string) -- The URL of the packaged OriginEndpoint for consumption.
    - Whitelist (list) -- A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
      - (string) --

list_tags_for_resource(**kwargs)¶

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)

Parameters

ResourceArn (string) -- [REQUIRED]

Return type

dict

Returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- 200 response
- Tags (dict) --
  - (string) --
    - (string) --

rotate_channel_credentials(**kwargs)¶

Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.rotate_channel_credentials(
    Id='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the channel to update.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

rotate_ingest_endpoint_credentials(**kwargs)¶

Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.

See also: AWS API Documentation

Request Syntax

response = client.rotate_ingest_endpoint_credentials(
    Id='string',
    IngestEndpointId='string'
)

Parameters

Id (string) -- [REQUIRED] The ID of the channel the IngestEndpoint is on.
IngestEndpointId (string) -- [REQUIRED] The id of the IngestEndpoint whose credentials should be rotated

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

tag_resource(**kwargs)¶

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

Parameters

ResourceArn (string) -- [REQUIRED]
Tags (dict) --
[REQUIRED]
- (string) --
  - (string) --

Returns

None

untag_resource(**kwargs)¶

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

Parameters

ResourceArn (string) -- [REQUIRED]
TagKeys (list) --
[REQUIRED] The key(s) of tag to be deleted
- (string) --

Returns

None

update_channel(**kwargs)¶

Updates an existing Channel.

See also: AWS API Documentation

Request Syntax

response = client.update_channel(
    Description='string',
    Id='string'
)

Parameters

Description (string) -- A short text description of the Channel.
Id (string) -- [REQUIRED] The ID of the Channel to update.

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'Description': 'string',
    'HlsIngest': {
        'IngestEndpoints': [
            {
                'Id': 'string',
                'Password': 'string',
                'Url': 'string',
                'Username': 'string'
            },
        ]
    },
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- The updated Channel record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
- Description (string) -- A short text description of the Channel.
- HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
  - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
    - (dict) -- An endpoint for ingesting source content for a Channel.
      - Id (string) -- The system generated unique identifier for the IngestEndpoint
      - Password (string) -- The system generated password for ingest authentication.
      - Url (string) -- The ingest URL to which the source stream should be sent.
      - Username (string) -- The system generated username for ingest authentication.
- Id (string) -- The ID of the Channel.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --

update_origin_endpoint(**kwargs)¶

Updates an existing OriginEndpoint.

See also: AWS API Documentation

Request Syntax

response = client.update_origin_endpoint(
    CmafPackage={
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Id': 'string',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123
            },
        ],
        'SegmentDurationSeconds': 123,
        'SegmentPrefix': 'string',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    DashPackage={
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestLayout': 'FULL'|'COMPACT',
        'ManifestWindowSeconds': 123,
        'MinBufferTimeSeconds': 123,
        'MinUpdatePeriodSeconds': 123,
        'PeriodTriggers': [
            'ADS',
        ],
        'Profile': 'NONE'|'HBBTV_1_5',
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'SuggestedPresentationDelaySeconds': 123
    },
    Description='string',
    HlsPackage={
        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'KeyRotationIntervalSeconds': 123,
            'RepeatExtXKey': True|False,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'IncludeIframeOnlyStream': True|False,
        'PlaylistType': 'NONE'|'EVENT'|'VOD',
        'PlaylistWindowSeconds': 123,
        'ProgramDateTimeIntervalSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'UseAudioRenditionGroup': True|False
    },
    Id='string',
    ManifestName='string',
    MssPackage={
        'Encryption': {
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestWindowSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    Origination='ALLOW'|'DENY',
    StartoverWindowSeconds=123,
    TimeDelaySeconds=123,
    Whitelist=[
        'string',
    ]
)

Parameters

CmafPackage (dict) --
A Common Media Application Format (CMAF) packaging configuration.
- Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
  - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- HlsManifests (list) -- A list of HLS manifest configurations
  - (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
    - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
    - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
      - (string) --
    - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
    - Id (string) -- [REQUIRED] The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
    - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
    - ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
    - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
    - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
    - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
- SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
DashPackage (dict) --
A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
- AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
  - (string) --
- AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
- Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
  - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
- ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
- MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
- MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
- PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
  - (string) --
- Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
- SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
- SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
Description (string) -- A short text description of the OriginEndpoint.
HlsPackage (dict) --
An HTTP Live Streaming (HLS) packaging configuration.
- AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
- AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
  - (string) --
- AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
- Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
  - ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
  - EncryptionMethod (string) -- The encryption method to use.
  - KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
  - RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
- PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
- PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
- ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
- SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
- UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
Id (string) -- [REQUIRED] The ID of the OriginEndpoint to update.
ManifestName (string) -- A short string that will be appended to the end of the Endpoint URL.
MssPackage (dict) --
A Microsoft Smooth Streaming (MSS) packaging configuration.
- Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
  - SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
    - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
    - ResourceId (string) -- [REQUIRED] The resource ID to include in key requests.
    - RoleArn (string) -- [REQUIRED] An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
    - SystemIds (list) -- [REQUIRED] The system IDs to include in key requests.
      - (string) --
    - Url (string) -- [REQUIRED] The URL of the external key provider service.
- ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
- SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
- StreamSelection (dict) -- A StreamSelection configuration.
  - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
  - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
  - StreamOrder (string) -- A directive that determines the order of streams in the output.
Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
StartoverWindowSeconds (integer) -- Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
TimeDelaySeconds (integer) -- Amount of delay (in seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
Whitelist (list) --
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
- (string) --

Return type

dict

Returns

Response Syntax

{
    'Arn': 'string',
    'ChannelId': 'string',
    'CmafPackage': {
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'Id': 'string',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123,
                'Url': 'string'
            },
        ],
        'SegmentDurationSeconds': 123,
        'SegmentPrefix': 'string',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'DashPackage': {
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'KeyRotationIntervalSeconds': 123,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestLayout': 'FULL'|'COMPACT',
        'ManifestWindowSeconds': 123,
        'MinBufferTimeSeconds': 123,
        'MinUpdatePeriodSeconds': 123,
        'PeriodTriggers': [
            'ADS',
        ],
        'Profile': 'NONE'|'HBBTV_1_5',
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'SuggestedPresentationDelaySeconds': 123
    },
    'Description': 'string',
    'HlsPackage': {
        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
        'AdTriggers': [
            'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
        ],
        'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'KeyRotationIntervalSeconds': 123,
            'RepeatExtXKey': True|False,
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'IncludeIframeOnlyStream': True|False,
        'PlaylistType': 'NONE'|'EVENT'|'VOD',
        'PlaylistWindowSeconds': 123,
        'ProgramDateTimeIntervalSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        },
        'UseAudioRenditionGroup': True|False
    },
    'Id': 'string',
    'ManifestName': 'string',
    'MssPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'CertificateArn': 'string',
                'ResourceId': 'string',
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'ManifestWindowSeconds': 123,
        'SegmentDurationSeconds': 123,
        'StreamSelection': {
            'MaxVideoBitsPerSecond': 123,
            'MinVideoBitsPerSecond': 123,
            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
        }
    },
    'Origination': 'ALLOW'|'DENY',
    'StartoverWindowSeconds': 123,
    'Tags': {
        'string': 'string'
    },
    'TimeDelaySeconds': 123,
    'Url': 'string',
    'Whitelist': [
        'string',
    ]
}

Response Structure

(dict) -- An updated OriginEndpoint record.
- Arn (string) -- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
- ChannelId (string) -- The ID of the Channel the OriginEndpoint is associated with.
- CmafPackage (dict) -- A Common Media Application Format (CMAF) packaging configuration.
  - Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - HlsManifests (list) -- A list of HLS manifest configurations
    - (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
      - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      - Id (string) -- The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
      - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
      - ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
      - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
      - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      - Url (string) -- The URL of the packaged OriginEndpoint for consumption.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
    - KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
  - ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
  - MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
  - MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
  - PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
    - (string) --
  - Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
  - SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
- Description (string) -- A short text description of the OriginEndpoint.
- HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.
  - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
  - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
    - (string) --
  - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
  - Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
    - ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
    - EncryptionMethod (string) -- The encryption method to use.
    - KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
    - RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
  - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
  - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
  - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
  - SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
  - UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
- Id (string) -- The ID of the OriginEndpoint.
- ManifestName (string) -- A short string appended to the end of the OriginEndpoint URL.
- MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) packaging configuration.
  - Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
    - SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
      - CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
      - ResourceId (string) -- The resource ID to include in key requests.
      - RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
      - SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
      - Url (string) -- The URL of the external key provider service.
  - ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
  - SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
  - StreamSelection (dict) -- A StreamSelection configuration.
    - MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
    - MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
    - StreamOrder (string) -- A directive that determines the order of streams in the output.
- Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
- StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
- Tags (dict) -- A collection of tags associated with a resource
  - (string) --
    - (string) --
- TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
- Url (string) -- The URL of the packaged OriginEndpoint for consumption.
- Whitelist (list) -- A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
  - (string) --

Paginators ¶

The available paginators are:

MediaPackage.Paginator.ListChannels
MediaPackage.Paginator.ListHarvestJobs
MediaPackage.Paginator.ListOriginEndpoints

class MediaPackage.Paginator.ListChannels¶

paginator = client.get_paginator('list_channels')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MediaPackage.Client.list_channels().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

{
    'Channels': [
        {
            'Arn': 'string',
            'Description': 'string',
            'HlsIngest': {
                'IngestEndpoints': [
                    {
                        'Id': 'string',
                        'Password': 'string',
                        'Url': 'string',
                        'Username': 'string'
                    },
                ]
            },
            'Id': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

(dict) -- A collection of Channel records.
- Channels (list) -- A list of Channel records.
  - (dict) -- A Channel resource configuration.
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the Channel.
    - Description (string) -- A short text description of the Channel.
    - HlsIngest (dict) -- An HTTP Live Streaming (HLS) ingest resource configuration.
      - IngestEndpoints (list) -- A list of endpoints to which the source stream should be sent.
        
        (dict) -- An endpoint for ingesting source content for a Channel.
        
        Id (string) -- The system generated unique identifier for the IngestEndpoint
        
        Password (string) -- The system generated password for ingest authentication.
        
        Url (string) -- The ingest URL to which the source stream should be sent.
        
        Username (string) -- The system generated username for ingest authentication.
    - Id (string) -- The ID of the Channel.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --

class MediaPackage.Paginator.ListHarvestJobs¶

paginator = client.get_paginator('list_harvest_jobs')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MediaPackage.Client.list_harvest_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    IncludeChannelId='string',
    IncludeStatus='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

IncludeChannelId (string) -- When specified, the request will return only HarvestJobs associated with the given Channel ID.
IncludeStatus (string) -- When specified, the request will return only HarvestJobs in the given status.
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

{
    'HarvestJobs': [
        {
            'Arn': 'string',
            'ChannelId': 'string',
            'CreatedAt': 'string',
            'EndTime': 'string',
            'Id': 'string',
            'OriginEndpointId': 'string',
            'S3Destination': {
                'BucketName': 'string',
                'ManifestKey': 'string',
                'RoleArn': 'string'
            },
            'StartTime': 'string',
            'Status': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED'
        },
    ],

}

Response Structure

(dict) -- A collection of HarvestJob records.
- HarvestJobs (list) -- A list of HarvestJob records.
  - (dict) -- A HarvestJob resource configuration
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the HarvestJob.
    - ChannelId (string) -- The ID of the Channel that the HarvestJob will harvest from.
    - CreatedAt (string) -- The time the HarvestJob was submitted
    - EndTime (string) -- The end of the time-window which will be harvested.
    - Id (string) -- The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
    - OriginEndpointId (string) -- The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
    - S3Destination (dict) -- Configuration parameters for where in an S3 bucket to place the harvested content
      - BucketName (string) -- The name of an S3 bucket within which harvested content will be exported
      - ManifestKey (string) -- The key in the specified S3 bucket where the harvested top-level manifest will be placed.
      - RoleArn (string) -- The IAM role used to write to the specified S3 bucket
    - StartTime (string) -- The start of the time-window which will be harvested.
    - Status (string) -- The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed.

class MediaPackage.Paginator.ListOriginEndpoints¶

paginator = client.get_paginator('list_origin_endpoints')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from MediaPackage.Client.list_origin_endpoints().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ChannelId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ChannelId (string) -- When specified, the request will return only OriginEndpoints associated with the given Channel ID.
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

{
    'OriginEndpoints': [
        {
            'Arn': 'string',
            'ChannelId': 'string',
            'CmafPackage': {
                'Encryption': {
                    'KeyRotationIntervalSeconds': 123,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'HlsManifests': [
                    {
                        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                        'Id': 'string',
                        'IncludeIframeOnlyStream': True|False,
                        'ManifestName': 'string',
                        'PlaylistType': 'NONE'|'EVENT'|'VOD',
                        'PlaylistWindowSeconds': 123,
                        'ProgramDateTimeIntervalSeconds': 123,
                        'Url': 'string'
                    },
                ],
                'SegmentDurationSeconds': 123,
                'SegmentPrefix': 'string',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
            'DashPackage': {
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Encryption': {
                    'KeyRotationIntervalSeconds': 123,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'ManifestLayout': 'FULL'|'COMPACT',
                'ManifestWindowSeconds': 123,
                'MinBufferTimeSeconds': 123,
                'MinUpdatePeriodSeconds': 123,
                'PeriodTriggers': [
                    'ADS',
                ],
                'Profile': 'NONE'|'HBBTV_1_5',
                'SegmentDurationSeconds': 123,
                'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                },
                'SuggestedPresentationDelaySeconds': 123
            },
            'Description': 'string',
            'HlsPackage': {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'AdTriggers': [
                    'SPLICE_INSERT'|'BREAK'|'PROVIDER_ADVERTISEMENT'|'DISTRIBUTOR_ADVERTISEMENT'|'PROVIDER_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_PLACEMENT_OPPORTUNITY'|'PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY'|'DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY',
                ],
                'AdsOnDeliveryRestrictions': 'NONE'|'RESTRICTED'|'UNRESTRICTED'|'BOTH',
                'Encryption': {
                    'ConstantInitializationVector': 'string',
                    'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
                    'KeyRotationIntervalSeconds': 123,
                    'RepeatExtXKey': True|False,
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'IncludeIframeOnlyStream': True|False,
                'PlaylistType': 'NONE'|'EVENT'|'VOD',
                'PlaylistWindowSeconds': 123,
                'ProgramDateTimeIntervalSeconds': 123,
                'SegmentDurationSeconds': 123,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                },
                'UseAudioRenditionGroup': True|False
            },
            'Id': 'string',
            'ManifestName': 'string',
            'MssPackage': {
                'Encryption': {
                    'SpekeKeyProvider': {
                        'CertificateArn': 'string',
                        'ResourceId': 'string',
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'ManifestWindowSeconds': 123,
                'SegmentDurationSeconds': 123,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
            'Origination': 'ALLOW'|'DENY',
            'StartoverWindowSeconds': 123,
            'Tags': {
                'string': 'string'
            },
            'TimeDelaySeconds': 123,
            'Url': 'string',
            'Whitelist': [
                'string',
            ]
        },
    ]
}

Response Structure

(dict) -- A collection of OriginEndpoint records.
- OriginEndpoints (list) -- A list of OriginEndpoint records.
  - (dict) -- An OriginEndpoint resource configuration.
    - Arn (string) -- The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
    - ChannelId (string) -- The ID of the Channel the OriginEndpoint is associated with.
    - CmafPackage (dict) -- A Common Media Application Format (CMAF) packaging configuration.
      - Encryption (dict) -- A Common Media Application Format (CMAF) encryption configuration.
        
        KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - HlsManifests (list) -- A list of HLS manifest configurations
        
        (dict) -- A HTTP Live Streaming (HLS) manifest configuration.
        
        AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
        
        Id (string) -- The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
        
        IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
        
        ManifestName (string) -- An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
        
        PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
        
        PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
        
        ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
        
        Url (string) -- The URL of the packaged OriginEndpoint for consumption.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      - SegmentPrefix (string) -- An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
    - DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
        
        (string) --
      - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
      - Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        
        KeyRotationIntervalSeconds (integer) -- Time (in seconds) between each encryption key rotation.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - ManifestLayout (string) -- Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
      - ManifestWindowSeconds (integer) -- Time window (in seconds) contained in each manifest.
      - MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.
      - MinUpdatePeriodSeconds (integer) -- Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
      - PeriodTriggers (list) -- A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.
        
        (string) --
      - Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      - SegmentTemplateFormat (string) -- Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
      - SuggestedPresentationDelaySeconds (integer) -- Duration (in seconds) to delay live content before presentation.
    - Description (string) -- A short text description of the OriginEndpoint.
    - HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.
      - AdMarkers (string) -- This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.
      - AdTriggers (list) -- A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.
        
        (string) --
      - AdsOnDeliveryRestrictions (string) -- This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.
      - Encryption (dict) -- An HTTP Live Streaming (HLS) encryption configuration.
        
        ConstantInitializationVector (string) -- A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
        
        EncryptionMethod (string) -- The encryption method to use.
        
        KeyRotationIntervalSeconds (integer) -- Interval (in seconds) between each encryption key rotation.
        
        RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.
      - PlaylistType (string) -- The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.
      - PlaylistWindowSeconds (integer) -- Time window (in seconds) contained in each parent manifest.
      - ProgramDateTimeIntervalSeconds (integer) -- The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
      - SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
      - UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.
    - Id (string) -- The ID of the OriginEndpoint.
    - ManifestName (string) -- A short string appended to the end of the OriginEndpoint URL.
    - MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) packaging configuration.
      - Encryption (dict) -- A Microsoft Smooth Streaming (MSS) encryption configuration.
        
        SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        
        CertificateArn (string) -- An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.
        
        ResourceId (string) -- The resource ID to include in key requests.
        
        RoleArn (string) -- An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        
        SystemIds (list) -- The system IDs to include in key requests.
        
        (string) --
        
        Url (string) -- The URL of the external key provider service.
      - ManifestWindowSeconds (integer) -- The time window (in seconds) contained in each manifest.
      - SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.
      - StreamSelection (dict) -- A StreamSelection configuration.
        
        MaxVideoBitsPerSecond (integer) -- The maximum video bitrate (bps) to include in output.
        
        MinVideoBitsPerSecond (integer) -- The minimum video bitrate (bps) to include in output.
        
        StreamOrder (string) -- A directive that determines the order of streams in the output.
    - Origination (string) -- Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination
    - StartoverWindowSeconds (integer) -- Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
    - Tags (dict) -- A collection of tags associated with a resource
      - (string) --
        
        (string) --
    - TimeDelaySeconds (integer) -- Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
    - Url (string) -- The URL of the packaged OriginEndpoint for consumption.
    - Whitelist (list) -- A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
      - (string) --

Navigation

Table Of Contents

MediaPackage¶

Client¶

Paginators¶

Navigation

MediaPackage ¶

Client ¶

Paginators ¶