1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PutPlaybackConfiguration`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`ad_decision_server_url(impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::ad_decision_server_url) / [`set_ad_decision_server_url(Option<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_ad_decision_server_url):<br>required: **false**<br><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><br>
    ///   - [`avail_suppression(AvailSuppression)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::avail_suppression) / [`set_avail_suppression(Option<AvailSuppression>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_avail_suppression):<br>required: **false**<br><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><br>
    ///   - [`bumper(Bumper)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::bumper) / [`set_bumper(Option<Bumper>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_bumper):<br>required: **false**<br><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><br>
    ///   - [`cdn_configuration(CdnConfiguration)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::cdn_configuration) / [`set_cdn_configuration(Option<CdnConfiguration>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_cdn_configuration):<br>required: **false**<br><p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p><br>
    ///   - [`configuration_aliases(impl Into<String>, HashMap::<String, String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::configuration_aliases) / [`set_configuration_aliases(Option<HashMap::<String, HashMap::<String, String>>>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_configuration_aliases):<br>required: **false**<br><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-domain.html">Domain Variables</a>.</p><br>
    ///   - [`dash_configuration(DashConfigurationForPut)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::dash_configuration) / [`set_dash_configuration(Option<DashConfigurationForPut>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_dash_configuration):<br>required: **false**<br><p>The configuration for DASH content.</p><br>
    ///   - [`insertion_mode(InsertionMode)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::insertion_mode) / [`set_insertion_mode(Option<InsertionMode>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_insertion_mode):<br>required: **false**<br><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><br>
    ///   - [`live_pre_roll_configuration(LivePreRollConfiguration)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::live_pre_roll_configuration) / [`set_live_pre_roll_configuration(Option<LivePreRollConfiguration>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_live_pre_roll_configuration):<br>required: **false**<br><p>The configuration for pre-roll ad insertion.</p><br>
    ///   - [`manifest_processing_rules(ManifestProcessingRules)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::manifest_processing_rules) / [`set_manifest_processing_rules(Option<ManifestProcessingRules>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_manifest_processing_rules):<br>required: **false**<br><p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_name):<br>required: **true**<br><p>The identifier for the playback configuration.</p><br>
    ///   - [`personalization_threshold_seconds(i32)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::personalization_threshold_seconds) / [`set_personalization_threshold_seconds(Option<i32>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_personalization_threshold_seconds):<br>required: **false**<br><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><br>
    ///   - [`slate_ad_url(impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::slate_ad_url) / [`set_slate_ad_url(Option<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_slate_ad_url):<br>required: **false**<br><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 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.</p><br>
    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_tags):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p><br>
    ///   - [`transcode_profile_name(impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::transcode_profile_name) / [`set_transcode_profile_name(Option<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_transcode_profile_name):<br>required: **false**<br><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><br>
    ///   - [`video_content_source_url(impl Into<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::video_content_source_url) / [`set_video_content_source_url(Option<String>)`](crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::set_video_content_source_url):<br>required: **false**<br><p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p><br>
    /// - On success, responds with [`PutPlaybackConfigurationOutput`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput) with field(s):
    ///   - [`ad_decision_server_url(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::ad_decision_server_url): <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(Option<AvailSuppression>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::avail_suppression): <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(Option<Bumper>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::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(Option<CdnConfiguration>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::cdn_configuration): <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
    ///   - [`configuration_aliases(Option<HashMap::<String, HashMap::<String, String>>>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::configuration_aliases): <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-domain.html">Domain Variables</a>.</p>
    ///   - [`dash_configuration(Option<DashConfiguration>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::dash_configuration): <p>The configuration for DASH content.</p>
    ///   - [`hls_configuration(Option<HlsConfiguration>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::hls_configuration): <p>The configuration for HLS content.</p>
    ///   - [`insertion_mode(InsertionMode)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::insertion_mode): <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(Option<LivePreRollConfiguration>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::live_pre_roll_configuration): <p>The configuration for pre-roll ad insertion.</p>
    ///   - [`log_configuration(Option<LogConfiguration>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::log_configuration): <p>The Amazon CloudWatch log settings for a playback configuration.</p>
    ///   - [`manifest_processing_rules(Option<ManifestProcessingRules>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::manifest_processing_rules): <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
    ///   - [`name(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::name): <p>The identifier for the playback configuration.</p>
    ///   - [`personalization_threshold_seconds(Option<i32>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::personalization_threshold_seconds): <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(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::playback_configuration_arn): <p>The Amazon Resource Name (ARN) associated with the playback configuration.</p>
    ///   - [`playback_endpoint_prefix(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::playback_endpoint_prefix): <p>The playback endpoint prefix associated with the playback configuration.</p>
    ///   - [`session_initialization_endpoint_prefix(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::session_initialization_endpoint_prefix): <p>The session initialization endpoint prefix associated with the playback configuration.</p>
    ///   - [`slate_ad_url(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::slate_ad_url): <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 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.</p>
    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::tags): <p>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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
    ///   - [`transcode_profile_name(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::transcode_profile_name): <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(Option<String>)`](crate::operation::put_playback_configuration::PutPlaybackConfigurationOutput::video_content_source_url): <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
    /// - On failure, responds with [`SdkError<PutPlaybackConfigurationError>`](crate::operation::put_playback_configuration::PutPlaybackConfigurationError)
    pub fn put_playback_configuration(&self) -> crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder {
        crate::operation::put_playback_configuration::builders::PutPlaybackConfigurationFluentBuilder::new(self.handle.clone())
    }
}