playback_configurations

Creates, updates, deletes, gets or lists a playback_configurations resource.

Overview

Name	playback_configurations
Type	Resource
Id	aws.mediatailor.playback_configurations

Fields

The following fields are returned by SELECT queries:

get_playback_configuration

Name	Datatype	Description
ad_conditioning_configuration	object	The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
ad_decision_server_configuration	object	The configuration for customizing HTTP requests to the ad decision server (ADS). This includes settings for request method, headers, body content, and compression options.
ad_decision_server_url	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.
ads_personalization_concurrency	object	The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
ads_personalization_timeouts	object	The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
avail_suppression	object	The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
bumper	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.
cdn_configuration	object	The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliases	object	The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
dash_configuration	object	The configuration for DASH content.
dual_stack_playback_endpoint_prefix	string	The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting.
dual_stack_session_initialization_endpoint_prefix	string	The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting.
function_mapping	object	A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
hls_configuration	object	The configuration for HLS content.
insertion_mode	string	The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched. (STITCHED_ONLY, PLAYER_SELECT)
live_pre_roll_configuration	object	The configuration for pre-roll ad insertion.
log_configuration	object	The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.
manifest_processing_rules	object	The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
name	string	The identifier for the playback configuration.
personalization_threshold_seconds	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.
playback_configuration_arn	string	The Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefix	string	The URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting.
session_initialization_endpoint_prefix	string	The URL that your player uses to initialize a session that uses client-side reporting.
slate_ad_url	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	object	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.
transcode_profile_name	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.
video_content_source_url	string	The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

list_playback_configurations

Name	Datatype	Description
ad_conditioning_configuration	object	The setting that indicates what conditioning MediaTailor will perform on ads that the ad decision server (ADS) returns, and what priority MediaTailor uses when inserting ads.
ad_decision_server_configuration	object	Configuration parameters for customizing HTTP requests sent to the ad decision server (ADS). This allows you to specify the HTTP method, headers, request body, and compression settings for ADS requests.
ad_decision_server_url	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.
ads_personalization_concurrency	object	The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.
ads_personalization_timeouts	object	The timeout settings for ad decision server interactions. These settings control how long MediaTailor waits for ADS responses and the total time budget for ad personalization across live, VOD, and prefetch workflows.
avail_suppression	object	The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
bumper	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.
cdn_configuration	object	The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
configuration_aliases	object	The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
dash_configuration	object	The configuration for a DASH source.
dual_stack_playback_endpoint_prefix	string	The dual-stack (IPv4 and IPv6) URL that your player accesses to get a manifest from AWS Elemental MediaTailor.
dual_stack_session_initialization_endpoint_prefix	string	The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting.
function_mapping	object	A map of lifecycle hook event names to function identifiers. The function mapping specifies which function MediaTailor executes at each lifecycle hook during ad insertion. Valid keys are PRE_SESSION_INITIALIZATION and PRE_ADS_REQUEST. For more information, see Functions lifecycle hooks in the MediaTailor User Guide.
hls_configuration	object	The configuration for HLS content.
insertion_mode	string	The setting that controls whether players can use stitched or guided ad insertion. The default, STITCHED_ONLY, forces all player sessions to use stitched (server-side) ad insertion. Choosing PLAYER_SELECT allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched. (STITCHED_ONLY, PLAYER_SELECT)
live_pre_roll_configuration	object	The configuration for pre-roll ad insertion.
log_configuration	object	Defines where AWS Elemental MediaTailor sends logs for the playback configuration.
manifest_processing_rules	object	The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
name	string	The identifier for the playback configuration.
personalization_threshold_seconds	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.
playback_configuration_arn	string	The Amazon Resource Name (ARN) for the playback configuration.
playback_endpoint_prefix	string	The URL that your player accesses to get a manifest from AWS Elemental MediaTailor.
session_initialization_endpoint_prefix	string	The URL that your player uses to initialize a session that uses client-side reporting.
slate_ad_url	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	object	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.
transcode_profile_name	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.
video_content_source_url	string	The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_playback_configuration	select	name, region		Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
list_playback_configurations	select	region	MaxResults, NextToken	Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
put_playback_configuration	replace	region		Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
delete_playback_configuration	delete	name, region		Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
configure_logs_for_playback_configuration	exec	region, PercentEnabled, PlaybackConfigurationName		Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the playback configuration.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback configurations, use the value of NextToken in the response to get the next page of results. The default value is 100. MediaTailor uses DynamoDB-based pagination, which means that a response might contain fewer than MaxResults items, including 0 items, even when more results are available. To retrieve all results, you must continue making requests using the NextToken value from each response until the response no longer includes a NextToken value.
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. For the first ListPlaybackConfigurations request, omit this value. For subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request. Continue making requests until the response no longer includes a NextToken value, which indicates that all results have been retrieved.

