Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . mediapackage ]

create-origin-endpoint

Description

Creates a new OriginEndpoint record.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-origin-endpoint
--channel-id <value>
[--cmaf-package <value>]
[--dash-package <value>]
[--description <value>]
[--hls-package <value>]
--id <value>
[--manifest-name <value>]
[--mss-package <value>]
[--startover-window-seconds <value>]
[--tags <value>]
[--time-delay-seconds <value>]
[--whitelist <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-id (string) The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.

--cmaf-package (structure) A Common Media Application Format (CMAF) packaging configuration.

JSON Syntax:

{
  "Encryption": {
    "KeyRotationIntervalSeconds": integer,
    "SpekeKeyProvider": {
      "CertificateArn": "string",
      "ResourceId": "string",
      "RoleArn": "string",
      "SystemIds": ["string", ...],
      "Url": "string"
    }
  },
  "HlsManifests": [
    {
      "AdMarkers": "NONE"|"SCTE35_ENHANCED"|"PASSTHROUGH",
      "AdTriggers": ["SPLICE_INSERT"|"BREAK"|"PROVIDER_ADVERTISEMENT"|"DISTRIBUTOR_ADVERTISEMENT"|"PROVIDER_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"|"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", ...],
      "AdsOnDeliveryRestrictions": "NONE"|"RESTRICTED"|"UNRESTRICTED"|"BOTH",
      "Id": "string",
      "IncludeIframeOnlyStream": true|false,
      "ManifestName": "string",
      "PlaylistType": "NONE"|"EVENT"|"VOD",
      "PlaylistWindowSeconds": integer,
      "ProgramDateTimeIntervalSeconds": integer
    }
    ...
  ],
  "SegmentDurationSeconds": integer,
  "SegmentPrefix": "string",
  "StreamSelection": {
    "MaxVideoBitsPerSecond": integer,
    "MinVideoBitsPerSecond": integer,
    "StreamOrder": "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"
  }
}

--dash-package (structure) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

JSON Syntax:

{
  "AdTriggers": ["SPLICE_INSERT"|"BREAK"|"PROVIDER_ADVERTISEMENT"|"DISTRIBUTOR_ADVERTISEMENT"|"PROVIDER_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"|"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", ...],
  "AdsOnDeliveryRestrictions": "NONE"|"RESTRICTED"|"UNRESTRICTED"|"BOTH",
  "Encryption": {
    "KeyRotationIntervalSeconds": integer,
    "SpekeKeyProvider": {
      "CertificateArn": "string",
      "ResourceId": "string",
      "RoleArn": "string",
      "SystemIds": ["string", ...],
      "Url": "string"
    }
  },
  "ManifestLayout": "FULL"|"COMPACT",
  "ManifestWindowSeconds": integer,
  "MinBufferTimeSeconds": integer,
  "MinUpdatePeriodSeconds": integer,
  "PeriodTriggers": ["ADS", ...],
  "Profile": "NONE"|"HBBTV_1_5",
  "SegmentDurationSeconds": integer,
  "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE"|"TIME_WITH_TIMELINE"|"NUMBER_WITH_DURATION",
  "StreamSelection": {
    "MaxVideoBitsPerSecond": integer,
    "MinVideoBitsPerSecond": integer,
    "StreamOrder": "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"
  },
  "SuggestedPresentationDelaySeconds": integer
}

--description (string) A short text description of the OriginEndpoint.

--hls-package (structure) An HTTP Live Streaming (HLS) packaging configuration.

JSON Syntax:

{
  "AdMarkers": "NONE"|"SCTE35_ENHANCED"|"PASSTHROUGH",
  "AdTriggers": ["SPLICE_INSERT"|"BREAK"|"PROVIDER_ADVERTISEMENT"|"DISTRIBUTOR_ADVERTISEMENT"|"PROVIDER_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_PLACEMENT_OPPORTUNITY"|"PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY"|"DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY", ...],
  "AdsOnDeliveryRestrictions": "NONE"|"RESTRICTED"|"UNRESTRICTED"|"BOTH",
  "Encryption": {
    "ConstantInitializationVector": "string",
    "EncryptionMethod": "AES_128"|"SAMPLE_AES",
    "KeyRotationIntervalSeconds": integer,
    "RepeatExtXKey": true|false,
    "SpekeKeyProvider": {
      "CertificateArn": "string",
      "ResourceId": "string",
      "RoleArn": "string",
      "SystemIds": ["string", ...],
      "Url": "string"
    }
  },
  "IncludeIframeOnlyStream": true|false,
  "PlaylistType": "NONE"|"EVENT"|"VOD",
  "PlaylistWindowSeconds": integer,
  "ProgramDateTimeIntervalSeconds": integer,
  "SegmentDurationSeconds": integer,
  "StreamSelection": {
    "MaxVideoBitsPerSecond": integer,
    "MinVideoBitsPerSecond": integer,
    "StreamOrder": "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"
  },
  "UseAudioRenditionGroup": true|false
}

--id (string) The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the OriginEndpoint is created.

--manifest-name (string) A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").

--mss-package (structure) A Microsoft Smooth Streaming (MSS) packaging configuration.

JSON Syntax:

{
  "Encryption": {
    "SpekeKeyProvider": {
      "CertificateArn": "string",
      "ResourceId": "string",
      "RoleArn": "string",
      "SystemIds": ["string", ...],
      "Url": "string"
    }
  },
  "ManifestWindowSeconds": integer,
  "SegmentDurationSeconds": integer,
  "StreamSelection": {
    "MaxVideoBitsPerSecond": integer,
    "MinVideoBitsPerSecond": integer,
    "StreamOrder": "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"
  }
}

--startover-window-seconds (integer) Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.

--tags (map) A collection of tags associated with a resource

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--time-delay-seconds (integer) Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.

--whitelist (list) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create an origin endpoint

The following create-origin-endpoint command creates an origin endpoint named cmafsports with the package settings provided in a JSON file and specified endpoint settings.

aws mediapackage create-origin-endpoint \
    --channel-id sportschannel \
    --id cmafsports \
    --cmaf-package file://file/path/cmafpkg.json --description "cmaf output of sports" \
    --id cmaf_sports \
    --manifest-name sports_channel \
    --startover-window-seconds 300 \
    --tags region=west,media=sports \
    --time-delay-seconds 10

Output:

{
    "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6",
    "ChannelId": "sportschannel",
    "CmafPackage": {
        "HlsManifests": [
            {
                "AdMarkers": "PASSTHROUGH",
                "Id": "cmaf_sports_endpoint",
                "IncludeIframeOnlyStream": true,
                "ManifestName": "index",
                "PlaylistType": "EVENT",
                "PlaylistWindowSeconds": 300,
                "ProgramDateTimeIntervalSeconds": 300,
                "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8"
            }
        ],
        "SegmentDurationSeconds": 2,
        "SegmentPrefix": "sportschannel"
    },
    "Description": "cmaf output of sports",
    "Id": "cmaf_sports",
    "ManifestName": "sports_channel",
    "StartoverWindowSeconds": 300,
    "Tags": {
        "region": "west",
        "media": "sports"
    },
    "TimeDelaySeconds": 10,
    "Url": "",
    "Whitelist": []
}

For more information, see Creating an Endpoint in the AWS Elemental MediaPackage User Guide.

Output

Arn -> (string)

The Amazon Resource Name (ARN) assigned to the OriginEndpoint.

ChannelId -> (string)

The ID of the Channel the OriginEndpoint is associated with.

CmafPackage -> (structure)

A Common Media Application Format (CMAF) packaging configuration.

Encryption -> (structure)

A Common Media Application Format (CMAF) encryption configuration.

KeyRotationIntervalSeconds -> (integer)

Time (in seconds) between each encryption key rotation.

SpekeKeyProvider -> (structure)

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

CertificateArn -> (string)

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

ResourceId -> (string)

The resource ID to include in key requests.

RoleArn -> (string)

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

SystemIds -> (list)

The system IDs to include in key requests.

(string)

Url -> (string)

The URL of the external key provider service.

HlsManifests -> (list)

A list of HLS manifest configurations

(structure)

A HTTP Live Streaming (HLS) manifest configuration.

AdMarkers -> (string)

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

Id -> (string)

The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.

IncludeIframeOnlyStream -> (boolean)

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

ManifestName -> (string)

An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.

PlaylistType -> (string)

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

PlaylistWindowSeconds -> (integer)

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

ProgramDateTimeIntervalSeconds -> (integer)

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

Url -> (string)

The URL of the packaged OriginEndpoint for consumption.

SegmentDurationSeconds -> (integer)

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

SegmentPrefix -> (string)

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

StreamSelection -> (structure)

A StreamSelection configuration.

MaxVideoBitsPerSecond -> (integer)

The maximum video bitrate (bps) to include in output.

MinVideoBitsPerSecond -> (integer)

The minimum video bitrate (bps) to include in output.

StreamOrder -> (string)

A directive that determines the order of streams in the output.

DashPackage -> (structure)

A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.

AdTriggers -> (list)

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

(string)

AdsOnDeliveryRestrictions -> (string)

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Encryption -> (structure)

A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.

KeyRotationIntervalSeconds -> (integer)

Time (in seconds) between each encryption key rotation.

SpekeKeyProvider -> (structure)

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

CertificateArn -> (string)

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

ResourceId -> (string)

The resource ID to include in key requests.

RoleArn -> (string)

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

SystemIds -> (list)

The system IDs to include in key requests.

(string)

Url -> (string)

The URL of the external key provider service.

ManifestLayout -> (string)

Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.

ManifestWindowSeconds -> (integer)

Time window (in seconds) contained in each manifest.

MinBufferTimeSeconds -> (integer)

Minimum duration (in seconds) that a player will buffer media before starting the presentation.

MinUpdatePeriodSeconds -> (integer)

Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).

