Origin_endpoints id
URI
/origin_endpoints/
id
HTTP methods
GET
Operation ID: DescribeOriginEndpoint
Provides details about an endpoint.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | String | True | Identifier for the object that you are working on. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | OriginEndpoint |
Endpoint details are 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. |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | String | True | Identifier for the object that you are working on. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | OriginEndpoint |
The endpoint is updated 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. |
DELETE
Operation ID: DeleteOriginEndpoint
Permanently deletes an endpoint.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | String | True | Identifier for the object that you are working on. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
202 | None |
AWS Elemental MediaPackage accepted the request but has not processed it yet. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 CORS by returning correct headers.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | String | True | Identifier for the object that you are working on. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 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.
Property | Type | Required | Description |
---|---|---|---|
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.
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). |
encryptionMethod | 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 |
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.
Property | Type | Required | Description |
---|---|---|---|
encryption | 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 | 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.
Property | Type | Required | Description |
---|---|---|---|
encryption | 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 | 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.
Property | Type | Required | Description |
---|---|---|---|
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
|
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
DashPackage
Parameters for DASH packaging.
Property | Type | Required | Description |
---|---|---|---|
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 | False | Parameters for encrypting content. | |
includeIframeOnlyStream | boolean | False | When enabled, an I-Frame only stream will be included in the output. |
manifestLayout | string Values: | False | Determines the position of some tags in the manifest. Value description:
|
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: | False | A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type |
profile | string Values: | 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: | False | Determines the type of variable used in the Value description:
|
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: | 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 |
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
to0
. -
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. |
encryptionMethod | string Values: | 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 |
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 | True | Parameters for the SPEKE key provider. |
HlsManifest
A HTTP Live Streaming (HLS) manifest configuration on a CMAF endpoint.
Property | Type | Required | Description |
---|---|---|---|
adMarkers | string Values: | False | Controls how ad markers are included in the packaged endpoint. Value description:
|
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: | False | When specified as either |
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 |
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.
Property | Type | Required | Description |
---|---|---|---|
adMarkers | string Values: | False | Controls how ad markers are included in the packaged endpoint. Value description:
|
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: | False | When specified as either |
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 |
HlsPackage
Parameters for Apple HLS packaging.
Property | Type | Required | Description |
---|---|---|---|
adMarkers | string Values: | False | Controls how ad markers are included in the packaged endpoint. Value description:
|
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 | 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: | False | When specified as either |
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 |
segmentDurationSeconds | integer | False | Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. |
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.
Property | Type | Required | Description |
---|---|---|---|
spekeKeyProvider | True | Parameters for the SPEKE key provider. |
MssPackage
Parameters for Microsoft Smooth Streaming packaging.
Property | Type | Required | Description |
---|---|---|---|
encryption | 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 | False | Limitations for outputs from the endpoint, based on the video bitrate. |
OriginEndpoint
OriginEndpoint configuration.
Property | Type | Required | Description |
---|---|---|---|
arn | string | False | The endpoint's unique system-generated resource name, based on the AWS record. |
authorization | False | Parameters for CDN authorization. | |
channelId | string | False | The ID of the channel associated with this endpoint. |
cmafPackage | False | Parameters for CMAF packaging. | |
createdAt | string | False | The date and time the OriginEndpoint was created. |
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 | 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 | False | Parameters for Microsoft Smooth Streaming packaging. | |
origination | string Values: | False | Controls video origination from this endpoint. Value description:
|
startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback.
A |
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 |
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
Property | Type | Required | Description |
---|---|---|---|
authorization | False | Parameters for CDN authorization. | |
cmafPackage | False | Parameters for CMAF packaging. | |
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 | 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 | False | Parameters for Microsoft Smooth Streaming packaging. | |
origination | string Values: | False | Controls video origination from this endpoint. Value description:
|
startoverWindowSeconds | integer | False | Maximum duration (seconds) of content to retain for startover playback.
Enter |
timeDelaySeconds | integer | False | Minimum duration (seconds) of delay to enforce on the playback of live content. Enter |
whitelist | Array of type string | False | The IP addresses that can access this endpoint. |
SpekeKeyProvider
Keyprovider settings for DRM.
Property | Type | Required | Description |
---|---|---|---|
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 | False | 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: |
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.
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" }
Property | Type | Required | Description |
---|---|---|---|
| string | False |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: