AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.MediaPackageVod

Inherits:
AWS.Service show all
Identifier:
mediapackagevod
API Version:
2018-11-07
Defined in:
(unknown)

Overview

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

Service Description

AWS Elemental MediaPackage VOD

Sending a Request Using MediaPackageVod

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

var mediapackagevod = new AWS.MediaPackageVod({apiVersion: '2018-11-07'});

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

AWS.config.apiVersions = {
  mediapackagevod: '2018-11-07',
  // other service API versions
};

var mediapackagevod = new AWS.MediaPackageVod();

Version:

  • 2018-11-07

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a MediaPackageVod object

var mediapackagevod = new AWS.MediaPackageVod({apiVersion: '2018-11-07'});

Options Hash (options):

  • params (map)

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

  • endpoint (String)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • retryDelayOptions (map)

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and 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.
  • httpOptions (map)

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Creates a new MediaPackage VOD Asset resource.

Service Reference:

Examples:

Calling the createAsset operation

var params = {
  Id: 'STRING_VALUE', /* required */
  PackagingGroupId: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  SourceRoleArn: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE'
};
mediapackagevod.createAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The unique identifier for the Asset.
    • PackagingGroupId — (String) The ID of the PackagingGroup for the Asset.
    • ResourceId — (String) The resource ID to include in SPEKE key requests.
    • SourceArn — (String) ARN of the source object in S3.
    • SourceRoleArn — (String) The IAM role ARN used to access the source S3 bucket.

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 of the Asset.
      • EgressEndpoints — (Array<map>) The list of egress endpoints available for the Asset.
        • PackagingConfigurationId — (String) The ID of the PackagingConfiguration being applied to the Asset.
        • Url — (String) The URL of the parent manifest for the repackaged Asset.
      • Id — (String) The unique identifier for the Asset.
      • PackagingGroupId — (String) The ID of the PackagingGroup for the Asset.
      • ResourceId — (String) The resource ID to include in SPEKE key requests.
      • SourceArn — (String) ARN of the source object in S3.
      • SourceRoleArn — (String) The IAM role_arn used to access the source S3 bucket.

Returns:

  • (AWS.Request)

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

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

Creates a new MediaPackage VOD PackagingConfiguration resource.

Service Reference:

Examples:

Calling the createPackagingConfiguration operation

