We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.MediaPackageV2

Inherits:
AWS.Service show all
Identifier:
mediapackagev2
API Version:
2022-12-25
Defined in:
(unknown)

Overview

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

Service Description

Note: This guide is intended for creating AWS Elemental MediaPackage resources in MediaPackage Version 2 (v2) starting from May 2023. To get started with MediaPackage v2, create your MediaPackage resources. There isn't an automated process to migrate your resources from MediaPackage v1 to MediaPackage v2. The names of the entities that you use to access this API, like URLs and ARNs, all have the versioning information added, like "v2", to distinguish from the prior version. If you used MediaPackage prior to this release, you can't use the MediaPackage v2 CLI or the MediaPackage v2 API to access any MediaPackage v1 resources. If you created resources in MediaPackage v1, use video on demand (VOD) workflows, and aren't looking to migrate to MediaPackage v2 yet, see the MediaPackage v1 Live API Reference.

This is the AWS Elemental MediaPackage v2 Live REST API Reference. It describes all the MediaPackage API operations for live content in detail, and provides sample requests, responses, and errors for the supported web services protocols.

We assume that you have the IAM permissions that you need to use MediaPackage via the REST API. We also assume that you are familiar with the features and operations of MediaPackage, as described in the AWS Elemental MediaPackage User Guide.

Sending a Request Using MediaPackageV2

var mediapackagev2 = new AWS.MediaPackageV2();
mediapackagev2.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 MediaPackageV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var mediapackagev2 = new AWS.MediaPackageV2({apiVersion: '2022-12-25'});

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

AWS.config.apiVersions = {
  mediapackagev2: '2022-12-25',
  // other service API versions
};

var mediapackagev2 = new AWS.MediaPackageV2();

Version:

  • 2022-12-25

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a MediaPackageV2 object

var mediapackagev2 = new AWS.MediaPackageV2({apiVersion: '2022-12-25'});

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|AWS.Endpoint) —

    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' or an Endpoint object.

  • 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.MediaPackageV2.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.MediaPackageV2.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.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets 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 error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • 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|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • 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'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.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

Create a channel to start receiving content streams. The channel represents the input to MediaPackage for incoming live content from an encoder such as AWS Elemental MediaLive. The channel receives content, and after packaging it, outputs it through an origin endpoint to downstream devices (such as video players or CDNs) that request the content. You can create only one channel with each request. We recommend that you spread out channels between channel groups, such as putting redundant channels in the same AWS Region in different channel groups.

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group. You can't change the name after you create the channel.

    • ClientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      Enter any descriptive text that helps you to identify the channel.

    • Tags — (map<String>)

      A comma-separated list of tag key:value pairs that you define. For example:

      "Key1": "Value1",

      "Key2": "Value2"

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) associated with the resource.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • CreatedAt — (Date)

        The date and time the channel was created.

      • ModifiedAt — (Date)

        The date and time the channel was modified.

      • Description — (String)

        The description for your channel.

      • IngestEndpoints — (Array<map>)

        The list of ingest endpoints.

        • Id — (String)

          The system-generated unique identifier for the IngestEndpoint.

        • Url — (String)

          The ingest domain URL where the source stream should be sent.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Create a channel group to group your channels and origin endpoints. A channel group is the top-level resource that consists of channels and origin endpoints that are associated with it and that provides predictable URLs for stream delivery. All channels and origin endpoints within the channel group are guaranteed to share the DNS. You can create only one channel group with each request.

Service Reference:

Examples:

