Class: Aws::MediaTailor::Types::GetPrefetchScheduleResponse

Inherits:

Struct

• Object
• Struct
• Aws::MediaTailor::Types::GetPrefetchScheduleResponse

Includes:

Structure

Defined in:

lib/aws-sdk-mediatailor/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the prefetch schedule.

• #consumption ⇒ Types::PrefetchConsumption

  The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules.

• #name ⇒ String

  The name of the prefetch schedule.

• #playback_configuration_name ⇒ String

  The name of the playback configuration to create the prefetch schedule for.

• #recurring_prefetch_configuration ⇒ Types::RecurringPrefetchConfiguration

  The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

• #retrieval ⇒ Types::PrefetchRetrieval

  A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

• #schedule_type ⇒ String

  The frequency that MediaTailor creates prefetch schedules.

• #stream_id ⇒ String

  An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the prefetch schedule.

Returns:

• (String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

class GetPrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  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:

• (Types::PrefetchConsumption)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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

#name ⇒ String

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

Returns:

• (String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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

#playback_configuration_name ⇒ String

The name of the playback configuration to create the prefetch schedule for.

Returns:

• (String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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

#recurring_prefetch_configuration ⇒ Types::RecurringPrefetchConfiguration

The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

Returns:

• (Types::RecurringPrefetchConfiguration)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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

#retrieval ⇒ Types::PrefetchRetrieval

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

Returns:

• (Types::PrefetchRetrieval)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

class GetPrefetchScheduleResponse < Struct.new(
  :arn,
  :consumption,
  :name,
  :playback_configuration_name,
  :retrieval,
  :schedule_type,
  :recurring_prefetch_configuration,
  :stream_id)
  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)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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

#stream_id ⇒ String

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Returns:

• (String)

# File 'lib/aws-sdk-mediatailor/types.rb', line 2442

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