Class: Aws::MediaTailor::Types::PrefetchRetrieval

Inherits:

Struct

• Object
• Struct
• Aws::MediaTailor::Types::PrefetchRetrieval

Includes:

Structure

Defined in:

lib/aws-sdk-mediatailor/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dynamic_variables ⇒ Hash<String,String>

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

• #end_time ⇒ Time

  The time when prefetch retrieval ends for the ad break.

• #start_time ⇒ Time

  The time when prefetch retrievals can start for this break.

• #traffic_shaping_retrieval_window ⇒ Types::TrafficShapingRetrievalWindow

  The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS).

• #traffic_shaping_tps_configuration ⇒ Types::TrafficShapingTpsConfiguration

  The configuration for TPS-based traffic shaping.

• #traffic_shaping_type ⇒ String

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

Instance Attribute Details

#dynamic_variables ⇒ Hash<String,String>

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.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

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.

Returns:

• (Time)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_shaping_retrieval_window ⇒ Types::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.

Returns:

• (Types::TrafficShapingRetrievalWindow)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_shaping_tps_configuration ⇒ Types::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.

Returns:

• (Types::TrafficShapingTpsConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#traffic_shaping_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 4397

class PrefetchRetrieval < Struct.new(
  :dynamic_variables,
  :end_time,
  :start_time,
  :traffic_shaping_type,
  :traffic_shaping_retrieval_window,
  :traffic_shaping_tps_configuration)
  SENSITIVE = []
  include Aws::Structure
end