Origin_endpoints id
URI
/origin_endpoints/id
HTTP Methods
GET
Operation ID: DescribeOriginEndpoint
Provides details about an endpoint.
AWS CLI Request Syntax
aws mediapackage describe-origin-endpoint --id <endpointId>
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.
AWS CLI Request Syntax
aws mediapackage update-origin-endpoint --id <endpointId> --dash-package | --hls-package | --mss-package} <packagingSettings> [--description <value>] [--manifest-name <value>] [--startover-window-seconds <value>] [--time-delay-seconds <value>] [--whitelist <value>]
For nested parameters, such as those for packagingSettings
, you can reference a JSON file file://<fileName>.json
that holds all of the 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.
AWS CLI Request Syntax
aws mediapackage delete-origin-endpoint --id <endpointId>
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. |
Schemas
Request Bodies
Example PUT
{ "startoverWindowSeconds": integer, "timeDelaySeconds": integer, "manifestName": "string", "description": "string", "whitelist": [ "string" ], "dashPackage": { "manifestWindowSeconds": integer, "minBufferTimeSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "profile": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "periodTriggers": [ enum ], "minUpdatePeriodSeconds": integer, "suggestedPresentationDelaySeconds": integer }, "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "playlistWindowSeconds": integer, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "playlistWindowSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean }, "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } }
Response Bodies
Example OriginEndpoint
{ "startoverWindowSeconds": integer, "manifestName": "string", "description": "string", "whitelist": [ "string" ], "dashPackage": { "manifestWindowSeconds": integer, "minBufferTimeSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "profile": enum, "manifestLayout": enum, "segmentTemplateFormat": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "periodTriggers": [ enum ], "minUpdatePeriodSeconds": integer, "suggestedPresentationDelaySeconds": integer }, "cmafPackage": { "segmentDurationSeconds": integer, "encryption": { "keyRotationIntervalSeconds": integer, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "hlsManifests": [ { "playlistWindowSeconds": integer, "adMarkers": enum, "manifestName": "string", "programDateTimeIntervalSeconds": integer, "playlistType": enum, "id": "string", "includeIframeOnlyStream": boolean, "url": "string" } ], "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "segmentPrefix": "string" }, "url": "string", "hlsPackage": { "useAudioRenditionGroup": boolean, "segmentDurationSeconds": integer, "playlistWindowSeconds": integer, "adMarkers": enum, "encryption": { "repeatExtXKey": boolean, "constantInitializationVector": "string", "keyRotationIntervalSeconds": integer, "encryptionMethod": enum, "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "programDateTimeIntervalSeconds": integer, "playlistType": enum, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer }, "includeIframeOnlyStream": boolean }, "timeDelaySeconds": integer, "id": "string", "arn": "string", "channelId": "string", "mssPackage": { "manifestWindowSeconds": integer, "segmentDurationSeconds": integer, "encryption": { "spekeKeyProvider": { "resourceId": "string", "certificateArn": "string", "systemIds": [ "string" ], "roleArn": "string", "url": "string" } }, "streamSelection": { "streamOrder": enum, "maxVideoBitsPerSecond": integer, "minVideoBitsPerSecond": integer } } }
Properties
Property | Type | Required | Description |
---|---|---|---|
segmentDurationSeconds |
integer |
False |
Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. |
encryption |
False |
Parameters for encrypting content. |
|
hlsManifests |
Array of type HlsManifest |
False |
A list of HLS manifest configurations available from this endpoint. |
streamSelection |
False |
Limitations for outputs from the endpoint, based on the video bitrate. |
|
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. |
CmafPackageCreateOrUpdateParameters
Property | Type | Required | Description |
---|---|---|---|
segmentDurationSeconds |
integer |
False |
Duration (in seconds) of each segment. Actual segments are rounded to the nearest multiple of the source segment duration. |
encryption |
False |
Parameters for encrypting content. |
|
hlsManifests |
Array of type HlsManifestCreateOrUpdateParameters |
False |
A list of HLS manifest configurations available from this endpoint. |
streamSelection |
False |
Limitations for outputs from the endpoint, based on the video bitrate. |
|
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. |
Property | Type | Required | 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. |
segmentDurationSeconds |
integer |
False |
Duration (in seconds) of each fragment. Actual fragments are rounded to the nearest multiple of the source fragment duration. |
encryption |
False |
Parameters for encrypting content. |
|
profile |
string Values: |
False |
DASH profile for the output, such as HbbTV. Valid values:
|
manifestLayout |
string Values: |
False |
Determines the position of some tags in the manifest. Options:
|
segmentTemplateFormat |
string Values: |
False |
Determines the type of variable used in the
|
streamSelection |
False |
Limitations for outputs from the endpoint, based on the video bitrate. |
|
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 |
minUpdatePeriodSeconds |
integer |
False |
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. |
suggestedPresentationDelaySeconds |
integer |
False |
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. |
HlsManifestCreateOrUpdateParameters
OriginEndpointUpdateParameters