1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 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: **true**<br><p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. 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: **true**<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>
    ///   - [`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 MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. 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>
    ///   - [`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())
    }
}