Skip to content

RecurringRetrieval

Source code in docs_src/capo_mediatailor/types/recurring_retrieval.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class RecurringRetrieval(TypedDict, closed=True):
    dynamic_variables: NotRequired[
        "capo_mediatailor.types.__map_of__string.__mapOf__string"
    ]
    """<p>The dynamic variables to use for substitution during prefetch requests to the ADS.</p>"""
    delay_after_avail_end_seconds: NotRequired[
        "capo_mediatailor.types.__integer.__integer"
    ]
    """<p>The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).</p>"""
    traffic_shaping_type: NotRequired[
        "capo_mediatailor.types.traffic_shaping_type.TrafficShapingType"
    ]
    """<p>Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.</p>"""
    traffic_shaping_retrieval_window: NotRequired[
        "capo_mediatailor.types.traffic_shaping_retrieval_window.TrafficShapingRetrievalWindow"
    ]
    """<p>The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.</p>"""
    traffic_shaping_tps_configuration: NotRequired[
        "capo_mediatailor.types.traffic_shaping_tps_configuration.TrafficShapingTpsConfiguration"
    ]
    """<p>The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.</p>"""

delay_after_avail_end_seconds instance-attribute 

delay_after_avail_end_seconds: NotRequired[__integer]

The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).

dynamic_variables instance-attribute 

dynamic_variables: NotRequired[__mapOf__string]

The dynamic variables to use for substitution during prefetch requests to the ADS.

traffic_shaping_retrieval_window instance-attribute 

traffic_shaping_retrieval_window: NotRequired[TrafficShapingRetrievalWindow]

The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

traffic_shaping_tps_configuration instance-attribute 

traffic_shaping_tps_configuration: NotRequired[TrafficShapingTpsConfiguration]

The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.

traffic_shaping_type instance-attribute 

traffic_shaping_type: NotRequired[TrafficShapingType]

Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.