Skip to content

GetPrefetchScheduleResponse

Source code in docs_src/capo_mediatailor/types/get_prefetch_schedule_response.py
class GetPrefetchScheduleResponse(TypedDict, closed=True):
    arn: NotRequired["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>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: NotRequired["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: NotRequired["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>"""
    recurring_prefetch_configuration: NotRequired[
        "capo_mediatailor.types.recurring_prefetch_configuration.RecurringPrefetchConfiguration"
    ]
    """<p>The configuration that defines how and when MediaTailor performs ad prefetching in a live event.</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>"""

arn instance-attribute

arn: NotRequired[__string]

The Amazon Resource Name (ARN) of the prefetch schedule.

consumption instance-attribute

consumption: NotRequired[PrefetchConsumption]

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 consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

name instance-attribute

name: NotRequired[__string]

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

playback_configuration_name instance-attribute

playback_configuration_name: NotRequired[__string]

The name of the playback configuration to create the prefetch schedule for.

recurring_prefetch_configuration instance-attribute

recurring_prefetch_configuration: NotRequired[RecurringPrefetchConfiguration]

The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

retrieval instance-attribute

retrieval: NotRequired[PrefetchRetrieval]

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

schedule_type instance-attribute

schedule_type: NotRequired[PrefetchScheduleType]

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

stream_id instance-attribute

stream_id: NotRequired[__string]

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

tags instance-attribute

tags: NotRequired[__mapOf__string]

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 Tagging AWS Elemental MediaTailor Resources.