PeriodTriggers -> (list)

A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Channel source contains SCTE-35 ad markers.

(string)

Profile -> (string)

The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.

SegmentDurationSeconds -> (integer)

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

SegmentTemplateFormat -> (string)

Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.

StreamSelection -> (structure)

A StreamSelection configuration.

MaxVideoBitsPerSecond -> (integer)

The maximum video bitrate (bps) to include in output.

MinVideoBitsPerSecond -> (integer)

The minimum video bitrate (bps) to include in output.

StreamOrder -> (string)

A directive that determines the order of streams in the output.

SuggestedPresentationDelaySeconds -> (integer)

Duration (in seconds) to delay live content before presentation.

Description -> (string)

A short text description of the OriginEndpoint.

HlsPackage -> (structure)

An HTTP Live Streaming (HLS) packaging configuration.

AdMarkers -> (string)

This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source.

AdTriggers -> (list)

A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no ad markers are output. Specify multiple items to create ad markers for all of the included message types.

(string)

AdsOnDeliveryRestrictions -> (string)

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Encryption -> (structure)

An HTTP Live Streaming (HLS) encryption configuration.

ConstantInitializationVector -> (string)

A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.

EncryptionMethod -> (string)

The encryption method to use.

KeyRotationIntervalSeconds -> (integer)

