Class: Aws::MediaTailor::Types::GetPlaybackConfigurationResponse

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

Overview

Returns the playback configuration for the specified name.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ad_decision_server_urlString

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#avail_suppressionTypes::AvailSuppression

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#bumperTypes::Bumper

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.

Returns:



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#cdn_configurationTypes::CdnConfiguration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_aliasesHash<String,Hash<String,String>>

The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.

Returns:

  • (Hash<String,Hash<String,String>>)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#dash_configurationTypes::DashConfiguration

The configuration for DASH content.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#hls_configurationTypes::HlsConfiguration

The configuration for HLS content.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#live_pre_roll_configurationTypes::LivePreRollConfiguration

The configuration for pre-roll ad insertion.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#log_configurationTypes::LogConfiguration

The Amazon CloudWatch log settings for a playback configuration.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#manifest_processing_rulesTypes::ManifestProcessingRules

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.



1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The identifier for the playback configuration.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#personalization_threshold_secondsInteger

Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.

Returns:

  • (Integer)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#playback_configuration_arnString

The Amazon Resource Name (ARN) for the playback configuration.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#playback_endpoint_prefixString

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#session_initialization_endpoint_prefixString

The URL that the player uses to initialize a session that uses client-side reporting.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#slate_ad_urlString

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags assigned to the playback configuration.

Returns:

  • (Hash<String,String>)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#transcode_profile_nameString

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end

#video_content_source_urlString

The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

  • (String)


1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-mediatailor/lib/aws-sdk-mediatailor/types.rb', line 1864

class GetPlaybackConfigurationResponse < Struct.new(
  :ad_decision_server_url,
  :avail_suppression,
  :bumper,
  :cdn_configuration,
  :configuration_aliases,
  :dash_configuration,
  :hls_configuration,
  :live_pre_roll_configuration,
  :log_configuration,
  :manifest_processing_rules,
  :name,
  :personalization_threshold_seconds,
  :playback_configuration_arn,
  :playback_endpoint_prefix,
  :session_initialization_endpoint_prefix,
  :slate_ad_url,
  :tags,
  :transcode_profile_name,
  :video_content_source_url)
  SENSITIVE = []
  include Aws::Structure
end