GetPlaybackConfiguration - AWS Elemental MediaTailor


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

Request Syntax

GET /playbackConfiguration/Name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The identifier for the playback configuration.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AdDecisionServerUrl": "string", "AvailSuppression": { "FillPolicy": "string", "Mode": "string", "Value": "string" }, "Bumper": { "EndUrl": "string", "StartUrl": "string" }, "CdnConfiguration": { "AdSegmentUrlPrefix": "string", "ContentSegmentUrlPrefix": "string" }, "ConfigurationAliases": { "string" : { "string" : "string" } }, "DashConfiguration": { "ManifestEndpointPrefix": "string", "MpdLocation": "string", "OriginManifestType": "string" }, "HlsConfiguration": { "ManifestEndpointPrefix": "string" }, "LivePreRollConfiguration": { "AdDecisionServerUrl": "string", "MaxDurationSeconds": number }, "LogConfiguration": { "PercentEnabled": number }, "ManifestProcessingRules": { "AdMarkerPassthrough": { "Enabled": boolean } }, "Name": "string", "PersonalizationThresholdSeconds": number, "PlaybackConfigurationArn": "string", "PlaybackEndpointPrefix": "string", "SessionInitializationEndpointPrefix": "string", "SlateAdUrl": "string", "tags": { "string" : "string" }, "TranscodeProfileName": "string", "VideoContentSourceUrl": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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.

Type: String


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

Type: AvailSuppression object


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.

Type: Bumper object


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

Type: CdnConfiguration object


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

Type: String to string to string map map


The configuration for DASH content.

Type: DashConfiguration object


The configuration for HLS content.

Type: HlsConfiguration object


The configuration for pre-roll ad insertion.

Type: LivePreRollConfiguration object


The Amazon CloudWatch log settings for a playback configuration.

Type: LogConfiguration object


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

Type: ManifestProcessingRules object


The identifier for the playback configuration.

Type: String


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.

Type: Integer

Valid Range: Minimum value of 1.


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

Type: String


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

Type: String


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

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

Type: String


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 Tagging AWS Elemental MediaTailor Resources.

Type: String to string map


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.

Type: String


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

Type: String


For information about the errors that are common to all actions, see Common Errors.

See Also

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