Calling the createChannelGroup operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mediapackagev2.createChannelGroup(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region. You can't use spaces in the name. You can't change the name after you create the channel group.

    • ClientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      Enter any descriptive text that helps you to identify the channel group.

    • Tags — (map<String>)

      A comma-separated list of tag key:value pairs that you define. For example:

      "Key1": "Value1",

      "Key2": "Value2"

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:

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • Arn — (String)

        The Amazon Resource Name (ARN) associated with the resource.

      • EgressDomain — (String)

        The output domain where the source stream should be sent. Integrate the egress domain with a downstream CDN (such as Amazon CloudFront) or playback device.

      • CreatedAt — (Date)

        The date and time the channel group was created.

      • ModifiedAt — (Date)

        The date and time the channel group was modified.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Description — (String)

        The description for your channel group.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel group.

Returns:

  • (AWS.Request) —

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

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

The endpoint is attached to a channel, and represents the output of the live content. You can associate multiple endpoints to a single channel. Each endpoint gives players and downstream CDNs (such as Amazon CloudFront) access to the content for playback. Content can't be served from a channel until it has an endpoint. You can create only one endpoint with each request.

Service Reference:

Examples:

Calling the createOriginEndpoint operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  ContainerType: TS | CMAF, /* required */
  OriginEndpointName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  DashManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      DrmSignaling: INDIVIDUAL | REFERENCED,
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      MinBufferTimeSeconds: 'NUMBER_VALUE',
      MinUpdatePeriodSeconds: 'NUMBER_VALUE',
      PeriodTriggers: [
        AVAILS | DRM_KEY_ROTATION | SOURCE_CHANGES | SOURCE_DISRUPTIONS | NONE,
        /* more items */
      ],
      ScteDash: {
        AdMarkerDash: BINARY | XML
      },
      SegmentTemplateFormat: NUMBER_WITH_TIMELINE,
      SuggestedPresentationDelaySeconds: 'NUMBER_VALUE',
      UtcTiming: {
        TimingMode: HTTP_HEAD | HTTP_ISO | HTTP_XSDATE | UTC_DIRECT,
        TimingSource: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  HlsManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      ChildManifestName: 'STRING_VALUE',
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
      ScteHls: {
        AdMarkerHls: DATERANGE
      }
    },
    /* more items */
  ],
  LowLatencyHlsManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      ChildManifestName: 'STRING_VALUE',
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
      ScteHls: {
        AdMarkerHls: DATERANGE
      }
    },
    /* more items */
  ],
  Segment: {
    Encryption: {
      EncryptionMethod: { /* required */
        CmafEncryptionMethod: CENC | CBCS,
        TsEncryptionMethod: AES_128 | SAMPLE_AES
      },
      SpekeKeyProvider: { /* required */
        DrmSystems: [ /* required */
          CLEAR_KEY_AES_128 | FAIRPLAY | PLAYREADY | WIDEVINE,
          /* more items */
        ],
        EncryptionContractConfiguration: { /* required */
          PresetSpeke20Audio: PRESET_AUDIO_1 | PRESET_AUDIO_2 | PRESET_AUDIO_3 | SHARED | UNENCRYPTED, /* required */
          PresetSpeke20Video: PRESET_VIDEO_1 | PRESET_VIDEO_2 | PRESET_VIDEO_3 | PRESET_VIDEO_4 | PRESET_VIDEO_5 | PRESET_VIDEO_6 | PRESET_VIDEO_7 | PRESET_VIDEO_8 | SHARED | UNENCRYPTED /* required */
        },
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        Url: 'STRING_VALUE' /* required */
      },
      ConstantInitializationVector: 'STRING_VALUE',
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    IncludeIframeOnlyStreams: true || false,
    Scte: {
      ScteFilter: [
        SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY | PROGRAM,
        /* more items */
      ]
    },
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentName: 'STRING_VALUE',
    TsIncludeDvbSubtitles: true || false,
    TsUseAudioRenditionGroup: true || false
  },
  StartoverWindowSeconds: 'NUMBER_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and must be unique for your account in the AWS Region and channel. You can't use spaces in the name. You can't change the name after you create the endpoint.

    • ContainerType — (String)

      The type of container to attach to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file. You can't change the container type after you create the endpoint.

      Possible values include:
      • "TS"
      • "CMAF"
    • Segment — (map)

      The segment configuration, including the segment name, duration, and other configuration values.

      • SegmentDurationSeconds — (Integer)

        The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

      • SegmentName — (String)

        The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

      • TsUseAudioRenditionGroup — (Boolean)

        When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

      • IncludeIframeOnlyStreams — (Boolean)

        When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

      • TsIncludeDvbSubtitles — (Boolean)

        By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

      • Scte — (map)

        The SCTE configuration options in the segment settings.

        • ScteFilter — (Array<String>)

          The SCTE-35 message types that you want to be treated as ad markers in the output.

      • Encryption — (map)

        The parameters for encrypting content.

        • ConstantInitializationVector — (String)

          A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

        • EncryptionMethod — required — (map)

          The encryption method to use.

          • TsEncryptionMethod — (String)

            The encryption method to use.

            Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • CmafEncryptionMethod — (String)

            The encryption method to use.

            Possible values include:
            • "CENC"
            • "CBCS"
        • KeyRotationIntervalSeconds — (Integer)

          The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

          The following example setting causes the service to rotate keys every thirty minutes: 1800

        • SpekeKeyProvider — required — (map)

          The parameters for the SPEKE key provider.

          • EncryptionContractConfiguration — required — (map)

            Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

            • PresetSpeke20Audio — required — (String)

              A collection of audio encryption presets.

              Value description:

              • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

              • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

              • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

              • SHARED - Use the same content key for all of the audio and video tracks in your stream.

              • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

              Possible values include:
              • "PRESET_AUDIO_1"
              • "PRESET_AUDIO_2"
              • "PRESET_AUDIO_3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String)

              A collection of video encryption presets.

              Value description:

              • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

              • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

              • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • SHARED - Use the same content key for all of the video and audio tracks in your stream.

              • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

              Possible values include:
              • "PRESET_VIDEO_1"
              • "PRESET_VIDEO_2"
              • "PRESET_VIDEO_3"
              • "PRESET_VIDEO_4"
              • "PRESET_VIDEO_5"
              • "PRESET_VIDEO_6"
              • "PRESET_VIDEO_7"
              • "PRESET_VIDEO_8"
              • "SHARED"
              • "UNENCRYPTED"
          • ResourceId — required — (String)

            The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

            The following example shows a resource ID: MovieNight20171126093045

          • DrmSystems — required — (Array<String>)

            The DRM solution provider you're using to protect your content during distribution.

          • RoleArn — required — (String)

            The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

            Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

          • Url — required — (String)

            The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

            The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

    • ClientToken — (String)

      A unique, case-sensitive token that you provide to ensure the idempotency of the request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Description — (String)

      Enter any descriptive text that helps you to identify the origin endpoint.

    • StartoverWindowSeconds — (Integer)

      The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

    • HlsManifests — (Array<map>)

      An HTTP live streaming (HLS) manifest configuration.

      • ManifestName — required — (String)

        A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ChildManifestName — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ScteHls — (map)

        The SCTE configuration.

        • AdMarkerHls — (String)

          Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

          Value description:

          • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

          Possible values include:
          • "DATERANGE"
      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • ProgramDateTimeIntervalSeconds — (Integer)

        Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

        Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

    • LowLatencyHlsManifests — (Array<map>)

      A low-latency HLS manifest configuration.

      • ManifestName — required — (String)

        A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ChildManifestName — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ScteHls — (map)

        The SCTE configuration.

        • AdMarkerHls — (String)

          Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

          Value description:

          • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

          Possible values include:
          • "DATERANGE"
      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • ProgramDateTimeIntervalSeconds — (Integer)

        Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

        Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

    • DashManifests — (Array<map>)

      A DASH manifest configuration.

      • ManifestName — required — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.

      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • MinUpdatePeriodSeconds — (Integer)

        Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

      • MinBufferTimeSeconds — (Integer)

        Minimum amount of content (in seconds) that a player must keep available in the buffer.

      • SuggestedPresentationDelaySeconds — (Integer)

        The amount of time (in seconds) that the player should be from the end of the manifest.

      • SegmentTemplateFormat — (String)

        Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

        Value description:

        • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

        Possible values include:
        • "NUMBER_WITH_TIMELINE"
      • PeriodTriggers — (Array<String>)

        A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

      • ScteDash — (map)

        The SCTE configuration.

        • AdMarkerDash — (String)

          Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

          Value description:

          • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

          • XML - The SCTE marker is expressed fully in XML.

          Possible values include:
          • "BINARY"
          • "XML"
      • DrmSignaling — (String)

        Determines how the DASH manifest signals the DRM content.

        Possible values include:
        • "INDIVIDUAL"
        • "REFERENCED"
      • UtcTiming — (map)

        Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

        • TimingMode — (String)

          The UTC timing mode.

          Possible values include:
          • "HTTP_HEAD"
          • "HTTP_ISO"
          • "HTTP_XSDATE"
          • "UTC_DIRECT"
        • TimingSource — (String)

          The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

    • Tags — (map<String>)

      A comma-separated list of tag key:value pairs that you define. For example:

      "Key1": "Value1",

      "Key2": "Value2"

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) associated with the resource.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • OriginEndpointName — (String)

        The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

      • ContainerType — (String)

        The type of container attached to this origin endpoint.

        Possible values include:
        • "TS"
        • "CMAF"
      • Segment — (map)

        The segment configuration, including the segment name, duration, and other configuration values.

        • SegmentDurationSeconds — (Integer)

          The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

        • SegmentName — (String)

          The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

        • TsUseAudioRenditionGroup — (Boolean)

          When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

        • IncludeIframeOnlyStreams — (Boolean)

          When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

        • TsIncludeDvbSubtitles — (Boolean)

          By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

        • Scte — (map)

          The SCTE configuration options in the segment settings.

          • ScteFilter — (Array<String>)

            The SCTE-35 message types that you want to be treated as ad markers in the output.

        • Encryption — (map)

          The parameters for encrypting content.

          • ConstantInitializationVector — (String)

            A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

          • EncryptionMethod — required — (map)

            The encryption method to use.

            • TsEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "AES_128"
              • "SAMPLE_AES"
            • CmafEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "CENC"
              • "CBCS"
          • KeyRotationIntervalSeconds — (Integer)

            The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

            The following example setting causes the service to rotate keys every thirty minutes: 1800

          • SpekeKeyProvider — required — (map)

            The parameters for the SPEKE key provider.

            • EncryptionContractConfiguration — required — (map)

              Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

              • PresetSpeke20Audio — required — (String)

                A collection of audio encryption presets.

                Value description:

                • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

                • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

                • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

                • SHARED - Use the same content key for all of the audio and video tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

                Possible values include:
                • "PRESET_AUDIO_1"
                • "PRESET_AUDIO_2"
                • "PRESET_AUDIO_3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String)

                A collection of video encryption presets.

                Value description:

                • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

                • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

                • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • SHARED - Use the same content key for all of the video and audio tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

                Possible values include:
                • "PRESET_VIDEO_1"
                • "PRESET_VIDEO_2"
                • "PRESET_VIDEO_3"
                • "PRESET_VIDEO_4"
                • "PRESET_VIDEO_5"
                • "PRESET_VIDEO_6"
                • "PRESET_VIDEO_7"
                • "PRESET_VIDEO_8"
                • "SHARED"
                • "UNENCRYPTED"
            • ResourceId — required — (String)

              The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

              The following example shows a resource ID: MovieNight20171126093045

            • DrmSystems — required — (Array<String>)

              The DRM solution provider you're using to protect your content during distribution.

            • RoleArn — required — (String)

              The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

              Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

            • Url — required — (String)

              The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

              The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

      • CreatedAt — (Date)

        The date and time the origin endpoint was created.

      • ModifiedAt — (Date)

        The date and time the origin endpoint was modified.

      • Description — (String)

        The description for your origin endpoint.

      • StartoverWindowSeconds — (Integer)

        The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

      • HlsManifests — (Array<map>)

        An HTTP live streaming (HLS) manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • LowLatencyHlsManifests — (Array<map>)

        A low-latency HLS manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • DashManifests — (Array<map>)

        A DASH manifest configuration.

        • ManifestName — required — (String)

          A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

        • MinUpdatePeriodSeconds — (Integer)

          Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

        • MinBufferTimeSeconds — (Integer)

          Minimum amount of content (in seconds) that a player must keep available in the buffer.

        • SuggestedPresentationDelaySeconds — (Integer)

          The amount of time (in seconds) that the player should be from the end of the manifest.

        • SegmentTemplateFormat — (String)

          Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

          Value description:

          • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

          Possible values include:
          • "NUMBER_WITH_TIMELINE"
        • PeriodTriggers — (Array<String>)

          A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

        • ScteDash — (map)

          The SCTE configuration.

          • AdMarkerDash — (String)

            Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

            Value description:

            • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

            • XML - The SCTE marker is expressed fully in XML.

            Possible values include:
            • "BINARY"
            • "XML"
        • DrmSignaling — (String)

          Determines how the DASH manifest signals the DRM content.

          Possible values include:
          • "INDIVIDUAL"
          • "REFERENCED"
        • UtcTiming — (map)

          Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

          • TimingMode — (String)

            The UTC timing mode.

            Possible values include:
            • "HTTP_HEAD"
            • "HTTP_ISO"
            • "HTTP_XSDATE"
            • "UTC_DIRECT"
          • TimingSource — (String)

            The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the origin endpoint.

