Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
Synopsis
- data PutPlaybackConfiguration = PutPlaybackConfiguration' {
- adDecisionServerUrl :: Maybe Text
- availSuppression :: Maybe AvailSuppression
- bumper :: Maybe Bumper
- cdnConfiguration :: Maybe CdnConfiguration
- configurationAliases :: Maybe (HashMap Text (HashMap Text Text))
- dashConfiguration :: Maybe DashConfigurationForPut
- livePreRollConfiguration :: Maybe LivePreRollConfiguration
- manifestProcessingRules :: Maybe ManifestProcessingRules
- personalizationThresholdSeconds :: Maybe Natural
- slateAdUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- transcodeProfileName :: Maybe Text
- videoContentSourceUrl :: Maybe Text
- name :: Text
- newPutPlaybackConfiguration :: Text -> PutPlaybackConfiguration
- putPlaybackConfiguration_adDecisionServerUrl :: Lens' PutPlaybackConfiguration (Maybe Text)
- putPlaybackConfiguration_availSuppression :: Lens' PutPlaybackConfiguration (Maybe AvailSuppression)
- putPlaybackConfiguration_bumper :: Lens' PutPlaybackConfiguration (Maybe Bumper)
- putPlaybackConfiguration_cdnConfiguration :: Lens' PutPlaybackConfiguration (Maybe CdnConfiguration)
- putPlaybackConfiguration_configurationAliases :: Lens' PutPlaybackConfiguration (Maybe (HashMap Text (HashMap Text Text)))
- putPlaybackConfiguration_dashConfiguration :: Lens' PutPlaybackConfiguration (Maybe DashConfigurationForPut)
- putPlaybackConfiguration_livePreRollConfiguration :: Lens' PutPlaybackConfiguration (Maybe LivePreRollConfiguration)
- putPlaybackConfiguration_manifestProcessingRules :: Lens' PutPlaybackConfiguration (Maybe ManifestProcessingRules)
- putPlaybackConfiguration_personalizationThresholdSeconds :: Lens' PutPlaybackConfiguration (Maybe Natural)
- putPlaybackConfiguration_slateAdUrl :: Lens' PutPlaybackConfiguration (Maybe Text)
- putPlaybackConfiguration_tags :: Lens' PutPlaybackConfiguration (Maybe (HashMap Text Text))
- putPlaybackConfiguration_transcodeProfileName :: Lens' PutPlaybackConfiguration (Maybe Text)
- putPlaybackConfiguration_videoContentSourceUrl :: Lens' PutPlaybackConfiguration (Maybe Text)
- putPlaybackConfiguration_name :: Lens' PutPlaybackConfiguration Text
- data PutPlaybackConfigurationResponse = PutPlaybackConfigurationResponse' {
- adDecisionServerUrl :: Maybe Text
- availSuppression :: Maybe AvailSuppression
- bumper :: Maybe Bumper
- cdnConfiguration :: Maybe CdnConfiguration
- configurationAliases :: Maybe (HashMap Text (HashMap Text Text))
- dashConfiguration :: Maybe DashConfiguration
- hlsConfiguration :: Maybe HlsConfiguration
- livePreRollConfiguration :: Maybe LivePreRollConfiguration
- logConfiguration :: Maybe LogConfiguration
- manifestProcessingRules :: Maybe ManifestProcessingRules
- name :: Maybe Text
- personalizationThresholdSeconds :: Maybe Natural
- playbackConfigurationArn :: Maybe Text
- playbackEndpointPrefix :: Maybe Text
- sessionInitializationEndpointPrefix :: Maybe Text
- slateAdUrl :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- transcodeProfileName :: Maybe Text
- videoContentSourceUrl :: Maybe Text
- httpStatus :: Int
- newPutPlaybackConfigurationResponse :: Int -> PutPlaybackConfigurationResponse
- putPlaybackConfigurationResponse_adDecisionServerUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_availSuppression :: Lens' PutPlaybackConfigurationResponse (Maybe AvailSuppression)
- putPlaybackConfigurationResponse_bumper :: Lens' PutPlaybackConfigurationResponse (Maybe Bumper)
- putPlaybackConfigurationResponse_cdnConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe CdnConfiguration)
- putPlaybackConfigurationResponse_configurationAliases :: Lens' PutPlaybackConfigurationResponse (Maybe (HashMap Text (HashMap Text Text)))
- putPlaybackConfigurationResponse_dashConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe DashConfiguration)
- putPlaybackConfigurationResponse_hlsConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe HlsConfiguration)
- putPlaybackConfigurationResponse_livePreRollConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe LivePreRollConfiguration)
- putPlaybackConfigurationResponse_logConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe LogConfiguration)
- putPlaybackConfigurationResponse_manifestProcessingRules :: Lens' PutPlaybackConfigurationResponse (Maybe ManifestProcessingRules)
- putPlaybackConfigurationResponse_name :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_personalizationThresholdSeconds :: Lens' PutPlaybackConfigurationResponse (Maybe Natural)
- putPlaybackConfigurationResponse_playbackConfigurationArn :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_playbackEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_sessionInitializationEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_slateAdUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_tags :: Lens' PutPlaybackConfigurationResponse (Maybe (HashMap Text Text))
- putPlaybackConfigurationResponse_transcodeProfileName :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_videoContentSourceUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text)
- putPlaybackConfigurationResponse_httpStatus :: Lens' PutPlaybackConfigurationResponse Int
Creating a Request
data PutPlaybackConfiguration Source #
See: newPutPlaybackConfiguration
smart constructor.
PutPlaybackConfiguration' | |
|
Instances
newPutPlaybackConfiguration Source #
Create a value of PutPlaybackConfiguration
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:
PutPlaybackConfiguration
, putPlaybackConfiguration_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.
PutPlaybackConfiguration
, putPlaybackConfiguration_availSuppression
- The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
PutPlaybackConfiguration
, putPlaybackConfiguration_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.
PutPlaybackConfiguration
, putPlaybackConfiguration_cdnConfiguration
- The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
PutPlaybackConfiguration
, putPlaybackConfiguration_configurationAliases
- The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
PutPlaybackConfiguration
, putPlaybackConfiguration_dashConfiguration
- The configuration for DASH content.
PutPlaybackConfiguration
, putPlaybackConfiguration_livePreRollConfiguration
- The configuration for pre-roll ad insertion.
PutPlaybackConfiguration
, putPlaybackConfiguration_manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
PutPlaybackConfiguration
, putPlaybackConfiguration_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.
PutPlaybackConfiguration
, putPlaybackConfiguration_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 configurations. For VPAID, the slate is required because
MediaTailor provides it in the slots that are designated for dynamic ad
content. The slate must be a high-quality asset that contains both audio
and video.
PutPlaybackConfiguration
, putPlaybackConfiguration_tags
- The tags to assign 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.
PutPlaybackConfiguration
, putPlaybackConfiguration_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.
PutPlaybackConfiguration
, putPlaybackConfiguration_videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
PutPlaybackConfiguration
, putPlaybackConfiguration_name
- The identifier for the playback configuration.
Request Lenses
putPlaybackConfiguration_adDecisionServerUrl :: Lens' PutPlaybackConfiguration (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.
putPlaybackConfiguration_availSuppression :: Lens' PutPlaybackConfiguration (Maybe AvailSuppression) Source #
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
putPlaybackConfiguration_bumper :: Lens' PutPlaybackConfiguration (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.
putPlaybackConfiguration_cdnConfiguration :: Lens' PutPlaybackConfiguration (Maybe CdnConfiguration) Source #
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
putPlaybackConfiguration_configurationAliases :: Lens' PutPlaybackConfiguration (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.
putPlaybackConfiguration_dashConfiguration :: Lens' PutPlaybackConfiguration (Maybe DashConfigurationForPut) Source #
The configuration for DASH content.
putPlaybackConfiguration_livePreRollConfiguration :: Lens' PutPlaybackConfiguration (Maybe LivePreRollConfiguration) Source #
The configuration for pre-roll ad insertion.
putPlaybackConfiguration_manifestProcessingRules :: Lens' PutPlaybackConfiguration (Maybe ManifestProcessingRules) Source #
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
putPlaybackConfiguration_personalizationThresholdSeconds :: Lens' PutPlaybackConfiguration (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.
putPlaybackConfiguration_slateAdUrl :: Lens' PutPlaybackConfiguration (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 configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
putPlaybackConfiguration_tags :: Lens' PutPlaybackConfiguration (Maybe (HashMap Text Text)) Source #
The tags to assign 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.
putPlaybackConfiguration_transcodeProfileName :: Lens' PutPlaybackConfiguration (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.
putPlaybackConfiguration_videoContentSourceUrl :: Lens' PutPlaybackConfiguration (Maybe Text) Source #
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
putPlaybackConfiguration_name :: Lens' PutPlaybackConfiguration Text Source #
The identifier for the playback configuration.
Destructuring the Response
data PutPlaybackConfigurationResponse Source #
See: newPutPlaybackConfigurationResponse
smart constructor.
PutPlaybackConfigurationResponse' | |
|
Instances
newPutPlaybackConfigurationResponse Source #
Create a value of PutPlaybackConfigurationResponse
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:
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_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.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_availSuppression
- The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_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.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_cdnConfiguration
- The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_configurationAliases
- The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_dashConfiguration
- The configuration for DASH content.
PutPlaybackConfigurationResponse
, putPlaybackConfigurationResponse_hlsConfiguration
- The configuration for HLS content.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_livePreRollConfiguration
- The configuration for pre-roll ad insertion.
PutPlaybackConfigurationResponse
, putPlaybackConfigurationResponse_logConfiguration
- The Amazon CloudWatch log settings for a playback configuration.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_name
- The identifier for the playback configuration.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_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.
PutPlaybackConfigurationResponse
, putPlaybackConfigurationResponse_playbackConfigurationArn
- The Amazon Resource Name (ARN) associated with the playback
configuration.
PutPlaybackConfigurationResponse
, putPlaybackConfigurationResponse_playbackEndpointPrefix
- The playback endpoint prefix associated with the playback configuration.
PutPlaybackConfigurationResponse
, putPlaybackConfigurationResponse_sessionInitializationEndpointPrefix
- The session initialization endpoint prefix associated with the playback
configuration.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_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 configurations. For VPAID, the slate is required because
MediaTailor provides it in the slots that are designated for dynamic ad
content. The slate must be a high-quality asset that contains both audio
and video.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_tags
- The tags to assign 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.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_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.
PutPlaybackConfiguration
, putPlaybackConfigurationResponse_videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
$sel:httpStatus:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_httpStatus
- The response's http status code.
Response Lenses
putPlaybackConfigurationResponse_adDecisionServerUrl :: Lens' PutPlaybackConfigurationResponse (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.
putPlaybackConfigurationResponse_availSuppression :: Lens' PutPlaybackConfigurationResponse (Maybe AvailSuppression) Source #
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
putPlaybackConfigurationResponse_bumper :: Lens' PutPlaybackConfigurationResponse (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.
putPlaybackConfigurationResponse_cdnConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe CdnConfiguration) Source #
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
putPlaybackConfigurationResponse_configurationAliases :: Lens' PutPlaybackConfigurationResponse (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.
putPlaybackConfigurationResponse_dashConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe DashConfiguration) Source #
The configuration for DASH content.
putPlaybackConfigurationResponse_hlsConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe HlsConfiguration) Source #
The configuration for HLS content.
putPlaybackConfigurationResponse_livePreRollConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe LivePreRollConfiguration) Source #
The configuration for pre-roll ad insertion.
putPlaybackConfigurationResponse_logConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe LogConfiguration) Source #
The Amazon CloudWatch log settings for a playback configuration.
putPlaybackConfigurationResponse_manifestProcessingRules :: Lens' PutPlaybackConfigurationResponse (Maybe ManifestProcessingRules) Source #
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
putPlaybackConfigurationResponse_name :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #
The identifier for the playback configuration.
putPlaybackConfigurationResponse_personalizationThresholdSeconds :: Lens' PutPlaybackConfigurationResponse (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.
putPlaybackConfigurationResponse_playbackConfigurationArn :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) associated with the playback configuration.
putPlaybackConfigurationResponse_playbackEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #
The playback endpoint prefix associated with the playback configuration.
putPlaybackConfigurationResponse_sessionInitializationEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #
The session initialization endpoint prefix associated with the playback configuration.
putPlaybackConfigurationResponse_slateAdUrl :: Lens' PutPlaybackConfigurationResponse (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 configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
putPlaybackConfigurationResponse_tags :: Lens' PutPlaybackConfigurationResponse (Maybe (HashMap Text Text)) Source #
The tags to assign 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.
putPlaybackConfigurationResponse_transcodeProfileName :: Lens' PutPlaybackConfigurationResponse (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.
putPlaybackConfigurationResponse_videoContentSourceUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
putPlaybackConfigurationResponse_httpStatus :: Lens' PutPlaybackConfigurationResponse Int Source #
The response's http status code.