SELECT examples

get_playback_configuration

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

SELECT
ad_conditioning_configuration,
ad_decision_server_configuration,
ad_decision_server_url,
ads_personalization_concurrency,
ads_personalization_timeouts,
avail_suppression,
bumper,
cdn_configuration,
configuration_aliases,
dash_configuration,
dual_stack_playback_endpoint_prefix,
dual_stack_session_initialization_endpoint_prefix,
function_mapping,
hls_configuration,
insertion_mode,
live_pre_roll_configuration,
log_configuration,
manifest_processing_rules,
name,
personalization_threshold_seconds,
playback_configuration_arn,
playback_endpoint_prefix,
session_initialization_endpoint_prefix,
slate_ad_url,
tags,
transcode_profile_name,
video_content_source_url
FROM aws.mediatailor.playback_configurations
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;

list_playback_configurations

Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

SELECT
ad_conditioning_configuration,
ad_decision_server_configuration,
ad_decision_server_url,
ads_personalization_concurrency,
ads_personalization_timeouts,
avail_suppression,
bumper,
cdn_configuration,
configuration_aliases,
dash_configuration,
dual_stack_playback_endpoint_prefix,
dual_stack_session_initialization_endpoint_prefix,
function_mapping,
hls_configuration,
insertion_mode,
live_pre_roll_configuration,
log_configuration,
manifest_processing_rules,
name,
personalization_threshold_seconds,
playback_configuration_arn,
playback_endpoint_prefix,
session_initialization_endpoint_prefix,
slate_ad_url,
tags,
transcode_profile_name,
video_content_source_url
FROM aws.mediatailor.playback_configurations
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

REPLACE examples

put_playback_configuration

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

REPLACE aws.mediatailor.playback_configurations
SET 
AdDecisionServerUrl = '{{ AdDecisionServerUrl }}',
AvailSuppression = '{{ AvailSuppression }}',
Bumper = '{{ Bumper }}',
CdnConfiguration = '{{ CdnConfiguration }}',
ConfigurationAliases = '{{ ConfigurationAliases }}',
DashConfiguration = '{{ DashConfiguration }}',
InsertionMode = '{{ InsertionMode }}',
LivePreRollConfiguration = '{{ LivePreRollConfiguration }}',
ManifestProcessingRules = '{{ ManifestProcessingRules }}',
Name = '{{ Name }}',
PersonalizationThresholdSeconds = {{ PersonalizationThresholdSeconds }},
SlateAdUrl = '{{ SlateAdUrl }}',
Tags = '{{ Tags }}',
TranscodeProfileName = '{{ TranscodeProfileName }}',
VideoContentSourceUrl = '{{ VideoContentSourceUrl }}',
AdConditioningConfiguration = '{{ AdConditioningConfiguration }}',
AdDecisionServerConfiguration = '{{ AdDecisionServerConfiguration }}',
FunctionMapping = '{{ FunctionMapping }}',
AdsPersonalizationTimeouts = '{{ AdsPersonalizationTimeouts }}',
AdsPersonalizationConcurrency = '{{ AdsPersonalizationConcurrency }}'
WHERE 
region = '{{ region }}' --required
RETURNING
ad_conditioning_configuration,
ad_decision_server_configuration,
ad_decision_server_url,
ads_personalization_concurrency,
ads_personalization_timeouts,
avail_suppression,
bumper,
cdn_configuration,
configuration_aliases,
dash_configuration,
dual_stack_playback_endpoint_prefix,
dual_stack_session_initialization_endpoint_prefix,
function_mapping,
hls_configuration,
insertion_mode,
live_pre_roll_configuration,
log_configuration,
manifest_processing_rules,
name,
personalization_threshold_seconds,
playback_configuration_arn,
playback_endpoint_prefix,
session_initialization_endpoint_prefix,
slate_ad_url,
tags,
transcode_profile_name,
video_content_source_url;

DELETE examples

delete_playback_configuration

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

DELETE FROM aws.mediatailor.playback_configurations
WHERE name = '{{ name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

configure_logs_for_playback_configuration

Defines where AWS Elemental MediaTailor sends logs for the playback configuration.

EXEC aws.mediatailor.playback_configurations.configure_logs_for_playback_configuration 
@region='{{ region }}' --required 
@@json=
'{
"PercentEnabled": {{ PercentEnabled }}, 
"PlaybackConfigurationName": "{{ PlaybackConfigurationName }}", 
"EnabledLoggingStrategies": "{{ EnabledLoggingStrategies }}", 
"AdsInteractionLog": "{{ AdsInteractionLog }}", 
"ManifestServiceInteractionLog": "{{ ManifestServiceInteractionLog }}"
}'
;