Packaging_configurations
URI
/packaging_configurations
HTTP methods
GET
Operation ID: ListPackagingConfigurations
Lists packaging configurations that match a set of filters that you define.
Name | Type | Required | Description |
---|---|---|---|
packagingGroupId | String | False | Limits the results to records that are associated with the given packaging group. |
nextToken | String | False | Pagination token. Use this token to request the next page of record results. |
maxResults | String | False | Upper bound on number of records to return. |
Status code | Response model | Description |
---|---|---|
200 | PackagingConfigurationList |
The list of tags is returned successfully. |
403 | None |
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. |
404 | None |
AWS Elemental MediaPackage did not find a representation of the target resource. |
422 | None |
AWS Elemental MediaPackage could not process the instructions in the body of the request. |
429 | None |
Too many requests have been sent in a given amount of time. |
500 | None |
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. |
503 | None |
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. |
POST
Operation ID: CreatePackagingConfiguration
Creates a packaging configuration in a packaging group.
The packaging configuration represents a single delivery point for an asset. It determines how the output from this endpoint is formatted.
Status code | Response model | Description |
---|---|---|
200 | PackagingConfiguration |
The list of tags is returned successfully. |
403 | None |
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials. |
404 | None |
AWS Elemental MediaPackage did not find a representation of the target resource. |
422 | None |
AWS Elemental MediaPackage could not process the instructions in the body of the request. |
429 | None |
Too many requests have been sent in a given amount of time. |
500 | None |
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request. |
503 | None |
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance. |
OPTIONS
Enable cross-origin resource sharing (CORS) by returning correct headers.
Status code | Response model | Description |
---|---|---|
200 | None |
The list of tags is returned successfully. |
Schemas
Request bodies
{ "packagingGroupId": "string", "dashPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "segmentTemplateFormat": enum, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "dashManifests": [ { "minBufferTimeSeconds": integer, "manifestName": "string", "profile": enum, "manifestLayout": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "scteMarkersSource": enum } ] }, "id": "string", "cmafPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ] }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ], "includeDvbSubtitles": boolean }, "mssPackage": { "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "mssManifests": [ { "manifestName": "string", "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } ] }, "tags": { } }
Response bodies
{ "nextToken": "string", "packagingConfigurations": [ { "createdAt": "string", "packagingGroupId": "string", "dashPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "segmentTemplateFormat": enum, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "dashManifests": [ { "minBufferTimeSeconds": integer, "manifestName": "string", "profile": enum, "manifestLayout": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "scteMarkersSource": enum } ] }, "id": "string", "arn": "string", "cmafPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ] }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ], "includeDvbSubtitles": boolean }, "mssPackage": { "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "mssManifests": [ { "manifestName": "string", "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } ] }, "tags": { } } ] }
{ "createdAt": "string", "packagingGroupId": "string", "dashPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "segmentTemplateFormat": enum, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "dashManifests": [ { "minBufferTimeSeconds": integer, "manifestName": "string", "profile": enum, "manifestLayout": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "scteMarkersSource": enum } ] }, "id": "string", "arn": "string", "cmafPackage": { "includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ] }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "repeatExtXKey": boolean, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean } ], "includeDvbSubtitles": boolean }, "mssPackage": { "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "mssManifests": [ { "manifestName": "string", "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } ] }, "tags": { } }
Properties
CmafEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
Property | Type | Required | Description |
---|---|---|---|
constantInitializationVector | string | False | An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV). |
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
CmafPackage
Parameters for a packaging configuration that uses Common Media Application Format (CMAF) packaging.
Property | Type | Required | Description |
---|---|---|---|
encryption | False | Parameters for encrypting content. | |
hlsManifests | Array of type HlsManifest | True | A list of HLS manifest configurations available from this endpoint. |
includeEncoderConfigurationInSegments | boolean | False | When true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback. |
segmentDurationSeconds | integer | False | Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source fragment duration. |
DashEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
Property | Type | Required | Description |
---|---|---|---|
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
DashManifest
Parameters for a DASH manifest.
Property | Type | Required | Description |
---|---|---|---|
manifestLayout | string Values: | False | Determines the position of some tags in the Media Presentation Description (MPD). Value description:
|
manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration. |
minBufferTimeSeconds | integer | False | Minimum amount of content (measured in seconds) that a player must keep available in the buffer. |
profile | string Values: | False | The DASH profile type for the ouput. Value description:
|
scteMarkersSource | string Values: | False | The source of scte markers used. Value description:
|
streamSelection | False | Limitations for outputs from the endpoint, based on the video bitrate. |
DashPackage
Parameters for a packaging configuration that uses DASH packaging.
Property | Type | Required | Description |
---|---|---|---|
dashManifests | Array of type DashManifest | True | A list of DASH manifest configurations available from this endpoint. |
encryption | False | Parameters for encrypting content. | |
includeEncoderConfigurationInSegments | boolean | False | When true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback. |
includeIframeOnlyStream | boolean | False | This applies only to stream sets with a single video track. When true, the stream set includes an additional I-frame trick-play only stream, along with the other tracks. If false, this extra stream is not included. |
periodTriggers | Array of type string Values: | False | A list of triggers that controls when the outgoing DASH Media Presentation Description (MPD) will be partitioned into multiple periods. Value description:
|
segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source segment duration. |
segmentTemplateFormat | string Values: | False | Determines the type of SegmentTemplate included in the MPD. Value description:
|
EncryptionContractConfiguration
Use encryptionContractConfiguration
to configure one or more content
encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract
defines the content keys used to encrypt the audio and video tracks in your stream.
To configure the encryption contract, specify which audio and video encryption
presets to use. For more information about these presets, see SPEKE Version 2.0 Presets.
Note the following considerations when using
encryptionContractConfiguration
:
-
You can use
encryptionContractConfiguration
for DASH endpoints that use SPEKE Version 2.0. SPEKE Version 2.0 relies on the CPIX Version 2.3 specification. -
You cannot combine an
UNENCRYPTED
preset withUNENCRYPTED
orSHARED
presets acrosspresetSpeke20Audio
andpresetSpeke20Video
. -
When you use a
SHARED
preset, you must use it for bothpresetSpeke20Audio
andpresetSpeke20Video
.
Property | Type | Required | Description |
---|---|---|---|
presetSpeke20Audio | string Values: | True | A collection of audio encryption presets. Value description:
|
presetSpeke20Video | string Values: | True | A collection of video encryption presets. Value description:
|
HlsEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
Property | Type | Required | Description |
---|---|---|---|
constantInitializationVector | string | False | A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a constant initialization vector (IV), MediaPackage periodically rotates the IV. |
encryptionMethod | string Values: | False | HLS encryption type. |
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
HlsManifest
Parameters for an HLS manifest.
Property | Type | Required | Description |
---|---|---|---|
adMarkers | string Values: | False | This setting controls ad markers in the packaged content. Value description:
|
includeIframeOnlyStream | boolean | False | Applies to stream sets with a single video track only. When enabled, the output includes an additional I-frame only trick-play stream, along with the other tracks. |
manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration. |
programDateTimeIntervalSeconds | integer | False | Inserts Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it's passed through to the HLS output. Omit this attribute or enter |
repeatExtXKey | boolean | False | Repeat the |
streamSelection | False | Video bitrate limitations for outputs from this packaging configuration. |
HlsPackage
Parameters for a packaging configuration that uses HTTP Live Streaming (HLS) packaging.
Property | Type | Required | Description |
---|---|---|---|
encryption | False | Parameters for encrypting content. | |
hlsManifests | Array of type HlsManifest | True | A list of HLS manifest configurations available from this endpoint. |
includeDvbSubtitles | boolean | False | When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output. |
segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration. |
useAudioRenditionGroup | boolean | False | When true, AWS Elemental MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group. |
MssEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
Property | Type | Required | Description |
---|---|---|---|
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
MssManifest
Parameters for a Microsoft Smooth manifest.
Property | Type | Required | Description |
---|---|---|---|
manifestName | string | False | A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration. |
streamSelection | False | Video bitrate limitations for outputs from this packaging configuration. |
MssPackage
Parameters for a packaging configuration that uses Microsoft Smooth Streaming (MSS) packaging.
Property | Type | Required | Description |
---|---|---|---|
encryption | False | Parameters for encrypting content. | |
mssManifests | Array of type MssManifest | True | A list of Microsoft Smooth manifest configurations available from this endpoint. |
segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. |
PackagingConfiguration
PackagingConfiguration.
Property | Type | Required | Description |
---|---|---|---|
arn | string | False | The Amazon Resource Name (ARN) for the packaging configuration. You can get this from the response to any request to the packaging configuration. |
cmafPackage | False | Parameters for CMAF packaging. | |
createdAt | string | False | The date and time the PackagingConfiguration was created. |
dashPackage | False | Parameters for DASH-ISO packaging. | |
hlsPackage | False | Parameters for Apple HLS packaging. | |
id | string | False | Unique identifier that you assign to the packaging configuration. |
mssPackage | False | Parameters for Microsoft Smooth Streaming packaging. | |
packagingGroupId | string | False | The ID of the packaging group associated with this packaging configuration. |
tags | False | The tags to assign to the packaging configuration. |
PackagingConfigurationCreateParameters
Parameters for creating a packaging configuration.
Property | Type | Required | Description |
---|---|---|---|
cmafPackage | False | Parameters for CMAF packaging. | |
dashPackage | False | Parameters for DASH-ISO packaging. | |
hlsPackage | False | Parameters for Apple HLS packaging. | |
id | string | True | Unique identifier that you assign to the packaging configuration. |
mssPackage | False | Parameters for Microsoft Smooth Streaming packaging. | |
packagingGroupId | string | True | The ID of the packaging group associated with this packaging configuration. |
tags | False | The tags to assign to the packaging configuration. |
PackagingConfigurationList
A collection of PackagingConfiguration records.
Property | Type | Required | Description |
---|---|---|---|
nextToken | string | False | Pagination token. Use this token to request the next page of packaging configuration results. |
packagingConfigurations | Array of type PackagingConfiguration | False | A list of PackagingConfiguration records. |
SpekeKeyProvider
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
Property | Type | Required | Description |
---|---|---|---|
encryptionContractConfiguration | False | Use | |
roleArn | string | True | The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows AWS Elemental MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Valid format: |
systemIds | Array of type string | True | List of unique identifiers for the DRM systems to use, as defined in the CPIX specification. |
url | string | True | URL for the key provider’s key retrieval API endpoint. Must start with https://. |
StreamSelection
Limitations for outputs from the endpoint, based on the video bitrate.
Property | Type | Required | Description |
---|---|---|---|
maxVideoBitsPerSecond | integer | False | The upper limit of the bitrates that this endpoint serves. If the video track exceeds this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 2147483647 bits per second. |
minVideoBitsPerSecond | integer | False | The lower limit of the bitrates that this endpoint serves. If the video track is below this threshold, then AWS Elemental MediaPackage excludes it from output. If you don't specify a value, it defaults to 0 bits per second. |
streamOrder | string Values: | False | Order in which the different video bitrates are presented to the player. |
Tags
A collection of tags associated with a resource.
Property | Type | Required | Description |
---|---|---|---|
| string | False |