PutPlaybackConfiguration - AWS Elemental MediaTailor

PutPlaybackConfiguration

Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

URI

/v1/playbackConfiguration

HTTP methods

PUT

Operation ID: PutPlaybackConfiguration

Adds a new playback configuration to AWS Elemental MediaTailor.

Example Request

PUT /playbackConfiguration { "Name": "testConfig", "AdDecisionServerUrl": "http://testAds.com", "VideoContentSourceUrl": "http://testOrigin.com", "tags": { "testKey": "testValue" } }

Example Response

Success: 200 { "Name": "testConfig", "AdDecisionServerUrl": "http://testAds.com", "VideoContentSourceUrl": "http://testOrigin.com", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-east-1:111111111111:playbackConfiguration/testConfig", "tags": { "testKey": "testValue" } }
Responses
Status code Response model Description
200 GetPlaybackConfigurationResponse

Success.

Schemas

Request bodies

{ "Bumper": { "StartUrl": "string", "EndUrl": "string" }, "DashConfiguration": { "MpdLocation": "string", "OriginManifestType": enum }, "CdnConfiguration": { "AdSegmentUrlPrefix": "string", "ContentSegmentUrlPrefix": "string" }, "ManifestProcessingRules": { "AdMarkerPassthrough": { "Enabled": boolean } }, "PersonalizationThresholdSeconds": integer, "LivePreRollConfiguration": { "AdDecisionServerUrl": "string", "MaxDurationSeconds": integer }, "VideoContentSourceUrl": "string", "Name": "string", "tags": { }, "TranscodeProfileName": "string", "ConfigurationAliases": { }, "AdDecisionServerUrl": "string", "SlateAdUrl": "string", "AvailSuppression": { "Mode": enum, "Value": "string" } }

Response bodies

{ "Bumper": { "StartUrl": "string", "EndUrl": "string" }, "SessionInitializationEndpointPrefix": "string", "DashConfiguration": { "ManifestEndpointPrefix": "string", "MpdLocation": "string", "OriginManifestType": enum }, "CdnConfiguration": { "AdSegmentUrlPrefix": "string", "ContentSegmentUrlPrefix": "string" }, "ManifestProcessingRules": { "AdMarkerPassthrough": { "Enabled": boolean } }, "PersonalizationThresholdSeconds": integer, "PlaybackConfigurationArn": "string", "LivePreRollConfiguration": { "AdDecisionServerUrl": "string", "MaxDurationSeconds": integer }, "HlsConfiguration": { "ManifestEndpointPrefix": "string" }, "VideoContentSourceUrl": "string", "Name": "string", "tags": { }, "TranscodeProfileName": "string", "ConfigurationAliases": { }, "AdDecisionServerUrl": "string", "SlateAdUrl": "string", "PlaybackEndpointPrefix": "string", "AvailSuppression": { "Mode": enum, "Value": "string" } }

Properties

AdMarkerPassthrough

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.

Property Type Required Description
Enabled

boolean

False

Enables ad marker passthrough for your configuration.

AvailSuppression

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

Property Type Required Description
Mode

string

Values: OFF | BEHIND_LIVE_EDGE

False

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.

Value

string

False

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

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.

Property Type Required Description
StartUrl

string

False

The URL for the start bumper asset.

EndUrl

string

False

The URL for the end bumper asset.

CdnConfiguration

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

Property Type Required Description
AdSegmentUrlPrefix

string

False

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

False

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.

ConfigurationAliasesRequest

The predefined aliases for dynamic variables.

Property Type Required Description

*

object

False

ConfigurationAliasesResponse

The predefined aliases for dynamic variables.

Property Type Required Description

*

object

False

DashConfiguration

The configuration for DASH content.

Property Type Required Description
ManifestEndpointPrefix

string

False

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

False

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

Values: SINGLE_PERIOD | MULTI_PERIOD

False

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.

DashConfigurationForPut

The configuration for DASH PUT operations.

Property Type Required Description
MpdLocation

string

False

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

Values: SINGLE_PERIOD | MULTI_PERIOD

False

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.

GetPlaybackConfigurationResponse

Returns the playback configuration for the specified name.

Property Type Required Description
Bumper

Bumper

False

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.

SessionInitializationEndpointPrefix

string

False

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

DashConfiguration

DashConfiguration

False

The configuration for DASH content.

CdnConfiguration

CdnConfiguration

False

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

ManifestProcessingRules

ManifestProcessingRules

False

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

PersonalizationThresholdSeconds

integer

Minimum: 1

False

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

False

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

LivePreRollConfiguration

LivePreRollConfiguration

False

The configuration for pre-roll ad insertion.

HlsConfiguration

HlsConfiguration

False

The configuration for HLS content.

VideoContentSourceUrl

string

False

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

Name

string

False

The identifier for the playback configuration.

tags

object

False

The tags assigned to the playback configuration.

TranscodeProfileName

string

False

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.

ConfigurationAliases

ConfigurationAliasesResponse

False

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

AdDecisionServerUrl

string

False

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.

SlateAdUrl

string

False

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.

PlaybackEndpointPrefix

string

False

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

AvailSuppression

AvailSuppression

False

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

HlsConfiguration

The configuration for HLS content.

Property Type Required Description
ManifestEndpointPrefix

string

False

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

LivePreRollConfiguration

The configuration for pre-roll ad insertion.

Property Type Required Description
AdDecisionServerUrl

string

False

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

False

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

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

Property Type Required Description
AdMarkerPassthrough

AdMarkerPassthrough

False

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.

PutPlaybackConfigurationRequest

The configuration for creating a playback configuration.

Property Type Required Description
Bumper

Bumper

False

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.

DashConfiguration

DashConfigurationForPut

False

The configuration for DASH content.

CdnConfiguration

CdnConfiguration

False

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

ManifestProcessingRules

ManifestProcessingRules

False

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

PersonalizationThresholdSeconds

integer

Minimum: 1

False

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.

LivePreRollConfiguration

LivePreRollConfiguration

False

The configuration for pre-roll ad insertion.

VideoContentSourceUrl

string

False

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

Name

string

False

The identifier for the playback configuration.

tags

object

False

The tags to assign to the playback configuration.

TranscodeProfileName

string

False

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.

ConfigurationAliases

ConfigurationAliasesRequest

False

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

Example

PUT /playbackConfiguration { "Name": "testConfig", "AdDecisionServerUrl": "http://testAds.com", "VideoContentSourceUrl": "http://testOrigin.com", ... "ConfigurationAliases": { "player_params.origin_domain": { "pdx": "123456789.mediapackage.us-west-2.amazonaws.com", "iad": "987654321.mediapackage.us-east-1.amazonaws.com", }, "player_params.ad_type": { "spec": "my-internal-ads-type", "default": "default-internal-ads-type" }, }, ... }
AdDecisionServerUrl

string

False

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.

SlateAdUrl

string

False

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.

AvailSuppression

AvailSuppression

False

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

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

PutPlaybackConfiguration