var params = {
  Id: 'STRING_VALUE', /* required */
  PackagingGroupId: 'STRING_VALUE', /* required */
  CmafPackage: {
    HlsManifests: [ /* required */
      {
        AdMarkers: NONE | SCTE35_ENHANCED | PASSTHROUGH,
        IncludeIframeOnlyStream: true || false,
        ManifestName: 'STRING_VALUE',
        ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
        RepeatExtXKey: true || false,
        StreamSelection: {
          MaxVideoBitsPerSecond: 'NUMBER_VALUE',
          MinVideoBitsPerSecond: 'NUMBER_VALUE',
          StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
        }
      },
      /* more items */
    ],
    Encryption: {
      SpekeKeyProvider: { /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE' /* required */
      }
    },
    SegmentDurationSeconds: 'NUMBER_VALUE'
  },
  DashPackage: {
    DashManifests: [ /* required */
      {
        ManifestName: 'STRING_VALUE',
        MinBufferTimeSeconds: 'NUMBER_VALUE',
        Profile: NONE | HBBTV_1_5,
        StreamSelection: {
          MaxVideoBitsPerSecond: 'NUMBER_VALUE',
          MinVideoBitsPerSecond: 'NUMBER_VALUE',
          StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
        }
      },
      /* more items */
    ],
    Encryption: {
      SpekeKeyProvider: { /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE' /* required */
      }
    },
    SegmentDurationSeconds: 'NUMBER_VALUE'
  },
  HlsPackage: {
    HlsManifests: [ /* required */
      {
        AdMarkers: NONE | SCTE35_ENHANCED | PASSTHROUGH,
        IncludeIframeOnlyStream: true || false,
        ManifestName: 'STRING_VALUE',
        ProgramDateTimeIntervalSeconds: 'NUMBER_VALUE',
        RepeatExtXKey: true || false,
        StreamSelection: {
          MaxVideoBitsPerSecond: 'NUMBER_VALUE',
          MinVideoBitsPerSecond: 'NUMBER_VALUE',
          StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
        }
      },
      /* more items */
    ],
    Encryption: {
      SpekeKeyProvider: { /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE' /* required */
      },
      ConstantInitializationVector: 'STRING_VALUE',
      EncryptionMethod: AES_128 | SAMPLE_AES
    },
    SegmentDurationSeconds: 'NUMBER_VALUE',
    UseAudioRenditionGroup: true || false
  },
  MssPackage: {
    MssManifests: [ /* required */
      {
        ManifestName: 'STRING_VALUE',
        StreamSelection: {
          MaxVideoBitsPerSecond: 'NUMBER_VALUE',
          MinVideoBitsPerSecond: 'NUMBER_VALUE',
          StreamOrder: ORIGINAL | VIDEO_BITRATE_ASCENDING | VIDEO_BITRATE_DESCENDING
        }
      },
      /* more items */
    ],
    Encryption: {
      SpekeKeyProvider: { /* required */
        RoleArn: 'STRING_VALUE', /* required */
        SystemIds: [ /* required */
          'STRING_VALUE',
          /* more items */
        ],
        Url: 'STRING_VALUE' /* required */
      }
    },
    SegmentDurationSeconds: 'NUMBER_VALUE'
  }
};
mediapackagevod.createPackagingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CmafPackage — (map) A CMAF packaging configuration.
      • Encryption — (map) A CMAF encryption configuration.
        • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
        • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
        • ManifestName — (String) An optional string to include in the name of the manifest.
        • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
        • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
        • StreamSelection — (map) A StreamSelection configuration.
          • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
          • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
          • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
    • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      • DashManifestsrequired — (Array<map>) A list of DASH manifest configurations.
        • ManifestName — (String) An optional string to include in the name of the manifest.
        • MinBufferTimeSeconds — (Integer) Minimum duration (in seconds) that a player will buffer media before starting the presentation.
        • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
          • "NONE"
          • "HBBTV_1_5"
        • StreamSelection — (map) A StreamSelection configuration.
          • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
          • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
          • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
    • HlsPackage — (map) An HTTP Live Streaming (HLS) packaging configuration.
      • Encryption — (map) An HTTP Live Streaming (HLS) encryption configuration.
        • ConstantInitializationVector — (String) A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
        • EncryptionMethod — (String) The encryption method to use. Possible values include:
          • "AES_128"
          • "SAMPLE_AES"
        • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
        • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
          • "NONE"
          • "SCTE35_ENHANCED"
          • "PASSTHROUGH"
        • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
        • ManifestName — (String) An optional string to include in the name of the manifest.
        • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
        • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
        • StreamSelection — (map) A StreamSelection configuration.
          • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
          • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
          • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
    • Id — (String) The ID of the PackagingConfiguration.
    • MssPackage — (map) A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
      • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
        • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
          • Urlrequired — (String) The URL of the external key provider service.
      • MssManifestsrequired — (Array<map>) A list of MSS manifest configurations.
        • ManifestName — (String) An optional string to include in the name of the manifest.
        • StreamSelection — (map) A StreamSelection configuration.
          • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
          • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
          • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
            • "ORIGINAL"
            • "VIDEO_BITRATE_ASCENDING"
            • "VIDEO_BITRATE_DESCENDING"
      • SegmentDurationSeconds — (Integer) The duration (in seconds) of each segment.
    • PackagingGroupId — (String) The ID of a PackagingGroup.

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 of the PackagingConfiguration.
      • CmafPackage — (map) A CMAF packaging configuration.
        • Encryption — (map) A CMAF encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
          • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
          • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • DashManifestsrequired — (Array<map>) A list of DASH manifest configurations.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • MinBufferTimeSeconds — (Integer) Minimum duration (in seconds) that a player will buffer media before starting the presentation.
          • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
            • "NONE"
            • "HBBTV_1_5"
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      • HlsPackage — (map) An HTTP Live Streaming (HLS) packaging configuration.
        • Encryption — (map) An HTTP Live Streaming (HLS) encryption configuration.
          • ConstantInitializationVector — (String) A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
          • EncryptionMethod — (String) The encryption method to use. Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
          • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
          • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
        • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
      • Id — (String) The ID of the PackagingConfiguration.
      • MssPackage — (map) A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
        • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • MssManifestsrequired — (Array<map>) A list of MSS manifest configurations.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) The duration (in seconds) of each segment.
      • PackagingGroupId — (String) The ID of a PackagingGroup.

Returns:

  • (AWS.Request)

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

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

Creates a new MediaPackage VOD PackagingGroup resource.

Service Reference:

Examples:

Calling the createPackagingGroup operation

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

Parameters:

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

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 of the PackagingGroup.
      • Id — (String) The ID of the PackagingGroup.

Returns:

  • (AWS.Request)

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

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

Deletes an existing MediaPackage VOD Asset resource.

Service Reference:

Examples:

Calling the deleteAsset operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the MediaPackage VOD Asset resource to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes a MediaPackage VOD PackagingConfiguration resource.

