PrefetchSchedule ¶

class PrefetchSchedule(TypedDict, closed=True):
    arn: "capo_mediatailor.types.__string.__string"
    """<p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>"""
    consumption: NotRequired[
        "capo_mediatailor.types.prefetch_consumption.PrefetchConsumption"
    ]
    """<p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>"""
    name: "capo_mediatailor.types.__string.__string"
    """<p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>"""
    playback_configuration_name: "capo_mediatailor.types.__string.__string"
    """<p>The name of the playback configuration to create the prefetch schedule for.</p>"""
    retrieval: NotRequired[
        "capo_mediatailor.types.prefetch_retrieval.PrefetchRetrieval"
    ]
    """<p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>"""
    schedule_type: NotRequired[
        "capo_mediatailor.types.prefetch_schedule_type.PrefetchScheduleType"
    ]
    """<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>"""
    recurring_prefetch_configuration: NotRequired[
        "capo_mediatailor.types.recurring_prefetch_configuration.RecurringPrefetchConfiguration"
    ]
    """<p>The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.</p>"""
    stream_id: NotRequired["capo_mediatailor.types.__string.__string"]
    """<p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>"""
    tags: NotRequired["capo_mediatailor.types.__map_of__string.__mapOf__string"]
    """<p>The tags assigned to the prefetch schedule. 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>"""