amazonka-mediatailor-2.0: Amazon MediaTailor SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MediaTailor.GetPlaybackConfiguration

Description

Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.

Synopsis

Creating a Request

data GetPlaybackConfiguration Source #

See: newGetPlaybackConfiguration smart constructor.

Constructors

GetPlaybackConfiguration' 

Fields

  • name :: Text

    The identifier for the playback configuration.

Instances

Instances details
ToHeaders GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

ToPath GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

ToQuery GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

AWSRequest GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Generic GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Associated Types

type Rep GetPlaybackConfiguration :: Type -> Type #

Read GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Show GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

NFData GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Eq GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Hashable GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

type AWSResponse GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

type Rep GetPlaybackConfiguration Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

type Rep GetPlaybackConfiguration = D1 ('MetaData "GetPlaybackConfiguration" "Amazonka.MediaTailor.GetPlaybackConfiguration" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "GetPlaybackConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetPlaybackConfiguration Source #

Create a value of GetPlaybackConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetPlaybackConfiguration, getPlaybackConfiguration_name - The identifier for the playback configuration.

Request Lenses

getPlaybackConfiguration_name :: Lens' GetPlaybackConfiguration Text Source #

The identifier for the playback configuration.

Destructuring the Response

data GetPlaybackConfigurationResponse Source #

See: newGetPlaybackConfigurationResponse smart constructor.

Constructors

GetPlaybackConfigurationResponse' 

Fields

  • adDecisionServerUrl :: Maybe Text

    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.

  • availSuppression :: Maybe AvailSuppression

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

  • bumper :: Maybe 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.

  • cdnConfiguration :: Maybe CdnConfiguration

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

  • configurationAliases :: Maybe (HashMap Text (HashMap Text Text))

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

  • dashConfiguration :: Maybe DashConfiguration

    The configuration for DASH content.

  • hlsConfiguration :: Maybe HlsConfiguration

    The configuration for HLS content.

  • livePreRollConfiguration :: Maybe LivePreRollConfiguration

    The configuration for pre-roll ad insertion.

  • logConfiguration :: Maybe LogConfiguration

    The Amazon CloudWatch log settings for a playback configuration.

  • manifestProcessingRules :: Maybe ManifestProcessingRules

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

  • name :: Maybe Text

    The identifier for the playback configuration.

  • personalizationThresholdSeconds :: Maybe Natural

    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.

  • playbackConfigurationArn :: Maybe Text

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

  • playbackEndpointPrefix :: Maybe Text

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

  • sessionInitializationEndpointPrefix :: Maybe Text

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

  • slateAdUrl :: Maybe Text

    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.

  • tags :: Maybe (HashMap Text Text)

    The tags assigned to the playback configuration. 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.

  • transcodeProfileName :: Maybe Text

    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.

  • videoContentSourceUrl :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Associated Types

type Rep GetPlaybackConfigurationResponse :: Type -> Type #

Read GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Show GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

NFData GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

Eq GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

type Rep GetPlaybackConfigurationResponse Source # 
Instance details

Defined in Amazonka.MediaTailor.GetPlaybackConfiguration

type Rep GetPlaybackConfigurationResponse = D1 ('MetaData "GetPlaybackConfigurationResponse" "Amazonka.MediaTailor.GetPlaybackConfiguration" "amazonka-mediatailor-2.0-6mxt6n51Pv3JbuBr2GKiO4" 'False) (C1 ('MetaCons "GetPlaybackConfigurationResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "adDecisionServerUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "availSuppression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailSuppression))) :*: (S1 ('MetaSel ('Just "bumper") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bumper)) :*: (S1 ('MetaSel ('Just "cdnConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CdnConfiguration)) :*: S1 ('MetaSel ('Just "configurationAliases") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text Text))))))) :*: ((S1 ('MetaSel ('Just "dashConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DashConfiguration)) :*: S1 ('MetaSel ('Just "hlsConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HlsConfiguration))) :*: (S1 ('MetaSel ('Just "livePreRollConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LivePreRollConfiguration)) :*: (S1 ('MetaSel ('Just "logConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LogConfiguration)) :*: S1 ('MetaSel ('Just "manifestProcessingRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ManifestProcessingRules)))))) :*: (((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "personalizationThresholdSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "playbackConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "playbackEndpointPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sessionInitializationEndpointPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "slateAdUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "transcodeProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "videoContentSourceUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newGetPlaybackConfigurationResponse Source #

Create a value of GetPlaybackConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_adDecisionServerUrl - 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.

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

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_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.

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

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

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_dashConfiguration - The configuration for DASH content.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_hlsConfiguration - The configuration for HLS content.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_livePreRollConfiguration - The configuration for pre-roll ad insertion.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_logConfiguration - The Amazon CloudWatch log settings for a playback configuration.

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

GetPlaybackConfiguration, getPlaybackConfigurationResponse_name - The identifier for the playback configuration.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_personalizationThresholdSeconds - 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.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_playbackConfigurationArn - The Amazon Resource Name (ARN) for the playback configuration.

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

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

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_slateAdUrl - 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.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_tags - The tags assigned to the playback configuration. 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.

GetPlaybackConfigurationResponse, getPlaybackConfigurationResponse_transcodeProfileName - 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.

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

$sel:httpStatus:GetPlaybackConfigurationResponse', getPlaybackConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

getPlaybackConfigurationResponse_adDecisionServerUrl :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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.

getPlaybackConfigurationResponse_availSuppression :: Lens' GetPlaybackConfigurationResponse (Maybe AvailSuppression) Source #

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

getPlaybackConfigurationResponse_bumper :: Lens' GetPlaybackConfigurationResponse (Maybe Bumper) Source #

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.

getPlaybackConfigurationResponse_cdnConfiguration :: Lens' GetPlaybackConfigurationResponse (Maybe CdnConfiguration) Source #

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

getPlaybackConfigurationResponse_configurationAliases :: Lens' GetPlaybackConfigurationResponse (Maybe (HashMap Text (HashMap Text Text))) Source #

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

getPlaybackConfigurationResponse_manifestProcessingRules :: Lens' GetPlaybackConfigurationResponse (Maybe ManifestProcessingRules) Source #

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

getPlaybackConfigurationResponse_personalizationThresholdSeconds :: Lens' GetPlaybackConfigurationResponse (Maybe Natural) Source #

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.

getPlaybackConfigurationResponse_playbackEndpointPrefix :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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

getPlaybackConfigurationResponse_sessionInitializationEndpointPrefix :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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

getPlaybackConfigurationResponse_slateAdUrl :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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.

getPlaybackConfigurationResponse_tags :: Lens' GetPlaybackConfigurationResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the playback configuration. 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.

getPlaybackConfigurationResponse_transcodeProfileName :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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.

getPlaybackConfigurationResponse_videoContentSourceUrl :: Lens' GetPlaybackConfigurationResponse (Maybe Text) Source #

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