Class: Aws::MediaTailor::Types::CreatePrefetchScheduleRequest

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

{
  consumption: { # required
    avail_matching_criteria: [
      {
        dynamic_variable: "__string", # required
        operator: "EQUALS", # required, accepts EQUALS
      },
    ],
    end_time: Time.now, # required
    start_time: Time.now,
  },
  name: "__string", # required
  playback_configuration_name: "__string", # required
  retrieval: { # required
    dynamic_variables: {
      "__string" => "__string",
    },
    end_time: Time.now, # required
    start_time: Time.now,
  },
  stream_id: "__string",
}

A complex type that contains configuration settings for retrieval, consumption, and an optional stream ID.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#consumptionTypes::PrefetchConsumption

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.



767
768
769
770
771
772
773
774
775
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 767

class CreatePrefetchScheduleRequest < Struct.new(
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 767

class CreatePrefetchScheduleRequest < Struct.new(
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_nameString

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 767

class CreatePrefetchScheduleRequest < Struct.new(
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#retrievalTypes::PrefetchRetrieval

The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.



767
768
769
770
771
772
773
774
775
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 767

class CreatePrefetchScheduleRequest < Struct.new(
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end

#stream_idString

An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

Returns:

  • (String)


767
768
769
770
771
772
773
774
775
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 767

class CreatePrefetchScheduleRequest < Struct.new(
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :stream_id)
  SENSITIVE = []
  include Aws::Structure
end