GetPlaybackConfigurationResponse ¶

class GetPlaybackConfigurationResponse(TypedDict, closed=True):
    ad_decision_server_url: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>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.</p>"""
    avail_suppression: NotRequired[
        "capo_mediatailor.types.avail_suppression.AvailSuppression"
    ]
    """<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>"""
    bumper: NotRequired["capo_mediatailor.types.bumper.Bumper"]
    """<p>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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>"""
    cdn_configuration: NotRequired[
        "capo_mediatailor.types.cdn_configuration.CdnConfiguration"
    ]
    """<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>"""
    configuration_aliases: NotRequired[
        "capo_mediatailor.types.configuration_aliases_response.ConfigurationAliasesResponse"
    ]
    """<p>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-domains.html">Domain Variables</a>.</p>"""
    dash_configuration: NotRequired[
        "capo_mediatailor.types.dash_configuration.DashConfiguration"
    ]
    """<p>The configuration for DASH content.</p>"""
    hls_configuration: NotRequired[
        "capo_mediatailor.types.hls_configuration.HlsConfiguration"
    ]
    """<p>The configuration for HLS content.</p>"""
    insertion_mode: "capo_mediatailor.types.insertion_mode.InsertionMode"
    """<p>The setting that controls whether players can use stitched or guided ad insertion. The default, <code>STITCHED_ONLY</code>, forces all player sessions to use stitched (server-side) ad insertion. Choosing <code>PLAYER_SELECT</code> 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.</p>"""
    live_pre_roll_configuration: NotRequired[
        "capo_mediatailor.types.live_pre_roll_configuration.LivePreRollConfiguration"
    ]
    """<p>The configuration for pre-roll ad insertion.</p>"""
    log_configuration: NotRequired[
        "capo_mediatailor.types.log_configuration.LogConfiguration"
    ]
    """<p>The configuration that defines where AWS Elemental MediaTailor sends logs for the playback configuration.</p>"""
    manifest_processing_rules: NotRequired[
        "capo_mediatailor.types.manifest_processing_rules.ManifestProcessingRules"
    ]
    """<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>"""
    name: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The identifier for the playback configuration.</p>"""
    personalization_threshold_seconds: NotRequired[
        "capo_mediatailor.types.__integer_min1.__integerMin1"
    ]
    """<p>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>.</p>"""
    playback_configuration_arn: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The Amazon Resource Name (ARN) for the playback configuration.</p>"""
    playback_endpoint_prefix: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The URL that your player accesses to get a manifest from AWS Elemental MediaTailor. The session uses server-side reporting.</p>"""
    dual_stack_playback_endpoint_prefix: NotRequired[
        "capo_mediatailor.types.__string.__string"
    ]
    """<p>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.</p>"""
    session_initialization_endpoint_prefix: NotRequired[
        "capo_mediatailor.types.__string.__string"
    ]
    """<p>The URL that your player uses to initialize a session that uses client-side reporting.</p>"""
    dual_stack_session_initialization_endpoint_prefix: NotRequired[
        "capo_mediatailor.types.__string.__string"
    ]
    """<p>The dual-stack (IPv4 and IPv6) URL that your player uses to initialize a session that uses client-side reporting.</p>"""
    slate_ad_url: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>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.</p>"""
    tags: NotRequired["capo_mediatailor.types.__map_of__string.__mapOf__string"]
    """<p>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>.</p>"""
    transcode_profile_name: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>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.</p>"""
    video_content_source_url: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>"""
    ad_conditioning_configuration: NotRequired[
        "capo_mediatailor.types.ad_conditioning_configuration.AdConditioningConfiguration"
    ]
    """<p>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. </p>"""
    ad_decision_server_configuration: NotRequired[
        "capo_mediatailor.types.ad_decision_server_configuration.AdDecisionServerConfiguration"
    ]
    """<p>The configuration for customizing HTTP requests to the ad decision server (ADS). This includes settings for request method, headers, body content, and compression options.</p>"""
    yield_optimization_configuration: NotRequired[
        "capo_mediatailor.types.yield_optimization_configuration.YieldOptimizationConfiguration"
    ]
    """<p>Configuration for Yield Optimization, which fills unsold ad inventory in ad breaks with programmatic ads from Amazon Publisher Services (APS).</p>"""
    function_mapping: NotRequired[
        "capo_mediatailor.types.function_mapping.FunctionMapping"
    ]
    """<p>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 <code>PRE_SESSION_INITIALIZATION</code>, <code>PRE_ADS_REQUEST</code>, <code>POST_ADS_RESPONSE</code>, and <code>PRE_MANIFEST_INSERTION</code>. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/monetization-functions-hooks.html">Functions lifecycle hooks</a> in the <i>MediaTailor User Guide</i>.</p>"""
    ads_personalization_timeouts: NotRequired[
        "capo_mediatailor.types.ads_personalization_timeouts.AdsPersonalizationTimeouts"
    ]
    """<p>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.</p>"""
    ads_personalization_concurrency: NotRequired[
        "capo_mediatailor.types.ads_personalization_concurrency.AdsPersonalizationConcurrency"
    ]
    """<p>The concurrency settings for ad decision server interactions. These settings control how many simultaneous ADS requests MediaTailor makes per manifest request.</p>"""
    beaconing_configuration: NotRequired[
        "capo_mediatailor.types.beaconing_configuration.BeaconingConfiguration"
    ]
    """<p>The beaconing configuration for this playback configuration, which controls whether MediaTailor includes beacons of its own in the ad tracking response. MediaTailor always returns this setting. If you created the playback configuration before this setting existed, MediaTailor reports <code>ReportingMode</code> as <code>INSIGHTS</code>. This is also the value MediaTailor uses for that configuration at playback time.</p>"""