View a markdown version of this page

PrefetchRetrieval - AWS Elemental MediaTailor

PrefetchRetrieval

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

Contents

EndTime

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Type: Timestamp

Required: Yes

DynamicVariables

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Type: String to string map

Required: No

StartTime

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Type: Timestamp

Required: No

TrafficShapingRetrievalWindow

The configuration that tells AWS 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.

Type: TrafficShapingRetrievalWindow object

Required: No

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.

Type: TrafficShapingTpsConfiguration object

Required: No

TrafficShapingType

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

Type: String

Valid Values: RETRIEVAL_WINDOW | TPS

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: