| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MediaTailor.Types
Contents
- Service Configuration
- Errors
- AccessType
- ChannelState
- MessageType
- Mode
- Operator
- OriginManifestType
- PlaybackMode
- RelativePosition
- ScheduleEntryType
- Type
- AccessConfiguration
- AdBreak
- AdMarkerPassthrough
- Alert
- AvailMatchingCriteria
- AvailSuppression
- Bumper
- CdnConfiguration
- Channel
- DashConfiguration
- DashConfigurationForPut
- DashPlaylistSettings
- DefaultSegmentDeliveryConfiguration
- HlsConfiguration
- HlsPlaylistSettings
- HttpConfiguration
- HttpPackageConfiguration
- LivePreRollConfiguration
- LogConfiguration
- ManifestProcessingRules
- PlaybackConfiguration
- PrefetchConsumption
- PrefetchRetrieval
- PrefetchSchedule
- RequestOutputItem
- ResponseOutputItem
- ScheduleAdBreak
- ScheduleConfiguration
- ScheduleEntry
- SecretsManagerAccessTokenConfiguration
- SlateSource
- SourceLocation
- SpliceInsertMessage
- Transition
- VodSource
Description
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AccessType where
- AccessType' { }
- pattern AccessType_S3_SIGV4 :: AccessType
- pattern AccessType_SECRETS_MANAGER_ACCESS_TOKEN :: AccessType
- newtype ChannelState where
- ChannelState' { }
- pattern ChannelState_RUNNING :: ChannelState
- pattern ChannelState_STOPPED :: ChannelState
- newtype MessageType where
- MessageType' { }
- pattern MessageType_SPLICE_INSERT :: MessageType
- newtype Mode where
- newtype Operator where
- Operator' {
- fromOperator :: Text
- pattern Operator_EQUALS :: Operator
- Operator' {
- newtype OriginManifestType where
- newtype PlaybackMode where
- PlaybackMode' { }
- pattern PlaybackMode_LINEAR :: PlaybackMode
- pattern PlaybackMode_LOOP :: PlaybackMode
- newtype RelativePosition where
- newtype ScheduleEntryType where
- ScheduleEntryType' { }
- pattern ScheduleEntryType_FILLER_SLATE :: ScheduleEntryType
- pattern ScheduleEntryType_PROGRAM :: ScheduleEntryType
- newtype Type where
- data AccessConfiguration = AccessConfiguration' {}
- newAccessConfiguration :: AccessConfiguration
- accessConfiguration_accessType :: Lens' AccessConfiguration (Maybe AccessType)
- accessConfiguration_secretsManagerAccessTokenConfiguration :: Lens' AccessConfiguration (Maybe SecretsManagerAccessTokenConfiguration)
- data AdBreak = AdBreak' {}
- newAdBreak :: AdBreak
- adBreak_spliceInsertMessage :: Lens' AdBreak (Maybe SpliceInsertMessage)
- adBreak_messageType :: Lens' AdBreak (Maybe MessageType)
- adBreak_slate :: Lens' AdBreak (Maybe SlateSource)
- adBreak_offsetMillis :: Lens' AdBreak (Maybe Integer)
- data AdMarkerPassthrough = AdMarkerPassthrough' {}
- newAdMarkerPassthrough :: AdMarkerPassthrough
- adMarkerPassthrough_enabled :: Lens' AdMarkerPassthrough (Maybe Bool)
- data Alert = Alert' {
- resourceArn :: Text
- alertCode :: Text
- lastModifiedTime :: POSIX
- relatedResourceArns :: [Text]
- alertMessage :: Text
- newAlert :: Text -> Text -> UTCTime -> Text -> Alert
- alert_resourceArn :: Lens' Alert Text
- alert_alertCode :: Lens' Alert Text
- alert_lastModifiedTime :: Lens' Alert UTCTime
- alert_relatedResourceArns :: Lens' Alert [Text]
- alert_alertMessage :: Lens' Alert Text
- data AvailMatchingCriteria = AvailMatchingCriteria' {}
- newAvailMatchingCriteria :: Operator -> Text -> AvailMatchingCriteria
- availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator
- availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text
- data AvailSuppression = AvailSuppression' {}
- newAvailSuppression :: AvailSuppression
- availSuppression_value :: Lens' AvailSuppression (Maybe Text)
- availSuppression_mode :: Lens' AvailSuppression (Maybe Mode)
- data Bumper = Bumper' {}
- newBumper :: Bumper
- bumper_endUrl :: Lens' Bumper (Maybe Text)
- bumper_startUrl :: Lens' Bumper (Maybe Text)
- data CdnConfiguration = CdnConfiguration' {}
- newCdnConfiguration :: CdnConfiguration
- cdnConfiguration_adSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text)
- cdnConfiguration_contentSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text)
- data Channel = Channel' {
- creationTime :: Maybe POSIX
- lastModifiedTime :: Maybe POSIX
- fillerSlate :: Maybe SlateSource
- tags :: Maybe (HashMap Text Text)
- channelState :: Text
- channelName :: Text
- outputs :: [ResponseOutputItem]
- arn :: Text
- playbackMode :: Text
- newChannel :: Text -> Text -> Text -> Text -> Channel
- channel_creationTime :: Lens' Channel (Maybe UTCTime)
- channel_lastModifiedTime :: Lens' Channel (Maybe UTCTime)
- channel_fillerSlate :: Lens' Channel (Maybe SlateSource)
- channel_tags :: Lens' Channel (Maybe (HashMap Text Text))
- channel_channelState :: Lens' Channel Text
- channel_channelName :: Lens' Channel Text
- channel_outputs :: Lens' Channel [ResponseOutputItem]
- channel_arn :: Lens' Channel Text
- channel_playbackMode :: Lens' Channel Text
- data DashConfiguration = DashConfiguration' {}
- newDashConfiguration :: DashConfiguration
- dashConfiguration_manifestEndpointPrefix :: Lens' DashConfiguration (Maybe Text)
- dashConfiguration_originManifestType :: Lens' DashConfiguration (Maybe OriginManifestType)
- dashConfiguration_mpdLocation :: Lens' DashConfiguration (Maybe Text)
- data DashConfigurationForPut = DashConfigurationForPut' {}
- newDashConfigurationForPut :: DashConfigurationForPut
- dashConfigurationForPut_originManifestType :: Lens' DashConfigurationForPut (Maybe OriginManifestType)
- dashConfigurationForPut_mpdLocation :: Lens' DashConfigurationForPut (Maybe Text)
- data DashPlaylistSettings = DashPlaylistSettings' {}
- newDashPlaylistSettings :: DashPlaylistSettings
- dashPlaylistSettings_minBufferTimeSeconds :: Lens' DashPlaylistSettings (Maybe Int)
- dashPlaylistSettings_minUpdatePeriodSeconds :: Lens' DashPlaylistSettings (Maybe Int)
- dashPlaylistSettings_suggestedPresentationDelaySeconds :: Lens' DashPlaylistSettings (Maybe Int)
- dashPlaylistSettings_manifestWindowSeconds :: Lens' DashPlaylistSettings (Maybe Int)
- data DefaultSegmentDeliveryConfiguration = DefaultSegmentDeliveryConfiguration' {}
- newDefaultSegmentDeliveryConfiguration :: DefaultSegmentDeliveryConfiguration
- defaultSegmentDeliveryConfiguration_baseUrl :: Lens' DefaultSegmentDeliveryConfiguration (Maybe Text)
- data HlsConfiguration = HlsConfiguration' {}
- newHlsConfiguration :: HlsConfiguration
- hlsConfiguration_manifestEndpointPrefix :: Lens' HlsConfiguration (Maybe Text)
- data HlsPlaylistSettings = HlsPlaylistSettings' {}
- newHlsPlaylistSettings :: HlsPlaylistSettings
- hlsPlaylistSettings_manifestWindowSeconds :: Lens' HlsPlaylistSettings (Maybe Int)
- data HttpConfiguration = HttpConfiguration' {}
- newHttpConfiguration :: Text -> HttpConfiguration
- httpConfiguration_baseUrl :: Lens' HttpConfiguration Text
- data HttpPackageConfiguration = HttpPackageConfiguration' {}
- newHttpPackageConfiguration :: Text -> Type -> Text -> HttpPackageConfiguration
- httpPackageConfiguration_path :: Lens' HttpPackageConfiguration Text
- httpPackageConfiguration_type :: Lens' HttpPackageConfiguration Type
- httpPackageConfiguration_sourceGroup :: Lens' HttpPackageConfiguration Text
- data LivePreRollConfiguration = LivePreRollConfiguration' {}
- newLivePreRollConfiguration :: LivePreRollConfiguration
- livePreRollConfiguration_adDecisionServerUrl :: Lens' LivePreRollConfiguration (Maybe Text)
- livePreRollConfiguration_maxDurationSeconds :: Lens' LivePreRollConfiguration (Maybe Int)
- data LogConfiguration = LogConfiguration' {}
- newLogConfiguration :: Int -> LogConfiguration
- logConfiguration_percentEnabled :: Lens' LogConfiguration Int
- data ManifestProcessingRules = ManifestProcessingRules' {}
- newManifestProcessingRules :: ManifestProcessingRules
- manifestProcessingRules_adMarkerPassthrough :: Lens' ManifestProcessingRules (Maybe AdMarkerPassthrough)
- data PlaybackConfiguration = PlaybackConfiguration' {
- playbackEndpointPrefix :: Maybe Text
- hlsConfiguration :: Maybe HlsConfiguration
- personalizationThresholdSeconds :: Maybe Natural
- playbackConfigurationArn :: Maybe Text
- availSuppression :: Maybe AvailSuppression
- bumper :: Maybe Bumper
- adDecisionServerUrl :: Maybe Text
- videoContentSourceUrl :: Maybe Text
- dashConfiguration :: Maybe DashConfiguration
- manifestProcessingRules :: Maybe ManifestProcessingRules
- logConfiguration :: Maybe LogConfiguration
- livePreRollConfiguration :: Maybe LivePreRollConfiguration
- name :: Maybe Text
- sessionInitializationEndpointPrefix :: Maybe Text
- configurationAliases :: Maybe (HashMap Text (HashMap Text Text))
- transcodeProfileName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- slateAdUrl :: Maybe Text
- cdnConfiguration :: Maybe CdnConfiguration
- newPlaybackConfiguration :: PlaybackConfiguration
- playbackConfiguration_playbackEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_hlsConfiguration :: Lens' PlaybackConfiguration (Maybe HlsConfiguration)
- playbackConfiguration_personalizationThresholdSeconds :: Lens' PlaybackConfiguration (Maybe Natural)
- playbackConfiguration_playbackConfigurationArn :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_availSuppression :: Lens' PlaybackConfiguration (Maybe AvailSuppression)
- playbackConfiguration_bumper :: Lens' PlaybackConfiguration (Maybe Bumper)
- playbackConfiguration_adDecisionServerUrl :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_videoContentSourceUrl :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_dashConfiguration :: Lens' PlaybackConfiguration (Maybe DashConfiguration)
- playbackConfiguration_manifestProcessingRules :: Lens' PlaybackConfiguration (Maybe ManifestProcessingRules)
- playbackConfiguration_logConfiguration :: Lens' PlaybackConfiguration (Maybe LogConfiguration)
- playbackConfiguration_livePreRollConfiguration :: Lens' PlaybackConfiguration (Maybe LivePreRollConfiguration)
- playbackConfiguration_name :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_sessionInitializationEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_configurationAliases :: Lens' PlaybackConfiguration (Maybe (HashMap Text (HashMap Text Text)))
- playbackConfiguration_transcodeProfileName :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_tags :: Lens' PlaybackConfiguration (Maybe (HashMap Text Text))
- playbackConfiguration_slateAdUrl :: Lens' PlaybackConfiguration (Maybe Text)
- playbackConfiguration_cdnConfiguration :: Lens' PlaybackConfiguration (Maybe CdnConfiguration)
- data PrefetchConsumption = PrefetchConsumption' {}
- newPrefetchConsumption :: UTCTime -> PrefetchConsumption
- prefetchConsumption_startTime :: Lens' PrefetchConsumption (Maybe UTCTime)
- prefetchConsumption_availMatchingCriteria :: Lens' PrefetchConsumption (Maybe [AvailMatchingCriteria])
- prefetchConsumption_endTime :: Lens' PrefetchConsumption UTCTime
- data PrefetchRetrieval = PrefetchRetrieval' {}
- newPrefetchRetrieval :: UTCTime -> PrefetchRetrieval
- prefetchRetrieval_startTime :: Lens' PrefetchRetrieval (Maybe UTCTime)
- prefetchRetrieval_dynamicVariables :: Lens' PrefetchRetrieval (Maybe (HashMap Text Text))
- prefetchRetrieval_endTime :: Lens' PrefetchRetrieval UTCTime
- data PrefetchSchedule = PrefetchSchedule' {}
- newPrefetchSchedule :: PrefetchRetrieval -> PrefetchConsumption -> Text -> Text -> Text -> PrefetchSchedule
- prefetchSchedule_streamId :: Lens' PrefetchSchedule (Maybe Text)
- prefetchSchedule_retrieval :: Lens' PrefetchSchedule PrefetchRetrieval
- prefetchSchedule_consumption :: Lens' PrefetchSchedule PrefetchConsumption
- prefetchSchedule_arn :: Lens' PrefetchSchedule Text
- prefetchSchedule_playbackConfigurationName :: Lens' PrefetchSchedule Text
- prefetchSchedule_name :: Lens' PrefetchSchedule Text
- data RequestOutputItem = RequestOutputItem' {}
- newRequestOutputItem :: Text -> Text -> RequestOutputItem
- requestOutputItem_hlsPlaylistSettings :: Lens' RequestOutputItem (Maybe HlsPlaylistSettings)
- requestOutputItem_dashPlaylistSettings :: Lens' RequestOutputItem (Maybe DashPlaylistSettings)
- requestOutputItem_manifestName :: Lens' RequestOutputItem Text
- requestOutputItem_sourceGroup :: Lens' RequestOutputItem Text
- data ResponseOutputItem = ResponseOutputItem' {}
- newResponseOutputItem :: Text -> Text -> Text -> ResponseOutputItem
- responseOutputItem_hlsPlaylistSettings :: Lens' ResponseOutputItem (Maybe HlsPlaylistSettings)
- responseOutputItem_dashPlaylistSettings :: Lens' ResponseOutputItem (Maybe DashPlaylistSettings)
- responseOutputItem_manifestName :: Lens' ResponseOutputItem Text
- responseOutputItem_playbackUrl :: Lens' ResponseOutputItem Text
- responseOutputItem_sourceGroup :: Lens' ResponseOutputItem Text
- data ScheduleAdBreak = ScheduleAdBreak' {}
- newScheduleAdBreak :: ScheduleAdBreak
- scheduleAdBreak_sourceLocationName :: Lens' ScheduleAdBreak (Maybe Text)
- scheduleAdBreak_approximateDurationSeconds :: Lens' ScheduleAdBreak (Maybe Integer)
- scheduleAdBreak_vodSourceName :: Lens' ScheduleAdBreak (Maybe Text)
- scheduleAdBreak_approximateStartTime :: Lens' ScheduleAdBreak (Maybe UTCTime)
- data ScheduleConfiguration = ScheduleConfiguration' {}
- newScheduleConfiguration :: Transition -> ScheduleConfiguration
- scheduleConfiguration_transition :: Lens' ScheduleConfiguration Transition
- data ScheduleEntry = ScheduleEntry' {}
- newScheduleEntry :: Text -> Text -> Text -> Text -> Text -> ScheduleEntry
- scheduleEntry_scheduleAdBreaks :: Lens' ScheduleEntry (Maybe [ScheduleAdBreak])
- scheduleEntry_approximateDurationSeconds :: Lens' ScheduleEntry (Maybe Integer)
- scheduleEntry_approximateStartTime :: Lens' ScheduleEntry (Maybe UTCTime)
- scheduleEntry_scheduleEntryType :: Lens' ScheduleEntry (Maybe ScheduleEntryType)
- scheduleEntry_vodSourceName :: Lens' ScheduleEntry Text
- scheduleEntry_channelName :: Lens' ScheduleEntry Text
- scheduleEntry_sourceLocationName :: Lens' ScheduleEntry Text
- scheduleEntry_arn :: Lens' ScheduleEntry Text
- scheduleEntry_programName :: Lens' ScheduleEntry Text
- data SecretsManagerAccessTokenConfiguration = SecretsManagerAccessTokenConfiguration' {}
- newSecretsManagerAccessTokenConfiguration :: SecretsManagerAccessTokenConfiguration
- secretsManagerAccessTokenConfiguration_headerName :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text)
- secretsManagerAccessTokenConfiguration_secretStringKey :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text)
- secretsManagerAccessTokenConfiguration_secretArn :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text)
- data SlateSource = SlateSource' {}
- newSlateSource :: SlateSource
- slateSource_sourceLocationName :: Lens' SlateSource (Maybe Text)
- slateSource_vodSourceName :: Lens' SlateSource (Maybe Text)
- data SourceLocation = SourceLocation' {}
- newSourceLocation :: Text -> HttpConfiguration -> Text -> SourceLocation
- sourceLocation_creationTime :: Lens' SourceLocation (Maybe UTCTime)
- sourceLocation_lastModifiedTime :: Lens' SourceLocation (Maybe UTCTime)
- sourceLocation_accessConfiguration :: Lens' SourceLocation (Maybe AccessConfiguration)
- sourceLocation_defaultSegmentDeliveryConfiguration :: Lens' SourceLocation (Maybe DefaultSegmentDeliveryConfiguration)
- sourceLocation_tags :: Lens' SourceLocation (Maybe (HashMap Text Text))
- sourceLocation_sourceLocationName :: Lens' SourceLocation Text
- sourceLocation_httpConfiguration :: Lens' SourceLocation HttpConfiguration
- sourceLocation_arn :: Lens' SourceLocation Text
- data SpliceInsertMessage = SpliceInsertMessage' {}
- newSpliceInsertMessage :: SpliceInsertMessage
- spliceInsertMessage_availNum :: Lens' SpliceInsertMessage (Maybe Int)
- spliceInsertMessage_uniqueProgramId :: Lens' SpliceInsertMessage (Maybe Int)
- spliceInsertMessage_availsExpected :: Lens' SpliceInsertMessage (Maybe Int)
- spliceInsertMessage_spliceEventId :: Lens' SpliceInsertMessage (Maybe Int)
- data Transition = Transition' {}
- newTransition :: Text -> RelativePosition -> Transition
- transition_scheduledStartTimeMillis :: Lens' Transition (Maybe Integer)
- transition_relativeProgram :: Lens' Transition (Maybe Text)
- transition_type :: Lens' Transition Text
- transition_relativePosition :: Lens' Transition RelativePosition
- data VodSource = VodSource' {}
- newVodSource :: Text -> Text -> Text -> VodSource
- vodSource_creationTime :: Lens' VodSource (Maybe UTCTime)
- vodSource_lastModifiedTime :: Lens' VodSource (Maybe UTCTime)
- vodSource_tags :: Lens' VodSource (Maybe (HashMap Text Text))
- vodSource_vodSourceName :: Lens' VodSource Text
- vodSource_sourceLocationName :: Lens' VodSource Text
- vodSource_httpPackageConfigurations :: Lens' VodSource [HttpPackageConfiguration]
- vodSource_arn :: Lens' VodSource Text
Service Configuration
defaultService :: Service Source #
API version 2018-04-23 of the Amazon MediaTailor SDK configuration.
Errors
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Invalid request parameters.
AccessType
newtype AccessType Source #
Constructors
| AccessType' | |
Fields | |
Bundled Patterns
| pattern AccessType_S3_SIGV4 :: AccessType | |
| pattern AccessType_SECRETS_MANAGER_ACCESS_TOKEN :: AccessType |
Instances
ChannelState
newtype ChannelState Source #
Constructors
| ChannelState' | |
Fields | |
Bundled Patterns
| pattern ChannelState_RUNNING :: ChannelState | |
| pattern ChannelState_STOPPED :: ChannelState |
Instances
MessageType
newtype MessageType Source #
Constructors
| MessageType' | |
Fields | |
Bundled Patterns
| pattern MessageType_SPLICE_INSERT :: MessageType |
Instances
Mode
Bundled Patterns
| pattern Mode_BEHIND_LIVE_EDGE :: Mode | |
| pattern Mode_OFF :: Mode |
Instances
Operator
Constructors
| Operator' | |
Fields
| |
Bundled Patterns
| pattern Operator_EQUALS :: Operator |
Instances
OriginManifestType
newtype OriginManifestType Source #
Constructors
| OriginManifestType' | |
Fields | |
Bundled Patterns
| pattern OriginManifestType_MULTI_PERIOD :: OriginManifestType | |
| pattern OriginManifestType_SINGLE_PERIOD :: OriginManifestType |
Instances
PlaybackMode
newtype PlaybackMode Source #
Constructors
| PlaybackMode' | |
Fields | |
Bundled Patterns
| pattern PlaybackMode_LINEAR :: PlaybackMode | |
| pattern PlaybackMode_LOOP :: PlaybackMode |
Instances
RelativePosition
newtype RelativePosition Source #
Constructors
| RelativePosition' | |
Fields | |
Bundled Patterns
| pattern RelativePosition_AFTER_PROGRAM :: RelativePosition | |
| pattern RelativePosition_BEFORE_PROGRAM :: RelativePosition |
Instances
ScheduleEntryType
newtype ScheduleEntryType Source #
Constructors
| ScheduleEntryType' | |
Fields | |
Bundled Patterns
| pattern ScheduleEntryType_FILLER_SLATE :: ScheduleEntryType | |
| pattern ScheduleEntryType_PROGRAM :: ScheduleEntryType |
Instances
Type
Instances
AccessConfiguration
data AccessConfiguration Source #
Access configuration parameters.
See: newAccessConfiguration smart constructor.
Constructors
| AccessConfiguration' | |
Fields
| |
Instances
newAccessConfiguration :: AccessConfiguration Source #
Create a value of AccessConfiguration 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:
$sel:accessType:AccessConfiguration', accessConfiguration_accessType - The type of authentication used to access content from
HttpConfiguration::BaseUrl on your source location. Accepted value:
S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
$sel:secretsManagerAccessTokenConfiguration:AccessConfiguration', accessConfiguration_secretsManagerAccessTokenConfiguration - AWS Secrets Manager access token configuration parameters.
accessConfiguration_accessType :: Lens' AccessConfiguration (Maybe AccessType) Source #
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
accessConfiguration_secretsManagerAccessTokenConfiguration :: Lens' AccessConfiguration (Maybe SecretsManagerAccessTokenConfiguration) Source #
AWS Secrets Manager access token configuration parameters.
AdBreak
Ad break configuration parameters.
See: newAdBreak smart constructor.
Constructors
| AdBreak' | |
Fields
| |
Instances
newAdBreak :: AdBreak Source #
Create a value of AdBreak 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:
$sel:spliceInsertMessage:AdBreak', adBreak_spliceInsertMessage - This defines the SCTE-35 splice_insert() message inserted around the ad.
For information about using splice_insert(), see the SCTE-35
specficiaiton, section 9.7.3.1.
$sel:messageType:AdBreak', adBreak_messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
$sel:slate:AdBreak', adBreak_slate - Ad break slate configuration.
$sel:offsetMillis:AdBreak', adBreak_offsetMillis - How long (in milliseconds) after the beginning of the program that an ad
starts. This value must fall within 100ms of a segment boundary,
otherwise the ad break will be skipped.
adBreak_spliceInsertMessage :: Lens' AdBreak (Maybe SpliceInsertMessage) Source #
This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
adBreak_messageType :: Lens' AdBreak (Maybe MessageType) Source #
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
adBreak_slate :: Lens' AdBreak (Maybe SlateSource) Source #
Ad break slate configuration.
adBreak_offsetMillis :: Lens' AdBreak (Maybe Integer) Source #
How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.
AdMarkerPassthrough
data AdMarkerPassthrough Source #
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
See: newAdMarkerPassthrough smart constructor.
Constructors
| AdMarkerPassthrough' | |
Instances
newAdMarkerPassthrough :: AdMarkerPassthrough Source #
Create a value of AdMarkerPassthrough 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:
$sel:enabled:AdMarkerPassthrough', adMarkerPassthrough_enabled - Enables ad marker passthrough for your configuration.
adMarkerPassthrough_enabled :: Lens' AdMarkerPassthrough (Maybe Bool) Source #
Enables ad marker passthrough for your configuration.
Alert
Alert configuration parameters.
See: newAlert smart constructor.
Constructors
| Alert' | |
Fields
| |
Instances
Create a value of Alert 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:
$sel:resourceArn:Alert', alert_resourceArn - The Amazon Resource Name (ARN) of the resource.
$sel:alertCode:Alert', alert_alertCode - The code for the alert. For example, NOT_PROCESSED.
$sel:lastModifiedTime:Alert', alert_lastModifiedTime - The timestamp when the alert was last modified.
$sel:relatedResourceArns:Alert', alert_relatedResourceArns - The Amazon Resource Names (ARNs) related to this alert.
$sel:alertMessage:Alert', alert_alertMessage - If an alert is generated for a resource, an explanation of the reason
for the alert.
alert_lastModifiedTime :: Lens' Alert UTCTime Source #
The timestamp when the alert was last modified.
alert_relatedResourceArns :: Lens' Alert [Text] Source #
The Amazon Resource Names (ARNs) related to this alert.
alert_alertMessage :: Lens' Alert Text Source #
If an alert is generated for a resource, an explanation of the reason for the alert.
AvailMatchingCriteria
data AvailMatchingCriteria Source #
MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
See: newAvailMatchingCriteria smart constructor.
Constructors
| AvailMatchingCriteria' | |
Fields
| |
Instances
newAvailMatchingCriteria Source #
Arguments
| :: Operator | |
| -> Text | |
| -> AvailMatchingCriteria |
Create a value of AvailMatchingCriteria 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:
$sel:operator:AvailMatchingCriteria', availMatchingCriteria_operator - For the DynamicVariable specified in AvailMatchingCriteria, the Operator
that is used for the comparison.
$sel:dynamicVariable:AvailMatchingCriteria', availMatchingCriteria_dynamicVariable - The dynamic variable(s) that MediaTailor should use as avail matching
criteria. MediaTailor only places the prefetched ads into the avail if
the avail matches the criteria defined by the dynamic variable. For
information about dynamic variables, see
Using dynamic ad variables
in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator Source #
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text Source #
The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
AvailSuppression
data AvailSuppression Source #
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
See: newAvailSuppression smart constructor.
Constructors
| AvailSuppression' | |
Fields
| |
Instances
newAvailSuppression :: AvailSuppression Source #
Create a value of AvailSuppression 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:
$sel:value:AvailSuppression', availSuppression_value - A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks
on or behind this time in the manifest lookback window. If Value is set
to 00:00:00, it is in sync with the live edge, and MediaTailor won't
fill any ad breaks on or behind the live edge. If you set a Value time,
MediaTailor won't fill any ad breaks on or behind this time in the
manifest lookback window. For example, if you set 00:45:00, then
MediaTailor will fill ad breaks that occur within 45 minutes behind the
live edge, but won't fill ad breaks on or behind 45 minutes behind the
live edge.
$sel:mode:AvailSuppression', availSuppression_mode - Sets the ad suppression mode. By default, ad suppression is off and all
ad breaks are filled with ads or slate. When Mode is set to
BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill
ad breaks on or behind the ad suppression Value time in the manifest
lookback window.
availSuppression_value :: Lens' AvailSuppression (Maybe Text) Source #
A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.
availSuppression_mode :: Lens' AvailSuppression (Maybe Mode) Source #
Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
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.
See: newBumper smart constructor.
Constructors
| Bumper' | |
Instances
| Eq Bumper Source # | |
| Read Bumper Source # | |
| Show Bumper Source # | |
| Generic Bumper Source # | |
| NFData Bumper Source # | |
Defined in Amazonka.MediaTailor.Types.Bumper | |
| Hashable Bumper Source # | |
Defined in Amazonka.MediaTailor.Types.Bumper | |
| ToJSON Bumper Source # | |
Defined in Amazonka.MediaTailor.Types.Bumper | |
| FromJSON Bumper Source # | |
| type Rep Bumper Source # | |
Defined in Amazonka.MediaTailor.Types.Bumper type Rep Bumper = D1 ('MetaData "Bumper" "Amazonka.MediaTailor.Types.Bumper" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "Bumper'" 'PrefixI 'True) (S1 ('MetaSel ('Just "endUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Bumper 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:
$sel:endUrl:Bumper', bumper_endUrl - The URL for the end bumper asset.
$sel:startUrl:Bumper', bumper_startUrl - The URL for the start bumper asset.
CdnConfiguration
data CdnConfiguration Source #
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
See: newCdnConfiguration smart constructor.
Constructors
| CdnConfiguration' | |
Fields
| |
Instances
newCdnConfiguration :: CdnConfiguration Source #
Create a value of CdnConfiguration 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:
$sel:adSegmentUrlPrefix:CdnConfiguration', cdnConfiguration_adSegmentUrlPrefix - A non-default content delivery network (CDN) to serve ad segments. By
default, AWS Elemental MediaTailor uses Amazon CloudFront with default
cache settings as its CDN for ad segments. To set up an alternate CDN,
create a rule in your CDN for the origin
ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name
in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a
manifest, it reports your CDN as the source for ad segments.
$sel:contentSegmentUrlPrefix:CdnConfiguration', cdnConfiguration_contentSegmentUrlPrefix - A content delivery network (CDN) to cache content segments, so that
content requests don’t always have to go to the origin server. First,
create a rule in your CDN for the content segment origin server. Then
specify the rule's name in this ContentSegmentUrlPrefix. When AWS
Elemental MediaTailor serves a manifest, it reports your CDN as the
source for content segments.
cdnConfiguration_adSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text) Source #
A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
cdnConfiguration_contentSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text) Source #
A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.
Channel
The configuration parameters for a channel.
See: newChannel smart constructor.
Constructors
| Channel' | |
Fields
| |
Instances
Create a value of Channel 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:
$sel:creationTime:Channel', channel_creationTime - The timestamp of when the channel was created.
$sel:lastModifiedTime:Channel', channel_lastModifiedTime - The timestamp of when the channel was last modified.
$sel:fillerSlate:Channel', channel_fillerSlate - Contains information about the slate used to fill gaps between programs
in the schedule. You must configure FillerSlate if your channel uses an
LINEAR PlaybackMode.
$sel:tags:Channel', channel_tags - The tags to assign to the channel.
$sel:channelState:Channel', channel_channelState - Returns the state whether the channel is running or not.
$sel:channelName:Channel', channel_channelName - The name of the channel.
$sel:outputs:Channel', channel_outputs - The channel's output properties.
$sel:arn:Channel', channel_arn - The ARN of the channel.
$sel:playbackMode:Channel', channel_playbackMode - The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
channel_creationTime :: Lens' Channel (Maybe UTCTime) Source #
The timestamp of when the channel was created.
channel_lastModifiedTime :: Lens' Channel (Maybe UTCTime) Source #
The timestamp of when the channel was last modified.
channel_fillerSlate :: Lens' Channel (Maybe SlateSource) Source #
Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.
channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #
The tags to assign to the channel.
channel_channelState :: Lens' Channel Text Source #
Returns the state whether the channel is running or not.
channel_outputs :: Lens' Channel [ResponseOutputItem] Source #
The channel's output properties.
channel_playbackMode :: Lens' Channel Text Source #
The type of playback mode for this channel.
LINEAR - Programs play back-to-back only once.
LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.
DashConfiguration
data DashConfiguration Source #
The configuration for DASH content.
See: newDashConfiguration smart constructor.
Constructors
| DashConfiguration' | |
Fields
| |
Instances
newDashConfiguration :: DashConfiguration Source #
Create a value of DashConfiguration 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:
$sel:manifestEndpointPrefix:DashConfiguration', dashConfiguration_manifestEndpointPrefix - The URL generated by MediaTailor to initiate a playback session. The
session uses server-side reporting. This setting is ignored in PUT
operations.
$sel:originManifestType:DashConfiguration', dashConfiguration_originManifestType - The setting that controls whether MediaTailor handles manifests from the
origin server as multi-period manifests or single-period manifests. If
your origin server produces single-period manifests, set this to
SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period
manifests, omit this setting or set it to MULTI_PERIOD.
$sel:mpdLocation:DashConfiguration', dashConfiguration_mpdLocation - The setting that controls whether MediaTailor includes the Location tag
in DASH manifests. MediaTailor populates the Location tag with the URL
for manifest update requests, to be used by players that don't support
sticky redirects. Disable this if you have CDN routing rules set up for
accessing MediaTailor manifests, and you are either using client-side
reporting or your players support sticky HTTP redirects. Valid values
are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the
inclusion of the tag and is the default value.
dashConfiguration_manifestEndpointPrefix :: Lens' DashConfiguration (Maybe Text) Source #
The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
dashConfiguration_originManifestType :: Lens' DashConfiguration (Maybe OriginManifestType) Source #
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
dashConfiguration_mpdLocation :: Lens' DashConfiguration (Maybe Text) Source #
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
DashConfigurationForPut
data DashConfigurationForPut Source #
The configuration for DASH PUT operations.
See: newDashConfigurationForPut smart constructor.
Constructors
| DashConfigurationForPut' | |
Fields
| |
Instances
newDashConfigurationForPut :: DashConfigurationForPut Source #
Create a value of DashConfigurationForPut 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:
$sel:originManifestType:DashConfigurationForPut', dashConfigurationForPut_originManifestType - The setting that controls whether MediaTailor handles manifests from the
origin server as multi-period manifests or single-period manifests. If
your origin server produces single-period manifests, set this to
SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period
manifests, omit this setting or set it to MULTI_PERIOD.
$sel:mpdLocation:DashConfigurationForPut', dashConfigurationForPut_mpdLocation - The setting that controls whether MediaTailor includes the Location tag
in DASH manifests. MediaTailor populates the Location tag with the URL
for manifest update requests, to be used by players that don't support
sticky redirects. Disable this if you have CDN routing rules set up for
accessing MediaTailor manifests, and you are either using client-side
reporting or your players support sticky HTTP redirects. Valid values
are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the
inclusion of the tag and is the default value.
dashConfigurationForPut_originManifestType :: Lens' DashConfigurationForPut (Maybe OriginManifestType) Source #
The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
dashConfigurationForPut_mpdLocation :: Lens' DashConfigurationForPut (Maybe Text) Source #
The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
DashPlaylistSettings
data DashPlaylistSettings Source #
Dash manifest configuration parameters.
See: newDashPlaylistSettings smart constructor.
Constructors
| DashPlaylistSettings' | |
Fields
| |
Instances
newDashPlaylistSettings :: DashPlaylistSettings Source #
Create a value of DashPlaylistSettings 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:
$sel:minBufferTimeSeconds:DashPlaylistSettings', dashPlaylistSettings_minBufferTimeSeconds - Minimum amount of content (measured in seconds) that a player must keep
available in the buffer. Minimum value: 2 seconds. Maximum value: 60
seconds.
$sel:minUpdatePeriodSeconds:DashPlaylistSettings', dashPlaylistSettings_minUpdatePeriodSeconds - Minimum amount of time (in seconds) that the player should wait before
requesting updates to the manifest. Minimum value: 2 seconds. Maximum
value: 60 seconds.
$sel:suggestedPresentationDelaySeconds:DashPlaylistSettings', dashPlaylistSettings_suggestedPresentationDelaySeconds - Amount of time (in seconds) that the player should be from the live
point at the end of the manifest. Minimum value: 2 seconds. Maximum
value: 60 seconds.
$sel:manifestWindowSeconds:DashPlaylistSettings', dashPlaylistSettings_manifestWindowSeconds - The total duration (in seconds) of each manifest. Minimum value: 30
seconds. Maximum value: 3600 seconds.
dashPlaylistSettings_minBufferTimeSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #
Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.
dashPlaylistSettings_minUpdatePeriodSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #
Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
dashPlaylistSettings_suggestedPresentationDelaySeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #
Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.
dashPlaylistSettings_manifestWindowSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
DefaultSegmentDeliveryConfiguration
data DefaultSegmentDeliveryConfiguration Source #
The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
See: newDefaultSegmentDeliveryConfiguration smart constructor.
Constructors
| DefaultSegmentDeliveryConfiguration' | |
Instances
newDefaultSegmentDeliveryConfiguration :: DefaultSegmentDeliveryConfiguration Source #
Create a value of DefaultSegmentDeliveryConfiguration 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:
$sel:baseUrl:DefaultSegmentDeliveryConfiguration', defaultSegmentDeliveryConfiguration_baseUrl - The hostname of the server that will be used to serve segments. This
string must include the protocol, such as https://.
defaultSegmentDeliveryConfiguration_baseUrl :: Lens' DefaultSegmentDeliveryConfiguration (Maybe Text) Source #
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
HlsConfiguration
data HlsConfiguration Source #
The configuration for HLS content.
See: newHlsConfiguration smart constructor.
Constructors
| HlsConfiguration' | |
Fields
| |
Instances
newHlsConfiguration :: HlsConfiguration Source #
Create a value of HlsConfiguration 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:
$sel:manifestEndpointPrefix:HlsConfiguration', hlsConfiguration_manifestEndpointPrefix - The URL that is used to initiate a playback session for devices that
support Apple HLS. The session uses server-side reporting.
hlsConfiguration_manifestEndpointPrefix :: Lens' HlsConfiguration (Maybe Text) Source #
The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
HlsPlaylistSettings
data HlsPlaylistSettings Source #
HLS playlist configuration parameters.
See: newHlsPlaylistSettings smart constructor.
Constructors
| HlsPlaylistSettings' | |
Fields
| |
Instances
newHlsPlaylistSettings :: HlsPlaylistSettings Source #
Create a value of HlsPlaylistSettings 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:
$sel:manifestWindowSeconds:HlsPlaylistSettings', hlsPlaylistSettings_manifestWindowSeconds - The total duration (in seconds) of each manifest. Minimum value: 30
seconds. Maximum value: 3600 seconds.
hlsPlaylistSettings_manifestWindowSeconds :: Lens' HlsPlaylistSettings (Maybe Int) Source #
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
HttpConfiguration
data HttpConfiguration Source #
The HTTP configuration for the source location.
See: newHttpConfiguration smart constructor.
Constructors
| HttpConfiguration' | |
Instances
Arguments
| :: Text | |
| -> HttpConfiguration |
Create a value of HttpConfiguration 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:
$sel:baseUrl:HttpConfiguration', httpConfiguration_baseUrl - The base URL for the source location host server. This string must
include the protocol, such as https://.
httpConfiguration_baseUrl :: Lens' HttpConfiguration Text Source #
The base URL for the source location host server. This string must include the protocol, such as https://.
HttpPackageConfiguration
data HttpPackageConfiguration Source #
The HTTP package configuration properties for the requested VOD source.
See: newHttpPackageConfiguration smart constructor.
Constructors
| HttpPackageConfiguration' | |
Fields
| |
Instances
newHttpPackageConfiguration Source #
Arguments
| :: Text | |
| -> Type | |
| -> Text | |
| -> HttpPackageConfiguration |
Create a value of HttpPackageConfiguration 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:
$sel:path:HttpPackageConfiguration', httpPackageConfiguration_path - The relative path to the URL for this VOD source. This is combined with
SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
$sel:type':HttpPackageConfiguration', httpPackageConfiguration_type - The streaming protocol for this package configuration. Supported values
are HLS and DASH.
$sel:sourceGroup:HttpPackageConfiguration', httpPackageConfiguration_sourceGroup - The name of the source group. This has to match one of the
Channel::Outputs::SourceGroup.
httpPackageConfiguration_path :: Lens' HttpPackageConfiguration Text Source #
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
httpPackageConfiguration_type :: Lens' HttpPackageConfiguration Type Source #
The streaming protocol for this package configuration. Supported values are HLS and DASH.
httpPackageConfiguration_sourceGroup :: Lens' HttpPackageConfiguration Text Source #
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
LivePreRollConfiguration
data LivePreRollConfiguration Source #
The configuration for pre-roll ad insertion.
See: newLivePreRollConfiguration smart constructor.
Constructors
| LivePreRollConfiguration' | |
Fields
| |
Instances
newLivePreRollConfiguration :: LivePreRollConfiguration Source #
Create a value of LivePreRollConfiguration 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:
$sel:adDecisionServerUrl:LivePreRollConfiguration', livePreRollConfiguration_adDecisionServerUrl - The URL for the ad decision server (ADS) for pre-roll 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.
$sel:maxDurationSeconds:LivePreRollConfiguration', livePreRollConfiguration_maxDurationSeconds - The maximum allowed duration for the pre-roll ad avail. AWS Elemental
MediaTailor won't play pre-roll ads to exceed this duration, regardless
of the total duration of ads that the ADS returns.
livePreRollConfiguration_adDecisionServerUrl :: Lens' LivePreRollConfiguration (Maybe Text) Source #
The URL for the ad decision server (ADS) for pre-roll 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.
livePreRollConfiguration_maxDurationSeconds :: Lens' LivePreRollConfiguration (Maybe Int) Source #
The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
LogConfiguration
data LogConfiguration Source #
Returns Amazon CloudWatch log settings for a playback configuration.
See: newLogConfiguration smart constructor.
Constructors
| LogConfiguration' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> LogConfiguration |
Create a value of LogConfiguration 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:
$sel:percentEnabled:LogConfiguration', logConfiguration_percentEnabled - The percentage of session logs that MediaTailor sends to your Cloudwatch
Logs account. For example, if your playback configuration has 1000
sessions and percentEnabled is set to 60, MediaTailor sends logs for 600
of the sessions to CloudWatch Logs. MediaTailor decides at random which
of the playback configuration sessions to send logs for. If you want to
view logs for a specific session, you can use the
debug log mode.
Valid values: 0 - 100
logConfiguration_percentEnabled :: Lens' LogConfiguration Int Source #
The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.
Valid values: 0 - 100
ManifestProcessingRules
data ManifestProcessingRules Source #
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
See: newManifestProcessingRules smart constructor.
Constructors
| ManifestProcessingRules' | |
Fields
| |
Instances
newManifestProcessingRules :: ManifestProcessingRules Source #
Create a value of ManifestProcessingRules 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:
$sel:adMarkerPassthrough:ManifestProcessingRules', manifestProcessingRules_adMarkerPassthrough - For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN,
EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin
manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
manifestProcessingRules_adMarkerPassthrough :: Lens' ManifestProcessingRules (Maybe AdMarkerPassthrough) Source #
For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.
No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.
PlaybackConfiguration
data PlaybackConfiguration Source #
Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
See: newPlaybackConfiguration smart constructor.
Constructors
| PlaybackConfiguration' | |
Fields
| |
Instances
newPlaybackConfiguration :: PlaybackConfiguration Source #
Create a value of PlaybackConfiguration 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:
$sel:playbackEndpointPrefix:PlaybackConfiguration', playbackConfiguration_playbackEndpointPrefix - The URL that the player accesses to get a manifest from AWS Elemental
MediaTailor.
$sel:hlsConfiguration:PlaybackConfiguration', playbackConfiguration_hlsConfiguration - The configuration for HLS content.
$sel:personalizationThresholdSeconds:PlaybackConfiguration', playbackConfiguration_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.
$sel:playbackConfigurationArn:PlaybackConfiguration', playbackConfiguration_playbackConfigurationArn - The Amazon Resource Name (ARN) for the playback configuration.
$sel:availSuppression:PlaybackConfiguration', playbackConfiguration_availSuppression - The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
$sel:bumper:PlaybackConfiguration', playbackConfiguration_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.
$sel:adDecisionServerUrl:PlaybackConfiguration', playbackConfiguration_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.
$sel:videoContentSourceUrl:PlaybackConfiguration', playbackConfiguration_videoContentSourceUrl - The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
$sel:dashConfiguration:PlaybackConfiguration', playbackConfiguration_dashConfiguration - The configuration for a DASH source.
$sel:manifestProcessingRules:PlaybackConfiguration', playbackConfiguration_manifestProcessingRules - The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
$sel:logConfiguration:PlaybackConfiguration', playbackConfiguration_logConfiguration - The Amazon CloudWatch log settings for a playback configuration.
$sel:livePreRollConfiguration:PlaybackConfiguration', playbackConfiguration_livePreRollConfiguration - The configuration for pre-roll ad insertion.
$sel:name:PlaybackConfiguration', playbackConfiguration_name - The identifier for the playback configuration.
$sel:sessionInitializationEndpointPrefix:PlaybackConfiguration', playbackConfiguration_sessionInitializationEndpointPrefix - The URL that the player uses to initialize a session that uses
client-side reporting.
$sel:configurationAliases:PlaybackConfiguration', playbackConfiguration_configurationAliases - The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
$sel:transcodeProfileName:PlaybackConfiguration', playbackConfiguration_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.
$sel:tags:PlaybackConfiguration', playbackConfiguration_tags - The tags to assign to the playback configuration.
$sel:slateAdUrl:PlaybackConfiguration', playbackConfiguration_slateAdUrl - The URL for a 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.
$sel:cdnConfiguration:PlaybackConfiguration', playbackConfiguration_cdnConfiguration - The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
playbackConfiguration_playbackEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text) Source #
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
playbackConfiguration_hlsConfiguration :: Lens' PlaybackConfiguration (Maybe HlsConfiguration) Source #
The configuration for HLS content.
playbackConfiguration_personalizationThresholdSeconds :: Lens' PlaybackConfiguration (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.
playbackConfiguration_playbackConfigurationArn :: Lens' PlaybackConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) for the playback configuration.
playbackConfiguration_availSuppression :: Lens' PlaybackConfiguration (Maybe AvailSuppression) Source #
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
playbackConfiguration_bumper :: Lens' PlaybackConfiguration (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.
playbackConfiguration_adDecisionServerUrl :: Lens' PlaybackConfiguration (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.
playbackConfiguration_videoContentSourceUrl :: Lens' PlaybackConfiguration (Maybe Text) Source #
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
playbackConfiguration_dashConfiguration :: Lens' PlaybackConfiguration (Maybe DashConfiguration) Source #
The configuration for a DASH source.
playbackConfiguration_manifestProcessingRules :: Lens' PlaybackConfiguration (Maybe ManifestProcessingRules) Source #
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
playbackConfiguration_logConfiguration :: Lens' PlaybackConfiguration (Maybe LogConfiguration) Source #
The Amazon CloudWatch log settings for a playback configuration.
playbackConfiguration_livePreRollConfiguration :: Lens' PlaybackConfiguration (Maybe LivePreRollConfiguration) Source #
The configuration for pre-roll ad insertion.
playbackConfiguration_name :: Lens' PlaybackConfiguration (Maybe Text) Source #
The identifier for the playback configuration.
playbackConfiguration_sessionInitializationEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text) Source #
The URL that the player uses to initialize a session that uses client-side reporting.
playbackConfiguration_configurationAliases :: Lens' PlaybackConfiguration (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.
playbackConfiguration_transcodeProfileName :: Lens' PlaybackConfiguration (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.
playbackConfiguration_tags :: Lens' PlaybackConfiguration (Maybe (HashMap Text Text)) Source #
The tags to assign to the playback configuration.
playbackConfiguration_slateAdUrl :: Lens' PlaybackConfiguration (Maybe Text) Source #
The URL for a 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.
playbackConfiguration_cdnConfiguration :: Lens' PlaybackConfiguration (Maybe CdnConfiguration) Source #
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
PrefetchConsumption
data PrefetchConsumption Source #
A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
See: newPrefetchConsumption smart constructor.
Constructors
| PrefetchConsumption' | |
Fields
| |
Instances
newPrefetchConsumption Source #
Arguments
| :: UTCTime | |
| -> PrefetchConsumption |
Create a value of PrefetchConsumption 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:
$sel:startTime:PrefetchConsumption', prefetchConsumption_startTime - The time when prefetched ads are considered for use in an ad break. If
you don't specify StartTime, the prefetched ads are available after
MediaTailor retrives them from the ad decision server.
$sel:availMatchingCriteria:PrefetchConsumption', prefetchConsumption_availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad
breaks) that match specific dynamic variables, such as scte.event_id,
set the avail matching criteria.
$sel:endTime:PrefetchConsumption', prefetchConsumption_endTime - The time when MediaTailor no longer considers the prefetched ads for use
in an ad break. MediaTailor automatically deletes prefetch schedules no
less than seven days after the end time. If you'd like to manually
delete the prefetch schedule, you can call DeletePrefetchSchedule.
prefetchConsumption_startTime :: Lens' PrefetchConsumption (Maybe UTCTime) Source #
The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
prefetchConsumption_availMatchingCriteria :: Lens' PrefetchConsumption (Maybe [AvailMatchingCriteria]) Source #
If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
prefetchConsumption_endTime :: Lens' PrefetchConsumption UTCTime Source #
The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
PrefetchRetrieval
data PrefetchRetrieval Source #
A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
See: newPrefetchRetrieval smart constructor.
Constructors
| PrefetchRetrieval' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> PrefetchRetrieval |
Create a value of PrefetchRetrieval 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:
$sel:startTime:PrefetchRetrieval', prefetchRetrieval_startTime - The time when prefetch retrievals can start for this break. Ad
prefetching will be attempted for manifest requests that occur at or
after this time. Defaults to the current time. If not specified, the
prefetch retrieval starts as soon as possible.
$sel:dynamicVariables:PrefetchRetrieval', prefetchRetrieval_dynamicVariables - The dynamic variables to use for substitution during prefetch requests
to the ad decision server (ADS).
You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
$sel:endTime:PrefetchRetrieval', prefetchRetrieval_endTime - The time when prefetch retrieval ends for the ad break. Prefetching will
be attempted for manifest requests that occur at or before this time.
prefetchRetrieval_startTime :: Lens' PrefetchRetrieval (Maybe UTCTime) Source #
The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
prefetchRetrieval_dynamicVariables :: Lens' PrefetchRetrieval (Maybe (HashMap Text Text)) Source #
The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
prefetchRetrieval_endTime :: Lens' PrefetchRetrieval UTCTime Source #
The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
PrefetchSchedule
data PrefetchSchedule Source #
A complex type that contains prefetch schedule information.
See: newPrefetchSchedule smart constructor.
Constructors
| PrefetchSchedule' | |
Fields
| |
Instances
Arguments
| :: PrefetchRetrieval | |
| -> PrefetchConsumption | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> PrefetchSchedule |
Create a value of PrefetchSchedule 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:
$sel:streamId:PrefetchSchedule', prefetchSchedule_streamId - An optional stream identifier that you can specify in order to prefetch
for multiple streams that use the same playback configuration.
$sel:retrieval:PrefetchSchedule', prefetchSchedule_retrieval - A complex type that contains settings for prefetch retrieval from the ad
decision server (ADS).
$sel:consumption:PrefetchSchedule', prefetchSchedule_consumption - Consumption settings determine how, and when, MediaTailor places the
prefetched ads into ad breaks. Ad consumption occurs within a span of
time that you define, called a consumption window. You can designate
which ad breaks that MediaTailor fills with prefetch ads by setting
avail matching criteria.
$sel:arn:PrefetchSchedule', prefetchSchedule_arn - The Amazon Resource Name (ARN) of the prefetch schedule.
$sel:playbackConfigurationName:PrefetchSchedule', prefetchSchedule_playbackConfigurationName - The name of the playback configuration to create the prefetch schedule
for.
$sel:name:PrefetchSchedule', prefetchSchedule_name - The name of the prefetch schedule. The name must be unique among all
prefetch schedules that are associated with the specified playback
configuration.
prefetchSchedule_streamId :: Lens' PrefetchSchedule (Maybe Text) Source #
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
prefetchSchedule_retrieval :: Lens' PrefetchSchedule PrefetchRetrieval Source #
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
prefetchSchedule_consumption :: Lens' PrefetchSchedule PrefetchConsumption Source #
Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
prefetchSchedule_arn :: Lens' PrefetchSchedule Text Source #
The Amazon Resource Name (ARN) of the prefetch schedule.
prefetchSchedule_playbackConfigurationName :: Lens' PrefetchSchedule Text Source #
The name of the playback configuration to create the prefetch schedule for.
prefetchSchedule_name :: Lens' PrefetchSchedule Text Source #
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
RequestOutputItem
data RequestOutputItem Source #
The output configuration for this channel.
See: newRequestOutputItem smart constructor.
Constructors
| RequestOutputItem' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RequestOutputItem |
Create a value of RequestOutputItem 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:
$sel:hlsPlaylistSettings:RequestOutputItem', requestOutputItem_hlsPlaylistSettings - HLS playlist configuration parameters.
$sel:dashPlaylistSettings:RequestOutputItem', requestOutputItem_dashPlaylistSettings - DASH manifest configuration parameters.
$sel:manifestName:RequestOutputItem', requestOutputItem_manifestName - The name of the manifest for the channel. The name appears in the
PlaybackUrl.
$sel:sourceGroup:RequestOutputItem', requestOutputItem_sourceGroup - A string used to match which HttpPackageConfiguration is used for each
VodSource.
requestOutputItem_hlsPlaylistSettings :: Lens' RequestOutputItem (Maybe HlsPlaylistSettings) Source #
HLS playlist configuration parameters.
requestOutputItem_dashPlaylistSettings :: Lens' RequestOutputItem (Maybe DashPlaylistSettings) Source #
DASH manifest configuration parameters.
requestOutputItem_manifestName :: Lens' RequestOutputItem Text Source #
The name of the manifest for the channel. The name appears in the PlaybackUrl.
requestOutputItem_sourceGroup :: Lens' RequestOutputItem Text Source #
A string used to match which HttpPackageConfiguration is used for each VodSource.
ResponseOutputItem
data ResponseOutputItem Source #
This response includes only the "property" : "type" property.
See: newResponseOutputItem smart constructor.
Constructors
| ResponseOutputItem' | |
Fields
| |
Instances
newResponseOutputItem Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResponseOutputItem |
Create a value of ResponseOutputItem 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:
$sel:hlsPlaylistSettings:ResponseOutputItem', responseOutputItem_hlsPlaylistSettings - HLS manifest configuration settings.
$sel:dashPlaylistSettings:ResponseOutputItem', responseOutputItem_dashPlaylistSettings - DASH manifest configuration settings.
$sel:manifestName:ResponseOutputItem', responseOutputItem_manifestName - The name of the manifest for the channel that will appear in the channel
output's playback URL.
$sel:playbackUrl:ResponseOutputItem', responseOutputItem_playbackUrl - The URL used for playback by content players.
$sel:sourceGroup:ResponseOutputItem', responseOutputItem_sourceGroup - A string used to associate a package configuration source group with a
channel output.
responseOutputItem_hlsPlaylistSettings :: Lens' ResponseOutputItem (Maybe HlsPlaylistSettings) Source #
HLS manifest configuration settings.
responseOutputItem_dashPlaylistSettings :: Lens' ResponseOutputItem (Maybe DashPlaylistSettings) Source #
DASH manifest configuration settings.
responseOutputItem_manifestName :: Lens' ResponseOutputItem Text Source #
The name of the manifest for the channel that will appear in the channel output's playback URL.
responseOutputItem_playbackUrl :: Lens' ResponseOutputItem Text Source #
The URL used for playback by content players.
responseOutputItem_sourceGroup :: Lens' ResponseOutputItem Text Source #
A string used to associate a package configuration source group with a channel output.
ScheduleAdBreak
data ScheduleAdBreak Source #
The schedule's ad break properties.
See: newScheduleAdBreak smart constructor.
Constructors
| ScheduleAdBreak' | |
Fields
| |
Instances
newScheduleAdBreak :: ScheduleAdBreak Source #
Create a value of ScheduleAdBreak 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:
$sel:sourceLocationName:ScheduleAdBreak', scheduleAdBreak_sourceLocationName - The name of the source location containing the VOD source used for the
ad break.
$sel:approximateDurationSeconds:ScheduleAdBreak', scheduleAdBreak_approximateDurationSeconds - The approximate duration of the ad break, in seconds.
$sel:vodSourceName:ScheduleAdBreak', scheduleAdBreak_vodSourceName - The name of the VOD source used for the ad break.
$sel:approximateStartTime:ScheduleAdBreak', scheduleAdBreak_approximateStartTime - The approximate time that the ad will start playing.
scheduleAdBreak_sourceLocationName :: Lens' ScheduleAdBreak (Maybe Text) Source #
The name of the source location containing the VOD source used for the ad break.
scheduleAdBreak_approximateDurationSeconds :: Lens' ScheduleAdBreak (Maybe Integer) Source #
The approximate duration of the ad break, in seconds.
scheduleAdBreak_vodSourceName :: Lens' ScheduleAdBreak (Maybe Text) Source #
The name of the VOD source used for the ad break.
scheduleAdBreak_approximateStartTime :: Lens' ScheduleAdBreak (Maybe UTCTime) Source #
The approximate time that the ad will start playing.
ScheduleConfiguration
data ScheduleConfiguration Source #
Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
See: newScheduleConfiguration smart constructor.
Constructors
| ScheduleConfiguration' | |
Fields
| |
Instances
newScheduleConfiguration Source #
Create a value of ScheduleConfiguration 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:
$sel:transition:ScheduleConfiguration', scheduleConfiguration_transition - Program transition configurations.
scheduleConfiguration_transition :: Lens' ScheduleConfiguration Transition Source #
Program transition configurations.
ScheduleEntry
data ScheduleEntry Source #
The properties for a schedule.
See: newScheduleEntry smart constructor.
Constructors
| ScheduleEntry' | |
Fields
| |
Instances
Create a value of ScheduleEntry 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:
$sel:scheduleAdBreaks:ScheduleEntry', scheduleEntry_scheduleAdBreaks - The schedule's ad break properties.
$sel:approximateDurationSeconds:ScheduleEntry', scheduleEntry_approximateDurationSeconds - The approximate duration of this program, in seconds.
$sel:approximateStartTime:ScheduleEntry', scheduleEntry_approximateStartTime - The approximate time that the program will start playing.
$sel:scheduleEntryType:ScheduleEntry', scheduleEntry_scheduleEntryType - The type of schedule entry.
Valid values: PROGRAM or FILLER_SLATE.
$sel:vodSourceName:ScheduleEntry', scheduleEntry_vodSourceName - The name of the VOD source.
$sel:channelName:ScheduleEntry', scheduleEntry_channelName - The name of the channel that uses this schedule.
$sel:sourceLocationName:ScheduleEntry', scheduleEntry_sourceLocationName - The name of the source location.
$sel:arn:ScheduleEntry', scheduleEntry_arn - The ARN of the program.
$sel:programName:ScheduleEntry', scheduleEntry_programName - The name of the program.
scheduleEntry_scheduleAdBreaks :: Lens' ScheduleEntry (Maybe [ScheduleAdBreak]) Source #
The schedule's ad break properties.
scheduleEntry_approximateDurationSeconds :: Lens' ScheduleEntry (Maybe Integer) Source #
The approximate duration of this program, in seconds.
scheduleEntry_approximateStartTime :: Lens' ScheduleEntry (Maybe UTCTime) Source #
The approximate time that the program will start playing.
scheduleEntry_scheduleEntryType :: Lens' ScheduleEntry (Maybe ScheduleEntryType) Source #
The type of schedule entry.
Valid values: PROGRAM or FILLER_SLATE.
scheduleEntry_vodSourceName :: Lens' ScheduleEntry Text Source #
The name of the VOD source.
scheduleEntry_channelName :: Lens' ScheduleEntry Text Source #
The name of the channel that uses this schedule.
scheduleEntry_sourceLocationName :: Lens' ScheduleEntry Text Source #
The name of the source location.
scheduleEntry_arn :: Lens' ScheduleEntry Text Source #
The ARN of the program.
scheduleEntry_programName :: Lens' ScheduleEntry Text Source #
The name of the program.
SecretsManagerAccessTokenConfiguration
data SecretsManagerAccessTokenConfiguration Source #
AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
See: newSecretsManagerAccessTokenConfiguration smart constructor.
Constructors
| SecretsManagerAccessTokenConfiguration' | |
Fields
| |
Instances
newSecretsManagerAccessTokenConfiguration :: SecretsManagerAccessTokenConfiguration Source #
Create a value of SecretsManagerAccessTokenConfiguration 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:
$sel:headerName:SecretsManagerAccessTokenConfiguration', secretsManagerAccessTokenConfiguration_headerName - The name of the HTTP header used to supply the access token in requests
to the source location.
$sel:secretStringKey:SecretsManagerAccessTokenConfiguration', secretsManagerAccessTokenConfiguration_secretStringKey - The AWS Secrets Manager
SecretString
key associated with the access token. MediaTailor uses the key to look
up SecretString key and value pair containing the access token.
$sel:secretArn:SecretsManagerAccessTokenConfiguration', secretsManagerAccessTokenConfiguration_secretArn - The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that
contains the access token.
secretsManagerAccessTokenConfiguration_headerName :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #
The name of the HTTP header used to supply the access token in requests to the source location.
secretsManagerAccessTokenConfiguration_secretStringKey :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #
The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
secretsManagerAccessTokenConfiguration_secretArn :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
SlateSource
data SlateSource Source #
Slate VOD source configuration.
See: newSlateSource smart constructor.
Constructors
| SlateSource' | |
Fields
| |
Instances
newSlateSource :: SlateSource Source #
Create a value of SlateSource 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:
$sel:sourceLocationName:SlateSource', slateSource_sourceLocationName - The name of the source location where the slate VOD source is stored.
$sel:vodSourceName:SlateSource', slateSource_vodSourceName - The slate VOD source name. The VOD source must already exist in a source
location before it can be used for slate.
slateSource_sourceLocationName :: Lens' SlateSource (Maybe Text) Source #
The name of the source location where the slate VOD source is stored.
slateSource_vodSourceName :: Lens' SlateSource (Maybe Text) Source #
The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
SourceLocation
data SourceLocation Source #
This response includes only the "type" : "object" property.
See: newSourceLocation smart constructor.
Constructors
| SourceLocation' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> HttpConfiguration | |
| -> Text | |
| -> SourceLocation |
Create a value of SourceLocation 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:
$sel:creationTime:SourceLocation', sourceLocation_creationTime - The timestamp that indicates when the source location was created.
$sel:lastModifiedTime:SourceLocation', sourceLocation_lastModifiedTime - The timestamp that indicates when the source location was last modified.
$sel:accessConfiguration:SourceLocation', sourceLocation_accessConfiguration - The access configuration for the source location.
$sel:defaultSegmentDeliveryConfiguration:SourceLocation', sourceLocation_defaultSegmentDeliveryConfiguration - The default segment delivery configuration.
$sel:tags:SourceLocation', sourceLocation_tags - The tags assigned to the source location.
$sel:sourceLocationName:SourceLocation', sourceLocation_sourceLocationName - The name of the source location.
$sel:httpConfiguration:SourceLocation', sourceLocation_httpConfiguration - The HTTP configuration for the source location.
$sel:arn:SourceLocation', sourceLocation_arn - The ARN of the SourceLocation.
sourceLocation_creationTime :: Lens' SourceLocation (Maybe UTCTime) Source #
The timestamp that indicates when the source location was created.
sourceLocation_lastModifiedTime :: Lens' SourceLocation (Maybe UTCTime) Source #
The timestamp that indicates when the source location was last modified.
sourceLocation_accessConfiguration :: Lens' SourceLocation (Maybe AccessConfiguration) Source #
The access configuration for the source location.
sourceLocation_defaultSegmentDeliveryConfiguration :: Lens' SourceLocation (Maybe DefaultSegmentDeliveryConfiguration) Source #
The default segment delivery configuration.
sourceLocation_tags :: Lens' SourceLocation (Maybe (HashMap Text Text)) Source #
The tags assigned to the source location.
sourceLocation_sourceLocationName :: Lens' SourceLocation Text Source #
The name of the source location.
sourceLocation_httpConfiguration :: Lens' SourceLocation HttpConfiguration Source #
The HTTP configuration for the source location.
sourceLocation_arn :: Lens' SourceLocation Text Source #
The ARN of the SourceLocation.
SpliceInsertMessage
data SpliceInsertMessage Source #
Splice insert message configuration.
See: newSpliceInsertMessage smart constructor.
Constructors
| SpliceInsertMessage' | |
Fields
| |
Instances
newSpliceInsertMessage :: SpliceInsertMessage Source #
Create a value of SpliceInsertMessage 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:
$sel:availNum:SpliceInsertMessage', spliceInsertMessage_availNum - This is written to splice_insert.avail_num, as defined in section
9.7.3.1 of the SCTE-35 specification. The default value is 0. Values
must be between 0 and 256, inclusive.
$sel:uniqueProgramId:SpliceInsertMessage', spliceInsertMessage_uniqueProgramId - This is written to splice_insert.unique_program_id, as defined in
section 9.7.3.1 of the SCTE-35 specification. The default value is 0.
Values must be between 0 and 256, inclusive.
$sel:availsExpected:SpliceInsertMessage', spliceInsertMessage_availsExpected - This is written to splice_insert.avails_expected, as defined in section
9.7.3.1 of the SCTE-35 specification. The default value is 0. Values
must be between 0 and 256, inclusive.
$sel:spliceEventId:SpliceInsertMessage', spliceInsertMessage_spliceEventId - This is written to splice_insert.splice_event_id, as defined in section
9.7.3.1 of the SCTE-35 specification. The default value is 1.
spliceInsertMessage_availNum :: Lens' SpliceInsertMessage (Maybe Int) Source #
This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
spliceInsertMessage_uniqueProgramId :: Lens' SpliceInsertMessage (Maybe Int) Source #
This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
spliceInsertMessage_availsExpected :: Lens' SpliceInsertMessage (Maybe Int) Source #
This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.
spliceInsertMessage_spliceEventId :: Lens' SpliceInsertMessage (Maybe Int) Source #
This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.
Transition
data Transition Source #
Program transition configuration.
See: newTransition smart constructor.
Constructors
| Transition' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RelativePosition | |
| -> Transition |
Create a value of Transition 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:
$sel:scheduledStartTimeMillis:Transition', transition_scheduledStartTimeMillis - The date and time that the program is scheduled to start, in epoch
milliseconds.
$sel:relativeProgram:Transition', transition_relativeProgram - The name of the program that this program will be inserted next to, as
defined by RelativePosition.
$sel:type':Transition', transition_type - Defines when the program plays in the schedule. You can set the value to
ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
$sel:relativePosition:Transition', transition_relativePosition - The position where this program will be inserted relative to the
RelativePosition.
transition_scheduledStartTimeMillis :: Lens' Transition (Maybe Integer) Source #
The date and time that the program is scheduled to start, in epoch milliseconds.
transition_relativeProgram :: Lens' Transition (Maybe Text) Source #
The name of the program that this program will be inserted next to, as defined by RelativePosition.
transition_type :: Lens' Transition Text Source #
Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.
ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.
Note the following considerations when using ABSOLUTE transitions:
If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.
If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.
RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.
transition_relativePosition :: Lens' Transition RelativePosition Source #
The position where this program will be inserted relative to the RelativePosition.
VodSource
VOD source configuration parameters.
See: newVodSource smart constructor.
Constructors
| VodSource' | |
Fields
| |
Instances
Create a value of VodSource 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:
$sel:creationTime:VodSource', vodSource_creationTime - The timestamp that indicates when the VOD source was created.
$sel:lastModifiedTime:VodSource', vodSource_lastModifiedTime - The timestamp that indicates when the VOD source was last modified.
$sel:tags:VodSource', vodSource_tags - The tags assigned to the VOD source.
$sel:vodSourceName:VodSource', vodSource_vodSourceName - The name of the VOD source.
$sel:sourceLocationName:VodSource', vodSource_sourceLocationName - The name of the source location that the VOD source is associated with.
$sel:httpPackageConfigurations:VodSource', vodSource_httpPackageConfigurations - The HTTP package configurations for the VOD source.
$sel:arn:VodSource', vodSource_arn - The ARN for the VOD source.
vodSource_creationTime :: Lens' VodSource (Maybe UTCTime) Source #
The timestamp that indicates when the VOD source was created.
vodSource_lastModifiedTime :: Lens' VodSource (Maybe UTCTime) Source #
The timestamp that indicates when the VOD source was last modified.
vodSource_tags :: Lens' VodSource (Maybe (HashMap Text Text)) Source #
The tags assigned to the VOD source.
vodSource_sourceLocationName :: Lens' VodSource Text Source #
The name of the source location that the VOD source is associated with.
vodSource_httpPackageConfigurations :: Lens' VodSource [HttpPackageConfiguration] Source #
The HTTP package configurations for the VOD source.