v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444174189.1 KB

Retrieves a playback configuration. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.

get/playbackConfiguration/{Name}

Path parameters

Namestring required

The identifier for the playback configuration.

Response

Success

AdDecisionServerUrlstring

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.

ConfigurationAliasesobject

The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.

Namestring

The identifier for the playback configuration.

PersonalizationThresholdSecondsinteger

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 <i>ad replacement</i> 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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.

PlaybackConfigurationArnstring

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

PlaybackEndpointPrefixstring

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

SessionInitializationEndpointPrefixstring

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

SlateAdUrlstring

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.

Tagsobject

The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.

TranscodeProfileNamestring

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.

VideoContentSourceUrlstring

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