Service Reference:

Examples:

Calling the deletePackagingConfiguration operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the MediaPackage VOD PackagingConfiguration resource to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Deletes a MediaPackage VOD PackagingGroup resource.

Service Reference:

Examples:

Calling the deletePackagingGroup operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of the MediaPackage VOD PackagingGroup resource to delete.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

Returns:

  • (AWS.Request)

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

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

Returns a description of a MediaPackage VOD Asset resource.

Service Reference:

Examples:

Calling the describeAsset operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of an MediaPackage VOD Asset resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Arn — (String) The ARN of the Asset.
      • EgressEndpoints — (Array<map>) The list of egress endpoints available for the Asset.
        • PackagingConfigurationId — (String) The ID of the PackagingConfiguration being applied to the Asset.
        • Url — (String) The URL of the parent manifest for the repackaged Asset.
      • Id — (String) The unique identifier for the Asset.
      • PackagingGroupId — (String) The ID of the PackagingGroup for the Asset.
      • ResourceId — (String) The resource ID to include in SPEKE key requests.
      • SourceArn — (String) ARN of the source object in S3.
      • SourceRoleArn — (String) The IAM role_arn used to access the source S3 bucket.

Returns:

  • (AWS.Request)

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

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

Returns a description of a MediaPackage VOD PackagingConfiguration resource.

Service Reference:

Examples:

Calling the describePackagingConfiguration operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of a MediaPackage VOD PackagingConfiguration resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Arn — (String) The ARN of the PackagingConfiguration.
      • CmafPackage — (map) A CMAF packaging configuration.
        • Encryption — (map) A CMAF encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
          • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
          • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • DashManifestsrequired — (Array<map>) A list of DASH manifest configurations.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • MinBufferTimeSeconds — (Integer) Minimum duration (in seconds) that a player will buffer media before starting the presentation.
          • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
            • "NONE"
            • "HBBTV_1_5"
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      • HlsPackage — (map) An HTTP Live Streaming (HLS) packaging configuration.
        • Encryption — (map) An HTTP Live Streaming (HLS) encryption configuration.
          • ConstantInitializationVector — (String) A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
          • EncryptionMethod — (String) The encryption method to use. Possible values include:
            • "AES_128"
            • "SAMPLE_AES"
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
          • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
            • "NONE"
            • "SCTE35_ENHANCED"
            • "PASSTHROUGH"
          • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
          • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
        • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
      • Id — (String) The ID of the PackagingConfiguration.
      • MssPackage — (map) A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
        • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
          • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
            • Urlrequired — (String) The URL of the external key provider service.
        • MssManifestsrequired — (Array<map>) A list of MSS manifest configurations.
          • ManifestName — (String) An optional string to include in the name of the manifest.
          • StreamSelection — (map) A StreamSelection configuration.
            • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
            • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
            • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
              • "ORIGINAL"
              • "VIDEO_BITRATE_ASCENDING"
              • "VIDEO_BITRATE_DESCENDING"
        • SegmentDurationSeconds — (Integer) The duration (in seconds) of each segment.
      • PackagingGroupId — (String) The ID of a PackagingGroup.

Returns:

  • (AWS.Request)

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

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

Returns a description of a MediaPackage VOD PackagingGroup resource.

Service Reference:

Examples:

Calling the describePackagingGroup operation

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

Parameters:

  • params (Object) (defaults to: {})
    • Id — (String) The ID of a MediaPackage VOD PackagingGroup resource.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • Arn — (String) The ARN of the PackagingGroup.
      • Id — (String) The ID of the PackagingGroup.

Returns:

  • (AWS.Request)

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

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

Returns a collection of MediaPackage VOD Asset resources.

Service Reference:

Examples:

Calling the listAssets operation

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

Parameters:

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

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:

      • Assets — (Array<map>) A list of MediaPackage VOD Asset resources.
        • Arn — (String) The ARN of the Asset.
        • Id — (String) The unique identifier for the Asset.
        • PackagingGroupId — (String) The ID of the PackagingGroup for the Asset.
        • ResourceId — (String) The resource ID to include in SPEKE key requests.
        • SourceArn — (String) ARN of the source object in S3.
        • SourceRoleArn — (String) The IAM role ARN used to access the source S3 bucket.
      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

  • (AWS.Request)

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

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

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

Service Reference:

Examples:

