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

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

Overview

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.



913
914
915
916
917
918
919
920
921
# File 'lib/aws-sdk-mediatailor/types.rb', line 913

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

#nameString

The name to assign to the schedule request.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
# File 'lib/aws-sdk-mediatailor/types.rb', line 913

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

#playback_configuration_nameString

The name to assign to the playback configuration.

Returns:

  • (String)


913
914
915
916
917
918
919
920
921
# File 'lib/aws-sdk-mediatailor/types.rb', line 913

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.



913
914
915
916
917
918
919
920
921
# File 'lib/aws-sdk-mediatailor/types.rb', line 913

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)


913
914
915
916
917
918
919
920
921
# File 'lib/aws-sdk-mediatailor/types.rb', line 913

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