Class: AWS.MediaPackageVod

var params = {
  Id: 'STRING_VALUE', /* required */
  PackagingGroupId: 'STRING_VALUE', /* required */
  SourceArn: 'STRING_VALUE', /* required */
  SourceRoleArn: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
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.
  • Tags — (map<String>) A collection of tags associated with a resource

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Arn — (String) The ARN of the Asset.
    • CreatedAt — (String) The time the Asset was initially submitted for Ingest.
    • EgressEndpoints — (Array<map>) The list of egress endpoints available for the Asset.
      • PackagingConfigurationId — (String) The ID of the PackagingConfiguration being applied to the Asset.
      • Status — (String) The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information won't be available for most assets ingested before 2021-09-30.
      • 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.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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 */
        EncryptionContractConfiguration: {
          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 */
        }
      },
      ConstantInitializationVector: 'STRING_VALUE'
    },
    IncludeEncoderConfigurationInSegments: true || false,
    SegmentDurationSeconds: 'NUMBER_VALUE'
  },
  DashPackage: {
    DashManifests: [ /* required */
      {
        ManifestLayout: FULL | COMPACT,
        ManifestName: 'STRING_VALUE',
        MinBufferTimeSeconds: 'NUMBER_VALUE',
        Profile: NONE | HBBTV_1_5,
        ScteMarkersSource: SEGMENTS | MANIFEST,
        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 */
        EncryptionContractConfiguration: {
          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 */
        }
      }
    },
    IncludeEncoderConfigurationInSegments: true || false,
    IncludeIframeOnlyStream: true || false,
    PeriodTriggers: [
      ADS,
      /* more items */
    ],
    SegmentDurationSeconds: 'NUMBER_VALUE',
    SegmentTemplateFormat: NUMBER_WITH_TIMELINE | TIME_WITH_TIMELINE | NUMBER_WITH_DURATION
  },
  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 */
        EncryptionContractConfiguration: {
          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 */
        }
      },
      ConstantInitializationVector: 'STRING_VALUE',
      EncryptionMethod: AES_128 | SAMPLE_AES
    },
    IncludeDvbSubtitles: true || false,
    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 */
        EncryptionContractConfiguration: {
          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 */
        }
      }
    },
    SegmentDurationSeconds: 'NUMBER_VALUE'
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
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.
      • ConstantInitializationVector — (String) An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
      • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
          • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
            • "PRESET-AUDIO-1"
            • "PRESET-AUDIO-2"
            • "PRESET-AUDIO-3"
            • "SHARED"
            • "UNENCRYPTED"
          • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
        • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        • SystemIds — required — (Array<String>) The system IDs to include in key requests.
        • Url — required — (String) The URL of the external key provider service.
    • HlsManifests — required — (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"
    • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
    • 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.
    • DashManifests — required — (Array<map>) A list of DASH manifest configurations.
      • ManifestLayout — (String) Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. Possible values include:
        • "FULL"
        • "COMPACT"
      • 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"
      • ScteMarkersSource — (String) The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. Possible values include:
        • "SEGMENTS"
        • "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"
    • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
      • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
          • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
            • "PRESET-AUDIO-1"
            • "PRESET-AUDIO-2"
            • "PRESET-AUDIO-3"
            • "SHARED"
            • "UNENCRYPTED"
          • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
        • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        • SystemIds — required — (Array<String>) The system IDs to include in key requests.
        • Url — required — (String) The URL of the external key provider service.
    • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
    • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
    • PeriodTriggers — (Array<String>) A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Asset contains SCTE-35 ad markers.
    • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
    • SegmentTemplateFormat — (String) Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. Possible values include:
      • "NUMBER_WITH_TIMELINE"
      • "TIME_WITH_TIMELINE"
      • "NUMBER_WITH_DURATION"
  • 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"
      • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
          • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
            • "PRESET-AUDIO-1"
            • "PRESET-AUDIO-2"
            • "PRESET-AUDIO-3"
            • "SHARED"
            • "UNENCRYPTED"
          • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
        • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        • SystemIds — required — (Array<String>) The system IDs to include in key requests.
        • Url — required — (String) The URL of the external key provider service.
    • HlsManifests — required — (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"
    • IncludeDvbSubtitles — (Boolean) When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
    • 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.
      • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
        • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
          • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
            • "PRESET-AUDIO-1"
            • "PRESET-AUDIO-2"
            • "PRESET-AUDIO-3"
            • "SHARED"
            • "UNENCRYPTED"
          • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
        • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
        • SystemIds — required — (Array<String>) The system IDs to include in key requests.
        • Url — required — (String) The URL of the external key provider service.
    • MssManifests — required — (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.
  • Tags — (map<String>) A collection of tags associated with a resource

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Arn — (String) The ARN of the PackagingConfiguration.
    • CmafPackage — (map) A CMAF packaging configuration.
      • Encryption — (map) A CMAF encryption configuration.
        • ConstantInitializationVector — (String) An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • HlsManifests — required — (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"
      • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
    • CreatedAt — (String) The time the PackagingConfiguration was created.
    • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      • DashManifests — required — (Array<map>) A list of DASH manifest configurations.
        • ManifestLayout — (String) Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. Possible values include:
          • "FULL"
          • "COMPACT"
        • 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"
        • ScteMarkersSource — (String) The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. Possible values include:
          • "SEGMENTS"
          • "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"
      • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
      • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
      • PeriodTriggers — (Array<String>) A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Asset contains SCTE-35 ad markers.
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      • SegmentTemplateFormat — (String) Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. Possible values include:
        • "NUMBER_WITH_TIMELINE"
        • "TIME_WITH_TIMELINE"
        • "NUMBER_WITH_DURATION"
    • 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"
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • HlsManifests — required — (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"
      • IncludeDvbSubtitles — (Boolean) When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
      • 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.
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • MssManifests — required — (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.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

var params = {
  Id: 'STRING_VALUE', /* required */
  Authorization: {
    CdnIdentifierSecret: 'STRING_VALUE', /* required */
    SecretsRoleArn: 'STRING_VALUE' /* required */
  },
  EgressAccessLogs: {
    LogGroupName: 'STRING_VALUE'
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
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: {}) —
  • Authorization — (map) CDN Authorization credentials
    • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
    • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
  • EgressAccessLogs — (map) Configure egress access logging.
    • LogGroupName — (String) Customize the log group name.
  • Id — (String) The ID of the PackagingGroup.
  • Tags — (map<String>) A collection of tags associated with a resource

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

    • Arn — (String) The ARN of the PackagingGroup.
    • Authorization — (map) CDN Authorization credentials
      • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
      • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
    • CreatedAt — (String) The time the PackagingGroup was created.
    • DomainName — (String) The fully qualified domain name for Assets in the PackagingGroup.
    • EgressAccessLogs — (map) Configure egress access logging.
      • LogGroupName — (String) Customize the log group name.
    • Id — (String) The ID of the PackagingGroup.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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.

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.

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.

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.
    • CreatedAt — (String) The time the Asset was initially submitted for Ingest.
    • EgressEndpoints — (Array<map>) The list of egress endpoints available for the Asset.
      • PackagingConfigurationId — (String) The ID of the PackagingConfiguration being applied to the Asset.
      • Status — (String) The current processing status of the asset used for the packaging configuration. The status can be either QUEUED, PROCESSING, PLAYABLE, or FAILED. Status information won't be available for most assets ingested before 2021-09-30.
      • 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.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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.
        • ConstantInitializationVector — (String) An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • HlsManifests — required — (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"
      • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
    • CreatedAt — (String) The time the PackagingConfiguration was created.
    • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
      • DashManifests — required — (Array<map>) A list of DASH manifest configurations.
        • ManifestLayout — (String) Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. Possible values include:
          • "FULL"
          • "COMPACT"
        • 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"
        • ScteMarkersSource — (String) The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. Possible values include:
          • "SEGMENTS"
          • "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"
      • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
      • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
      • PeriodTriggers — (Array<String>) A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Asset contains SCTE-35 ad markers.
      • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
      • SegmentTemplateFormat — (String) Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. Possible values include:
        • "NUMBER_WITH_TIMELINE"
        • "TIME_WITH_TIMELINE"
        • "NUMBER_WITH_DURATION"
    • 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"
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • HlsManifests — required — (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"
      • IncludeDvbSubtitles — (Boolean) When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
      • 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.
        • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
          • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
            • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
              • "PRESET-AUDIO-1"
              • "PRESET-AUDIO-2"
              • "PRESET-AUDIO-3"
              • "SHARED"
              • "UNENCRYPTED"
            • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
          • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
          • SystemIds — required — (Array<String>) The system IDs to include in key requests.
          • Url — required — (String) The URL of the external key provider service.
      • MssManifests — required — (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.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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:

    • ApproximateAssetCount — (Integer) The approximate asset count of the PackagingGroup.
    • Arn — (String) The ARN of the PackagingGroup.
    • Authorization — (map) CDN Authorization credentials
      • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
      • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
    • CreatedAt — (String) The time the PackagingGroup was created.
    • DomainName — (String) The fully qualified domain name for Assets in the PackagingGroup.
    • EgressAccessLogs — (map) Configure egress access logging.
      • LogGroupName — (String) Customize the log group name.
    • Id — (String) The ID of the PackagingGroup.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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.
      • CreatedAt — (String) The time the Asset was initially submitted for Ingest.
      • 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.
      • Tags — (map<String>) A collection of tags associated with a resource
    • NextToken — (String) A token that can be used to resume pagination from the end of the collection.

Returns:

• (AWS.Request) —

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

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.
          • ConstantInitializationVector — (String) An optional 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting blocks. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).
          • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
              • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
                • "PRESET-AUDIO-1"
                • "PRESET-AUDIO-2"
                • "PRESET-AUDIO-3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
            • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIds — required — (Array<String>) The system IDs to include in key requests.
            • Url — required — (String) The URL of the external key provider service.
        • HlsManifests — required — (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"
        • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source fragment duration.
      • CreatedAt — (String) The time the PackagingConfiguration was created.
      • DashPackage — (map) A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.
        • DashManifests — required — (Array<map>) A list of DASH manifest configurations.
          • ManifestLayout — (String) Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level. Possible values include:
            • "FULL"
            • "COMPACT"
          • 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"
          • ScteMarkersSource — (String) The source of scte markers used. When set to SEGMENTS, the scte markers are sourced from the segments of the ingested content. When set to MANIFEST, the scte markers are sourced from the manifest of the ingested content. Possible values include:
            • "SEGMENTS"
            • "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"
        • Encryption — (map) A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.
          • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
              • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
                • "PRESET-AUDIO-1"
                • "PRESET-AUDIO-2"
                • "PRESET-AUDIO-3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
            • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIds — required — (Array<String>) The system IDs to include in key requests.
            • Url — required — (String) The URL of the external key provider service.
        • IncludeEncoderConfigurationInSegments — (Boolean) When includeEncoderConfigurationInSegments is set to true, MediaPackage places your encoder's Sequence Parameter Set (SPS), Picture Parameter Set (PPS), and Video Parameter Set (VPS) metadata in every video segment instead of in the init fragment. This lets you use different SPS/PPS/VPS settings for your assets during content playback.
        • IncludeIframeOnlyStream — (Boolean) When enabled, an I-Frame only stream will be included in the output.
        • PeriodTriggers — (Array<String>) A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into more than one period. If the list contains "ADS", new periods will be created where the Asset contains SCTE-35 ad markers.
        • SegmentDurationSeconds — (Integer) Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source segment duration.
        • SegmentTemplateFormat — (String) Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs. Possible values include:
          • "NUMBER_WITH_TIMELINE"
          • "TIME_WITH_TIMELINE"
          • "NUMBER_WITH_DURATION"
      • 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"
          • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
              • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
                • "PRESET-AUDIO-1"
                • "PRESET-AUDIO-2"
                • "PRESET-AUDIO-3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
            • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIds — required — (Array<String>) The system IDs to include in key requests.
            • Url — required — (String) The URL of the external key provider service.
        • HlsManifests — required — (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"
        • IncludeDvbSubtitles — (Boolean) When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.
        • 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.
          • SpekeKeyProvider — required — (map) A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.
            • EncryptionContractConfiguration — (map) Use encryptionContractConfiguration to configure one or more content encryption keys for your endpoints that use SPEKE 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. Note the following considerations when using encryptionContractConfiguration: encryptionContractConfiguration can be used for DASH endpoints that use SPEKE 2.0. SPEKE 2.0 relies on the CPIX 2.3 specification. You must disable key rotation for this endpoint by setting keyRotationIntervalSeconds to 0.
              • PresetSpeke20Audio — required — (String) A collection of audio encryption presets. Possible values include:
                • "PRESET-AUDIO-1"
                • "PRESET-AUDIO-2"
                • "PRESET-AUDIO-3"
                • "SHARED"
                • "UNENCRYPTED"
              • PresetSpeke20Video — required — (String) A collection of video encryption presets. 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"
            • RoleArn — required — (String) An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key provider service.
            • SystemIds — required — (Array<String>) The system IDs to include in key requests.
            • Url — required — (String) The URL of the external key provider service.
        • MssManifests — required — (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.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

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.
      • ApproximateAssetCount — (Integer) The approximate asset count of the PackagingGroup.
      • Arn — (String) The ARN of the PackagingGroup.
      • Authorization — (map) CDN Authorization credentials
        • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
        • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
      • CreatedAt — (String) The time the PackagingGroup was created.
      • DomainName — (String) The fully qualified domain name for Assets in the PackagingGroup.
      • EgressAccessLogs — (map) Configure egress access logging.
        • LogGroupName — (String) Customize the log group name.
      • Id — (String) The ID of the PackagingGroup.
      • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mediapackagevod.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 Amazon Resource Name (ARN) for the resource. You can get this from the response to any request 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. The data object has the following properties:

    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediapackagevod.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 Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
  • Tags — (map<String>) A collection of tags associated with a resource

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mediapackagevod.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 Amazon Resource Name (ARN) for the resource. You can get this from the response to any request to the resource.
  • TagKeys — (Array<String>) A comma-separated list of the 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.

var params = {
  Id: 'STRING_VALUE', /* required */
  Authorization: {
    CdnIdentifierSecret: 'STRING_VALUE', /* required */
    SecretsRoleArn: 'STRING_VALUE' /* required */
  }
};
mediapackagevod.updatePackagingGroup(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: {}) —
  • Authorization — (map) CDN Authorization credentials
    • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
    • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
  • 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:

    • ApproximateAssetCount — (Integer) The approximate asset count of the PackagingGroup.
    • Arn — (String) The ARN of the PackagingGroup.
    • Authorization — (map) CDN Authorization credentials
      • CdnIdentifierSecret — required — (String) The Amazon Resource Name (ARN) for the secret in AWS Secrets Manager that is used for CDN authorization.
      • SecretsRoleArn — required — (String) The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.
    • CreatedAt — (String) The time the PackagingGroup was created.
    • DomainName — (String) The fully qualified domain name for Assets in the PackagingGroup.
    • EgressAccessLogs — (map) Configure egress access logging.
      • LogGroupName — (String) Customize the log group name.
    • Id — (String) The ID of the PackagingGroup.
    • Tags — (map<String>) A collection of tags associated with a resource

Returns:

• (AWS.Request) —

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