Calling the listPackagingConfigurations operation

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

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer) Upper bound on number of records to return.
    • NextToken — (String) A token used to resume pagination from the end of a previous request.
    • PackagingGroupId — (String) Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.
      • PackagingConfigurations — (Array<map>) A list of MediaPackage VOD PackagingConfiguration resources.
        • Arn — (String) The ARN of the PackagingConfiguration.
        • CmafPackage — (map) A CMAF packaging configuration.
          • Encryption — (map) A CMAF encryption configuration.
            • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (String) The URL of the external key provider service.
          • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
            • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
              • "NONE"
              • "SCTE35_ENHANCED"
              • "PASSTHROUGH"
            • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
            • ManifestName — (String) An optional string to include in the name of the manifest.
            • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
            • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
            • StreamSelection — (map) A StreamSelection configuration.
              • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
              • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
              • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
                • "ORIGINAL"
                • "VIDEO_BITRATE_ASCENDING"
                • "VIDEO_BITRATE_DESCENDING"
          • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
        • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
          • DashManifestsrequired — (Array<map>) A list of DASH manifest configurations.
            • ManifestName — (String) An optional string to include in the name of the manifest.
            • MinBufferTimeSeconds — (Integer) Minimum duration (in seconds) that a player will buffer media before starting the presentation.
            • Profile — (String) The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled. Possible values include:
              • "NONE"
              • "HBBTV_1_5"
            • StreamSelection — (map) A StreamSelection configuration.
              • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
              • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
              • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
                • "ORIGINAL"
                • "VIDEO_BITRATE_ASCENDING"
                • "VIDEO_BITRATE_DESCENDING"
          • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
            • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (String) The URL of the external key provider service.
          • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
        • HlsPackage — (map) An HTTP Live Streaming (HLS) packaging configuration.
          • Encryption — (map) An HTTP Live Streaming (HLS) encryption configuration.
            • ConstantInitializationVector — (String) A constant initialization vector for encryption (optional). When not specified the initialization vector will be periodically rotated.
            • EncryptionMethod — (String) The encryption method to use. Possible values include:
              • "AES_128"
              • "SAMPLE_AES"
            • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (String) The URL of the external key provider service.
          • HlsManifestsrequired — (Array<map>) A list of HLS manifest configurations.
            • AdMarkers — (String) This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35 messages in the input source. Possible values include:
              • "NONE"
              • "SCTE35_ENHANCED"
              • "PASSTHROUGH"
            • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
            • ManifestName — (String) An optional string to include in the name of the manifest.
            • ProgramDateTimeIntervalSeconds — (Integer) The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.
            • RepeatExtXKey — (Boolean) When enabled, the EXT-X-KEY tag will be repeated in output manifests.
            • StreamSelection — (map) A StreamSelection configuration.
              • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
              • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
              • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
                • "ORIGINAL"
                • "VIDEO_BITRATE_ASCENDING"
                • "VIDEO_BITRATE_DESCENDING"
          • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
          • UseAudioRenditionGroup — (Boolean) When enabled, audio streams will be placed in rendition groups in the output.
        • Id — (String) The ID of the PackagingConfiguration.
        • MssPackage — (map) A Microsoft Smooth Streaming (MSS) PackagingConfiguration.
          • Encryption — (map) A Microsoft Smooth Streaming (MSS) encryption configuration.
            • SpekeKeyProviderrequired — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
              • RoleArnrequired — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
              • SystemIdsrequired — (Array<String>) The system IDs to include in key requests.
              • Urlrequired — (String) The URL of the external key provider service.
          • MssManifestsrequired — (Array<map>) A list of MSS manifest configurations.
            • ManifestName — (String) An optional string to include in the name of the manifest.
            • StreamSelection — (map) A StreamSelection configuration.
              • MaxVideoBitsPerSecond — (Integer) The maximum video bitrate (bps) to include in output.
              • MinVideoBitsPerSecond — (Integer) The minimum video bitrate (bps) to include in output.
              • StreamOrder — (String) A directive that determines the order of streams in the output. Possible values include:
                • "ORIGINAL"
                • "VIDEO_BITRATE_ASCENDING"
                • "VIDEO_BITRATE_DESCENDING"
          • SegmentDurationSeconds — (Integer) The duration (in seconds) of each segment.
        • PackagingGroupId — (String) The ID of a PackagingGroup.

Returns:

  • (AWS.Request)

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

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

Returns a collection of MediaPackage VOD PackagingGroup resources.

Service Reference:

Examples:

Calling the listPackagingGroups operation

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

Parameters:

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response)

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

    Parameters:

    • err (Error)

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

    • data (Object)

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

      • NextToken — (String) A token that can be used to resume pagination from the end of the collection.
      • PackagingGroups — (Array<map>) A list of MediaPackage VOD PackagingGroup resources.
        • Arn — (String) The ARN of the PackagingGroup.
        • Id — (String) The ID of the PackagingGroup.

Returns:

  • (AWS.Request)

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