Origin_endpoints id - AWS Elemental MediaPackage

Origin_endpoints id

URI

/origin_endpoints/id

HTTP methods

GET

Operation ID: DescribeOriginEndpoint

Provides details about an endpoint.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200OriginEndpoint

200 OK response

Endpoint details are returned successfully.

403None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

PUT

Operation ID: UpdateOriginEndpoint

Updates a specific endpoint. When you submit the request to update an endpoint, include all necessary attributes in the request, even the ones that aren't being updated. If you send only the updated attributes, then all modifiable attributes that weren't specifically included in the request will reset to default values. For example, if you are using a 30 second time delay and submit a request to only update the endpoint description, then the time delay will update to zero (disabled). We recommend that you submit a GET request to obtain the endpoint's existing attributes and submit an updated version of the GET response body when you are updating an endpoint.

You can't change the id attribute or any other system-generated attributes.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200OriginEndpoint

200 OK response

The endpoint is updated successfully.

403None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

DELETE

Operation ID: DeleteOriginEndpoint

Permanently deletes an endpoint.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
202None

202 Accepted response

AWS Elemental MediaPackage accepted the request but has not processed it yet.

403None

403 Forbidden response

AWS Elemental MediaPackage cannot authorize the request, possibly due to insufficient authentication credentials.

404None

404 Not Found response

AWS Elemental MediaPackage did not find a representation of the target resource.

422None

422 Unprocessable Entity response

AWS Elemental MediaPackage could not process the instructions in the body of the request.

429None

429 Too Many Requests response

Too many requests have been sent in a given amount of time.

500None

500 Internal Server Error response

An unexpected condition prevented AWS Elemental MediaPackage from fulfilling the request.

503None

Service unavailable response

AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.

OPTIONS

Enable CORS by returning correct headers.

Path parameters
NameTypeRequiredDescription
idStringTrue

Identifier for the object that you are working on.

Responses
Status codeResponse modelDescription
200None

Default response for CORS method.

Schemas

Request bodies

{ "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "startoverWindowSeconds": integer, "origination": enum, "timeDelaySeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } }

Response bodies

{ "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "dashPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string", "profile": enum, "utcTiming": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "periodTriggers": [ enum ], "suggestedPresentationDelaySeconds": integer, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "whitelist": [ "string" ], "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "adMarkers": enum, "playlistWindowSeconds": integer, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "url": "string" } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "playlistWindowSeconds": integer, "includeDvbSubtitles": boolean, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean, "adTriggers": [ enum ], "adsOnDeliveryRestrictions": enum }, "url": "string", "tags": { }, "authorization": { "cdnIdentifierSecret": "string", "secretsRoleArn": "string" }, "createdAt": "string", "origination": enum, "timeDelaySeconds": integer, "id": "string", "arn": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "encryptionContractConfiguration": { "presetSpeke20Audio": enum, "presetSpeke20Video": enum }, "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } }

Properties

AdsOnDeliveryRestrictions

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad.

Value description:

  • NONE - No SCTE-35 messages become ads.

  • RESTRICTED - SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads.

  • UNRESTRICTED - SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads.

  • BOTH - All SCTE-35 messages of the types specified in AdTriggers will be treated as ads.

For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

  • NONE

  • RESTRICTED

  • UNRESTRICTED

  • BOTH

Authorization

Parameters for enabling CDN authorization on the endpoint.

PropertyTypeRequiredDescription
cdnIdentifierSecret

string

True

The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that your Content Delivery Network (CDN) uses for authorization to access your endpoint.

secretsRoleArn

string

True

The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.

CmafEncryption

Holds encryption information so that access to the content can be controlled by a DRM solution.

PropertyTypeRequiredDescription
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).

encryptionMethod

CmafEncryptionMethod

False

The encryption method to use.

keyRotationIntervalSeconds

integer

False

Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to 0 to disable key rotation.

spekeKeyProvider

SpekeKeyProvider

True

Parameters for the SPEKE key provider.

CmafEncryptionMethod

The encryption method to use.

  • SAMPLE_AES

  • AES_CTR

CmafPackage

Parameters for Common Media Application Format (CMAF) packaging.

PropertyTypeRequiredDescription
encryption

CmafEncryption

False

Parameters for encrypting content.

hlsManifests

Array of type HlsManifest

False

A list of HLS manifest configurations available from this endpoint.

segmentDurationSeconds

integer

False

Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration.

segmentPrefix

string

False

An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId.

streamSelection

StreamSelection

