Class: Aws::MediaTailor::Types::CreatePrefetchScheduleResponse

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN to assign to the prefetch schedule.

Returns:

  • (String) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#consumption ⇒ Types::PrefetchConsumption

The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. 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.

Returns:



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name to assign to the prefetch schedule.

Returns:

  • (String) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_name ⇒ String

The name to assign to the playback configuration.

Returns:

  • (String) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#recurring_prefetch_configuration ⇒ Types::RecurringPrefetchConfiguration

The configuration that defines how MediaTailor performs recurring prefetch.

Returns:



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval ⇒ Types::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.

Returns:



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_type ⇒ String

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

Returns:

  • (String) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

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) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags assigned to the prefetch schedule. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

Returns:

  • (Hash<String,String>) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1144

class CreatePrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :recurring_prefetch_configuration,
  :schedule_type,
  :stream_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end