Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

PutPlaybackConfiguration

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

Request Syntax


PUT /playbackConfiguration HTTP/1.1
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": { 
      "MpdLocation": "string",
      "OriginManifestType": "string"
   },
   "LivePreRollConfiguration": { 
      "AdDecisionServerUrl": "string",
      "MaxDurationSeconds": number
   },
   "ManifestProcessingRules": { 
      "AdMarkerPassthrough": { 
         "Enabled": boolean
      }
   },
   "Name": "string",
   "PersonalizationThresholdSeconds": number,
   "SlateAdUrl": "string",
   "tags": { 
      "string" : "string" 
   },
   "TranscodeProfileName": "string",
   "VideoContentSourceUrl": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AdDecisionServerUrl

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

Required: No

AvailSuppression

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

Type: AvailSuppression object

Required: No

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.

Type: Bumper object

Required: No

CdnConfiguration

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

Type: CdnConfiguration object

Required: No

ConfigurationAliases

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

Required: No

DashConfiguration

The configuration for DASH content.

Type: DashConfigurationForPut object

Required: No

LivePreRollConfiguration

The configuration for pre-roll ad insertion.

Type: LivePreRollConfiguration object

Required: No

ManifestProcessingRules

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

Type: ManifestProcessingRules object

Required: No

Name

The identifier for the playback configuration.

Type: String

Required: Yes

PersonalizationThresholdSeconds

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.

Required: No

SlateAdUrl

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.

Type: String

Required: No

tags

The tags to assign 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

Required: No

TranscodeProfileName

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

Required: No

VideoContentSourceUrl

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

Type: String

Required: No

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.

AdDecisionServerUrl

Type: String

AvailSuppression

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

Type: AvailSuppression object

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.

Type: Bumper object

CdnConfiguration