False

Limitations for outputs from the endpoint, based on the video bitrate.

CmafPackageCreateOrUpdateParameters

Parameters for creating an endpoint that supports Common Media Application Format (CMAF) packaging.

PropertyTypeRequiredDescription
encryption

CmafEncryption

False

Parameters for encrypting content.

hlsManifests

Array of type HlsManifestCreateOrUpdateParameters

False

A list of HLS manifest configurations available from this endpoint.

segmentDurationSeconds

integer

False

Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration.

segmentPrefix

string

False

An optional custom string that is prepended to the name of each segment. If not specified, the segment prefix defaults to the ChannelId.

streamSelection

StreamSelection

False

Limitations for outputs from the endpoint, based on the video bitrate.

DashEncryption

Holds encryption information so that access to the content can be controlled by a DRM solution.

PropertyTypeRequiredDescription
keyRotationIntervalSeconds

integer

False

Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to 0 to disable key rotation.

spekeKeyProvider

SpekeKeyProvider

True

Parameters for the SPEKE key provider.

DashPackage

Parameters for DASH packaging.

PropertyTypeRequiredDescription
adsOnDeliveryRestrictions

AdsOnDeliveryRestrictions

False

The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

adTriggers

Array of type string

False

The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

encryption

DashEncryption

False

Parameters for encrypting content.

includeIframeOnlyStream

boolean

False

When enabled, an I-Frame only stream will be included in the output.

manifestLayout

string

Values: FULL | COMPACT

False

Determines the position of some tags in the manifest.

Value description:

  • FULL - Elements like SegmentTemplate and ContentProtection are included in each Representation.

  • COMPACT - Duplicate elements are combined and presented at the AdaptationSet level.

manifestWindowSeconds

integer

False

Time window (in seconds) contained in each manifest.

minBufferTimeSeconds

integer

False

Minimum amount of content (measured in seconds) that a player must keep available in the buffer.

minUpdatePeriodSeconds

integer

False

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

periodTriggers

Array of type string

Values: ADS

False

A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

profile

string

Values: NONE | HBBTV_1_5 | HYBRIDCAST | DVB_DASH_2014

False

The DASH profile for the output.

Value description:

segmentDurationSeconds

integer

False

Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

segmentTemplateFormat

string

Values: NUMBER_WITH_TIMELINE | TIME_WITH_TIMELINE | NUMBER_WITH_DURATION

False

Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

Value description:

  • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

  • NUMBER_WITH_DURATION - The $Number$ variable is used in the media URL and a duration attribute is added to the segment template. The SegmentTimeline object is removed from the representation.

  • TIME_WITH_TIMELINE - The $Time$ variable is used in the media URL. The value of this variable is the timestamp of when the segment starts. A full SegmentTimeline object is presented in each SegmentTemplate.

streamSelection

StreamSelection

False

Limitations for outputs from the endpoint, based on the video bitrate.

suggestedPresentationDelaySeconds

integer

False

Amount of time (in seconds) that the player should be from the live point at the end of the manifest.

utcTiming

string

Values: NONE | HTTP-HEAD | HTTP-ISO | HTTP-XSDATE

False

Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

utcTimingUri

string

False

Specifies the value attribute of the UTC timing field when utcTiming is set to HTTP-ISO or HTTP-HEAD.

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 must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.

  • You cannot combine an UNENCRYPTED preset with UNENCRYPTED or SHARED presets across presetSpeke20Audio and presetSpeke20Video.

  • When you use a SHARED preset, you must use it for both presetSpeke20Audio and presetSpeke20Video.

PropertyTypeRequiredDescription
presetSpeke20Audio

string

Values: PRESET-AUDIO-1 | PRESET-AUDIO-2 | PRESET-AUDIO-3 | SHARED | UNENCRYPTED

True

A collection of audio encryption presets.

Value description:

  • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

  • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

  • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

  • SHARED - Use the same content key for all of the audio and video tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

presetSpeke20Video

string

Values: PRESET-VIDEO-1 | PRESET-VIDEO-2 | PRESET-VIDEO-3 | PRESET-VIDEO-4 | PRESET-VIDEO-5 | PRESET-VIDEO-6 | PRESET-VIDEO-7 | PRESET-VIDEO-8 | SHARED | UNENCRYPTED

True

A collection of video encryption presets.

Value description:

  • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

  • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

  • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

  • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

  • SHARED - Use the same content key for all of the video and audio tracks in your stream.

  • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

HlsEncryption