Returns:

  • (AWS.Request) —

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

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

Delete a channel to stop AWS Elemental MediaPackage from receiving further content. You must delete the channel's origin endpoints before you can delete the channel.

Service Reference:

Examples:

Calling the deleteChannel operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE' /* required */
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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.

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

Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

Service Reference:

Examples:

Calling the deleteChannelGroup operation

var params = {
  ChannelGroupName: 'STRING_VALUE' /* required */
};
mediapackagev2.deleteChannelGroup(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

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.

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

Delete a channel policy.

Service Reference:

Examples:

Calling the deleteChannelPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE' /* required */
};
mediapackagev2.deleteChannelPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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

Origin endpoints can serve content until they're deleted. Delete the endpoint if it should no longer respond to playback requests. You must delete all endpoints from a channel before you can delete the channel.

Service Reference:

Examples:

Calling the deleteOriginEndpoint operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  OriginEndpointName: 'STRING_VALUE' /* required */
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and 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.

Returns:

  • (AWS.Request) —

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

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

Delete an origin endpoint policy.

Service Reference:

Examples:

Calling the deleteOriginEndpointPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  OriginEndpointName: 'STRING_VALUE' /* required */
};
mediapackagev2.deleteOriginEndpointPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and 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.

Returns:

  • (AWS.Request) —

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

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

Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Service Reference:

Examples:

Calling the getChannel operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE' /* required */
};
mediapackagev2.getChannel(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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) associated with the resource.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • CreatedAt — (Date)

        The date and time the channel was created.

      • ModifiedAt — (Date)

        The date and time the channel was modified.

      • Description — (String)

        The description for your channel.

      • IngestEndpoints — (Array<map>)

        The list of ingest endpoints.

        • Id — (String)

          The system-generated unique identifier for the IngestEndpoint.

        • Url — (String)

          The ingest domain URL where the source stream should be sent.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Retrieves the specified channel group that's configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

Service Reference:

Examples:

Calling the getChannelGroup operation

var params = {
  ChannelGroupName: 'STRING_VALUE' /* required */
};
mediapackagev2.getChannelGroup(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

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:

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • Arn — (String)

        The Amazon Resource Name (ARN) associated with the resource.

      • EgressDomain — (String)

        The output domain where the source stream should be sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

      • CreatedAt — (Date)

        The date and time the channel group was created.

      • ModifiedAt — (Date)

        The date and time the channel group was modified.

      • Description — (String)

        The description for your channel group.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel group.

Returns:

  • (AWS.Request) —

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

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

Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources.

Service Reference:

Examples:

Calling the getChannelPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE' /* required */
};
mediapackagev2.getChannelPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

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:

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • Policy — (String)

        The policy assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.