Interval (in seconds) between each encryption key rotation.

RepeatExtXKey -> (boolean)

When enabled, the EXT-X-KEY tag will be repeated in output manifests.

SpekeKeyProvider -> (structure)

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

CertificateArn -> (string)

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

ResourceId -> (string)

The resource ID to include in key requests.

RoleArn -> (string)

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

SystemIds -> (list)

The system IDs to include in key requests.

(string)

Url -> (string)

The URL of the external key provider service.

IncludeIframeOnlyStream -> (boolean)

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

PlaylistType -> (string)

The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.

PlaylistWindowSeconds -> (integer)

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

ProgramDateTimeIntervalSeconds -> (integer)

The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.

SegmentDurationSeconds -> (integer)

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

StreamSelection -> (structure)

A StreamSelection configuration.

MaxVideoBitsPerSecond -> (integer)

The maximum video bitrate (bps) to include in output.

MinVideoBitsPerSecond -> (integer)

The minimum video bitrate (bps) to include in output.

StreamOrder -> (string)

A directive that determines the order of streams in the output.

UseAudioRenditionGroup -> (boolean)

When enabled, audio streams will be placed in rendition groups in the output.

Id -> (string)

The ID of the OriginEndpoint.

ManifestName -> (string)

A short string appended to the end of the OriginEndpoint URL.

MssPackage -> (structure)

A Microsoft Smooth Streaming (MSS) packaging configuration.

Encryption -> (structure)

A Microsoft Smooth Streaming (MSS) encryption configuration.

SpekeKeyProvider -> (structure)

A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.

CertificateArn -> (string)

An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing secure end-to-end data transfer with the key provider service.

ResourceId -> (string)

The resource ID to include in key requests.

RoleArn -> (string)

An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.

SystemIds -> (list)

The system IDs to include in key requests.

(string)

Url -> (string)

The URL of the external key provider service.

ManifestWindowSeconds -> (integer)

The time window (in seconds) contained in each manifest.

SegmentDurationSeconds -> (integer)

The duration (in seconds) of each segment.

StreamSelection -> (structure)

A StreamSelection configuration.

MaxVideoBitsPerSecond -> (integer)

The maximum video bitrate (bps) to include in output.

MinVideoBitsPerSecond -> (integer)

The minimum video bitrate (bps) to include in output.

StreamOrder -> (string)

A directive that determines the order of streams in the output.

StartoverWindowSeconds -> (integer)

Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.

Tags -> (map)

A collection of tags associated with a resource

key -> (string)

value -> (string)

TimeDelaySeconds -> (integer)

Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.

Url -> (string)

The URL of the packaged OriginEndpoint for consumption.

Whitelist -> (list)

A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

(string)