aws_sdk_mediatailor/client/

create_prefetch_schedule.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreatePrefetchSchedule`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`consumption(PrefetchConsumption)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::consumption) / [`set_consumption(Option<PrefetchConsumption>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_consumption):<br>required: **false**<br><p>The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p><br>
    ///   - [`name(impl Into<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_name):<br>required: **true**<br><p>The name to assign to the schedule request.</p><br>
    ///   - [`playback_configuration_name(impl Into<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::playback_configuration_name) / [`set_playback_configuration_name(Option<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_playback_configuration_name):<br>required: **true**<br><p>The name to assign to the playback configuration.</p><br>
    ///   - [`retrieval(PrefetchRetrieval)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::retrieval) / [`set_retrieval(Option<PrefetchRetrieval>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_retrieval):<br>required: **false**<br><p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p><br>
    ///   - [`recurring_prefetch_configuration(RecurringPrefetchConfiguration)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::recurring_prefetch_configuration) / [`set_recurring_prefetch_configuration(Option<RecurringPrefetchConfiguration>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_recurring_prefetch_configuration):<br>required: **false**<br><p>The configuration that defines how and when MediaTailor performs ad prefetching in a live event.</p><br>
    ///   - [`schedule_type(PrefetchScheduleType)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::schedule_type) / [`set_schedule_type(Option<PrefetchScheduleType>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_schedule_type):<br>required: **false**<br><p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p> <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a></p><br>
    ///   - [`stream_id(impl Into<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::stream_id) / [`set_stream_id(Option<String>)`](crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::set_stream_id):<br>required: **false**<br><p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p><br>
    /// - On success, responds with [`CreatePrefetchScheduleOutput`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput) with field(s):
    ///   - [`arn(Option<String>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::arn): <p>The ARN to assign to the prefetch schedule.</p>
    ///   - [`consumption(Option<PrefetchConsumption>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::consumption): <p>The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
    ///   - [`name(Option<String>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::name): <p>The name to assign to the prefetch schedule.</p>
    ///   - [`playback_configuration_name(Option<String>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::playback_configuration_name): <p>The name to assign to the playback configuration.</p>
    ///   - [`retrieval(Option<PrefetchRetrieval>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::retrieval): <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
    ///   - [`recurring_prefetch_configuration(Option<RecurringPrefetchConfiguration>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::recurring_prefetch_configuration): <p>The configuration that defines how MediaTailor performs recurring prefetch.</p>
    ///   - [`schedule_type(Option<PrefetchScheduleType>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::schedule_type): <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
    ///   - [`stream_id(Option<String>)`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleOutput::stream_id): <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
    /// - On failure, responds with [`SdkError<CreatePrefetchScheduleError>`](crate::operation::create_prefetch_schedule::CreatePrefetchScheduleError)
    pub fn create_prefetch_schedule(&self) -> crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder {
        crate::operation::create_prefetch_schedule::builders::CreatePrefetchScheduleFluentBuilder::new(self.handle.clone())
    }
}