You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MediaTailor

Inherits:
AWS.Service show all
Identifier:
mediatailor
API Version:
2018-04-23
Defined in:
(unknown)

Overview

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

Service Description

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

Sending a Request Using MediaTailor

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

Locking the API Version

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

var mediatailor = new AWS.MediaTailor({apiVersion: '2018-04-23'});

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

AWS.config.apiVersions = {
  mediatailor: '2018-04-23',
  // other service API versions
};

var mediatailor = new AWS.MediaTailor();

Version:

  • 2018-04-23

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a MediaTailor object

var mediatailor = new AWS.MediaTailor({apiVersion: '2018-04-23'});

Options Hash (options):

  • params (map) —

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

  • endpoint (String|AWS.Endpoint) —

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

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

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

  • credentialProvider (AWS.CredentialProviderChain) —

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

  • region (String) —

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

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

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

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

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

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

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

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Configures Amazon CloudWatch log settings for a playback configuration.

Service Reference:

Examples:

Calling the configureLogsForPlaybackConfiguration operation

var params = {
  PercentEnabled: 'NUMBER_VALUE', /* required */
  PlaybackConfigurationName: 'STRING_VALUE' /* required */
};
mediatailor.configureLogsForPlaybackConfiguration(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: {}) —
    • PercentEnabled — (Integer)

      The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

      Valid values: 0 - 100

    • PlaybackConfigurationName — (String)

      The name of the playback configuration.

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:

      • PercentEnabled — (Integer)

        The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.

      • PlaybackConfigurationName — (String)

        The name of the playback configuration.

Returns:

  • (AWS.Request) —

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

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

