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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb

Overview

Note:

When making an API call, you may pass PrefetchRetrieval data as a hash:

{
  dynamic_variables: {
    "__string" => "__string",
  },
  end_time: Time.now, # required
  start_time: Time.now,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dynamic_variablesHash<String,String>

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

You intially 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>)


3049
3050
3051
3052
3053
3054
3055
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3049

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

#end_timeTime

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)


3049
3050
3051
3052
3053
3054
3055
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3049

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

#start_timeTime

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)


3049
3050
3051
3052
3053
3054
3055
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 3049

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