Class: Aws::MediaTailor::Types::PrefetchConsumption

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 PrefetchConsumption data as a hash:

{
  avail_matching_criteria: [
    {
      dynamic_variable: "__string", # required
      operator: "EQUALS", # required, accepts EQUALS
    },
  ],
  end_time: Time.now, # required
  start_time: Time.now,
}

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#avail_matching_criteriaArray<Types::AvailMatchingCriteria>

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Returns:



2997
2998
2999
3000
3001
3002
3003
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2997

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

#end_timeTime

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

Returns:

  • (Time)


2997
2998
2999
3000
3001
3002
3003
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2997

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

#start_timeTime

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

Returns:

  • (Time)


2997
2998
2999
3000
3001
3002
3003
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 2997

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