Creates a channel.

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  ChannelName: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      ManifestName: 'STRING_VALUE', /* required */
      SourceGroup: 'STRING_VALUE', /* required */
      DashPlaylistSettings: {
        ManifestWindowSeconds: 'NUMBER_VALUE',
        MinBufferTimeSeconds: 'NUMBER_VALUE',
        MinUpdatePeriodSeconds: 'NUMBER_VALUE',
        SuggestedPresentationDelaySeconds: 'NUMBER_VALUE'
      },
      HlsPlaylistSettings: {
        ManifestWindowSeconds: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ],
  PlaybackMode: LOOP | LINEAR, /* required */
  FillerSlate: {
    SourceLocationName: 'STRING_VALUE',
    VodSourceName: 'STRING_VALUE'
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediatailor.createChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier for the channel you are working on.

    • FillerSlate — (map)

      The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses a LINEAR PlaybackMode.

      • SourceLocationName — (String)

        The name of the source location where the slate VOD source is stored.

      • VodSourceName — (String)

        The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

    • Outputs — (Array<map>)

      The channel's output properties.

      • DashPlaylistSettings — (map)

        DASH manifest configuration parameters.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • MinBufferTimeSeconds — (Integer)

          Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • MinUpdatePeriodSeconds — (Integer)

          Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • SuggestedPresentationDelaySeconds — (Integer)

          Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

      • HlsPlaylistSettings — (map)

        HLS playlist configuration parameters.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

      • ManifestName — required — (String)

        The name of the manifest for the channel. The name appears in the PlaybackUrl.

      • SourceGroup — required — (String)

        A string used to match which HttpPackageConfiguration is used for each VodSource.

    • PlaybackMode — (String)

      The type of playback mode to use for this channel.

      LINEAR - The programs in the schedule play once back-to-back in the schedule.

      LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

      Possible values include:
      • "LOOP"
      • "LINEAR"
    • Tags — (map<String>)

      The tags to assign to the channel.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Arn — (String)

        The ARN of the channel.

      • ChannelName — (String)

        The name of the channel.

      • ChannelState — (String)

        Indicates whether the channel is in a running state or not.

        Possible values include:
        • "RUNNING"
        • "STOPPED"
      • CreationTime — (Date)

        The timestamp of when the channel was created.

      • FillerSlate — (map)

        Contains information about the slate used to fill gaps between programs in the schedule.

        • SourceLocationName — (String)

          The name of the source location where the slate VOD source is stored.

        • VodSourceName — (String)

          The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

      • LastModifiedTime — (Date)

        The timestamp of when the channel was last modified.

      • Outputs — (Array<map>)

        The channel's output properties.

        • DashPlaylistSettings — (map)

          DASH manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

          • MinBufferTimeSeconds — (Integer)

            Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • MinUpdatePeriodSeconds — (Integer)

            Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • SuggestedPresentationDelaySeconds — (Integer)

            Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • HlsPlaylistSettings — (map)

          HLS manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • ManifestName — required — (String)

          The name of the manifest for the channel that will appear in the channel output's playback URL.

        • PlaybackUrl — required — (String)

          The URL used for playback by content players.

        • SourceGroup — required — (String)

          A string used to associate a package configuration source group with a channel output.

      • PlaybackMode — (String)

        The channel's playback mode.

      • Tags — (map<String>)

        The tags assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Creates a new prefetch schedule for the specified playback configuration.

Service Reference:

Examples:

Calling the createPrefetchSchedule operation

var params = {
  Consumption: { /* required */
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    AvailMatchingCriteria: [
      {
        DynamicVariable: 'STRING_VALUE', /* required */
        Operator: EQUALS /* required */
      },
      /* more items */
    ],
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  Name: 'STRING_VALUE', /* required */
  PlaybackConfigurationName: 'STRING_VALUE', /* required */
  Retrieval: { /* required */
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    DynamicVariables: {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    },
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  },
  StreamId: 'STRING_VALUE'
};
mediatailor.createPrefetchSchedule(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: {}) —
    • Consumption — (map)

      The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

      • AvailMatchingCriteria — (Array<map>)

        If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

        • DynamicVariable — required — (String)

          The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

          You can include up to 100 dynamic variables.

        • Operator — required — (String)

          For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

          Possible values include:
          • "EQUALS"
      • EndTime — required — (Date)

        The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

      • StartTime — (Date)

        The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

    • Name — (String)

      The identifier for the playback configuration.

    • PlaybackConfigurationName — (String)

      The name of the playback configuration.

    • Retrieval — (map)

      The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

      • DynamicVariables — (map<String>)

        The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

        You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

      • EndTime — required — (Date)

        The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

      • StartTime — (Date)

        The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

    • StreamId — (String)

      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Arn — (String)

        The Amazon Resource Name (ARN) of the prefetch schedule.

      • Consumption — (map)

        Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

        • AvailMatchingCriteria — (Array<map>)

          If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

          • DynamicVariable — required — (String)

            The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

            You can include up to 100 dynamic variables.

          • Operator — required — (String)

            For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

            Possible values include:
            • "EQUALS"
        • EndTime — required — (Date)

          The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

        • StartTime — (Date)

          The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

      • Name — (String)

        The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

      • PlaybackConfigurationName — (String)

        The name of the playback configuration to create the prefetch schedule for.

      • Retrieval — (map)

        A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

        • DynamicVariables — (map<String>)

          The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

          You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

        • EndTime — required — (Date)

          The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

        • StartTime — (Date)

          The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

      • StreamId — (String)

        An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Returns:

  • (AWS.Request) —

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

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

Creates a program.

Service Reference:

Examples:

Calling the createProgram operation

var params = {
  ChannelName: 'STRING_VALUE', /* required */
  ProgramName: 'STRING_VALUE', /* required */
  ScheduleConfiguration: { /* required */
    Transition: { /* required */
      RelativePosition: BEFORE_PROGRAM | AFTER_PROGRAM, /* required */
      Type: 'STRING_VALUE', /* required */
      RelativeProgram: 'STRING_VALUE',
      ScheduledStartTimeMillis: 'NUMBER_VALUE'
    }
  },
  SourceLocationName: 'STRING_VALUE', /* required */
  VodSourceName: 'STRING_VALUE', /* required */
  AdBreaks: [
    {
      MessageType: SPLICE_INSERT,
      OffsetMillis: 'NUMBER_VALUE',
      Slate: {
        SourceLocationName: 'STRING_VALUE',
        VodSourceName: 'STRING_VALUE'
      },
      SpliceInsertMessage: {
        AvailNum: 'NUMBER_VALUE',
        AvailsExpected: 'NUMBER_VALUE',
        SpliceEventId: 'NUMBER_VALUE',
        UniqueProgramId: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ]
};
mediatailor.createProgram(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: {}) —
    • AdBreaks — (Array<map>)

      The ad break configuration settings.

      • MessageType — (String)

        The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

        Possible values include:
        • "SPLICE_INSERT"
      • OffsetMillis — (Integer)

        How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

      • Slate — (map)

        Ad break slate configuration.

        • SourceLocationName — (String)

          The name of the source location where the slate VOD source is stored.

        • VodSourceName — (String)

          The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

      • SpliceInsertMessage — (map)

        This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

        • AvailNum — (Integer)

          This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

        • AvailsExpected — (Integer)

          This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

        • SpliceEventId — (Integer)

          This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

        • UniqueProgramId — (Integer)

          This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

    • ChannelName — (String)

      The identifier for the channel you are working on.

    • ProgramName — (String)

      The identifier for the program you are working on.

    • ScheduleConfiguration — (map)

      The schedule configuration settings.

      • Transition — required — (map)

        Program transition configurations.

        • RelativePosition — required — (String)

          The position where this program will be inserted relative to the RelativePosition.

          Possible values include:
          • "BEFORE_PROGRAM"
          • "AFTER_PROGRAM"
        • RelativeProgram — (String)

          The name of the program that this program will be inserted next to, as defined by RelativePosition.

        • ScheduledStartTimeMillis — (Integer)

          The date and time that the program is scheduled to start, in epoch milliseconds.

        • Type — required — (String)

          Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.

          ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.

          Note the following considerations when using ABSOLUTE transitions:

          If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.

          If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.

          RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.

    • SourceLocationName — (String)

      The name of the source location.

    • VodSourceName — (String)

      The name that's used to refer to a VOD source.

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:

      • AdBreaks — (Array<map>)

        The ad break configuration settings.

        • MessageType — (String)

          The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

          Possible values include:
          • "SPLICE_INSERT"
        • OffsetMillis — (Integer)

          How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

        • Slate — (map)

          Ad break slate configuration.

          • SourceLocationName — (String)

            The name of the source location where the slate VOD source is stored.

          • VodSourceName — (String)

            The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

        • SpliceInsertMessage — (map)

          This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

          • AvailNum — (Integer)

            This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

          • AvailsExpected — (Integer)

            This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

          • SpliceEventId — (Integer)

            This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

          • UniqueProgramId — (Integer)

            This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

      • Arn — (String)

        The ARN of the program.

      • ChannelName — (String)

        The name of the channel that the program belongs to.

      • CreationTime — (Date)

        The timestamp of when the program was created.

      • ProgramName — (String)

        The name of the program.

      • ScheduledStartTime — (Date)

        The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

      • SourceLocationName — (String)

        The source location name.

      • VodSourceName — (String)

        The name that's used to refer to a VOD source.

Returns:

  • (AWS.Request) —

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

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

Creates a source location on a specific channel.

Service Reference:

Examples:

Calling the createSourceLocation operation

var params = {
  HttpConfiguration: { /* required */
    BaseUrl: 'STRING_VALUE' /* required */
  },
  SourceLocationName: 'STRING_VALUE', /* required */
  AccessConfiguration: {
    AccessType: S3_SIGV4 | SECRETS_MANAGER_ACCESS_TOKEN,
    SecretsManagerAccessTokenConfiguration: {
      HeaderName: 'STRING_VALUE',
      SecretArn: 'STRING_VALUE',
      SecretStringKey: 'STRING_VALUE'
    }
  },
  DefaultSegmentDeliveryConfiguration: {
    BaseUrl: 'STRING_VALUE'
  },
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediatailor.createSourceLocation(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: {}) —
    • AccessConfiguration — (map)

      Access configuration parameters. Configures the type of authentication used to access content from your source location.

      • AccessType — (String)

        The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

        S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

        Before you can use S3_SIGV4, you must meet these requirements:

        • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

        • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

        • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

        Possible values include:
        • "S3_SIGV4"
        • "SECRETS_MANAGER_ACCESS_TOKEN"
      • SecretsManagerAccessTokenConfiguration — (map)

        AWS Secrets Manager access token configuration parameters.

        • HeaderName — (String)

          The name of the HTTP header used to supply the access token in requests to the source location.

        • SecretArn — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

        • SecretStringKey — (String)

          The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

    • DefaultSegmentDeliveryConfiguration — (map)

      The optional configuration for the server that serves segments.

      • BaseUrl — (String)

        The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

    • HttpConfiguration — (map)

      The source's HTTP package configurations.

      • BaseUrl — required — (String)

        The base URL for the source location host server. This string must include the protocol, such as https://.

    • SourceLocationName — (String)

      The identifier for the source location you are working on.

    • Tags — (map<String>)

      The tags to assign to the source location.

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:

      • AccessConfiguration — (map)

        The access configuration for the source location.

        • AccessType — (String)

          The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

          S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

          Before you can use S3_SIGV4, you must meet these requirements:

          • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

          • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

          • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

          Possible values include:
          • "S3_SIGV4"
          • "SECRETS_MANAGER_ACCESS_TOKEN"
        • SecretsManagerAccessTokenConfiguration — (map)

          AWS Secrets Manager access token configuration parameters.

          • HeaderName — (String)

            The name of the HTTP header used to supply the access token in requests to the source location.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

          • SecretStringKey — (String)

            The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

      • Arn — (String)

        The ARN of the source location.

      • CreationTime — (Date)

        The timestamp that indicates when the source location was created.

      • DefaultSegmentDeliveryConfiguration — (map)

        The default segment delivery configuration settings.

        • BaseUrl — (String)

          The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

      • HttpConfiguration — (map)

        The HTTP package configuration settings for the source location.

        • BaseUrl — required — (String)

          The base URL for the source location host server. This string must include the protocol, such as https://.

      • LastModifiedTime — (Date)

        The timestamp that indicates when the source location was last modified.

      • SourceLocationName — (String)

        The name of the source location.

      • Tags — (map<String>)

        The tags assigned to the source location.

Returns:

  • (AWS.Request) —

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

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

Creates name for a specific VOD source in a source location.

Service Reference:

Examples:

Calling the createVodSource operation

var params = {
  HttpPackageConfigurations: [ /* required */
    {
      Path: 'STRING_VALUE', /* required */
      SourceGroup: 'STRING_VALUE', /* required */
      Type: DASH | HLS /* required */
    },
    /* more items */
  ],
  SourceLocationName: 'STRING_VALUE', /* required */
  VodSourceName: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediatailor.createVodSource(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: {}) —
    • HttpPackageConfigurations — (Array<map>)

      An array of HTTP package configuration parameters for this VOD source.

      • Path — required — (String)

        The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

      • SourceGroup — required — (String)

        The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

      • Type — required — (String)

        The streaming protocol for this package configuration. Supported values are HLS and DASH.

        Possible values include:
        • "DASH"
        • "HLS"
    • SourceLocationName — (String)

      The identifier for the source location you are working on.

    • Tags — (map<String>)

      The tags to assign to the VOD source.

    • VodSourceName — (String)

      The identifier for the VOD source you are working on.

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 VOD source.

      • CreationTime — (Date)

        The timestamp that indicates when the VOD source was created.

      • HttpPackageConfigurations — (Array<map>)

        The HTTP package configurations.

        • Path — required — (String)

          The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

        • SourceGroup — required — (String)

          The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

        • Type — required — (String)

          The streaming protocol for this package configuration. Supported values are HLS and DASH.

          Possible values include:
          • "DASH"
          • "HLS"
      • LastModifiedTime — (Date)

        The ARN for the VOD source.

      • SourceLocationName — (String)

        The name of the source location associated with the VOD source.

      • Tags — (map<String>)

        The tags assigned to the VOD source.

      • VodSourceName — (String)

        The name of the VOD source.

Returns:

  • (AWS.Request) —

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

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

Deletes a channel. You must stop the channel before it can be deleted.

Service Reference:

Examples:

Calling the deleteChannel operation

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

Parameters:

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

      The identifier for the channel you are working on.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Deletes a channel's IAM policy.

Service Reference:

Examples:

Calling the deleteChannelPolicy operation

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

Parameters:

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

      The identifier for the channel you are working on.

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.

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

Deletes the playback configuration for the specified name.

Service Reference:

Examples:

Calling the deletePlaybackConfiguration operation

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

      The identifier for the playback configuration.

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.

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

Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Service Reference:

Examples:

Calling the deletePrefetchSchedule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  PlaybackConfigurationName: 'STRING_VALUE' /* required */
};
mediatailor.deletePrefetchSchedule(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: {}) —
    • Name — (String)

      The identifier for the playback configuration.

    • PlaybackConfigurationName — (String)

      The name of the playback configuration.

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.

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

Deletes a specific program on a specific channel.

Service Reference:

Examples:

Calling the deleteProgram operation

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

      The identifier for the channel you are working on.

    • ProgramName — (String)

      The identifier for the program you are working on.

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.

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

Deletes a source location on a specific channel.

Service Reference:

Examples:

Calling the deleteSourceLocation operation

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

      The identifier for the source location you are working on.

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.

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

Deletes a specific VOD source in a specific source location.

Service Reference:

Examples:

Calling the deleteVodSource operation

var params = {
  SourceLocationName: 'STRING_VALUE', /* required */
  VodSourceName: 'STRING_VALUE' /* required */
};
mediatailor.deleteVodSource(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: {}) —
    • SourceLocationName — (String)

      The identifier for the source location you are working on.

    • VodSourceName — (String)

      The identifier for the VOD source you are working on.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Describes the properties of a specific channel.

Service Reference:

Examples:

Calling the describeChannel operation

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

Parameters:

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

      The identifier for the channel you are working on.

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 channel.

      • ChannelName — (String)

        The name of the channel.

      • ChannelState — (String)

        Indicates whether the channel is in a running state or not.

        Possible values include:
        • "RUNNING"
        • "STOPPED"
      • CreationTime — (Date)

        The timestamp of when the channel was created.

      • FillerSlate — (map)

        Contains information about the slate used to fill gaps between programs in the schedule.

        • SourceLocationName — (String)

          The name of the source location where the slate VOD source is stored.

        • VodSourceName — (String)

          The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

      • LastModifiedTime — (Date)

        The timestamp of when the channel was last modified.

      • Outputs — (Array<map>)

        The channel's output properties.

        • DashPlaylistSettings — (map)

          DASH manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

          • MinBufferTimeSeconds — (Integer)

            Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • MinUpdatePeriodSeconds — (Integer)

            Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • SuggestedPresentationDelaySeconds — (Integer)

            Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • HlsPlaylistSettings — (map)

          HLS manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • ManifestName — required — (String)

          The name of the manifest for the channel that will appear in the channel output's playback URL.

        • PlaybackUrl — required — (String)

          The URL used for playback by content players.

        • SourceGroup — required — (String)

          A string used to associate a package configuration source group with a channel output.

      • PlaybackMode — (String)

        The channel's playback mode.

      • Tags — (map<String>)

        The tags assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Retrieves the properties of the requested program.

Service Reference:

Examples:

Calling the describeProgram operation

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

      The identifier for the channel you are working on.

    • ProgramName — (String)

      The identifier for the program you are working on.

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:

      • AdBreaks — (Array<map>)

        The ad break configuration settings.

        • MessageType — (String)

          The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

          Possible values include:
          • "SPLICE_INSERT"
        • OffsetMillis — (Integer)

          How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

        • Slate — (map)

          Ad break slate configuration.

          • SourceLocationName — (String)

            The name of the source location where the slate VOD source is stored.

          • VodSourceName — (String)

            The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

        • SpliceInsertMessage — (map)

          This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

          • AvailNum — (Integer)

            This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

          • AvailsExpected — (Integer)

            This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

          • SpliceEventId — (Integer)

            This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

          • UniqueProgramId — (Integer)

            This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

      • Arn — (String)

        The ARN of the program.

      • ChannelName — (String)

        The name of the channel that the program belongs to.

      • CreationTime — (Date)

        The timestamp of when the program was created.

      • ProgramName — (String)

        The name of the program.

      • ScheduledStartTime — (Date)

        The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

      • SourceLocationName — (String)

        The source location name.

      • VodSourceName — (String)

        The name that's used to refer to a VOD source.

Returns:

  • (AWS.Request) —

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

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

Retrieves the properties of the requested source location.

Service Reference:

Examples:

Calling the describeSourceLocation operation

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

      The identifier for the source location you are working on.

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:

      • AccessConfiguration — (map)

        The access configuration for the source location.

        • AccessType — (String)

          The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

          S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

          Before you can use S3_SIGV4, you must meet these requirements:

          • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

          • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

          • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

          Possible values include:
          • "S3_SIGV4"
          • "SECRETS_MANAGER_ACCESS_TOKEN"
        • SecretsManagerAccessTokenConfiguration — (map)

          AWS Secrets Manager access token configuration parameters.

          • HeaderName — (String)

            The name of the HTTP header used to supply the access token in requests to the source location.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

          • SecretStringKey — (String)

            The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

      • Arn — (String)

        The ARN of the source location.

      • CreationTime — (Date)

        The timestamp that indicates when the source location was created.

      • DefaultSegmentDeliveryConfiguration — (map)

        The default segment delivery configuration settings.

        • BaseUrl — (String)

          The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

      • HttpConfiguration — (map)

        The HTTP package configuration settings for the source location.

        • BaseUrl — required — (String)

          The base URL for the source location host server. This string must include the protocol, such as https://.

      • LastModifiedTime — (Date)

        The timestamp that indicates when the source location was last modified.

      • SourceLocationName — (String)

        The name of the source location.

      • Tags — (map<String>)

        The tags assigned to the source location.

Returns:

  • (AWS.Request) —

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

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

Provides details about a specific VOD source in a specific source location.

Service Reference:

Examples:

Calling the describeVodSource operation

var params = {
  SourceLocationName: 'STRING_VALUE', /* required */
  VodSourceName: 'STRING_VALUE' /* required */
};
mediatailor.describeVodSource(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: {}) —
    • SourceLocationName — (String)

      The identifier for the source location you are working on.

    • VodSourceName — (String)

      The identifier for the VOD source you are working on.

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 VOD source.

      • CreationTime — (Date)

        The timestamp that indicates when the VOD source was created.

      • HttpPackageConfigurations — (Array<map>)

        The HTTP package configurations.

        • Path — required — (String)

          The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

        • SourceGroup — required — (String)

          The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

        • Type — required — (String)

          The streaming protocol for this package configuration. Supported values are HLS and DASH.

          Possible values include:
          • "DASH"
          • "HLS"
      • LastModifiedTime — (Date)

        The ARN for the VOD source.

      • SourceLocationName — (String)

        The name of the source location associated with the VOD source.

      • Tags — (map<String>)

        The tags assigned to the VOD source.

      • VodSourceName — (String)

        The name of the VOD source.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about a channel's IAM policy.

Service Reference:

Examples:

Calling the getChannelPolicy operation

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

Parameters:

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

      The identifier for the channel you are working on.

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:

      • Policy — (String)

        The IAM policy for the channel.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about your channel's schedule.

Service Reference:

Examples:

Calling the getChannelSchedule operation

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

      The identifier for the channel you are working on.

    • DurationMinutes — (String)

      The schedule duration in minutes. The maximum duration is 4320 minutes (three days).

    • MaxResults — (Integer)

      Upper bound on number of records to return. The maximum number of results is 100.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        An array of schedule entries for the channel.

        • ApproximateDurationSeconds — (Integer)

          The approximate duration of this program, in seconds.

        • ApproximateStartTime — (Date)

          The approximate time that the program will start playing.

        • Arn — required — (String)

          The ARN of the program.

        • ChannelName — required — (String)

          The name of the channel that uses this schedule.

        • ProgramName — required — (String)

          The name of the program.

        • ScheduleAdBreaks — (Array<map>)

          The schedule's ad break properties.

          • ApproximateDurationSeconds — (Integer)

            The approximate duration of the ad break, in seconds.

          • ApproximateStartTime — (Date)

            The approximate time that the ad will start playing.

          • SourceLocationName — (String)

            The name of the source location containing the VOD source used for the ad break.

          • VodSourceName — (String)

            The name of the VOD source used for the ad break.

        • ScheduleEntryType — (String)

          The type of schedule entry.

          Valid values: PROGRAM or FILLER_SLATE.

          Possible values include:
          • "PROGRAM"
          • "FILLER_SLATE"
        • SourceLocationName — required — (String)

          The name of the source location.

        • VodSourceName — required — (String)

          The name of the VOD source.

      • NextToken — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns the playback configuration for the specified name.

Service Reference:

Examples:

Calling the getPlaybackConfiguration operation

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

      The identifier for the playback configuration.

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:

      • AdDecisionServerUrl — (String)

        The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

      • AvailSuppression — (map)

        The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

        • Mode — (String)

          Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

          Possible values include:
          • "OFF"
          • "BEHIND_LIVE_EDGE"
        • Value — (String)

          A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

      • Bumper — (map)

        The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

        • EndUrl — (String)

          The URL for the end bumper asset.

        • StartUrl — (String)

          The URL for the start bumper asset.

      • CdnConfiguration — (map)

        The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

        • AdSegmentUrlPrefix — (String)

          A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

        • ContentSegmentUrlPrefix — (String)

          A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

      • ConfigurationAliases — (map<map<String>>)

        The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

      • DashConfiguration — (map)

        The configuration for DASH content.

        • ManifestEndpointPrefix — (String)

          The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

        • MpdLocation — (String)

          The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

        • OriginManifestType — (String)

          The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

          Possible values include:
          • "SINGLE_PERIOD"
          • "MULTI_PERIOD"
      • HlsConfiguration — (map)

        The configuration for HLS content.

        • ManifestEndpointPrefix — (String)

          The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

      • LivePreRollConfiguration — (map)

        The configuration for pre-roll ad insertion.

        • AdDecisionServerUrl — (String)

          The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

        • MaxDurationSeconds — (Integer) The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
      • LogConfiguration — (map)

        The Amazon CloudWatch log settings for a playback configuration.

        • PercentEnabled — required — (Integer)

          The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

          Valid values: 0 - 100

      • ManifestProcessingRules — (map)

        The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

        • AdMarkerPassthrough — (map)

          For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

          No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

          • Enabled — (Boolean)

            Enables ad marker passthrough for your configuration.

      • Name — (String)

        The identifier for the playback configuration.

      • PersonalizationThresholdSeconds — (Integer)

        Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

      • PlaybackConfigurationArn — (String)

        The Amazon Resource Name (ARN) for the playback configuration.

      • PlaybackEndpointPrefix — (String)

        The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

      • SessionInitializationEndpointPrefix — (String)

        The URL that the player uses to initialize a session that uses client-side reporting.

      • SlateAdUrl — (String)

        The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

      • Tags — (map<String>)

        The tags assigned to the playback configuration.

      • TranscodeProfileName — (String)

        The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

      • VideoContentSourceUrl — (String)

        The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

  • (AWS.Request) —

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

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

Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.

Service Reference:

Examples:

Calling the getPrefetchSchedule operation

var params = {
  Name: 'STRING_VALUE', /* required */
  PlaybackConfigurationName: 'STRING_VALUE' /* required */
};
mediatailor.getPrefetchSchedule(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: {}) —
    • Name — (String)

      The identifier for the playback configuration.

    • PlaybackConfigurationName — (String)

      The name of the playback configuration.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Arn — (String)

        The Amazon Resource Name (ARN) of the prefetch schedule.

      • Consumption — (map)

        Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

        • AvailMatchingCriteria — (Array<map>)

          If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

          • DynamicVariable — required — (String)

            The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

            You can include up to 100 dynamic variables.

          • Operator — required — (String)

            For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

            Possible values include:
            • "EQUALS"
        • EndTime — required — (Date)

          The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

        • StartTime — (Date)

          The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

      • Name — (String)

        The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

      • PlaybackConfigurationName — (String)

        The name of the playback configuration to create the prefetch schedule for.

      • Retrieval — (map)

        A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

        • DynamicVariables — (map<String>)

          The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

          You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

        • EndTime — required — (Date)

          The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

        • StartTime — (Date)

          The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

      • StreamId — (String)

        An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Returns:

  • (AWS.Request) —

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

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

Returns a list of alerts for the given resource.

Service Reference:

Examples:

Calling the listAlerts operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediatailor.listAlerts(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. The maximum number of results is 100.

    • NextToken — (String)

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

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of 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:

      • Items — (Array<map>)

        An array of alerts that are associated with this resource.

        • AlertCode — required — (String)

          The code for the alert. For example, NOT_PROCESSED.

        • AlertMessage — required — (String)

          If an alert is generated for a resource, an explanation of the reason for the alert.

        • LastModifiedTime — required — (Date)

          The timestamp when the alert was last modified.

        • RelatedResourceArns — required — (Array<String>)

          The Amazon Resource Names (ARNs) related to this alert.

        • ResourceArn — required — (String)

          The Amazon Resource Name (ARN) of the resource.

      • NextToken — (String)

        Pagination token from the list request. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of channels that are associated with this account.

Service Reference:

Examples:

Calling the listChannels operation

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

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      Upper bound on number of records to return. The maximum number of results is 100.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        An array of channels that are associated with this account.

        • Arn — required — (String)

          The ARN of the channel.

        • ChannelName — required — (String)

          The name of the channel.

        • ChannelState — required — (String)

          Returns the state whether the channel is running or not.

        • CreationTime — (Date)

          The timestamp of when the channel was created.

        • FillerSlate — (map)

          Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

          • SourceLocationName — (String)

            The name of the source location where the slate VOD source is stored.

          • VodSourceName — (String)

            The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

        • LastModifiedTime — (Date)

          The timestamp of when the channel was last modified.

        • Outputs — required — (Array<map>)

          The channel's output properties.

          • DashPlaylistSettings — (map)

            DASH manifest configuration settings.

            • ManifestWindowSeconds — (Integer)

              The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

            • MinBufferTimeSeconds — (Integer)

              Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

            • MinUpdatePeriodSeconds — (Integer)

              Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

            • SuggestedPresentationDelaySeconds — (Integer)

              Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • HlsPlaylistSettings — (map)

            HLS manifest configuration settings.

            • ManifestWindowSeconds — (Integer)

              The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

          • ManifestName — required — (String)

            The name of the manifest for the channel that will appear in the channel output's playback URL.

          • PlaybackUrl — required — (String)

            The URL used for playback by content players.

          • SourceGroup — required — (String)

            A string used to associate a package configuration source group with a channel output.

        • PlaybackMode — required — (String)

          The type of playback mode for this channel.

          LINEAR - Programs play back-to-back only once.

          LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

        • Tags — (map<String>)

          The tags to assign to the channel.

      • NextToken — (String)

        Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

Service Reference:

Examples:

Calling the listPlaybackConfigurations operation

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

      Maximum number of records to return.

    • NextToken — (String)

      Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.

        • AdDecisionServerUrl — (String)

          The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

        • AvailSuppression — (map)

          The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

          • Mode — (String)

            Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

            Possible values include:
            • "OFF"
            • "BEHIND_LIVE_EDGE"
          • Value — (String)

            A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

        • Bumper — (map)

          The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

          • EndUrl — (String)

            The URL for the end bumper asset.

          • StartUrl — (String)

            The URL for the start bumper asset.

        • CdnConfiguration — (map)

          The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

          • AdSegmentUrlPrefix — (String)

            A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

          • ContentSegmentUrlPrefix — (String)

            A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

        • ConfigurationAliases — (map<map<String>>)

          The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

        • DashConfiguration — (map)

          The configuration for a DASH source.

          • ManifestEndpointPrefix — (String)

            The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

          • MpdLocation — (String)

            The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

          • OriginManifestType — (String)

            The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

            Possible values include:
            • "SINGLE_PERIOD"
            • "MULTI_PERIOD"
        • HlsConfiguration — (map)

          The configuration for HLS content.

          • ManifestEndpointPrefix — (String)

            The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

        • LivePreRollConfiguration — (map)

          The configuration for pre-roll ad insertion.

          • AdDecisionServerUrl — (String)

            The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

          • MaxDurationSeconds — (Integer) The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
        • LogConfiguration — (map)

          The Amazon CloudWatch log settings for a playback configuration.

          • PercentEnabled — required — (Integer)

            The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

            Valid values: 0 - 100

        • ManifestProcessingRules — (map)

          The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

          • AdMarkerPassthrough — (map)

            For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

            No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

            • Enabled — (Boolean)

              Enables ad marker passthrough for your configuration.

        • Name — (String)

          The identifier for the playback configuration.

        • PersonalizationThresholdSeconds — (Integer)

          Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

        • PlaybackConfigurationArn — (String)

          The Amazon Resource Name (ARN) for the playback configuration.

        • PlaybackEndpointPrefix — (String)

          The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.

        • SessionInitializationEndpointPrefix — (String)

          The URL that the player uses to initialize a session that uses client-side reporting.

        • SlateAdUrl — (String)

          The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

        • Tags — (map<String>)

          The tags to assign to the playback configuration.

        • TranscodeProfileName — (String)

          The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

        • VideoContentSourceUrl — (String)

          The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

      • NextToken — (String)

        Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Creates a new prefetch schedule.

Service Reference:

Examples:

Calling the listPrefetchSchedules operation

var params = {
  PlaybackConfigurationName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StreamId: 'STRING_VALUE'
};
mediatailor.listPrefetchSchedules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer)

      The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.

    • NextToken — (String)

      (Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.

      For the first ListPrefetchSchedulesRequest request, omit this value.

      For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

      If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.

    • PlaybackConfigurationName — (String)

      The name of the playback configuration.

    • StreamId — (String)

      An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.

        • Arn — required — (String)

          The Amazon Resource Name (ARN) of the prefetch schedule.

        • Consumption — required — (map)

          Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

          • AvailMatchingCriteria — (Array<map>)

            If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

            • DynamicVariable — required — (String)

              The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

              You can include up to 100 dynamic variables.

            • Operator — required — (String)

              For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

              Possible values include:
              • "EQUALS"
          • EndTime — required — (Date)

            The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

          • StartTime — (Date)

            The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

        • Name — required — (String)

          The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

        • PlaybackConfigurationName — required — (String)

          The name of the playback configuration to create the prefetch schedule for.

        • Retrieval — required — (map)

          A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

          • DynamicVariables — (map<String>)

            The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

            You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

          • EndTime — required — (Date)

            The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

          • StartTime — (Date)

            The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

        • StreamId — (String)

          An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

      • NextToken — (String)

        The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.

Returns:

  • (AWS.Request) —

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

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

Retrieves a list of source locations.

Service Reference:

Examples:

Calling the listSourceLocations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediatailor.listSourceLocations(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. The maximum number of results is 100.

    • NextToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        An array of source locations.

        • AccessConfiguration — (map)

          The access configuration for the source location.

          • AccessType — (String)

            The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

            S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

            Before you can use S3_SIGV4, you must meet these requirements:

            • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

            • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

            • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

            Possible values include:
            • "S3_SIGV4"
            • "SECRETS_MANAGER_ACCESS_TOKEN"
          • SecretsManagerAccessTokenConfiguration — (map)

            AWS Secrets Manager access token configuration parameters.

            • HeaderName — (String)

              The name of the HTTP header used to supply the access token in requests to the source location.

            • SecretArn — (String)

              The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

            • SecretStringKey — (String)

              The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

        • Arn — required — (String)

          The ARN of the SourceLocation.

        • CreationTime — (Date)

          The timestamp that indicates when the source location was created.

        • DefaultSegmentDeliveryConfiguration — (map)

          The default segment delivery configuration.

          • BaseUrl — (String)

            The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

        • HttpConfiguration — required — (map)

          The HTTP configuration for the source location.

          • BaseUrl — required — (String)

            The base URL for the source location host server. This string must include the protocol, such as https://.

        • LastModifiedTime — (Date)

          The timestamp that indicates when the source location was last modified.

        • SourceLocationName — required — (String)

          The name of the source location.

        • Tags — (map<String>)

          The tags assigned to the source location.

      • NextToken — (String)

        Pagination token from the list request. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Returns a list of the tags assigned to the specified playback configuration resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
mediatailor.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 playback configuration. You can get this from the response to any playback configuration 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:

      • Tags — (map<String>)

        A comma-separated list of tag key:value pairs.

Returns:

  • (AWS.Request) —

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

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

Lists all the VOD sources in a source location.

Service Reference:

Examples:

Calling the listVodSources operation

var params = {
  SourceLocationName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
mediatailor.listVodSources(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. The maximum number of results is 100.

    • NextToken — (String)

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

    • SourceLocationName — (String)

      The identifier for the source location you are working on.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Items — (Array<map>)

        Lists the VOD sources.

        • Arn — required — (String)

          The ARN for the VOD source.

        • CreationTime — (Date)

          The timestamp that indicates when the VOD source was created.

        • HttpPackageConfigurations — required — (Array<map>)

          The HTTP package configurations for the VOD source.

          • Path — required — (String)

            The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

          • SourceGroup — required — (String)

            The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

          • Type — required — (String)

            The streaming protocol for this package configuration. Supported values are HLS and DASH.

            Possible values include:
            • "DASH"
            • "HLS"
        • LastModifiedTime — (Date)

          The timestamp that indicates when the VOD source was last modified.

        • SourceLocationName — required — (String)

          The name of the source location that the VOD source is associated with.

        • Tags — (map<String>)

          The tags assigned to the VOD source.

        • VodSourceName — required — (String)

          The name of the VOD source.

      • NextToken — (String)

        Pagination token from the list request. Use the token to fetch the next page of results.

Returns:

  • (AWS.Request) —

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

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

Creates an IAM policy for the channel.

Service Reference:

Examples:

Calling the putChannelPolicy operation

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

Parameters:

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

      The identifier for the channel you are working on.

    • Policy — (String)

      Adds an IAM role that determines the permissions of your channel.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Adds a new playback configuration to AWS Elemental MediaTailor.

Service Reference:

Examples:

Calling the putPlaybackConfiguration operation

var params = {
  AdDecisionServerUrl: 'STRING_VALUE',
  AvailSuppression: {
    Mode: OFF | BEHIND_LIVE_EDGE,
    Value: 'STRING_VALUE'
  },
  Bumper: {
    EndUrl: 'STRING_VALUE',
    StartUrl: 'STRING_VALUE'
  },
  CdnConfiguration: {
    AdSegmentUrlPrefix: 'STRING_VALUE',
    ContentSegmentUrlPrefix: 'STRING_VALUE'
  },
  ConfigurationAliases: {
    '<__string>': {
      '<__string>': 'STRING_VALUE',
      /* '<__string>': ... */
    },
    /* '<__string>': ... */
  },
  DashConfiguration: {
    MpdLocation: 'STRING_VALUE',
    OriginManifestType: SINGLE_PERIOD | MULTI_PERIOD
  },
  LivePreRollConfiguration: {
    AdDecisionServerUrl: 'STRING_VALUE',
    MaxDurationSeconds: 'NUMBER_VALUE'
  },
  ManifestProcessingRules: {
    AdMarkerPassthrough: {
      Enabled: true || false
    }
  },
  Name: 'STRING_VALUE',
  PersonalizationThresholdSeconds: 'NUMBER_VALUE',
  SlateAdUrl: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  TranscodeProfileName: 'STRING_VALUE',
  VideoContentSourceUrl: 'STRING_VALUE'
};
mediatailor.putPlaybackConfiguration(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: {}) —
    • AdDecisionServerUrl — (String)

      The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

    • AvailSuppression — (map)

      The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

      • Mode — (String)

        Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

        Possible values include:
        • "OFF"
        • "BEHIND_LIVE_EDGE"
      • Value — (String)

        A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

    • Bumper — (map)

      The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

      • EndUrl — (String)

        The URL for the end bumper asset.

      • StartUrl — (String)

        The URL for the start bumper asset.

    • CdnConfiguration — (map)

      The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

      • AdSegmentUrlPrefix — (String)

        A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

      • ContentSegmentUrlPrefix — (String)

        A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

    • ConfigurationAliases — (map<map<String>>)

      The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

    • DashConfiguration — (map)

      The configuration for DASH content.

      • MpdLocation — (String)

        The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

      • OriginManifestType — (String)

        The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

        Possible values include:
        • "SINGLE_PERIOD"
        • "MULTI_PERIOD"
    • LivePreRollConfiguration — (map)

      The configuration for pre-roll ad insertion.

      • AdDecisionServerUrl — (String)

        The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

      • MaxDurationSeconds — (Integer) The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
    • ManifestProcessingRules — (map)

      The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

      • AdMarkerPassthrough — (map)

        For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

        No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

        • Enabled — (Boolean)

          Enables ad marker passthrough for your configuration.

    • Name — (String)

      The identifier for the playback configuration.

    • PersonalizationThresholdSeconds — (Integer)

      Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

    • SlateAdUrl — (String)

      The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

    • Tags — (map<String>)

      The tags to assign to the playback configuration.

    • TranscodeProfileName — (String)

      The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

    • VideoContentSourceUrl — (String)

      The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

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:

      • AdDecisionServerUrl — (String)

        The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

      • AvailSuppression — (map)

        The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

        • Mode — (String)

          Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

          Possible values include:
          • "OFF"
          • "BEHIND_LIVE_EDGE"
        • Value — (String)

          A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

      • Bumper — (map)

        The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

        • EndUrl — (String)

          The URL for the end bumper asset.

        • StartUrl — (String)

          The URL for the start bumper asset.

      • CdnConfiguration — (map)

        The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

        • AdSegmentUrlPrefix — (String)

          A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

        • ContentSegmentUrlPrefix — (String)

          A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

      • ConfigurationAliases — (map<map<String>>)

        The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

      • DashConfiguration — (map)

        The configuration for DASH content.

        • ManifestEndpointPrefix — (String)

          The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

        • MpdLocation — (String)

          The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

        • OriginManifestType — (String)

          The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

          Possible values include:
          • "SINGLE_PERIOD"
          • "MULTI_PERIOD"
      • HlsConfiguration — (map)

        The configuration for HLS content.

        • ManifestEndpointPrefix — (String)

          The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

      • LivePreRollConfiguration — (map)

        The configuration for pre-roll ad insertion.

        • AdDecisionServerUrl — (String)

          The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

        • MaxDurationSeconds — (Integer) The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
      • LogConfiguration — (map)

        The Amazon CloudWatch log settings for a playback configuration.

        • PercentEnabled — required — (Integer)

          The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

          Valid values: 0 - 100

      • ManifestProcessingRules — (map)

        The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

        • AdMarkerPassthrough — (map)

          For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

          No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

          • Enabled — (Boolean)

            Enables ad marker passthrough for your configuration.

      • Name — (String)

        The identifier for the playback configuration.

      • PersonalizationThresholdSeconds — (Integer)

        Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

      • PlaybackConfigurationArn — (String)

        The Amazon Resource Name (ARN) for the playback configuration.

      • PlaybackEndpointPrefix — (String)

        The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

      • SessionInitializationEndpointPrefix — (String)

        The URL that the player uses to initialize a session that uses client-side reporting.

      • SlateAdUrl — (String)

        The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

      • Tags — (map<String>)

        The tags assigned to the playback configuration.

      • TranscodeProfileName — (String)

        The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

      • VideoContentSourceUrl — (String)

        The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

  • (AWS.Request) —

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

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

Starts a specific channel.

Service Reference:

Examples:

Calling the startChannel operation

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

      The identifier for the channel you are working on.

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.

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

Stops a specific channel.

Service Reference:

Examples:

Calling the stopChannel operation

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

      The identifier for the channel you are working on.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
mediatailor.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 playback configuration. You can get this from the response to any playback configuration request.

    • Tags — (map<String>)

      A comma-separated list of tag key:value pairs.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
mediatailor.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 playback configuration. You can get this from the response to any playback configuration request.

    • TagKeys — (Array<String>)

      A comma-separated list of the tag keys to remove from the playback configuration.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Updates an existing channel.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  ChannelName: 'STRING_VALUE', /* required */
  Outputs: [ /* required */
    {
      ManifestName: 'STRING_VALUE', /* required */
      SourceGroup: 'STRING_VALUE', /* required */
      DashPlaylistSettings: {
        ManifestWindowSeconds: 'NUMBER_VALUE',
        MinBufferTimeSeconds: 'NUMBER_VALUE',
        MinUpdatePeriodSeconds: 'NUMBER_VALUE',
        SuggestedPresentationDelaySeconds: 'NUMBER_VALUE'
      },
      HlsPlaylistSettings: {
        ManifestWindowSeconds: 'NUMBER_VALUE'
      }
    },
    /* more items */
  ]
};
mediatailor.updateChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      The identifier for the channel you are working on.

    • Outputs — (Array<map>)

      The channel's output properties.

      • DashPlaylistSettings — (map)

        DASH manifest configuration parameters.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • MinBufferTimeSeconds — (Integer)

          Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • MinUpdatePeriodSeconds — (Integer)

          Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • SuggestedPresentationDelaySeconds — (Integer)

          Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

      • HlsPlaylistSettings — (map)

        HLS playlist configuration parameters.

        • ManifestWindowSeconds — (Integer)

          The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

      • ManifestName — required — (String)

        The name of the manifest for the channel. The name appears in the PlaybackUrl.

      • SourceGroup — required — (String)

        A string used to match which HttpPackageConfiguration is used for each VodSource.

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 channel.

      • ChannelName — (String)

        The name of the channel.

      • ChannelState — (String)

        Indicates whether the channel is in a running state or not.

        Possible values include:
        • "RUNNING"
        • "STOPPED"
      • CreationTime — (Date)

        The timestamp of when the channel was created.

      • FillerSlate — (map)

        Contains information about the slate used to fill gaps between programs in the schedule.

        • SourceLocationName — (String)

          The name of the source location where the slate VOD source is stored.

        • VodSourceName — (String)

          The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

      • LastModifiedTime — (Date)

        The timestamp of when the channel was last modified.

      • Outputs — (Array<map>)

        The channel's output properties.

        • DashPlaylistSettings — (map)

          DASH manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

          • MinBufferTimeSeconds — (Integer)

            Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • MinUpdatePeriodSeconds — (Integer)

            Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

          • SuggestedPresentationDelaySeconds — (Integer)

            Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

        • HlsPlaylistSettings — (map)

          HLS manifest configuration settings.

          • ManifestWindowSeconds — (Integer)

            The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

        • ManifestName — required — (String)

          The name of the manifest for the channel that will appear in the channel output's playback URL.

        • PlaybackUrl — required — (String)

          The URL used for playback by content players.

        • SourceGroup — required — (String)

          A string used to associate a package configuration source group with a channel output.

      • PlaybackMode — (String)

        The channel's playback mode.

      • Tags — (map<String>)

        The tags assigned to the channel.

Returns:

  • (AWS.Request) —

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

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

Updates a source location on a specific channel.

Service Reference:

Examples:

Calling the updateSourceLocation operation

var params = {
  HttpConfiguration: { /* required */
    BaseUrl: 'STRING_VALUE' /* required */
  },
  SourceLocationName: 'STRING_VALUE', /* required */
  AccessConfiguration: {
    AccessType: S3_SIGV4 | SECRETS_MANAGER_ACCESS_TOKEN,
    SecretsManagerAccessTokenConfiguration: {
      HeaderName: 'STRING_VALUE',
      SecretArn: 'STRING_VALUE',
      SecretStringKey: 'STRING_VALUE'
    }
  },
  DefaultSegmentDeliveryConfiguration: {
    BaseUrl: 'STRING_VALUE'
  }
};
mediatailor.updateSourceLocation(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: {}) —
    • AccessConfiguration — (map)

      Access configuration parameters. Configures the type of authentication used to access content from your source location.

      • AccessType — (String)

        The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

        S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

        Before you can use S3_SIGV4, you must meet these requirements:

        • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

        • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

        • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

        Possible values include:
        • "S3_SIGV4"
        • "SECRETS_MANAGER_ACCESS_TOKEN"
      • SecretsManagerAccessTokenConfiguration — (map)

        AWS Secrets Manager access token configuration parameters.

        • HeaderName — (String)

          The name of the HTTP header used to supply the access token in requests to the source location.

        • SecretArn — (String)

          The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

        • SecretStringKey — (String)

          The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

    • DefaultSegmentDeliveryConfiguration — (map)

      The optional configuration for the host server that serves segments.

      • BaseUrl — (String)

        The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

    • HttpConfiguration — (map)

      The HTTP configuration for the source location.

      • BaseUrl — required — (String)

        The base URL for the source location host server. This string must include the protocol, such as https://.

    • SourceLocationName — (String)

      The identifier for the source location you are working on.

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:

      • AccessConfiguration — (map)

        The access configuration for the source location.

        • AccessType — (String)

          The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

          S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

          Before you can use S3_SIGV4, you must meet these requirements:

          • You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

          • The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

          • The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

          Possible values include:
          • "S3_SIGV4"
          • "SECRETS_MANAGER_ACCESS_TOKEN"
        • SecretsManagerAccessTokenConfiguration — (map)

          AWS Secrets Manager access token configuration parameters.

          • HeaderName — (String)

            The name of the HTTP header used to supply the access token in requests to the source location.

          • SecretArn — (String)

            The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

          • SecretStringKey — (String)

            The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

      • Arn — (String)

        The ARN of the source location.

      • CreationTime — (Date)

        The timestamp that indicates when the source location was created.

      • DefaultSegmentDeliveryConfiguration — (map)

        The default segment delivery configuration settings.

        • BaseUrl — (String)

          The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

      • HttpConfiguration — (map)

        The HTTP package configuration settings for the source location.

        • BaseUrl — required — (String)

          The base URL for the source location host server. This string must include the protocol, such as https://.

      • LastModifiedTime — (Date)

        The timestamp that indicates when the source location was last modified.

      • SourceLocationName — (String)

        The name of the source location.

      • Tags — (map<String>)

        The tags assigned to the source location.

Returns:

  • (AWS.Request) —

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

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

Updates a specific VOD source in a specific source location.

Service Reference:

Examples:

Calling the updateVodSource operation

var params = {
  HttpPackageConfigurations: [ /* required */
    {
      Path: 'STRING_VALUE', /* required */
      SourceGroup: 'STRING_VALUE', /* required */
      Type: DASH | HLS /* required */
    },
    /* more items */
  ],
  SourceLocationName: 'STRING_VALUE', /* required */
  VodSourceName: 'STRING_VALUE' /* required */
};
mediatailor.updateVodSource(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: {}) —
    • HttpPackageConfigurations — (Array<map>)

      An array of HTTP package configurations for the VOD source on this account.

      • Path — required — (String)

        The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

      • SourceGroup — required — (String)

        The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

      • Type — required — (String)

        The streaming protocol for this package configuration. Supported values are HLS and DASH.

        Possible values include:
        • "DASH"
        • "HLS"
    • SourceLocationName — (String)

      The identifier for the source location you are working on.

    • VodSourceName — (String)

      The identifier for the VOD source you are working on.

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 VOD source.

      • CreationTime — (Date)

        The timestamp that indicates when the VOD source was created.

      • HttpPackageConfigurations — (Array<map>)

        The HTTP package configurations.

        • Path — required — (String)

          The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

        • SourceGroup — required — (String)

          The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

        • Type — required — (String)

          The streaming protocol for this package configuration. Supported values are HLS and DASH.

          Possible values include:
          • "DASH"
          • "HLS"
      • LastModifiedTime — (Date)

        The ARN for the VOD source.

      • SourceLocationName — (String)

        The name of the source location associated with the VOD source.

      • Tags — (map<String>)

        The tags assigned to the VOD source.

      • VodSourceName — (String)

        The name of the VOD source.

Returns:

  • (AWS.Request) —

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