Service Reference:

Examples:

Calling the getOriginEndpoint operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  OriginEndpointName: 'STRING_VALUE' /* required */
};
mediapackagev2.getOriginEndpoint(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and 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) associated with the resource.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • OriginEndpointName — (String)

        The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

      • ContainerType — (String)

        The type of container attached to this origin endpoint.

        Possible values include:
        • "TS"
        • "CMAF"
      • Segment — (map)

        The segment configuration, including the segment name, duration, and other configuration values.

        • SegmentDurationSeconds — (Integer)

          The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

        • SegmentName — (String)

          The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

        • TsUseAudioRenditionGroup — (Boolean)

          When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

        • IncludeIframeOnlyStreams — (Boolean)

          When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

        • TsIncludeDvbSubtitles — (Boolean)

          By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

        • Scte — (map)

          The SCTE configuration options in the segment settings.

          • ScteFilter — (Array<String>)

            The SCTE-35 message types that you want to be treated as ad markers in the output.

        • Encryption — (map)

          The parameters for encrypting content.

          • ConstantInitializationVector — (String)

            A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

          • EncryptionMethod — required — (map)

            The encryption method to use.

            • TsEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "AES_128"
              • "SAMPLE_AES"
            • CmafEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "CENC"
              • "CBCS"
          • KeyRotationIntervalSeconds — (Integer)

            The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

            The following example setting causes the service to rotate keys every thirty minutes: 1800

          • SpekeKeyProvider — required — (map)

            The parameters for the SPEKE key provider.

            • EncryptionContractConfiguration — required — (map)

              Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

              • PresetSpeke20Audio — required — (String)

                A collection of audio encryption presets.

                Value description:

                • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

                • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

                • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

                • SHARED - Use the same content key for all of the audio and video tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

                Possible values include:
                • "PRESET_AUDIO_1"
                • "PRESET_AUDIO_2"
                • "PRESET_AUDIO_3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String)

                A collection of video encryption presets.

                Value description:

                • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

                • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

                • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • SHARED - Use the same content key for all of the video and audio tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

                Possible values include:
                • "PRESET_VIDEO_1"
                • "PRESET_VIDEO_2"
                • "PRESET_VIDEO_3"
                • "PRESET_VIDEO_4"
                • "PRESET_VIDEO_5"
                • "PRESET_VIDEO_6"
                • "PRESET_VIDEO_7"
                • "PRESET_VIDEO_8"
                • "SHARED"
                • "UNENCRYPTED"
            • ResourceId — required — (String)

              The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

              The following example shows a resource ID: MovieNight20171126093045

            • DrmSystems — required — (Array<String>)

              The DRM solution provider you're using to protect your content during distribution.

            • RoleArn — required — (String)

              The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

              Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

            • Url — required — (String)

              The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

              The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

      • CreatedAt — (Date)

        The date and time the origin endpoint was created.

      • ModifiedAt — (Date)

        The date and time the origin endpoint was modified.

      • Description — (String)

        The description for your origin endpoint.

      • StartoverWindowSeconds — (Integer)

        The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

      • HlsManifests — (Array<map>)

        An HTTP live streaming (HLS) manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • LowLatencyHlsManifests — (Array<map>)

        A low-latency HLS manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the origin endpoint.

      • DashManifests — (Array<map>)

        A DASH manifest configuration.

        • ManifestName — required — (String)

          A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

        • MinUpdatePeriodSeconds — (Integer)

          Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

        • MinBufferTimeSeconds — (Integer)

          Minimum amount of content (in seconds) that a player must keep available in the buffer.

        • SuggestedPresentationDelaySeconds — (Integer)

          The amount of time (in seconds) that the player should be from the end of the manifest.

        • SegmentTemplateFormat — (String)

          Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

          Value description:

          • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

          Possible values include:
          • "NUMBER_WITH_TIMELINE"
        • PeriodTriggers — (Array<String>)

          A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

        • ScteDash — (map)

          The SCTE configuration.

          • AdMarkerDash — (String)

            Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

            Value description:

            • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

            • XML - The SCTE marker is expressed fully in XML.

            Possible values include:
            • "BINARY"
            • "XML"
        • DrmSignaling — (String)

          Determines how the DASH manifest signals the DRM content.

          Possible values include:
          • "INDIVIDUAL"
          • "REFERENCED"
        • UtcTiming — (map)

          Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

          • TimingMode — (String)

            The UTC timing mode.

            Possible values include:
            • "HTTP_HEAD"
            • "HTTP_ISO"
            • "HTTP_XSDATE"
            • "UTC_DIRECT"
          • TimingSource — (String)

            The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

Returns:

  • (AWS.Request) —

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

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

Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.

Service Reference:

Examples:

Calling the getOriginEndpointPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  OriginEndpointName: 'STRING_VALUE' /* required */
};
mediapackagev2.getOriginEndpointPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and 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:

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • OriginEndpointName — (String)

        The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

      • Policy — (String)

        The policy assigned to the origin endpoint.

Returns:

  • (AWS.Request) —

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

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

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

Service Reference:

Examples:

Calling the listChannelGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackagev2.listChannelGroups(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)

      The maximum number of results to return in the response.

    • NextToken — (String)

      The pagination token from the GET list request. Use the token to fetch the next page of results.

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:

      • Items — (Array<map>)

        The objects being returned.

        • ChannelGroupName — required — (String)

          The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) associated with the resource.

        • CreatedAt — required — (Date)

          The date and time the channel group was created.

        • ModifiedAt — required — (Date)

          The date and time the channel group was modified.

        • Description — (String)

          Any descriptive information that you want to add to the channel group for future identification purposes.

      • NextToken — (String)

        The pagination token from the GET list request. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Service Reference:

Examples:

Calling the listChannels operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

    • NextToken — (String)

      The pagination token from the GET list request. Use the token to fetch the next page of results.

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:

      • Items — (Array<map>)

        The objects being returned.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) associated with the resource.

        • ChannelName — required — (String)

          The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

        • ChannelGroupName — required — (String)

          The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

        • CreatedAt — required — (Date)

          The date and time the channel was created.

        • ModifiedAt — required — (Date)

          The date and time the channel was modified.

        • Description — (String)

          Any descriptive information that you want to add to the channel for future identification purposes.

      • NextToken — (String)

        The pagination token from the GET list request.

Returns:

  • (AWS.Request) —

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

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

Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.

Service Reference:

Examples:

Calling the listOriginEndpoints operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • MaxResults — (Integer)

      The maximum number of results to return in the response.

    • NextToken — (String)

      The pagination token from the GET list request. Use the token to fetch the next page of results.

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:

      • Items — (Array<map>)

        The objects being returned.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) associated with the resource.

        • ChannelGroupName — required — (String)

          The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

        • ChannelName — required — (String)

          The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

        • OriginEndpointName — required — (String)

          The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

        • ContainerType — required — (String)

          The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

          Possible values include:
          • "TS"
          • "CMAF"
        • Description — (String)

          Any descriptive information that you want to add to the origin endpoint for future identification purposes.

        • CreatedAt — (Date)

          The date and time the origin endpoint was created.

        • ModifiedAt — (Date)

          The date and time the origin endpoint was modified.

        • HlsManifests — (Array<map>)

          An HTTP live streaming (HLS) manifest configuration.

          • ManifestName — required — (String)

            A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

          • ChildManifestName — (String)

            A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

          • Url — (String)

            The egress domain URL for stream delivery from MediaPackage.

        • LowLatencyHlsManifests — (Array<map>)

          A low-latency HLS manifest configuration.

          • ManifestName — required — (String)

            A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

          • ChildManifestName — (String)

            A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

          • Url — (String)

            The egress domain URL for stream delivery from MediaPackage.

        • DashManifests — (Array<map>)

          A DASH manifest configuration.

          • ManifestName — required — (String)

            A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

          • Url — (String)

            The egress domain URL for stream delivery from MediaPackage.

      • NextToken — (String)

        The pagination token from the GET list request. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Lists the tags assigned to a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mediapackagev2.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)

      The ARN of the CloudWatch resource that you want to view tags for.

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>)

        Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Returns:

  • (AWS.Request) —

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

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

Attaches an IAM policy to the specified channel. With policies, you can specify who has access to AWS resources and what actions they can perform on those resources. You can attach only one policy with each request.

Service Reference:

Examples:

Calling the putChannelPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
mediapackagev2.putChannelPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • Policy — (String)

      The policy to attach to the specified 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.

Returns:

  • (AWS.Request) —

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

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

Attaches an IAM policy to the specified origin endpoint. You can attach only one policy with each request.

Service Reference:

Examples:

Calling the putOriginEndpointPolicy operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  OriginEndpointName: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
mediapackagev2.putOriginEndpointPolicy(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

    • Policy — (String)

      The policy to attach to the specified origin endpoint.

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.

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

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
mediapackagev2.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)

      The ARN of the MediaPackage resource that you're adding tags to.

    • Tags — (map<String>)

      Contains a map of the key-value pairs for the resource tag or tags assigned to the 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.

Returns:

  • (AWS.Request) —

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

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

Removes one or more tags from the specified resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mediapackagev2.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)

      The ARN of the MediaPackage resource that you're removing tags from.

    • TagKeys — (Array<String>)

      The list of tag keys to remove from the 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.

Returns:

  • (AWS.Request) —

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

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

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ETag: 'STRING_VALUE'
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • ETag — (String)

      The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

    • Description — (String)

      Any descriptive information that you want to add to the channel for future identification purposes.

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) associated with the resource.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • CreatedAt — (Date)

        The date and time the channel was created.

      • ModifiedAt — (Date)

        The date and time the channel was modified.

      • Description — (String)

        The description for your channel.

      • IngestEndpoints — (Array<map>)

        The list of ingest endpoints.

        • Id — (String)

          The system-generated unique identifier for the IngestEndpoint.

        • Url — (String)

          The ingest domain URL where the source stream should be sent.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Update the specified channel group. You can edit the description on a channel group for easier identification later from the AWS Elemental MediaPackage console. You can't edit the name of the channel group.

Any edits you make that impact the video output may not be reflected for a few minutes.

Service Reference:

Examples:

Calling the updateChannelGroup operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ETag: 'STRING_VALUE'
};
mediapackagev2.updateChannelGroup(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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ETag — (String)

      The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

    • Description — (String)

      Any descriptive information that you want to add to the channel group for future identification purposes.

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:

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • Arn — (String)

        The Amazon Resource Name (ARN) associated with the resource.

      • EgressDomain — (String)

        The output domain where the source stream is sent. Integrate the domain with a downstream CDN (such as Amazon CloudFront) or playback device.

      • CreatedAt — (Date)

        The date and time the channel group was created.

      • ModifiedAt — (Date)

        The date and time the channel group was modified.

      • Description — (String)

        The description for your channel group.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the channel group.

Returns:

  • (AWS.Request) —

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

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

Update the specified origin endpoint. Edit the packaging preferences on an endpoint to optimize the viewing experience. You can't edit the name of the endpoint.

Any edits you make that impact the video output may not be reflected for a few minutes.

Service Reference:

Examples:

Calling the updateOriginEndpoint operation

var params = {
  ChannelGroupName: 'STRING_VALUE', /* required */
  ChannelName: 'STRING_VALUE', /* required */
  ContainerType: TS | CMAF, /* required */
  OriginEndpointName: 'STRING_VALUE', /* required */
  DashManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      DrmSignaling: INDIVIDUAL | REFERENCED,
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      MinBufferTimeSeconds: 'NUMBER_VALUE',
      MinUpdatePeriodSeconds: 'NUMBER_VALUE',
      PeriodTriggers: [
        AVAILS | DRM_KEY_ROTATION | SOURCE_CHANGES | SOURCE_DISRUPTIONS | NONE,
        /* more items */
      ],
      ScteDash: {
        AdMarkerDash: BINARY | XML
      },
      SegmentTemplateFormat: NUMBER_WITH_TIMELINE,
      SuggestedPresentationDelaySeconds: 'NUMBER_VALUE',
      UtcTiming: {
        TimingMode: HTTP_HEAD | HTTP_ISO | HTTP_XSDATE | UTC_DIRECT,
        TimingSource: 'STRING_VALUE'
      }
    },
    /* more items */
  ],
  Description: 'STRING_VALUE',
  ETag: 'STRING_VALUE',
  HlsManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      ChildManifestName: 'STRING_VALUE',
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
      ScteHls: {
        AdMarkerHls: DATERANGE
      }
    },
    /* more items */
  ],
  LowLatencyHlsManifests: [
    {
      ManifestName: 'STRING_VALUE', /* required */
      ChildManifestName: 'STRING_VALUE',
      FilterConfiguration: {
        End: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        ManifestFilter: 'STRING_VALUE',
        Start: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        TimeDelaySeconds: 'NUMBER_VALUE'
      },
      ManifestWindowSeconds: 'NUMBER_VALUE',
      ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
      ScteHls: {
        AdMarkerHls: DATERANGE
      }
    },
    /* more items */
  ],
  Segment: {
    Encryption: {
      EncryptionMethod: { /* required */
        CmafEncryptionMethod: CENC | CBCS,
        TsEncryptionMethod: AES_128 | SAMPLE_AES
      },
      SpekeKeyProvider: { /* required */
        DrmSystems: [ /* required */
          CLEAR_KEY_AES_128 | FAIRPLAY | PLAYREADY | WIDEVINE,
          /* more items */
        ],
        EncryptionContractConfiguration: { /* required */
          PresetSpeke20Audio: PRESET_AUDIO_1 | PRESET_AUDIO_2 | PRESET_AUDIO_3 | SHARED | UNENCRYPTED, /* required */
          PresetSpeke20Video: PRESET_VIDEO_1 | PRESET_VIDEO_2 | PRESET_VIDEO_3 | PRESET_VIDEO_4 | PRESET_VIDEO_5 | PRESET_VIDEO_6 | PRESET_VIDEO_7 | PRESET_VIDEO_8 | SHARED | UNENCRYPTED /* required */
        },
        ResourceId: 'STRING_VALUE', /* required */
        RoleArn: 'STRING_VALUE', /* required */
        Url: 'STRING_VALUE' /* required */
      },
      ConstantInitializationVector: 'STRING_VALUE',
      KeyRotationIntervalSeconds: 'NUMBER_VALUE'
    },
    IncludeIframeOnlyStreams: true || false,
    Scte: {
      ScteFilter: [
        SPLICE_INSERT | BREAK | PROVIDER_ADVERTISEMENT | DISTRIBUTOR_ADVERTISEMENT | PROVIDER_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_PLACEMENT_OPPORTUNITY | PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY | DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY | PROGRAM,
        /* more items */
      ]
    },
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentName: 'STRING_VALUE',
    TsIncludeDvbSubtitles: true || false,
    TsUseAudioRenditionGroup: true || false
  },
  StartoverWindowSeconds: 'NUMBER_VALUE'
};
mediapackagev2.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: {}) —
    • ChannelGroupName — (String)

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • ChannelName — (String)

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • OriginEndpointName — (String)

      The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

    • ContainerType — (String)

      The type of container attached to this origin endpoint. A container type is a file format that encapsulates one or more media streams, such as audio and video, into a single file.

      Possible values include:
      • "TS"
      • "CMAF"
    • Segment — (map)

      The segment configuration, including the segment name, duration, and other configuration values.

      • SegmentDurationSeconds — (Integer)

        The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

      • SegmentName — (String)

        The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

      • TsUseAudioRenditionGroup — (Boolean)

        When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

      • IncludeIframeOnlyStreams — (Boolean)

        When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

      • TsIncludeDvbSubtitles — (Boolean)

        By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

      • Scte — (map)

        The SCTE configuration options in the segment settings.

        • ScteFilter — (Array<String>)

          The SCTE-35 message types that you want to be treated as ad markers in the output.

      • Encryption — (map)

        The parameters for encrypting content.

        • ConstantInitializationVector — (String)

          A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

        • EncryptionMethod — required — (map)

          The encryption method to use.

          • TsEncryptionMethod — (String)

            The encryption method to use.

            Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • CmafEncryptionMethod — (String)

            The encryption method to use.

            Possible values include:
            • "CENC"
            • "CBCS"
        • KeyRotationIntervalSeconds — (Integer)

          The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

          The following example setting causes the service to rotate keys every thirty minutes: 1800

        • SpekeKeyProvider — required — (map)

          The parameters for the SPEKE key provider.

          • EncryptionContractConfiguration — required — (map)

            Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

            • PresetSpeke20Audio — required — (String)

              A collection of audio encryption presets.

              Value description:

              • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

              • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

              • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

              • SHARED - Use the same content key for all of the audio and video tracks in your stream.

              • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

              Possible values include:
              • "PRESET_AUDIO_1"
              • "PRESET_AUDIO_2"
              • "PRESET_AUDIO_3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String)

              A collection of video encryption presets.

              Value description:

              • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

              • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

              • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

              • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

              • SHARED - Use the same content key for all of the video and audio tracks in your stream.

              • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

              Possible values include:
              • "PRESET_VIDEO_1"
              • "PRESET_VIDEO_2"
              • "PRESET_VIDEO_3"
              • "PRESET_VIDEO_4"
              • "PRESET_VIDEO_5"
              • "PRESET_VIDEO_6"
              • "PRESET_VIDEO_7"
              • "PRESET_VIDEO_8"
              • "SHARED"
              • "UNENCRYPTED"
          • ResourceId — required — (String)

            The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

            The following example shows a resource ID: MovieNight20171126093045

          • DrmSystems — required — (Array<String>)

            The DRM solution provider you're using to protect your content during distribution.

          • RoleArn — required — (String)

            The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

            Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

          • Url — required — (String)

            The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

            The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

    • Description — (String)

      Any descriptive information that you want to add to the origin endpoint for future identification purposes.

    • StartoverWindowSeconds — (Integer)

      The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window. The maximum startover window is 1,209,600 seconds (14 days).

    • HlsManifests — (Array<map>)

      An HTTP live streaming (HLS) manifest configuration.

      • ManifestName — required — (String)

        A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ChildManifestName — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ScteHls — (map)

        The SCTE configuration.

        • AdMarkerHls — (String)

          Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

          Value description:

          • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

          Possible values include:
          • "DATERANGE"
      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • ProgramDateTimeIntervalSeconds — (Integer)

        Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

        Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

    • LowLatencyHlsManifests — (Array<map>)

      A low-latency HLS manifest configuration.

      • ManifestName — required — (String)

        A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ChildManifestName — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index, with an added suffix to distinguish it from the manifest name. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

      • ScteHls — (map)

        The SCTE configuration.

        • AdMarkerHls — (String)

          Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

          Value description:

          • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

          Possible values include:
          • "DATERANGE"
      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • ProgramDateTimeIntervalSeconds — (Integer)

        Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

        Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

    • DashManifests — (Array<map>)

      A DASH manifest configuration.

      • ManifestName — required — (String)

        A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint.

      • ManifestWindowSeconds — (Integer)

        The total duration (in seconds) of the manifest's content.

      • FilterConfiguration — (map)

        Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

        • ManifestFilter — (String)

          Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

        • Start — (Date)

          Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

        • End — (Date)

          Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

        • TimeDelaySeconds — (Integer)

          Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • MinUpdatePeriodSeconds — (Integer)

        Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

      • MinBufferTimeSeconds — (Integer)

        Minimum amount of content (in seconds) that a player must keep available in the buffer.

      • SuggestedPresentationDelaySeconds — (Integer)

        The amount of time (in seconds) that the player should be from the end of the manifest.

      • SegmentTemplateFormat — (String)

        Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

        Value description:

        • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

        Possible values include:
        • "NUMBER_WITH_TIMELINE"
      • PeriodTriggers — (Array<String>)

        A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Type ADS to indicate that AWS Elemental MediaPackage must create periods in the output manifest that correspond to SCTE-35 ad markers in the input source. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

      • ScteDash — (map)

        The SCTE configuration.

        • AdMarkerDash — (String)

          Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

          Value description:

          • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

          • XML - The SCTE marker is expressed fully in XML.

          Possible values include:
          • "BINARY"
          • "XML"
      • DrmSignaling — (String)

        Determines how the DASH manifest signals the DRM content.

        Possible values include:
        • "INDIVIDUAL"
        • "REFERENCED"
      • UtcTiming — (map)

        Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

        • TimingMode — (String)

          The UTC timing mode.

          Possible values include:
          • "HTTP_HEAD"
          • "HTTP_ISO"
          • "HTTP_XSDATE"
          • "UTC_DIRECT"
        • TimingSource — (String)

          The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

    • ETag — (String)

      The expected current Entity Tag (ETag) for the resource. If the specified ETag does not match the resource's current entity tag, the update request will be rejected.

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 ARN associated with the resource.

      • ChannelGroupName — (String)

        The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      • ChannelName — (String)

        The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      • OriginEndpointName — (String)

        The name that describes the origin endpoint. The name is the primary identifier for the origin endpoint, and and must be unique for your account in the AWS Region and channel.

      • ContainerType — (String)

        The type of container attached to this origin endpoint.

        Possible values include:
        • "TS"
        • "CMAF"
      • Segment — (map)

        The segment configuration, including the segment name, duration, and other configuration values.

        • SegmentDurationSeconds — (Integer)

          The duration (in seconds) of each segment. Enter a value equal to, or a multiple of, the input segment duration. If the value that you enter is different from the input segment duration, MediaPackage rounds segments to the nearest multiple of the input segment duration.

        • SegmentName — (String)

          The name that describes the segment. The name is the base name of the segment used in all content manifests inside of the endpoint. You can't use spaces in the name.

        • TsUseAudioRenditionGroup — (Boolean)

          When selected, MediaPackage bundles all audio tracks in a rendition group. All other tracks in the stream can be used with any audio rendition from the group.

        • IncludeIframeOnlyStreams — (Boolean)

          When selected, the stream set includes an additional I-frame only stream, along with the other tracks. If false, this extra stream is not included. MediaPackage generates an I-frame only stream from the first rendition in the manifest. The service inserts EXT-I-FRAMES-ONLY tags in the output manifest, and then generates and includes an I-frames only playlist in the stream. This playlist permits player functionality like fast forward and rewind.

        • TsIncludeDvbSubtitles — (Boolean)

          By default, MediaPackage excludes all digital video broadcasting (DVB) subtitles from the output. When selected, MediaPackage passes through DVB subtitles into the output.

        • Scte — (map)

          The SCTE configuration options in the segment settings.

          • ScteFilter — (Array<String>)

            The SCTE-35 message types that you want to be treated as ad markers in the output.

        • Encryption — (map)

          The parameters for encrypting content.

          • ConstantInitializationVector — (String)

            A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

          • EncryptionMethod — required — (map)

            The encryption method to use.

            • TsEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "AES_128"
              • "SAMPLE_AES"
            • CmafEncryptionMethod — (String)

              The encryption method to use.

              Possible values include:
              • "CENC"
              • "CBCS"
          • KeyRotationIntervalSeconds — (Integer)

            The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

            The following example setting causes the service to rotate keys every thirty minutes: 1800

          • SpekeKeyProvider — required — (map)

            The parameters for the SPEKE key provider.

            • EncryptionContractConfiguration — required — (map)

              Configure one or more content encryption keys for your endpoints that use SPEKE Version 2.0. The encryption contract defines which content keys are used to encrypt the audio and video tracks in your stream. To configure the encryption contract, specify which audio and video encryption presets to use.

              • PresetSpeke20Audio — required — (String)

                A collection of audio encryption presets.

                Value description:

                • PRESET-AUDIO-1 - Use one content key to encrypt all of the audio tracks in your stream.

                • PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo audio tracks and one content key to encrypt all of the multichannel audio tracks.

                • PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo audio tracks, one content key to encrypt all of the multichannel audio tracks with 3 to 6 channels, and one content key to encrypt all of the multichannel audio tracks with more than 6 channels.

                • SHARED - Use the same content key for all of the audio and video tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the audio tracks in your stream.

                Possible values include:
                • "PRESET_AUDIO_1"
                • "PRESET_AUDIO_2"
                • "PRESET_AUDIO_3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String)

                A collection of video encryption presets.

                Value description:

                • PRESET-VIDEO-1 - Use one content key to encrypt all of the video tracks in your stream.

                • PRESET-VIDEO-2 - Use one content key to encrypt all of the SD video tracks and one content key for all HD and higher resolutions video tracks.

                • PRESET-VIDEO-3 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-4 - Use one content key to encrypt all of the SD video tracks, one content key for HD video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-5 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • PRESET-VIDEO-6 - Use one content key to encrypt all of the SD video tracks, one content key for HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks and one content key for all UHD video tracks.

                • PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1 video tracks, one content key for HD2 video tracks, one content key for all UHD1 video tracks and one content key for all UHD2 video tracks.

                • SHARED - Use the same content key for all of the video and audio tracks in your stream.

                • UNENCRYPTED - Don't encrypt any of the video tracks in your stream.

                Possible values include:
                • "PRESET_VIDEO_1"
                • "PRESET_VIDEO_2"
                • "PRESET_VIDEO_3"
                • "PRESET_VIDEO_4"
                • "PRESET_VIDEO_5"
                • "PRESET_VIDEO_6"
                • "PRESET_VIDEO_7"
                • "PRESET_VIDEO_8"
                • "SHARED"
                • "UNENCRYPTED"
            • ResourceId — required — (String)

              The unique identifier for the content. The service sends this to the key server to identify the current endpoint. How unique you make this depends on how fine-grained you want access controls to be. The service does not permit you to use the same ID for two simultaneous encryption processes. The resource ID is also known as the content ID.

              The following example shows a resource ID: MovieNight20171126093045

            • DrmSystems — required — (Array<String>)

              The DRM solution provider you're using to protect your content during distribution.

            • RoleArn — required — (String)

              The ARN for the IAM role granted by the key provider that provides access to the key provider API. This role must have a trust policy that allows MediaPackage to assume the role, and it must have a sufficient permissions policy to allow access to the specific key retrieval URL. Get this from your DRM solution provider.

              Valid format: arn:aws:iam::{accountID}:role/{name}. The following example shows a role ARN: arn:aws:iam::444455556666:role/SpekeAccess

            • Url — required — (String)

              The URL of the API Gateway proxy that you set up to talk to your key server. The API Gateway proxy must reside in the same AWS Region as MediaPackage and must start with https://.

              The following example shows a URL: https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection

      • CreatedAt — (Date)

        The date and time the origin endpoint was created.

      • ModifiedAt — (Date)

        The date and time the origin endpoint was modified.

      • Description — (String)

        The description of the origin endpoint.

      • StartoverWindowSeconds — (Integer)

        The size of the window (in seconds) to create a window of the live stream that's available for on-demand viewing. Viewers can start-over or catch-up on content that falls within the window.

      • HlsManifests — (Array<map>)

        An HTTP live streaming (HLS) manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • LowLatencyHlsManifests — (Array<map>)

        A low-latency HLS manifest configuration.

        • ManifestName — required — (String)

          A short short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index. MediaPackage automatically inserts the format extension, such as .m3u8. You can't use the same manifest name if you use HLS manifest and low-latency HLS manifest. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ChildManifestName — (String)

          A short string that's appended to the endpoint URL. The child manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default child manifest name, index_1. The manifestName on the HLSManifest object overrides the manifestName you provided on the originEndpoint object.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • ProgramDateTimeIntervalSeconds — (Integer)

          Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the interval that you specify. If you don't enter an interval, EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The tags sync the stream to the wall clock so that viewers can seek to a specific time in the playback timeline on the player. ID3Timed metadata messages generate every 5 seconds whenever the content is ingested.

          Irrespective of this parameter, if any ID3Timed metadata is in the HLS input, it is passed through to the HLS output.

        • ScteHls — (map)

          The SCTE configuration.

          • AdMarkerHls — (String)

            Ad markers indicate when ads should be inserted during playback. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output. Choose what you want MediaPackage to do with the ad markers.

            Value description:

            • DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program transition events in TS and CMAF manifests. If you use DATERANGE, you must set a programDateTimeIntervalSeconds value of 1 or higher. To learn more about DATERANGE, see SCTE-35 Ad Marker EXT-X-DATERANGE.

            Possible values include:
            • "DATERANGE"
        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

      • ETag — (String)

        The current Entity Tag (ETag) associated with this resource. The entity tag can be used to safely make concurrent updates to the resource.

      • Tags — (map<String>)

        The comma-separated list of tag key:value pairs assigned to the origin endpoint.

      • DashManifests — (Array<map>)

        A DASH manifest configuration.

        • ManifestName — required — (String)

          A short string that's appended to the endpoint URL. The manifest name creates a unique path to this endpoint. If you don't enter a value, MediaPackage uses the default manifest name, index.

        • Url — required — (String)

          The egress domain URL for stream delivery from MediaPackage.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of the manifest's content.

        • FilterConfiguration — (map)

          Filter configuration includes settings for manifest filtering, start and end times, and time delay that apply to all of your egress requests for this manifest.

          • ManifestFilter — (String)

            Optionally specify one or more manifest filters for all of your manifest egress requests. When you include a manifest filter, note that you cannot use an identical manifest filter query parameter for this manifest's endpoint URL.

          • Start — (Date)

            Optionally specify the start time for all of your manifest egress requests. When you include start time, note that you cannot use start time query parameters for this manifest's endpoint URL.

          • End — (Date)

            Optionally specify the end time for all of your manifest egress requests. When you include end time, note that you cannot use end time query parameters for this manifest's endpoint URL.

          • TimeDelaySeconds — (Integer)

            Optionally specify the time delay for all of your manifest egress requests. Enter a value that is smaller than your endpoint's startover window. When you include time delay, note that you cannot use time delay query parameters for this manifest's endpoint URL.

        • MinUpdatePeriodSeconds — (Integer)

          Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest.

        • MinBufferTimeSeconds — (Integer)

          Minimum amount of content (in seconds) that a player must keep available in the buffer.

        • SuggestedPresentationDelaySeconds — (Integer)

          The amount of time (in seconds) that the player should be from the end of the manifest.

        • SegmentTemplateFormat — (String)

          Determines the type of variable used in the media URL of the SegmentTemplate tag in the manifest. Also specifies if segment timeline information is included in SegmentTimeline or SegmentTemplate.

          Value description:

          • NUMBER_WITH_TIMELINE - The $Number$ variable is used in the media URL. The value of this variable is the sequential number of the segment. A full SegmentTimeline object is presented in each SegmentTemplate.

          Possible values include:
          • "NUMBER_WITH_TIMELINE"
        • PeriodTriggers — (Array<String>)

          A list of triggers that controls when AWS Elemental MediaPackage separates the MPEG-DASH manifest into multiple periods. Leave this value empty to indicate that the manifest is contained all in one period. For more information about periods in the DASH manifest, see Multi-period DASH in AWS Elemental MediaPackage.

        • ScteDash — (map)

          The SCTE configuration.

          • AdMarkerDash — (String)

            Choose how ad markers are included in the packaged content. If you include ad markers in the content stream in your upstream encoders, then you need to inform MediaPackage what to do with the ad markers in the output.

            Value description:

            • Binary - The SCTE-35 marker is expressed as a hex-string (Base64 string) rather than full XML.

            • XML - The SCTE marker is expressed fully in XML.

            Possible values include:
            • "BINARY"
            • "XML"
        • DrmSignaling — (String)

          Determines how the DASH manifest signals the DRM content.

          Possible values include:
          • "INDIVIDUAL"
          • "REFERENCED"
        • UtcTiming — (map)

          Determines the type of UTC timing included in the DASH Media Presentation Description (MPD).

          • TimingMode — (String)

            The UTC timing mode.

            Possible values include:
            • "HTTP_HEAD"
            • "HTTP_ISO"
            • "HTTP_XSDATE"
            • "UTC_DIRECT"
          • TimingSource — (String)

            The the method that the player uses to synchronize to coordinated universal time (UTC) wall clock time.

Returns:

  • (AWS.Request) —

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

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

Waits for a given MediaPackageV2 resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

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