Holds encryption information so that access to the content can be controlled by a DRM solution.

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

encryptionMethod

string

Values: AES_128 | SAMPLE_AES

False

HLS encryption type.

keyRotationIntervalSeconds

integer

False

Number of seconds before AWS Elemental MediaPackage rotates to a new key. By default, rotation is set to 60 seconds. Set to 0 to disable key rotation.

repeatExtXKey

boolean

False

Repeat the EXT-X-KEY directive for every media segment. This might result in an increase in client requests to the DRM server.

spekeKeyProvider

SpekeKeyProvider

True

Parameters for the SPEKE key provider.

HlsManifest

A HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.

PropertyTypeRequiredDescription
adMarkers

string

Values: NONE | SCTE35_ENHANCED | PASSTHROUGH | DATERANGE

False

Controls how ad markers are included in the packaged endpoint.

Value description:

  • NONE - Omits all SCTE-35 ad markers from the output.

  • PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.

  • SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

  • DATERANGE - Inserts SCTE-35 EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value greater than 0. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

id

string

True

The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created.

includeIframeOnlyStream

boolean

False

Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

manifestName

string

False

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

playlistType

string

Values: NONE | EVENT | VOD

False

When specified as either event or vod, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content.

playlistWindowSeconds

integer

False

Time window (in seconds) contained in each parent manifest.

programDateTimeIntervalSeconds

integer

False

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.

url

string

False

The URL that's used to request this manifest from this endpoint.

HlsManifestCreateOrUpdateParameters

Parameters for creating an HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.

PropertyTypeRequiredDescription
adMarkers

string

Values: NONE | SCTE35_ENHANCED | PASSTHROUGH | DATERANGE

False

Controls how ad markers are included in the packaged endpoint.

Value description:

  • NONE - Omits all SCTE-35 ad markers from the output.

  • PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.

  • SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

  • DATERANGE - Inserts SCTE-35 EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value greater than 0. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

adsOnDeliveryRestrictions

AdsOnDeliveryRestrictions

False

The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

adTriggers

Array of type string

False

The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

id

string

True

The manifest ID is required and must be unique within the OriginEndpoint. The ID can't be changed after the endpoint is created.

includeIframeOnlyStream

boolean

False

Applies to stream sets with a single video track only. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

manifestName

string

False

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

playlistType

string

Values: NONE | EVENT | VOD

False

When specified as either event or vod, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content.

playlistWindowSeconds

integer

False

Time window (in seconds) contained in each parent manifest.

programDateTimeIntervalSeconds

integer

False

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.

HlsPackage

Parameters for Apple HLS packaging.

PropertyTypeRequiredDescription
adMarkers

string

Values: NONE | SCTE35_ENHANCED | PASSTHROUGH | DATERANGE

False

Controls how ad markers are included in the packaged endpoint.

Value description:

  • NONE - Omits all SCTE-35 ad markers from the output.

  • PASSTHROUGH - Creates a copy in the output of the SCTE-35 ad markers (comments) taken directly from the input manifest.

  • SCTE35_ENHANCED - Generates ad markers and blackout tags in the output based on the SCTE-35 messages from the input manifest.

  • DATERANGE - Inserts SCTE-35 EXT-X-DATERANGE tags to signal ad and program transition events in HLS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value greater than 0. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

adsOnDeliveryRestrictions

AdsOnDeliveryRestrictions

False

The flags on SCTE-35 segmentation descriptors that have to be present for MediaPackage to insert ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

adTriggers

Array of type string

False

The SCTE-35 message types that MediaPackage treats as ad markers in the output manifest. For information about SCTE-35 in MediaPackage, see SCTE-35 Message Options in AWS Elemental MediaPackage.

encryption

HlsEncryption

False

Parameters for encrypting content.

includeDvbSubtitles

boolean

False

When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.

includeIframeOnlyStream

boolean

False

Only applies to stream sets with a single video track. When true, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included.

playlistType

string

Values: NONE | EVENT | VOD

False

When specified as either event or vod, a corresponding EXT-X-PLAYLIST-TYPE entry is included in the media playlist. Indicates if the playlist is live to VOD content.

playlistWindowSeconds

integer

False

Time window (in seconds) contained in each parent manifest.

programDateTimeIntervalSeconds

integer

False

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.

segmentDurationSeconds

integer

False

Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

streamSelection

StreamSelection

False

Limitations for outputs from the endpoint, based on the video bitrate.

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.

PropertyTypeRequiredDescription
spekeKeyProvider

SpekeKeyProvider

True

