Name Type Required Description
id String True Identifier for the object
that you're working on.
Responses
Status code Response model Description
200 PackagingConfiguration (p. 37)200 OK response
HTTP methods
Status code Response model Description
The list of tags is returned successfully.
403 None 403 Forbidden response
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.
404 None 404 Not Found response
AWS Elemental MediaPackage did not find a representation of the target resource.
422 None 422 Unprocessable Entity
response
AWS Elemental MediaPackage could not process the
instructions in the body of the request.
429 None 429 Too Many Requests
response
Too many requests have been sent in a given amount of time.
500 None 500 Internal Server Error
response
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.
503 None Service unavailable
response
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.
DELETE
Operation ID: DeletePackagingConfiguration Permanently deletes a packaging configuration.
HTTP methods
Path parameters
Name Type Required Description
id String True Identifier for the object
that you're working on.
Responses
Status code Response model Description
202 None 202 Accepted response
AWS Elemental MediaPackage accepted the request but has not processed it yet.
403 None 403 Forbidden response
AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.
404 None 404 Not Found response
AWS Elemental MediaPackage did not find a representation of the target resource.
422 None 422 Unprocessable Entity
response
AWS Elemental MediaPackage could not process the
instructions in the body of the request.
429 None 429 Too Many Requests
response
Too many requests have been sent in a given amount of time.
500 None 500 Internal Server Error
response
An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.
503 None Service unavailable
response
AWS Elemental MediaPackage can't currently complete the request, usually because of
Schemas
Status code Response model Description
a temporary overload or maintenance.
OPTIONS
Enable cross-origin resource sharing (CORS) by returning correct headers.
Responses
Status code Response model Description
200 None 200 OK response
The list of tags is returned successfully.
Schemas
Response bodies
PackagingConfiguration schema
{ "packagingGroupId": "string", "dashPackage": {
"includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer,
"encryption": {
"segmentTemplateFormat": enum, "periodTriggers": [
enum ],
"dashManifests": [ {
"minBufferTimeSeconds": integer, "manifestName": "string", "arn": "string", "cmafPackage": {
Schemas
"includeEncoderConfigurationInSegments": boolean, "segmentDurationSeconds": integer,
"encryption": {
"constantInitializationVector": "string", "spekeKeyProvider": {
"programDateTimeIntervalSeconds": integer, "streamSelection": {
"streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"includeIframeOnlyStream": boolean }
]
}, "hlsPackage": {
"useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "encryption": {
"constantInitializationVector": "string", "encryptionMethod": enum,
"spekeKeyProvider": {
"programDateTimeIntervalSeconds": integer, "streamSelection": {
"streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"includeIframeOnlyStream": boolean }
],
"includeDvbSubtitles": boolean }, "mssPackage": {
"segmentDurationSeconds": integer, "encryption": {
Properties
Holds encryption information so that access to the content can be controlled by a DRM solution.
constantInitializationVector
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).
Type: string Required: False
spekeKeyProvider
Parameters for the SPEKE key provider.
Type: SpekeKeyProvider (p. 46) Required: True
CmafPackage
Parameters for a packaging configuration that uses Common Media Application Format (CMAF) packaging.
includeEncoderConfigurationInSegments
When includeEncoderConfigurationInSegments is set to 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.
Type: boolean Required: False
segmentDurationSeconds
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source fragment duration.
Properties
Type: integer Required: False
encryption
Parameters for encrypting content.
Type: CmafEncryption (p. 39) Required: False
hlsManifests
A list of HLS manifest configurations available from this endpoint.
Type: Array of type HlsManifest (p. 42) Required: True
DashEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
spekeKeyProvider
Parameters for the SPEKE key provider.
Type: SpekeKeyProvider (p. 46) Required: True
DashManifest
Parameters for a DASH manifest.
minBufferTimeSeconds
Minimum amount of content (measured in seconds) that a player must keep available in the buffer.
Type: integer Required: False
manifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration.
Type: string Required: False
profile
The DASH profile type. When set to HBBTV_1_5, the content is compliant with HbbTV 1.5.
Type: string Required: False
Values: NONE | HBBTV_1_5
Properties
manifestLayout
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.
Type: string Required: False
Values: FULL | COMPACT
streamSelection
Limitations for outputs from the endpoint, based on the video bitrate.
Type: StreamSelection (p. 47) Required: False
DashPackage
Parameters for a packaging configuration that uses Dynamic Adaptive Streaming over HTTP (DASH) packaging.
includeEncoderConfigurationInSegments
When includeEncoderConfigurationInSegments is set to 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.
Type: boolean Required: False
segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source segment duration.
Type: integer Required: False
encryption
Parameters for encrypting content.
Type: DashEncryption (p. 40) Required: False
segmentTemplateFormat
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.
Properties
Type: string Required: False
Values: NUMBER_WITH_TIMELINE | TIME_WITH_TIMELINE | NUMBER_WITH_DURATION
periodTriggers
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 set to NONE, the entire duration of the ouput manifest is included in a single period. If set to ADS, multiple periods are added to the output manifest based on SCTE-35 ad markers in the source video stream.
Type: Array of type string Required: False
Values: ADS
dashManifests
A list of DASH manifest configurations available from this endpoint.
Type: Array of type DashManifest (p. 40) Required: True
HlsEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
constantInitializationVector
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.
Type: string Required: False
encryptionMethod
HLS encryption type.Type: string Required: False
Values: AES_128 | SAMPLE_AES
spekeKeyProvider
Parameters for the SPEKE key provider.
Type: SpekeKeyProvider (p. 46) Required: True
HlsManifest
Parameters for an HLS manifest.
Properties
repeatExtXKey
Repeat the EXT-X-KEY directive for every media segment. This might result in an increase in client requests to the DRM server.
Type: boolean Required: False
adMarkers
This setting controls ad markers in the packaged content. NONE omits SCTE-35 ad markers from the output. PASSTHROUGH copies SCTE-35 ad markers from the source content to the output.
SCTE35_ENHANCED generates ad markers and blackout tags in the output, based on SCTE-35 messages in the source content.
Type: string Required: False
Values: NONE | SCTE35_ENHANCED | PASSTHROUGH
manifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration.
Type: string Required: False
programDateTimeIntervalSeconds
Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify.
Additionally, ID3Timed metadata messages are generated every 5 seconds starting when the content was ingested.
Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.
Omit this attribute or enter 0 to indicate that the EXT-X-PROGRAM-DATE-TIME tags are not included in the manifest.
Type: integer Required: False
streamSelection
Video bitrate limitations for outputs from this packaging configuration.
Type: StreamSelection (p. 47) Required: False
includeIframeOnlyStream
Applies to stream sets with a single video track only. When enabled, the output includes an additional I-frame only stream, along with the other tracks.
Type: boolean
Properties
Required: False
HlsPackage
Parameters for a packaging configuration that uses HTTP Live Streaming (HLS) packaging.
useAudioRenditionGroup
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.
Type: boolean Required: False
segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
Type: integer Required: False
encryption
Parameters for encrypting content.
Type: HlsEncryption (p. 42) Required: False
hlsManifests
A list of HLS manifest configurations available from this endpoint.
Type: Array of type HlsManifest (p. 42) Required: True
includeDvbSubtitles
When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
Type: boolean Required: False
MssEncryption
Holds encryption information so that access to the content can be controlled by a DRM solution.
spekeKeyProvider
Parameters for the SPEKE key provider.
Type: SpekeKeyProvider (p. 46) Required: True
Properties
MssManifest
Parameters for a Microsoft Smooth manifest.
manifestName
A short string that's appended to the end of the endpoint URL to create a unique path to this packaging configuration.
Type: string Required: False
streamSelection
Video bitrate limitations for outputs from this packaging configuration.
Type: StreamSelection (p. 47) Required: False
MssPackage
Parameters for a packaging configuration that uses Microsoft Smooth Streaming (MSS) packaging.
segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.
Type: integer Required: False
encryption
Parameters for encrypting content.
Type: MssEncryption (p. 44) Required: False
mssManifests
A list of Microsoft Smooth manifest configurations available from this endpoint.
Type: Array of type MssManifest (p. 45) Required: True
PackagingConfiguration
PackagingConfiguration.
packagingGroupId
The ID of the packaging group associated with this packaging configuration.
Type: string Required: False
Properties
dashPackage
Parameters for DASH-ISO packaging.
Type: DashPackage (p. 41) Required: False
id
Unique identifier that you assign to the packaging configuration.
Type: string Required: False
arn
The Amazon Resource Name (ARN) for the packaging configuration. You can get this from the response to any request to the packaging configuration.
Type: string Required: False
cmafPackage
Parameters for CMAF packaging.
Type: CmafPackage (p. 39) Required: False
hlsPackage
Parameters for Apple HLS packaging.
Type: HlsPackage (p. 44) Required: False
mssPackage
Parameters for Microsoft Smooth Streaming packaging.
Type: MssPackage (p. 45) Required: False
tags
The tags to assign to the packaging configuration.
Type: Tags (p. 48) Required: False
SpekeKeyProvider
A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
Properties
systemIds
List of unique identifiers for the DRM systems to use, as defined in the CPIX specification.
Type: Array of type string Required: True
roleArn
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:
arn:aws:iam::{accountID}:role/{name}
Type: string Required: True
url
URL for the key provider’s key retrieval API endpoint. Must start with https://.
Type: string Required: True
StreamSelection
Limitations for outputs from the endpoint, based on the video bitrate.
streamOrder
Order in which the different video bitrates are presented to the player.
Type: string Required: False
Values: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
maxVideoBitsPerSecond
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.
Type: integer Required: False
minVideoBitsPerSecond
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.
Type: integer Required: False