Class: AWS.MediaPackage

Inherits:
AWS.Service show all
Identifier:
mediapackage
API Version:
2017-10-12
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

AWS Elemental MediaPackage

Sending a Request Using MediaPackage

var mediapackage = new AWS.MediaPackage();
mediapackage.createChannel(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MediaPackage object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mediapackage = new AWS.MediaPackage({apiVersion: '2017-10-12'});

You can also set the API version globally in AWS.config.apiVersions using the mediapackage service identifier:

AWS.config.apiVersions = {
  mediapackage: '2017-10-12',
  // other service API versions
};

var mediapackage = new AWS.MediaPackage();

Version:

  • 2017-10-12

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MediaPackage(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MediaPackage object

var mediapackage = new AWS.MediaPackage({apiVersion: '2017-10-12'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.MediaPackage.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.MediaPackage.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.MediaPackage.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createChannel(params = {}, callback) ⇒ AWS.Request

Creates a new Channel.

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediapackage.createChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Description — (String) A short text description of the Channel.
    • Id — (String) The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is created.
    • Tags — (map<String>) A collection of tags associated with a resource

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
      • Description — (String) A short text description of the Channel.
      • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
        • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
          • Id — (String) The system generated unique identifier for the IngestEndpoint
          • Password — (String) The system generated password for ingest authentication.
          • Url — (String) The ingest URL to which the source stream should be sent.
          • Username — (String) The system generated username for ingest authentication.
      • Id — (String) The ID of the Channel.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createHarvestJob(params = {}, callback) ⇒ AWS.Request

Creates a new HarvestJob record.

Service Reference:

Examples:

Calling the createHarvestJob operation

var params = {
  EndTime: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  OriginEndpointId: 'STRING_VALUE', /* required */
  S3Destination: { /* required */
    BucketName: 'STRING_VALUE', /* required */
    ManifestKey: 'STRING_VALUE', /* required */
    RoleArn: 'STRING_VALUE' /* required */
  },
  StartTime: 'STRING_VALUE' /* required */
};
mediapackage.createHarvestJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • EndTime — (String) The end of the time-window which will be harvested
    • Id — (String) The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted
    • OriginEndpointId — (String) The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
    • S3Destination — (map) Configuration parameters for where in an S3 bucket to place the harvested content
      • BucketNamerequired — (String) The name of an S3 bucket within which harvested content will be exported
      • ManifestKeyrequired — (String) The key in the specified S3 bucket where the harvested top-level manifest will be placed.
      • RoleArnrequired — (String) The IAM role used to write to the specified S3 bucket
    • StartTime — (String) The start of the time-window which will be harvested

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the HarvestJob.
      • ChannelId — (String) The ID of the Channel that the HarvestJob will harvest from.
      • CreatedAt — (String) The time the HarvestJob was submitted
      • EndTime — (String) The end of the time-window which will be harvested.
      • Id — (String) The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
      • OriginEndpointId — (String) The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
      • S3Destination — (map) Configuration parameters for where in an S3 bucket to place the harvested content
        • BucketNamerequired — (String) The name of an S3 bucket within which harvested content will be exported
        • ManifestKeyrequired — (String) The key in the specified S3 bucket where the harvested top-level manifest will be placed.
        • RoleArnrequired — (String) The IAM role used to write to the specified S3 bucket
      • StartTime — (String) The start of the time-window which will be harvested.
      • Status — (String) The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed. Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createOriginEndpoint(params = {}, callback) ⇒ AWS.Request

Creates a new OriginEndpoint record.

Service Reference:

Examples:

Calling the createOriginEndpoint operation

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  Id: 'STRING_VALUE', /* required */
  CmafPackage: {
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    HlsManifests: [
      {
        Id: 'STRING_VALUE', /* required */
        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,
          /* more items */
        ],
        AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
        IncludeIframeOnlyStream: true || false,
        ManifestName: 'STRING_VALUE',
        PlaylistType: NONE | EVENT | VOD,
        PlaylistWindowSeconds: 'NUMBER_VALUE',
        ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentPrefix: 'STRING_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    }
  },
  DashPackage: {
    AdTriggers: [
      SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY,
      /* more items */
    ],
    AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    ManifestLayout: FULL | COMPACT,
    ManifestWindowSeconds: 'NUMBER_VALUE',
    MinBufferTimeSeconds: 'NUMBER_VALUE',
    MinUpdatePeriodSeconds: 'NUMBER_VALUE',
    PeriodTriggers: [
      ADS,
      /* more items */
    ],
    Profile: NONE | HBBTV_1_5,
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentTemplateFormat: NUMBER_WITH_TIMELINE | TIME_WITH_TIMELINE | NUMBER_WITH_DURATION,
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    },
    SuggestedPresentationDelaySeconds: 'NUMBER_VALUE'
  },
  Description: 'STRING_VALUE',
  HlsPackage: {
    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,
      /* more items */
    ],
    AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      ConstantInitializationVector: 'STRING_VALUE',
      EncryptionMethod: AES_128 | SAMPLE_AES,
      KeyRotationIntervalSeconds: 'NUMBER_VALUE',
      RepeatExtXKey: true || false
    },
    IncludeIframeOnlyStream: true || false,
    PlaylistType: NONE | EVENT | VOD,
    PlaylistWindowSeconds: 'NUMBER_VALUE',
    ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
    SegmentDurationSeconds: 'NUMBER_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    },
    UseAudioRenditionGroup: true || false
  },
  ManifestName: 'STRING_VALUE',
  MssPackage: {
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      }
    },
    ManifestWindowSeconds: 'NUMBER_VALUE',
    SegmentDurationSeconds: 'NUMBER_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    }
  },
  Origination: ALLOW | DENY,
  StartoverWindowSeconds: 'NUMBER_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  TimeDelaySeconds: 'NUMBER_VALUE',
  Whitelist: [
    'STRING_VALUE',
    /* more items */
  ]
};
mediapackage.createOriginEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ChannelId — (String) The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the OriginEndpoint is created.
    • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
      • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
        • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • HlsManifests — (Array<map>) A list of HLS manifest configurations
        • 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. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Idrequired — (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. Possible values include:
          • "NONE"
          • "EVENT"
          • "VOD"
        • 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 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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
    • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      • AdTriggers — (Array<String>) 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.
      • 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. Possible values include:
        • "NONE"
        • "RESTRICTED"
        • "UNRESTRICTED"
        • "BOTH"
      • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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. Possible values include:
        • "FULL"
        • "COMPACT"
      • 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 — (Array<String>) 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.
      • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
        • "NONE"
        • "HBBTV_1_5"
      • 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. Possible values include:
        • "NUMBER_WITH_TIMELINE"
        • "TIME_WITH_TIMELINE"
        • "NUMBER_WITH_DURATION"
      • StreamSelection — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
      • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
    • Description — (String) A short text description of the OriginEndpoint.
    • HlsPackage — (map) 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. Possible values include:
        • "NONE"
        • "SCTE35_ENHANCED"
        • "PASSTHROUGH"
      • AdTriggers — (Array<String>) 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.
      • 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. Possible values include:
        • "NONE"
        • "RESTRICTED"
        • "UNRESTRICTED"
        • "BOTH"
      • Encryption — (map) 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. Possible values include:
          • "AES_128"
          • "SAMPLE_AES"
        • 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.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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. Possible values include:
        • "NONE"
        • "EVENT"
        • "VOD"
      • 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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
      • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
    • 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.
    • ManifestName — (String) A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
    • MssPackage — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
      • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
    • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
      • "ALLOW"
      • "DENY"
    • 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<String>) A collection of tags associated with a resource
    • 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.
    • Whitelist — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
      • ChannelId — (String) The ID of the Channel the OriginEndpoint is associated with.
      • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
        • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifests — (Array<map>) A list of HLS manifest configurations
          • 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. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • Idrequired — (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. Possible values include:
            • "NONE"
            • "EVENT"
            • "VOD"
          • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "FULL"
          • "COMPACT"
        • 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 — (Array<String>) 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.
        • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
          • "NONE"
          • "HBBTV_1_5"
        • 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. Possible values include:
          • "NUMBER_WITH_TIMELINE"
          • "TIME_WITH_TIMELINE"
          • "NUMBER_WITH_DURATION"
        • StreamSelection — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
      • Description — (String) A short text description of the OriginEndpoint.
      • HlsPackage — (map) 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. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) 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. Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • 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.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "NONE"
          • "EVENT"
          • "VOD"
        • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • 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 — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
        • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
        • "ALLOW"
        • "DENY"
      • 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<String>) A collection of tags associated with a resource
      • 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 — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteChannel(params = {}, callback) ⇒ AWS.Request

