URI
/origin_endpoints
HTTP methods
GET
Operation ID: ListOriginEndpoints
Lists endpoints that match a set of filters that you define.
Query parameters
Name Type Required Description
nextToken String False Pagination token from
the GET list request.
HTTP methods
Name Type Required Description
Use the token to fetch the next page of results.
maxResults String False Upper bound on
number of records to return.
channelId String False Limits results to
endpoints associated with the given channel ID.
Responses
Status code Response model Description
200 OriginEndpointList (p. 52)200 OK response
The list of endpoints 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
HTTP methods
Status code Response model Description
AWS Elemental MediaPackage can't currently complete the request, usually because of a temporary overload or maintenance.
POST
Operation ID: CreateOriginEndpoint
Create an endpoint on an AWS Elemental MediaPackage channel.
An endpoint represents a single delivery point of a channel, and defines content output handling through various components, such as packaging protocols, DRM and encryption integration, and more.
Once created, an endpoint provides a fixed public URL. This URL remains the same throughout the lifetime of the endpoint, regardless of any failures or upgrades that might occur. Integrate the URL with a downstream CDN (such as Amazon CloudFront) or playback device.
Responses
Status code Response model Description
200 OriginEndpoint (p. 55) 200 OK response
The endpoint is created 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
Schemas
Status code Response model Description
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.
OPTIONS
Enable CORS by returning correct headers.
Responses
Status code Response model Description
200 None Default response for CORS
method.
Schemas
Request bodies
POST schema
{ "startoverWindowSeconds": integer, "manifestName": "string",
"description": "string", "dashPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string",
"profile": enum, "utcTiming": enum,
"segmentTemplateFormat": enum, "manifestLayout": enum,
"minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": {
"keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
Schemas
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"periodTriggers": [ enum
],
"suggestedPresentationDelaySeconds": integer, "adsOnDeliveryRestrictions": enum,
"adTriggers": [ enum
] },
"whitelist": [ "string"
], "cmafPackage": {
"segmentDurationSeconds": integer, "encryption": {
"constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
"playlistWindowSeconds": integer, "manifestName": "string",
"programDateTimeIntervalSeconds": integer, "playlistType": enum,
"includeIframeOnlyStream": boolean, "id": "string",
"adsOnDeliveryRestrictions": enum, "adTriggers": [
enum ] } ],
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"segmentPrefix": "string"
}, "hlsPackage": {
"useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer,
Schemas
"adMarkers": enum,
"includeDvbSubtitles": boolean,
"programDateTimeIntervalSeconds": integer, "playlistType": enum,
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"includeIframeOnlyStream": boolean, "adsOnDeliveryRestrictions": enum, "adTriggers": [
enum ] }, "tags": {
}, "authorization": {
"cdnIdentifierSecret": "string", "secretsRoleArn": "string"
},
"origination": enum,
"timeDelaySeconds": integer, "id": "string",
"channelId": "string", "mssPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": {
"spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }
} }
Response bodies
OriginEndpointList schema
{ "originEndpoints": [ {
"startoverWindowSeconds": integer, "manifestName": "string",
"description": "string", "dashPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer,
Schemas
"minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": {
"keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
"suggestedPresentationDelaySeconds": integer, "adsOnDeliveryRestrictions": enum,
"adTriggers": [
"segmentDurationSeconds": integer, "encryption": {
"constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
Schemas
"useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "adMarkers": enum,
"includeDvbSubtitles": boolean,
"programDateTimeIntervalSeconds": integer, "playlistType": enum,
"includeIframeOnlyStream": boolean, "adsOnDeliveryRestrictions": enum, "adTriggers": [
"cdnIdentifierSecret": "string", "secretsRoleArn": "string"
},
"origination": enum,
"timeDelaySeconds": integer, "id": "string",
"arn": "string", "channelId": "string", "mssPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": {
Schemas
}
], "nextToken": "string"
}
OriginEndpoint schema
{ "startoverWindowSeconds": integer, "manifestName": "string",
"description": "string", "dashPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "utcTimingUri": "string",
"profile": enum, "utcTiming": enum,
"segmentTemplateFormat": enum, "manifestLayout": enum,
"minUpdatePeriodSeconds": integer, "minBufferTimeSeconds": integer, "encryption": {
"keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"periodTriggers": [ enum
],
"suggestedPresentationDelaySeconds": integer, "adsOnDeliveryRestrictions": enum,
"adTriggers": [
"cmafPackage": {
"segmentDurationSeconds": integer, "encryption": {
"constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
"presetSpeke20Video": enum },
Schemas
"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,
"includeDvbSubtitles": boolean,
"programDateTimeIntervalSeconds": integer, "playlistType": enum,
"streamSelection": { "streamOrder": enum,
"maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer },
"includeIframeOnlyStream": boolean, "adsOnDeliveryRestrictions": enum, "adTriggers": [
enum ] },
"url": "string", "tags": { },
"authorization": {
"cdnIdentifierSecret": "string", "secretsRoleArn": "string"
}, "origination": enum,
"timeDelaySeconds": integer, "id": "string",
"arn": "string", "channelId": "string", "mssPackage": {
"manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": {
"spekeKeyProvider": {
"encryptionContractConfiguration": { "presetSpeke20Audio": enum,
"presetSpeke20Video": enum
Properties
"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.
• 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.
NONERESTRICTED UNRESTRICTED BOTH
Authorization
Parameters for enabling CDN authorization on the endpoint.