Parameters for the SPEKE key provider.

MssPackage

Parameters for Microsoft Smooth Streaming packaging.

PropertyTypeRequiredDescription
encryption

MssEncryption

False

Parameters for encrypting content.

manifestWindowSeconds

integer

False

Time window (in seconds) contained in each manifest.

segmentDurationSeconds

integer

False

Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration.

streamSelection

StreamSelection

False

Limitations for outputs from the endpoint, based on the video bitrate.

OriginEndpoint

OriginEndpoint configuration.

PropertyTypeRequiredDescription
arn

string

False

The endpoint's unique system-generated resource name, based on the AWS record.

authorization

Authorization

False

Parameters for CDN authorization.

channelId

string

False

The ID of the channel associated with this endpoint.

cmafPackage

CmafPackage

False

Parameters for CMAF packaging.

createdAt

string

False

The date and time the OriginEndpoint was created.

dashPackage

DashPackage

False

Parameters for DASH packaging.

description

string

False

Any descriptive information that you want to add to the endpoint for future identification purposes.

hlsPackage

HlsPackage

False

Parameters for Apple HLS packaging.

id

string

False

The endpoint identifier.

manifestName

string

False

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

mssPackage

MssPackage

False

Parameters for Microsoft Smooth Streaming packaging.

origination

string

Values: ALLOW | DENY

False

Controls video origination from this endpoint.

Value description:

  • ALLOW - Enables this endpoint to serve content to requesting devices.

  • DENY - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements.

startoverWindowSeconds

integer

False

Maximum duration (seconds) of content to retain for startover playback. A 0 indicates that startover playback is disabled for this endpoint.

tags

Tags

False

The tags assigned to the endpoint.

timeDelaySeconds

integer

False

Minimum duration (seconds) of delay to enforce on the playback of live content. A 0 indicates that there is no time delay in effect for this endpoint

url

string

False

The URL that's used to request content from this endpoint.

whitelist

Array of type string

False

The IP addresses that can access this endpoint.

OriginEndpointUpdateParameters

OriginEndpoint configuration

PropertyTypeRequiredDescription
authorization

Authorization

False

Parameters for CDN authorization.

cmafPackage

CmafPackageCreateOrUpdateParameters

False

Parameters for CMAF packaging.

dashPackage

DashPackage

False

Parameters for DASH packaging.

description

string

False

Any descriptive information that you want to add to the endpoint for future identification purposes.

hlsPackage

HlsPackage

False

Parameters for Apple HLS packaging.

manifestName

string

False

A short string that's appended to the end of the endpoint URL to create a unique path to this endpoint.

mssPackage

MssPackage

False

Parameters for Microsoft Smooth Streaming packaging.

origination

string

Values: ALLOW | DENY

False

Controls video origination from this endpoint.

Value description:

  • ALLOW - Enables this endpoint to serve content to requesting devices.

  • DENY - Prevents this endpoint from serving content. Denying origination is helpful for harvesting live-to-VOD assets. For more information about harvesting and origination, see Live-to-VOD Requirements.

startoverWindowSeconds

integer

False

Maximum duration (seconds) of content to retain for startover playback. Enter 0 to indicate that startover playback is disabled for this endpoint.

timeDelaySeconds

integer

False

Minimum duration (seconds) of delay to enforce on the playback of live content. Enter 0 to indicate that there is no time delay in effect for this endpoint.

whitelist

Array of type string

False

The IP addresses that can access this endpoint.

SpekeKeyProvider

Keyprovider settings for DRM.

PropertyTypeRequiredDescription
certificateArn

string

False

The Amazon Resource Name (ARN) for the certificate that you imported to AWS Certificate Manager to add content key encryption to this endpoint. For this feature to work, your DRM key provider must support content key encryption.

encryptionContractConfiguration

EncryptionContractConfiguration

False

Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

resourceId

string

True

Unique identifier for this endpoint, as it is configured in the key provider service.

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: arn:aws:iam::accountID:role/name

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.

PropertyTypeRequiredDescription
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: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING

False

Order in which the different video bitrates are presented to the player.

Tags

A collection of tags associated with a resource.

Value description:

  • Property: "key1": "value1"

  • Type: string

  • Required: True

  • Description: A comma-separated list of tag key:value pairs that you define. For example:

    { "Key1": "Value1", "Key2": "Value2" }
PropertyTypeRequiredDescription

*

string

False

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DescribeOriginEndpoint

UpdateOriginEndpoint

DeleteOriginEndpoint