Deletes an existing Channel.

Service Reference:

Examples:

Calling the deleteChannel operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.deleteChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the Channel to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteOriginEndpoint(params = {}, callback) ⇒ AWS.Request

Deletes an existing OriginEndpoint.

Service Reference:

Examples:

Calling the deleteOriginEndpoint operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.deleteOriginEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the OriginEndpoint to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeChannel(params = {}, callback) ⇒ AWS.Request

Gets details about a Channel.

Service Reference:

Examples:

Calling the describeChannel operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.describeChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of a Channel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
      • Description — (String) A short text description of the Channel.
      • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
        • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
          • Id — (String) The system generated unique identifier for the IngestEndpoint
          • Password — (String) The system generated password for ingest authentication.
          • Url — (String) The ingest URL to which the source stream should be sent.
          • Username — (String) The system generated username for ingest authentication.
      • Id — (String) The ID of the Channel.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeHarvestJob(params = {}, callback) ⇒ AWS.Request

Gets details about an existing HarvestJob.

Service Reference:

Examples:

Calling the describeHarvestJob operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.describeHarvestJob(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the HarvestJob.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the HarvestJob.
      • ChannelId — (String) The ID of the Channel that the HarvestJob will harvest from.
      • CreatedAt — (String) The time the HarvestJob was submitted
      • EndTime — (String) The end of the time-window which will be harvested.
      • Id — (String) The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
      • OriginEndpointId — (String) The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
      • S3Destination — (map) Configuration parameters for where in an S3 bucket to place the harvested content
        • BucketNamerequired — (String) The name of an S3 bucket within which harvested content will be exported
        • ManifestKeyrequired — (String) The key in the specified S3 bucket where the harvested top-level manifest will be placed.
        • RoleArnrequired — (String) The IAM role used to write to the specified S3 bucket
      • StartTime — (String) The start of the time-window which will be harvested.
      • Status — (String) The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed. Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeOriginEndpoint(params = {}, callback) ⇒ AWS.Request

Gets details about an existing OriginEndpoint.

Service Reference:

Examples:

Calling the describeOriginEndpoint operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.describeOriginEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the OriginEndpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
      • ChannelId — (String) The ID of the Channel the OriginEndpoint is associated with.
      • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
        • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifests — (Array<map>) A list of HLS manifest configurations
          • 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. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • Idrequired — (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. Possible values include:
            • "NONE"
            • "EVENT"
            • "VOD"
          • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "FULL"
          • "COMPACT"
        • 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 — (Array<String>) 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.
        • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
          • "NONE"
          • "HBBTV_1_5"
        • 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. Possible values include:
          • "NUMBER_WITH_TIMELINE"
          • "TIME_WITH_TIMELINE"
          • "NUMBER_WITH_DURATION"
        • StreamSelection — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
      • Description — (String) A short text description of the OriginEndpoint.
      • HlsPackage — (map) 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. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) 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. Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • 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.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "NONE"
          • "EVENT"
          • "VOD"
        • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • 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 — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
        • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
        • "ALLOW"
        • "DENY"
      • 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<String>) A collection of tags associated with a resource
      • 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 — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listChannels(params = {}, callback) ⇒ AWS.Request

