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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

[1]: docs.aws.amazon.com/mediatailor/latest/ug/variables.html

Returns:

  • (Hash<String,String>) 


3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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) 


3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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) 


3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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

Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

Returns:



3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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 that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.

Returns:



3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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 for prefetch traffic shaping and limiting the number of requests to the ADS at one time.

Returns:

  • (String) 


3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
 
# File 'lib/aws-sdk-mediatailor/types.rb', line 3475

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