AWS Elemental MediaPackage VOD

2020/04/23 - AWS Elemental MediaPackage VOD - 3 new 9 updated api methods

Changes  Adds tagging support for PackagingGroups, PackagingConfigurations, and Assets

ListTagsForResource (new) Link ¶

List tags for a given MediaPackage VOD resource

See also: AWS API Documentation

Request Syntax

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

string

param ResourceArn

[REQUIRED]

rtype

dict

returns

Response Syntax

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

Response Structure

  • (dict) -- 200 response

    • Tags (dict) --

      • (string) --

        • (string) --

TagResource (new) Link ¶

Set tags for a given MediaPackage VOD resource

See also: AWS API Documentation

Request Syntax

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

string

param ResourceArn

[REQUIRED]

type Tags

dict

param Tags

[REQUIRED]

  • (string) --

    • (string) --

returns

None

UntagResource (new) Link ¶

Delete tags for a given MediaPackage VOD resource

See also: AWS API Documentation

Request Syntax

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

string

param ResourceArn

[REQUIRED]

type TagKeys

list

param TagKeys

[REQUIRED] The key(s) of tag to be deleted

  • (string) --

returns

None

CreateAsset (updated) Link ¶
Changes (both)
{'Tags': {'string': 'string'}}

Creates a new MediaPackage VOD Asset resource.

See also: AWS API Documentation

Request Syntax

client.create_asset(
    Id='string',
    PackagingGroupId='string',
    ResourceId='string',
    SourceArn='string',
    SourceRoleArn='string',
    Tags={
        'string': 'string'
    }
)
type Id

string

param Id

[REQUIRED] The unique identifier for the Asset.

type PackagingGroupId

string

param PackagingGroupId

[REQUIRED] The ID of the PackagingGroup for the Asset.

type ResourceId

string

param ResourceId

The resource ID to include in SPEKE key requests.

type SourceArn

string

param SourceArn

[REQUIRED] ARN of the source object in S3.

type SourceRoleArn

string

param SourceRoleArn

[REQUIRED] The IAM role ARN used to access the source S3 bucket.

type Tags

dict

param Tags

A collection of tags associated with a resource

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': 'string',
    'EgressEndpoints': [
        {
            'PackagingConfigurationId': 'string',
            'Url': 'string'
        },
    ],
    'Id': 'string',
    'PackagingGroupId': 'string',
    'ResourceId': 'string',
    'SourceArn': 'string',
    'SourceRoleArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- The new MediaPackage VOD Asset resource.

    • Arn (string) -- The ARN of the Asset.

    • CreatedAt (string) -- The time the Asset was initially submitted for Ingest.

    • EgressEndpoints (list) -- The list of egress endpoints available for the Asset.

      • (dict) -- The endpoint URL used to access an Asset using one PackagingConfiguration.

        • PackagingConfigurationId (string) -- The ID of the PackagingConfiguration being applied to the Asset.

        • Url (string) -- The URL of the parent manifest for the repackaged Asset.

    • Id (string) -- The unique identifier for the Asset.

    • PackagingGroupId (string) -- The ID of the PackagingGroup for the Asset.

    • ResourceId (string) -- The resource ID to include in SPEKE key requests.

    • SourceArn (string) -- ARN of the source object in S3.

    • SourceRoleArn (string) -- The IAM role_arn used to access the source S3 bucket.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

CreatePackagingConfiguration (updated) Link ¶
Changes (both)
{'Tags': {'string': 'string'}}

Creates a new MediaPackage VOD PackagingConfiguration resource.

See also: AWS API Documentation

Request Syntax

client.create_packaging_configuration(
    CmafPackage={
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    DashPackage={
        'DashManifests': [
            {
                'ManifestLayout': 'FULL'|'COMPACT',
                'ManifestName': 'string',
                'MinBufferTimeSeconds': 123,
                'Profile': 'NONE'|'HBBTV_1_5',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'PeriodTriggers': [
            'ADS',
        ],
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION'
    },
    HlsPackage={
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123,
        'UseAudioRenditionGroup': True|False
    },
    Id='string',
    MssPackage={
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'MssManifests': [
            {
                'ManifestName': 'string',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    PackagingGroupId='string',
    Tags={
        'string': 'string'
    }
)
type CmafPackage

dict

param CmafPackage

A CMAF packaging configuration.

  • Encryption (dict) -- A CMAF encryption configuration.

    • SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

      • 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) -- [REQUIRED] A list of HLS manifest configurations.

    • (dict) -- An 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.

      • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

      • ManifestName (string) -- An optional string to include in the name of the 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.

      • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

      • 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.

  • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

type DashPackage

dict

param DashPackage

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

  • DashManifests (list) -- [REQUIRED] A list of DASH manifest configurations.

    • (dict) -- A DASH manifest configuration.

      • 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.

      • ManifestName (string) -- An optional string to include in the name of the manifest.

      • MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.

      • Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

      • 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.

  • Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

    • SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

      • 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.

  • 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 Asset contains SCTE-35 ad markers.

    • (string) --

  • 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.

type HlsPackage

dict

param HlsPackage

An HTTP Live Streaming (HLS) packaging configuration.

  • 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.

    • SpekeKeyProvider (dict) -- [REQUIRED] A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

      • 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) -- [REQUIRED] A list of HLS manifest configurations.

    • (dict) -- An 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.

      • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

      • ManifestName (string) -- An optional string to include in the name of the 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.

      • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

      • 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.

  • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

  • UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.

type Id

string

param Id

[REQUIRED] The ID of the PackagingConfiguration.

type MssPackage

dict

param MssPackage

A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

  • 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.

      • 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.

  • MssManifests (list) -- [REQUIRED] A list of MSS manifest configurations.

    • (dict) -- A Microsoft Smooth Streaming (MSS) manifest configuration.

      • ManifestName (string) -- An optional string to include in the name of the manifest.

      • 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.

  • SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.

type PackagingGroupId

string

param PackagingGroupId

[REQUIRED] The ID of a PackagingGroup.

type Tags

dict

param Tags

A collection of tags associated with a resource

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CmafPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    'DashPackage': {
        'DashManifests': [
            {
                'ManifestLayout': 'FULL'|'COMPACT',
                'ManifestName': 'string',
                'MinBufferTimeSeconds': 123,
                'Profile': 'NONE'|'HBBTV_1_5',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'PeriodTriggers': [
            'ADS',
        ],
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION'
    },
    'HlsPackage': {
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123,
        'UseAudioRenditionGroup': True|False
    },
    'Id': 'string',
    'MssPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'MssManifests': [
            {
                'ManifestName': 'string',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    'PackagingGroupId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- The new MediaPackage VOD PackagingConfiguration resource.

    • Arn (string) -- The ARN of the PackagingConfiguration.

    • CmafPackage (dict) -- A CMAF packaging configuration.

      • Encryption (dict) -- A CMAF encryption configuration.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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) -- An 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.

          • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

          • ManifestName (string) -- An optional string to include in the name of the 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.

          • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

          • 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.

      • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

    • DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

      • DashManifests (list) -- A list of DASH manifest configurations.

        • (dict) -- A DASH manifest configuration.

          • 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.

          • ManifestName (string) -- An optional string to include in the name of the manifest.

          • MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.

          • Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

          • 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.

      • Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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.

      • 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 Asset contains SCTE-35 ad markers.

        • (string) --

      • 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.

    • HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.

      • 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.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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) -- An 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.

          • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

          • ManifestName (string) -- An optional string to include in the name of the 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.

          • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

          • 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.

      • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

      • UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.

    • Id (string) -- The ID of the PackagingConfiguration.

    • MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

      • 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.

          • 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.

      • MssManifests (list) -- A list of MSS manifest configurations.

        • (dict) -- A Microsoft Smooth Streaming (MSS) manifest configuration.

          • ManifestName (string) -- An optional string to include in the name of the manifest.

          • 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.

      • SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.

    • PackagingGroupId (string) -- The ID of a PackagingGroup.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

CreatePackagingGroup (updated) Link ¶
Changes (both)
{'Tags': {'string': 'string'}}

Creates a new MediaPackage VOD PackagingGroup resource.

See also: AWS API Documentation

Request Syntax

client.create_packaging_group(
    Id='string',
    Tags={
        'string': 'string'
    }
)
type Id

string

param Id

[REQUIRED] The ID of the PackagingGroup.

type Tags

dict

param Tags

A collection of tags associated with a resource

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'DomainName': 'string',
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- The new MediaPackage VOD PackagingGroup resource.

    • Arn (string) -- The ARN of the PackagingGroup.

    • DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.

    • Id (string) -- The ID of the PackagingGroup.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

DescribeAsset (updated) Link ¶
Changes (response)
{'Tags': {'string': 'string'}}

Returns a description of a MediaPackage VOD Asset resource.

See also: AWS API Documentation

Request Syntax

client.describe_asset(
    Id='string'
)
type Id

string

param Id

[REQUIRED] The ID of an MediaPackage VOD Asset resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': 'string',
    'EgressEndpoints': [
        {
            'PackagingConfigurationId': 'string',
            'Url': 'string'
        },
    ],
    'Id': 'string',
    'PackagingGroupId': 'string',
    'ResourceId': 'string',
    'SourceArn': 'string',
    'SourceRoleArn': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- A MediaPackage VOD Asset resource.

    • Arn (string) -- The ARN of the Asset.

    • CreatedAt (string) -- The time the Asset was initially submitted for Ingest.

    • EgressEndpoints (list) -- The list of egress endpoints available for the Asset.

      • (dict) -- The endpoint URL used to access an Asset using one PackagingConfiguration.

        • PackagingConfigurationId (string) -- The ID of the PackagingConfiguration being applied to the Asset.

        • Url (string) -- The URL of the parent manifest for the repackaged Asset.

    • Id (string) -- The unique identifier for the Asset.

    • PackagingGroupId (string) -- The ID of the PackagingGroup for the Asset.

    • ResourceId (string) -- The resource ID to include in SPEKE key requests.

    • SourceArn (string) -- ARN of the source object in S3.

    • SourceRoleArn (string) -- The IAM role_arn used to access the source S3 bucket.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

DescribePackagingConfiguration (updated) Link ¶
Changes (response)
{'Tags': {'string': 'string'}}

Returns a description of a MediaPackage VOD PackagingConfiguration resource.

See also: AWS API Documentation

Request Syntax

client.describe_packaging_configuration(
    Id='string'
)
type Id

string

param Id

[REQUIRED] The ID of a MediaPackage VOD PackagingConfiguration resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'CmafPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    'DashPackage': {
        'DashManifests': [
            {
                'ManifestLayout': 'FULL'|'COMPACT',
                'ManifestName': 'string',
                'MinBufferTimeSeconds': 123,
                'Profile': 'NONE'|'HBBTV_1_5',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'PeriodTriggers': [
            'ADS',
        ],
        'SegmentDurationSeconds': 123,
        'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION'
    },
    'HlsPackage': {
        'Encryption': {
            'ConstantInitializationVector': 'string',
            'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'HlsManifests': [
            {
                'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                'IncludeIframeOnlyStream': True|False,
                'ManifestName': 'string',
                'ProgramDateTimeIntervalSeconds': 123,
                'RepeatExtXKey': True|False,
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123,
        'UseAudioRenditionGroup': True|False
    },
    'Id': 'string',
    'MssPackage': {
        'Encryption': {
            'SpekeKeyProvider': {
                'RoleArn': 'string',
                'SystemIds': [
                    'string',
                ],
                'Url': 'string'
            }
        },
        'MssManifests': [
            {
                'ManifestName': 'string',
                'StreamSelection': {
                    'MaxVideoBitsPerSecond': 123,
                    'MinVideoBitsPerSecond': 123,
                    'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                }
            },
        ],
        'SegmentDurationSeconds': 123
    },
    'PackagingGroupId': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- A MediaPackage VOD PackagingConfiguration resource.

    • Arn (string) -- The ARN of the PackagingConfiguration.

    • CmafPackage (dict) -- A CMAF packaging configuration.

      • Encryption (dict) -- A CMAF encryption configuration.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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) -- An 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.

          • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

          • ManifestName (string) -- An optional string to include in the name of the 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.

          • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

          • 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.

      • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

    • DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

      • DashManifests (list) -- A list of DASH manifest configurations.

        • (dict) -- A DASH manifest configuration.

          • 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.

          • ManifestName (string) -- An optional string to include in the name of the manifest.

          • MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.

          • Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

          • 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.

      • Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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.

      • 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 Asset contains SCTE-35 ad markers.

        • (string) --

      • 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.

    • HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.

      • 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.

        • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

          • 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) -- An 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.

          • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

          • ManifestName (string) -- An optional string to include in the name of the 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.

          • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

          • 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.

      • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

      • UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.

    • Id (string) -- The ID of the PackagingConfiguration.

    • MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

      • 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.

          • 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.

      • MssManifests (list) -- A list of MSS manifest configurations.

        • (dict) -- A Microsoft Smooth Streaming (MSS) manifest configuration.

          • ManifestName (string) -- An optional string to include in the name of the manifest.

          • 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.

      • SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.

    • PackagingGroupId (string) -- The ID of a PackagingGroup.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

DescribePackagingGroup (updated) Link ¶
Changes (response)
{'Tags': {'string': 'string'}}

Returns a description of a MediaPackage VOD PackagingGroup resource.

See also: AWS API Documentation

Request Syntax

client.describe_packaging_group(
    Id='string'
)
type Id

string

param Id

[REQUIRED] The ID of a MediaPackage VOD PackagingGroup resource.

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'DomainName': 'string',
    'Id': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) -- A MediaPackage VOD PackagingGroup resource.

    • Arn (string) -- The ARN of the PackagingGroup.

    • DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.

    • Id (string) -- The ID of the PackagingGroup.

    • Tags (dict) -- A collection of tags associated with a resource

      • (string) --

        • (string) --

ListAssets (updated) Link ¶
Changes (response)
{'Assets': {'Tags': {'string': 'string'}}}

Returns a collection of MediaPackage VOD Asset resources.

See also: AWS API Documentation

Request Syntax

client.list_assets(
    MaxResults=123,
    NextToken='string',
    PackagingGroupId='string'
)
type MaxResults

integer

param MaxResults

Upper bound on number of records to return.

type NextToken

string

param NextToken

A token used to resume pagination from the end of a previous request.

type PackagingGroupId

string

param PackagingGroupId

Returns Assets associated with the specified PackagingGroup.

rtype

dict

returns

Response Syntax

{
    'Assets': [
        {
            'Arn': 'string',
            'CreatedAt': 'string',
            'Id': 'string',
            'PackagingGroupId': 'string',
            'ResourceId': 'string',
            'SourceArn': 'string',
            'SourceRoleArn': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) -- A collection of MediaPackage VOD Asset resources.

    • Assets (list) -- A list of MediaPackage VOD Asset resources.

      • (dict) -- A MediaPackage VOD Asset resource.

        • Arn (string) -- The ARN of the Asset.

        • CreatedAt (string) -- The time the Asset was initially submitted for Ingest.

        • Id (string) -- The unique identifier for the Asset.

        • PackagingGroupId (string) -- The ID of the PackagingGroup for the Asset.

        • ResourceId (string) -- The resource ID to include in SPEKE key requests.

        • SourceArn (string) -- ARN of the source object in S3.

        • SourceRoleArn (string) -- The IAM role ARN used to access the source S3 bucket.

        • 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.

ListPackagingConfigurations (updated) Link ¶
Changes (response)
{'PackagingConfigurations': {'Tags': {'string': 'string'}}}

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

See also: AWS API Documentation

Request Syntax

client.list_packaging_configurations(
    MaxResults=123,
    NextToken='string',
    PackagingGroupId='string'
)
type MaxResults

integer

param MaxResults

Upper bound on number of records to return.

type NextToken

string

param NextToken

A token used to resume pagination from the end of a previous request.

type PackagingGroupId

string

param PackagingGroupId

Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'PackagingConfigurations': [
        {
            'Arn': 'string',
            'CmafPackage': {
                'Encryption': {
                    'SpekeKeyProvider': {
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'HlsManifests': [
                    {
                        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                        'IncludeIframeOnlyStream': True|False,
                        'ManifestName': 'string',
                        'ProgramDateTimeIntervalSeconds': 123,
                        'RepeatExtXKey': True|False,
                        'StreamSelection': {
                            'MaxVideoBitsPerSecond': 123,
                            'MinVideoBitsPerSecond': 123,
                            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                        }
                    },
                ],
                'SegmentDurationSeconds': 123
            },
            'DashPackage': {
                'DashManifests': [
                    {
                        'ManifestLayout': 'FULL'|'COMPACT',
                        'ManifestName': 'string',
                        'MinBufferTimeSeconds': 123,
                        'Profile': 'NONE'|'HBBTV_1_5',
                        'StreamSelection': {
                            'MaxVideoBitsPerSecond': 123,
                            'MinVideoBitsPerSecond': 123,
                            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                        }
                    },
                ],
                'Encryption': {
                    'SpekeKeyProvider': {
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'PeriodTriggers': [
                    'ADS',
                ],
                'SegmentDurationSeconds': 123,
                'SegmentTemplateFormat': 'NUMBER_WITH_TIMELINE'|'TIME_WITH_TIMELINE'|'NUMBER_WITH_DURATION'
            },
            'HlsPackage': {
                'Encryption': {
                    'ConstantInitializationVector': 'string',
                    'EncryptionMethod': 'AES_128'|'SAMPLE_AES',
                    'SpekeKeyProvider': {
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'HlsManifests': [
                    {
                        'AdMarkers': 'NONE'|'SCTE35_ENHANCED'|'PASSTHROUGH',
                        'IncludeIframeOnlyStream': True|False,
                        'ManifestName': 'string',
                        'ProgramDateTimeIntervalSeconds': 123,
                        'RepeatExtXKey': True|False,
                        'StreamSelection': {
                            'MaxVideoBitsPerSecond': 123,
                            'MinVideoBitsPerSecond': 123,
                            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                        }
                    },
                ],
                'SegmentDurationSeconds': 123,
                'UseAudioRenditionGroup': True|False
            },
            'Id': 'string',
            'MssPackage': {
                'Encryption': {
                    'SpekeKeyProvider': {
                        'RoleArn': 'string',
                        'SystemIds': [
                            'string',
                        ],
                        'Url': 'string'
                    }
                },
                'MssManifests': [
                    {
                        'ManifestName': 'string',
                        'StreamSelection': {
                            'MaxVideoBitsPerSecond': 123,
                            'MinVideoBitsPerSecond': 123,
                            'StreamOrder': 'ORIGINAL'|'VIDEO_BITRATE_ASCENDING'|'VIDEO_BITRATE_DESCENDING'
                        }
                    },
                ],
                'SegmentDurationSeconds': 123
            },
            'PackagingGroupId': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) -- A collection of MediaPackage VOD PackagingConfiguration resources.

    • NextToken (string) -- A token that can be used to resume pagination from the end of the collection.

    • PackagingConfigurations (list) -- A list of MediaPackage VOD PackagingConfiguration resources.

      • (dict) -- A MediaPackage VOD PackagingConfiguration resource.

        • Arn (string) -- The ARN of the PackagingConfiguration.

        • CmafPackage (dict) -- A CMAF packaging configuration.

          • Encryption (dict) -- A CMAF encryption configuration.

            • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

              • 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) -- An 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.

              • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

              • ManifestName (string) -- An optional string to include in the name of the 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.

              • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

              • 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.

          • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

        • DashPackage (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

          • DashManifests (list) -- A list of DASH manifest configurations.

            • (dict) -- A DASH manifest configuration.

              • 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.

              • ManifestName (string) -- An optional string to include in the name of the manifest.

              • MinBufferTimeSeconds (integer) -- Minimum duration (in seconds) that a player will buffer media before starting the presentation.

              • Profile (string) -- The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

              • 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.

          • Encryption (dict) -- A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

            • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

              • 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.

          • 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 Asset contains SCTE-35 ad markers.

            • (string) --

          • 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.

        • HlsPackage (dict) -- An HTTP Live Streaming (HLS) packaging configuration.

          • 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.

            • SpekeKeyProvider (dict) -- A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

              • 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) -- An 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.

              • IncludeIframeOnlyStream (boolean) -- When enabled, an I-Frame only stream will be included in the output.

              • ManifestName (string) -- An optional string to include in the name of the 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.

              • RepeatExtXKey (boolean) -- When enabled, the EXT-X-KEY tag will be repeated in output manifests.

              • 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.

          • SegmentDurationSeconds (integer) -- Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.

          • UseAudioRenditionGroup (boolean) -- When enabled, audio streams will be placed in rendition groups in the output.

        • Id (string) -- The ID of the PackagingConfiguration.

        • MssPackage (dict) -- A Microsoft Smooth Streaming (MSS) PackagingConfiguration.

          • 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.

              • 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.

          • MssManifests (list) -- A list of MSS manifest configurations.

            • (dict) -- A Microsoft Smooth Streaming (MSS) manifest configuration.

              • ManifestName (string) -- An optional string to include in the name of the manifest.

              • 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.

          • SegmentDurationSeconds (integer) -- The duration (in seconds) of each segment.

        • PackagingGroupId (string) -- The ID of a PackagingGroup.

        • Tags (dict) -- A collection of tags associated with a resource

          • (string) --

            • (string) --

ListPackagingGroups (updated) Link ¶
Changes (response)
{'PackagingGroups': {'Tags': {'string': 'string'}}}

Returns a collection of MediaPackage VOD PackagingGroup resources.

See also: AWS API Documentation

Request Syntax

client.list_packaging_groups(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

Upper bound on number of records to return.

type NextToken

string

param NextToken

A token used to resume pagination from the end of a previous request.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'PackagingGroups': [
        {
            'Arn': 'string',
            'DomainName': 'string',
            'Id': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) -- A collection of MediaPackage VOD PackagingGroup resources.

    • NextToken (string) -- A token that can be used to resume pagination from the end of the collection.

    • PackagingGroups (list) -- A list of MediaPackage VOD PackagingGroup resources.

      • (dict) -- A MediaPackage VOD PackagingGroup resource.

        • Arn (string) -- The ARN of the PackagingGroup.

        • DomainName (string) -- The fully qualified domain name for Assets in the PackagingGroup.

        • Id (string) -- The ID of the PackagingGroup.

        • Tags (dict) -- A collection of tags associated with a resource

          • (string) --

            • (string) --