Returns a collection of Channels.

Service Reference:

Examples:

Calling the listChannels operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackage.listChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Channels — (Array<map>) A list of Channel records.
        • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
        • Description — (String) A short text description of the Channel.
        • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
          • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
            • Id — (String) The system generated unique identifier for the IngestEndpoint
            • Password — (String) The system generated password for ingest authentication.
            • Url — (String) The ingest URL to which the source stream should be sent.
            • Username — (String) The system generated username for ingest authentication.
        • Id — (String) The ID of the Channel.
        • Tags — (map<String>) A collection of tags associated with a resource
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listHarvestJobs(params = {}, callback) ⇒ AWS.Request

Returns a collection of HarvestJob records.

Service Reference:

Examples:

Calling the listHarvestJobs operation

var params = {
  IncludeChannelId: 'STRING_VALUE',
  IncludeStatus: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackage.listHarvestJobs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • IncludeChannelId — (String) When specified, the request will return only HarvestJobs associated with the given Channel ID.
    • IncludeStatus — (String) When specified, the request will return only HarvestJobs in the given status.
    • MaxResults — (Integer) The upper bound on the number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HarvestJobs — (Array<map>) A list of HarvestJob records.
        • Arn — (String) The Amazon Resource Name (ARN) assigned to the HarvestJob.
        • ChannelId — (String) The ID of the Channel that the HarvestJob will harvest from.
        • CreatedAt — (String) The time the HarvestJob was submitted
        • EndTime — (String) The end of the time-window which will be harvested.
        • Id — (String) The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob is submitted.
        • OriginEndpointId — (String) The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob is submitted.
        • S3Destination — (map) Configuration parameters for where in an S3 bucket to place the harvested content
          • BucketNamerequired — (String) The name of an S3 bucket within which harvested content will be exported
          • ManifestKeyrequired — (String) The key in the specified S3 bucket where the harvested top-level manifest will be placed.
          • RoleArnrequired — (String) The IAM role used to write to the specified S3 bucket
        • StartTime — (String) The start of the time-window which will be harvested.
        • Status — (String) The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob failed. Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listOriginEndpoints(params = {}, callback) ⇒ AWS.Request

Returns a collection of OriginEndpoint records.

Service Reference:

Examples:

Calling the listOriginEndpoints operation

var params = {
  ChannelId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackage.listOriginEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ChannelId — (String) When specified, the request will return only OriginEndpoints associated with the given Channel ID.
    • MaxResults — (Integer) The upper bound on the number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.
      • OriginEndpoints — (Array<map>) A list of OriginEndpoint records.
        • Arn — (String) The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
        • ChannelId — (String) The ID of the Channel the OriginEndpoint is associated with.
        • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
          • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
            • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
            • SpekeKeyProviderrequired — (map) 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.
              • ResourceIdrequired — (String) The resource ID to include in key requests.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (String) The URL of the external key provider service.
          • HlsManifests — (Array<map>) A list of HLS manifest configurations
            • 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. Possible values include:
              • "NONE"
              • "SCTE35_ENHANCED"
              • "PASSTHROUGH"
            • Idrequired — (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. Possible values include:
              • "NONE"
              • "EVENT"
              • "VOD"
            • 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 — (map) 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. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
          • AdTriggers — (Array<String>) 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.
          • 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. Possible values include:
            • "NONE"
            • "RESTRICTED"
            • "UNRESTRICTED"
            • "BOTH"
          • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
            • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
            • SpekeKeyProviderrequired — (map) 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.
              • ResourceIdrequired — (String) The resource ID to include in key requests.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (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. Possible values include:
            • "FULL"
            • "COMPACT"
          • 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 — (Array<String>) 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.
          • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
            • "NONE"
            • "HBBTV_1_5"
          • 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. Possible values include:
            • "NUMBER_WITH_TIMELINE"
            • "TIME_WITH_TIMELINE"
            • "NUMBER_WITH_DURATION"
          • StreamSelection — (map) 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. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
          • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
        • Description — (String) A short text description of the OriginEndpoint.
        • HlsPackage — (map) 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. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • AdTriggers — (Array<String>) 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.
          • 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. Possible values include:
            • "NONE"
            • "RESTRICTED"
            • "UNRESTRICTED"
            • "BOTH"
          • Encryption — (map) 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. Possible values include:
              • "AES_128"
              • "SAMPLE_AES"
            • 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.
            • SpekeKeyProviderrequired — (map) 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.
              • ResourceIdrequired — (String) The resource ID to include in key requests.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (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. Possible values include:
            • "NONE"
            • "EVENT"
            • "VOD"
          • 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 — (map) 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. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
          • 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 — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
          • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
            • SpekeKeyProviderrequired — (map) 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.
              • ResourceIdrequired — (String) The resource ID to include in key requests.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (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 — (map) 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. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
          • "ALLOW"
          • "DENY"
        • 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<String>) A collection of tags associated with a resource
        • 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 — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Calls the ListTagsForResource API operation.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mediapackage.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rotateChannelCredentials(params = {}, callback) ⇒ AWS.Request

Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead

Service Reference:

Examples:

Calling the rotateChannelCredentials operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
mediapackage.rotateChannelCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the channel to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
      • Description — (String) A short text description of the Channel.
      • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
        • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
          • Id — (String) The system generated unique identifier for the IngestEndpoint
          • Password — (String) The system generated password for ingest authentication.
          • Url — (String) The ingest URL to which the source stream should be sent.
          • Username — (String) The system generated username for ingest authentication.
      • Id — (String) The ID of the Channel.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rotateIngestEndpointCredentials(params = {}, callback) ⇒ AWS.Request

Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.

Service Reference:

Examples:

Calling the rotateIngestEndpointCredentials operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IngestEndpointId: 'STRING_VALUE' /* required */
};
mediapackage.rotateIngestEndpointCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the channel the IngestEndpoint is on.
    • IngestEndpointId — (String) The id of the IngestEndpoint whose credentials should be rotated

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
      • Description — (String) A short text description of the Channel.
      • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
        • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
          • Id — (String) The system generated unique identifier for the IngestEndpoint
          • Password — (String) The system generated password for ingest authentication.
          • Url — (String) The ingest URL to which the source stream should be sent.
          • Username — (String) The system generated username for ingest authentication.
      • Id — (String) The ID of the Channel.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Calls the TagResource API operation.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediapackage.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)
    • Tags — (map<String>)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Calls the UntagResource API operation.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mediapackage.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)
    • TagKeys — (Array<String>) The key(s) of tag to be deleted

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateChannel(params = {}, callback) ⇒ AWS.Request

Updates an existing Channel.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
mediapackage.updateChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Description — (String) A short text description of the Channel.
    • Id — (String) The ID of the Channel to update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the Channel.
      • Description — (String) A short text description of the Channel.
      • HlsIngest — (map) An HTTP Live Streaming (HLS) ingest resource configuration.
        • IngestEndpoints — (Array<map>) A list of endpoints to which the source stream should be sent.
          • Id — (String) The system generated unique identifier for the IngestEndpoint
          • Password — (String) The system generated password for ingest authentication.
          • Url — (String) The ingest URL to which the source stream should be sent.
          • Username — (String) The system generated username for ingest authentication.
      • Id — (String) The ID of the Channel.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateOriginEndpoint(params = {}, callback) ⇒ AWS.Request

Updates an existing OriginEndpoint.

Service Reference:

Examples:

Calling the updateOriginEndpoint operation

var params = {
  Id: 'STRING_VALUE', /* required */
  CmafPackage: {
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    HlsManifests: [
      {
        Id: 'STRING_VALUE', /* required */
        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,
          /* more items */
        ],
        AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
        IncludeIframeOnlyStream: true || false,
        ManifestName: 'STRING_VALUE',
        PlaylistType: NONE | EVENT | VOD,
        PlaylistWindowSeconds: 'NUMBER_VALUE',
        ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentPrefix: 'STRING_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    }
  },
  DashPackage: {
    AdTriggers: [
      SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY,
      /* more items */
    ],
    AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    ManifestLayout: FULL | COMPACT,
    ManifestWindowSeconds: 'NUMBER_VALUE',
    MinBufferTimeSeconds: 'NUMBER_VALUE',
    MinUpdatePeriodSeconds: 'NUMBER_VALUE',
    PeriodTriggers: [
      ADS,
      /* more items */
    ],
    Profile: NONE | HBBTV_1_5,
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentTemplateFormat: NUMBER_WITH_TIMELINE | TIME_WITH_TIMELINE | NUMBER_WITH_DURATION,
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    },
    SuggestedPresentationDelaySeconds: 'NUMBER_VALUE'
  },
  Description: 'STRING_VALUE',
  HlsPackage: {
    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,
      /* more items */
    ],
    AdsOnDeliveryRestrictions: NONE | RESTRICTED | UNRESTRICTED | BOTH,
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      },
      ConstantInitializationVector: 'STRING_VALUE',
      EncryptionMethod: AES_128 | SAMPLE_AES,
      KeyRotationIntervalSeconds: 'NUMBER_VALUE',
      RepeatExtXKey: true || false
    },
    IncludeIframeOnlyStream: true || false,
    PlaylistType: NONE | EVENT | VOD,
    PlaylistWindowSeconds: 'NUMBER_VALUE',
    ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
    SegmentDurationSeconds: 'NUMBER_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    },
    UseAudioRenditionGroup: true || false
  },
  ManifestName: 'STRING_VALUE',
  MssPackage: {
    Encryption: {
      SpekeKeyProvider: { /* required */
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE', /* required */
        CertificateArn: 'STRING_VALUE'
      }
    },
    ManifestWindowSeconds: 'NUMBER_VALUE',
    SegmentDurationSeconds: 'NUMBER_VALUE',
    StreamSelection: {
      MaxVideoBitsPerSecond: 'NUMBER_VALUE',
      MinVideoBitsPerSecond: 'NUMBER_VALUE',
      StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
    }
  },
  Origination: ALLOW | DENY,
  StartoverWindowSeconds: 'NUMBER_VALUE',
  TimeDelaySeconds: 'NUMBER_VALUE',
  Whitelist: [
    'STRING_VALUE',
    /* more items */
  ]
};
mediapackage.updateOriginEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
      • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
        • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • HlsManifests — (Array<map>) A list of HLS manifest configurations
        • 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. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Idrequired — (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. Possible values include:
          • "NONE"
          • "EVENT"
          • "VOD"
        • 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 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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
    • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      • AdTriggers — (Array<String>) 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.
      • 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. Possible values include:
        • "NONE"
        • "RESTRICTED"
        • "UNRESTRICTED"
        • "BOTH"
      • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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. Possible values include:
        • "FULL"
        • "COMPACT"
      • 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 — (Array<String>) 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.
      • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
        • "NONE"
        • "HBBTV_1_5"
      • 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. Possible values include:
        • "NUMBER_WITH_TIMELINE"
        • "TIME_WITH_TIMELINE"
        • "NUMBER_WITH_DURATION"
      • StreamSelection — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
      • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
    • Description — (String) A short text description of the OriginEndpoint.
    • HlsPackage — (map) 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. Possible values include:
        • "NONE"
        • "SCTE35_ENHANCED"
        • "PASSTHROUGH"
      • AdTriggers — (Array<String>) 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.
      • 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. Possible values include:
        • "NONE"
        • "RESTRICTED"
        • "UNRESTRICTED"
        • "BOTH"
      • Encryption — (map) 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. Possible values include:
          • "AES_128"
          • "SAMPLE_AES"
        • 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.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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. Possible values include:
        • "NONE"
        • "EVENT"
        • "VOD"
      • 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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
      • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
    • Id — (String) The ID of the OriginEndpoint to update.
    • ManifestName — (String) A short string that will be appended to the end of the Endpoint URL.
    • MssPackage — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
      • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
        • SpekeKeyProviderrequired — (map) 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.
          • ResourceIdrequired — (String) The resource ID to include in key requests.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (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 — (map) 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. Possible values include:
          • "ORIGINAL"
          • "VIDEO_BITRATE_ASCENDING"
          • "VIDEO_BITRATE_DESCENDING"
    • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
      • "ALLOW"
      • "DENY"
    • StartoverWindowSeconds — (Integer) Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback will be disabled for the OriginEndpoint.
    • TimeDelaySeconds — (Integer) Amount of delay (in seconds) to enforce on the playback of live content. If not specified, there will be no time delay in effect for the OriginEndpoint.
    • Whitelist — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
      • ChannelId — (String) The ID of the Channel the OriginEndpoint is associated with.
      • CmafPackage — (map) A Common Media Application Format (CMAF) packaging configuration.
        • Encryption — (map) A Common Media Application Format (CMAF) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifests — (Array<map>) A list of HLS manifest configurations
          • 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. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • Idrequired — (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. Possible values include:
            • "NONE"
            • "EVENT"
            • "VOD"
          • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • KeyRotationIntervalSeconds — (Integer) Time (in seconds) between each encryption key rotation.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "FULL"
          • "COMPACT"
        • 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 — (Array<String>) 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.
        • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
          • "NONE"
          • "HBBTV_1_5"
        • 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. Possible values include:
          • "NUMBER_WITH_TIMELINE"
          • "TIME_WITH_TIMELINE"
          • "NUMBER_WITH_DURATION"
        • StreamSelection — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • SuggestedPresentationDelaySeconds — (Integer) Duration (in seconds) to delay live content before presentation.
      • Description — (String) A short text description of the OriginEndpoint.
      • HlsPackage — (map) 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. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • AdTriggers — (Array<String>) 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.
        • 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. Possible values include:
          • "NONE"
          • "RESTRICTED"
          • "UNRESTRICTED"
          • "BOTH"
        • Encryption — (map) 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. Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • 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.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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. Possible values include:
          • "NONE"
          • "EVENT"
          • "VOD"
        • 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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
        • 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 — (map) A Microsoft Smooth Streaming (MSS) packaging configuration.
        • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
          • SpekeKeyProviderrequired — (map) 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.
            • ResourceIdrequired — (String) The resource ID to include in key requests.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (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 — (map) 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. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • Origination — (String) Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination Possible values include:
        • "ALLOW"
        • "DENY"
      • 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<String>) A collection of tags associated with a resource
      • 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 — (Array<String>) A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.