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 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateSourceLocation
- ListPrefetchSchedules (Paginated)
- DeletePrefetchSchedule
- ListAlerts (Paginated)
- ListChannels (Paginated)
- CreatePrefetchSchedule
- ListTagsForResource
- DeleteChannel
- UpdateChannel
- GetChannelPolicy
- DescribeVodSource
- DescribeSourceLocation
- GetPrefetchSchedule
- CreateProgram
- StartChannel
- ListPlaybackConfigurations (Paginated)
- DeletePlaybackConfiguration
- PutPlaybackConfiguration
- ListSourceLocations (Paginated)
- UpdateSourceLocation
- DeleteSourceLocation
- GetPlaybackConfiguration
- DeleteVodSource
- UpdateVodSource
- CreateVodSource
- CreateChannel
- DeleteChannelPolicy
- PutChannelPolicy
- DeleteProgram
- GetChannelSchedule (Paginated)
- TagResource
- ConfigureLogsForPlaybackConfiguration
- StopChannel
- UntagResource
- DescribeChannel
- ListVodSources (Paginated)
- DescribeProgram
- Types
- 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
Derived from API version 2018-04-23
of the AWS service descriptions, licensed under Apache 2.0.
Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data CreateSourceLocation = CreateSourceLocation' (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Text HttpConfiguration
- newCreateSourceLocation :: Text -> HttpConfiguration -> CreateSourceLocation
- data CreateSourceLocationResponse = CreateSourceLocationResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe HttpConfiguration) (Maybe POSIX) (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Int
- newCreateSourceLocationResponse :: Int -> CreateSourceLocationResponse
- data ListPrefetchSchedules = ListPrefetchSchedules' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListPrefetchSchedules :: Text -> ListPrefetchSchedules
- data ListPrefetchSchedulesResponse = ListPrefetchSchedulesResponse' (Maybe [PrefetchSchedule]) (Maybe Text) Int
- newListPrefetchSchedulesResponse :: Int -> ListPrefetchSchedulesResponse
- data DeletePrefetchSchedule = DeletePrefetchSchedule' Text Text
- newDeletePrefetchSchedule :: Text -> Text -> DeletePrefetchSchedule
- data DeletePrefetchScheduleResponse = DeletePrefetchScheduleResponse' Int
- newDeletePrefetchScheduleResponse :: Int -> DeletePrefetchScheduleResponse
- data ListAlerts = ListAlerts' (Maybe Text) (Maybe Natural) Text
- newListAlerts :: Text -> ListAlerts
- data ListAlertsResponse = ListAlertsResponse' (Maybe [Alert]) (Maybe Text) Int
- newListAlertsResponse :: Int -> ListAlertsResponse
- data ListChannels = ListChannels' (Maybe Text) (Maybe Natural)
- newListChannels :: ListChannels
- data ListChannelsResponse = ListChannelsResponse' (Maybe [Channel]) (Maybe Text) Int
- newListChannelsResponse :: Int -> ListChannelsResponse
- data CreatePrefetchSchedule = CreatePrefetchSchedule' (Maybe Text) Text Text PrefetchConsumption PrefetchRetrieval
- newCreatePrefetchSchedule :: Text -> Text -> PrefetchConsumption -> PrefetchRetrieval -> CreatePrefetchSchedule
- data CreatePrefetchScheduleResponse = CreatePrefetchScheduleResponse' (Maybe Text) (Maybe Text) (Maybe PrefetchRetrieval) (Maybe Text) (Maybe PrefetchConsumption) (Maybe Text) Int
- newCreatePrefetchScheduleResponse :: Int -> CreatePrefetchScheduleResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DeleteChannel = DeleteChannel' Text
- newDeleteChannel :: Text -> DeleteChannel
- data DeleteChannelResponse = DeleteChannelResponse' Int
- newDeleteChannelResponse :: Int -> DeleteChannelResponse
- data UpdateChannel = UpdateChannel' Text [RequestOutputItem]
- newUpdateChannel :: Text -> UpdateChannel
- data UpdateChannelResponse = UpdateChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int
- newUpdateChannelResponse :: Int -> UpdateChannelResponse
- data GetChannelPolicy = GetChannelPolicy' Text
- newGetChannelPolicy :: Text -> GetChannelPolicy
- data GetChannelPolicyResponse = GetChannelPolicyResponse' (Maybe Text) Int
- newGetChannelPolicyResponse :: Int -> GetChannelPolicyResponse
- data DescribeVodSource = DescribeVodSource' Text Text
- newDescribeVodSource :: Text -> Text -> DescribeVodSource
- data DescribeVodSourceResponse = DescribeVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribeVodSourceResponse :: Int -> DescribeVodSourceResponse
- data DescribeSourceLocation = DescribeSourceLocation' Text
- newDescribeSourceLocation :: Text -> DescribeSourceLocation
- data DescribeSourceLocationResponse = DescribeSourceLocationResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe HttpConfiguration) (Maybe POSIX) (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Int
- newDescribeSourceLocationResponse :: Int -> DescribeSourceLocationResponse
- data GetPrefetchSchedule = GetPrefetchSchedule' Text Text
- newGetPrefetchSchedule :: Text -> Text -> GetPrefetchSchedule
- data GetPrefetchScheduleResponse = GetPrefetchScheduleResponse' (Maybe Text) (Maybe Text) (Maybe PrefetchRetrieval) (Maybe Text) (Maybe PrefetchConsumption) (Maybe Text) Int
- newGetPrefetchScheduleResponse :: Int -> GetPrefetchScheduleResponse
- data CreateProgram = CreateProgram' (Maybe [AdBreak]) Text Text Text ScheduleConfiguration Text
- newCreateProgram :: Text -> Text -> Text -> ScheduleConfiguration -> Text -> CreateProgram
- data CreateProgramResponse = CreateProgramResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [AdBreak]) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newCreateProgramResponse :: Int -> CreateProgramResponse
- data StartChannel = StartChannel' Text
- newStartChannel :: Text -> StartChannel
- data StartChannelResponse = StartChannelResponse' Int
- newStartChannelResponse :: Int -> StartChannelResponse
- data ListPlaybackConfigurations = ListPlaybackConfigurations' (Maybe Text) (Maybe Natural)
- newListPlaybackConfigurations :: ListPlaybackConfigurations
- data ListPlaybackConfigurationsResponse = ListPlaybackConfigurationsResponse' (Maybe [PlaybackConfiguration]) (Maybe Text) Int
- newListPlaybackConfigurationsResponse :: Int -> ListPlaybackConfigurationsResponse
- data DeletePlaybackConfiguration = DeletePlaybackConfiguration' Text
- newDeletePlaybackConfiguration :: Text -> DeletePlaybackConfiguration
- data DeletePlaybackConfigurationResponse = DeletePlaybackConfigurationResponse' Int
- newDeletePlaybackConfigurationResponse :: Int -> DeletePlaybackConfigurationResponse
- data PutPlaybackConfiguration = PutPlaybackConfiguration' (Maybe Natural) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfigurationForPut) (Maybe ManifestProcessingRules) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration)
- newPutPlaybackConfiguration :: PutPlaybackConfiguration
- data PutPlaybackConfigurationResponse = PutPlaybackConfigurationResponse' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) Int
- newPutPlaybackConfigurationResponse :: Int -> PutPlaybackConfigurationResponse
- data ListSourceLocations = ListSourceLocations' (Maybe Text) (Maybe Natural)
- newListSourceLocations :: ListSourceLocations
- data ListSourceLocationsResponse = ListSourceLocationsResponse' (Maybe [SourceLocation]) (Maybe Text) Int
- newListSourceLocationsResponse :: Int -> ListSourceLocationsResponse
- data UpdateSourceLocation = UpdateSourceLocation' (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) Text HttpConfiguration
- newUpdateSourceLocation :: Text -> HttpConfiguration -> UpdateSourceLocation
- data UpdateSourceLocationResponse = UpdateSourceLocationResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe HttpConfiguration) (Maybe POSIX) (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Int
- newUpdateSourceLocationResponse :: Int -> UpdateSourceLocationResponse
- data DeleteSourceLocation = DeleteSourceLocation' Text
- newDeleteSourceLocation :: Text -> DeleteSourceLocation
- data DeleteSourceLocationResponse = DeleteSourceLocationResponse' Int
- newDeleteSourceLocationResponse :: Int -> DeleteSourceLocationResponse
- data GetPlaybackConfiguration = GetPlaybackConfiguration' Text
- newGetPlaybackConfiguration :: Text -> GetPlaybackConfiguration
- data GetPlaybackConfigurationResponse = GetPlaybackConfigurationResponse' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) Int
- newGetPlaybackConfigurationResponse :: Int -> GetPlaybackConfigurationResponse
- data DeleteVodSource = DeleteVodSource' Text Text
- newDeleteVodSource :: Text -> Text -> DeleteVodSource
- data DeleteVodSourceResponse = DeleteVodSourceResponse' Int
- newDeleteVodSourceResponse :: Int -> DeleteVodSourceResponse
- data UpdateVodSource = UpdateVodSource' Text Text [HttpPackageConfiguration]
- newUpdateVodSource :: Text -> Text -> UpdateVodSource
- data UpdateVodSourceResponse = UpdateVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newUpdateVodSourceResponse :: Int -> UpdateVodSourceResponse
- data CreateVodSource = CreateVodSource' (Maybe (HashMap Text Text)) Text Text [HttpPackageConfiguration]
- newCreateVodSource :: Text -> Text -> CreateVodSource
- data CreateVodSourceResponse = CreateVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newCreateVodSourceResponse :: Int -> CreateVodSourceResponse
- data CreateChannel = CreateChannel' (Maybe SlateSource) (Maybe (HashMap Text Text)) Text [RequestOutputItem] PlaybackMode
- newCreateChannel :: Text -> PlaybackMode -> CreateChannel
- data CreateChannelResponse = CreateChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int
- newCreateChannelResponse :: Int -> CreateChannelResponse
- data DeleteChannelPolicy = DeleteChannelPolicy' Text
- newDeleteChannelPolicy :: Text -> DeleteChannelPolicy
- data DeleteChannelPolicyResponse = DeleteChannelPolicyResponse' Int
- newDeleteChannelPolicyResponse :: Int -> DeleteChannelPolicyResponse
- data PutChannelPolicy = PutChannelPolicy' Text Text
- newPutChannelPolicy :: Text -> Text -> PutChannelPolicy
- data PutChannelPolicyResponse = PutChannelPolicyResponse' Int
- newPutChannelPolicyResponse :: Int -> PutChannelPolicyResponse
- data DeleteProgram = DeleteProgram' Text Text
- newDeleteProgram :: Text -> Text -> DeleteProgram
- data DeleteProgramResponse = DeleteProgramResponse' Int
- newDeleteProgramResponse :: Int -> DeleteProgramResponse
- data GetChannelSchedule = GetChannelSchedule' (Maybe Text) (Maybe Text) (Maybe Natural) Text
- newGetChannelSchedule :: Text -> GetChannelSchedule
- data GetChannelScheduleResponse = GetChannelScheduleResponse' (Maybe [ScheduleEntry]) (Maybe Text) Int
- newGetChannelScheduleResponse :: Int -> GetChannelScheduleResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data ConfigureLogsForPlaybackConfiguration = ConfigureLogsForPlaybackConfiguration' Int Text
- newConfigureLogsForPlaybackConfiguration :: Int -> Text -> ConfigureLogsForPlaybackConfiguration
- data ConfigureLogsForPlaybackConfigurationResponse = ConfigureLogsForPlaybackConfigurationResponse' (Maybe Text) (Maybe Int) Int
- newConfigureLogsForPlaybackConfigurationResponse :: Int -> ConfigureLogsForPlaybackConfigurationResponse
- data StopChannel = StopChannel' Text
- newStopChannel :: Text -> StopChannel
- data StopChannelResponse = StopChannelResponse' Int
- newStopChannelResponse :: Int -> StopChannelResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data DescribeChannel = DescribeChannel' Text
- newDescribeChannel :: Text -> DescribeChannel
- data DescribeChannelResponse = DescribeChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int
- newDescribeChannelResponse :: Int -> DescribeChannelResponse
- data ListVodSources = ListVodSources' (Maybe Text) (Maybe Natural) Text
- newListVodSources :: Text -> ListVodSources
- data ListVodSourcesResponse = ListVodSourcesResponse' (Maybe [VodSource]) (Maybe Text) Int
- newListVodSourcesResponse :: Int -> ListVodSourcesResponse
- data DescribeProgram = DescribeProgram' Text Text
- newDescribeProgram :: Text -> Text -> DescribeProgram
- data DescribeProgramResponse = DescribeProgramResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [AdBreak]) (Maybe Text) (Maybe POSIX) (Maybe Text) Int
- newDescribeProgramResponse :: Int -> DescribeProgramResponse
- 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' (Maybe AccessType) (Maybe SecretsManagerAccessTokenConfiguration)
- newAccessConfiguration :: AccessConfiguration
- data AdBreak = AdBreak' (Maybe SpliceInsertMessage) (Maybe MessageType) (Maybe SlateSource) (Maybe Integer)
- newAdBreak :: AdBreak
- data AdMarkerPassthrough = AdMarkerPassthrough' (Maybe Bool)
- newAdMarkerPassthrough :: AdMarkerPassthrough
- data Alert = Alert' Text Text POSIX [Text] Text
- newAlert :: Text -> Text -> UTCTime -> Text -> Alert
- data AvailMatchingCriteria = AvailMatchingCriteria' Operator Text
- newAvailMatchingCriteria :: Operator -> Text -> AvailMatchingCriteria
- data AvailSuppression = AvailSuppression' (Maybe Text) (Maybe Mode)
- newAvailSuppression :: AvailSuppression
- data Bumper = Bumper' (Maybe Text) (Maybe Text)
- newBumper :: Bumper
- data CdnConfiguration = CdnConfiguration' (Maybe Text) (Maybe Text)
- newCdnConfiguration :: CdnConfiguration
- data Channel = Channel' (Maybe POSIX) (Maybe POSIX) (Maybe SlateSource) (Maybe (HashMap Text Text)) Text Text [ResponseOutputItem] Text Text
- newChannel :: Text -> Text -> Text -> Text -> Channel
- data DashConfiguration = DashConfiguration' (Maybe Text) (Maybe OriginManifestType) (Maybe Text)
- newDashConfiguration :: DashConfiguration
- data DashConfigurationForPut = DashConfigurationForPut' (Maybe OriginManifestType) (Maybe Text)
- newDashConfigurationForPut :: DashConfigurationForPut
- data DashPlaylistSettings = DashPlaylistSettings' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newDashPlaylistSettings :: DashPlaylistSettings
- data DefaultSegmentDeliveryConfiguration = DefaultSegmentDeliveryConfiguration' (Maybe Text)
- newDefaultSegmentDeliveryConfiguration :: DefaultSegmentDeliveryConfiguration
- data HlsConfiguration = HlsConfiguration' (Maybe Text)
- newHlsConfiguration :: HlsConfiguration
- data HlsPlaylistSettings = HlsPlaylistSettings' (Maybe Int)
- newHlsPlaylistSettings :: HlsPlaylistSettings
- data HttpConfiguration = HttpConfiguration' Text
- newHttpConfiguration :: Text -> HttpConfiguration
- data HttpPackageConfiguration = HttpPackageConfiguration' Text Type Text
- newHttpPackageConfiguration :: Text -> Type -> Text -> HttpPackageConfiguration
- data LivePreRollConfiguration = LivePreRollConfiguration' (Maybe Text) (Maybe Int)
- newLivePreRollConfiguration :: LivePreRollConfiguration
- data LogConfiguration = LogConfiguration' Int
- newLogConfiguration :: Int -> LogConfiguration
- data ManifestProcessingRules = ManifestProcessingRules' (Maybe AdMarkerPassthrough)
- newManifestProcessingRules :: ManifestProcessingRules
- data PlaybackConfiguration = PlaybackConfiguration' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration)
- newPlaybackConfiguration :: PlaybackConfiguration
- data PrefetchConsumption = PrefetchConsumption' (Maybe POSIX) (Maybe [AvailMatchingCriteria]) POSIX
- newPrefetchConsumption :: UTCTime -> PrefetchConsumption
- data PrefetchRetrieval = PrefetchRetrieval' (Maybe POSIX) (Maybe (HashMap Text Text)) POSIX
- newPrefetchRetrieval :: UTCTime -> PrefetchRetrieval
- data PrefetchSchedule = PrefetchSchedule' (Maybe Text) PrefetchRetrieval PrefetchConsumption Text Text Text
- newPrefetchSchedule :: PrefetchRetrieval -> PrefetchConsumption -> Text -> Text -> Text -> PrefetchSchedule
- data RequestOutputItem = RequestOutputItem' (Maybe HlsPlaylistSettings) (Maybe DashPlaylistSettings) Text Text
- newRequestOutputItem :: Text -> Text -> RequestOutputItem
- data ResponseOutputItem = ResponseOutputItem' (Maybe HlsPlaylistSettings) (Maybe DashPlaylistSettings) Text Text Text
- newResponseOutputItem :: Text -> Text -> Text -> ResponseOutputItem
- data ScheduleAdBreak = ScheduleAdBreak' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe POSIX)
- newScheduleAdBreak :: ScheduleAdBreak
- data ScheduleConfiguration = ScheduleConfiguration' Transition
- newScheduleConfiguration :: Transition -> ScheduleConfiguration
- data ScheduleEntry = ScheduleEntry' (Maybe [ScheduleAdBreak]) (Maybe Integer) (Maybe POSIX) (Maybe ScheduleEntryType) Text Text Text Text Text
- newScheduleEntry :: Text -> Text -> Text -> Text -> Text -> ScheduleEntry
- data SecretsManagerAccessTokenConfiguration = SecretsManagerAccessTokenConfiguration' (Maybe Text) (Maybe Text) (Maybe Text)
- newSecretsManagerAccessTokenConfiguration :: SecretsManagerAccessTokenConfiguration
- data SlateSource = SlateSource' (Maybe Text) (Maybe Text)
- newSlateSource :: SlateSource
- data SourceLocation = SourceLocation' (Maybe POSIX) (Maybe POSIX) (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Text HttpConfiguration Text
- newSourceLocation :: Text -> HttpConfiguration -> Text -> SourceLocation
- data SpliceInsertMessage = SpliceInsertMessage' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newSpliceInsertMessage :: SpliceInsertMessage
- data Transition = Transition' (Maybe Integer) (Maybe Text) Text RelativePosition
- newTransition :: Text -> RelativePosition -> Transition
- data VodSource = VodSource' (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text Text)) Text Text [HttpPackageConfiguration] Text
- newVodSource :: Text -> Text -> Text -> VodSource
Service Configuration
defaultService :: Service Source #
API version 2018-04-23
of the Amazon MediaTailor SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by MediaTailor
.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Invalid request parameters.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateSourceLocation
data CreateSourceLocation Source #
See: newCreateSourceLocation
smart constructor.
CreateSourceLocation' (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Text HttpConfiguration |
Instances
newCreateSourceLocation Source #
Create a value of CreateSourceLocation
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:accessConfiguration:CreateSourceLocation'
, createSourceLocation_accessConfiguration
- Access configuration parameters. Configures the type of authentication
used to access content from your source location.
$sel:defaultSegmentDeliveryConfiguration:CreateSourceLocation'
, createSourceLocation_defaultSegmentDeliveryConfiguration
- The optional configuration for the server that serves segments.
$sel:tags:CreateSourceLocation'
, createSourceLocation_tags
- The tags to assign to the source location.
$sel:sourceLocationName:CreateSourceLocation'
, createSourceLocation_sourceLocationName
- The identifier for the source location you are working on.
$sel:httpConfiguration:CreateSourceLocation'
, createSourceLocation_httpConfiguration
- The source's HTTP package configurations.
data CreateSourceLocationResponse Source #
See: newCreateSourceLocationResponse
smart constructor.
Instances
newCreateSourceLocationResponse Source #
Create a value of CreateSourceLocationResponse
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:CreateSourceLocationResponse'
, createSourceLocationResponse_creationTime
- The timestamp that indicates when the source location was created.
$sel:sourceLocationName:CreateSourceLocation'
, createSourceLocationResponse_sourceLocationName
- The name of the source location.
$sel:arn:CreateSourceLocationResponse'
, createSourceLocationResponse_arn
- The ARN of the source location.
$sel:httpConfiguration:CreateSourceLocation'
, createSourceLocationResponse_httpConfiguration
- The HTTP package configuration settings for the source location.
$sel:lastModifiedTime:CreateSourceLocationResponse'
, createSourceLocationResponse_lastModifiedTime
- The timestamp that indicates when the source location was last modified.
$sel:accessConfiguration:CreateSourceLocation'
, createSourceLocationResponse_accessConfiguration
- The access configuration for the source location.
$sel:defaultSegmentDeliveryConfiguration:CreateSourceLocation'
, createSourceLocationResponse_defaultSegmentDeliveryConfiguration
- The default segment delivery configuration settings.
$sel:tags:CreateSourceLocation'
, createSourceLocationResponse_tags
- The tags assigned to the source location.
$sel:httpStatus:CreateSourceLocationResponse'
, createSourceLocationResponse_httpStatus
- The response's http status code.
ListPrefetchSchedules (Paginated)
data ListPrefetchSchedules Source #
See: newListPrefetchSchedules
smart constructor.
Instances
newListPrefetchSchedules Source #
Create a value of ListPrefetchSchedules
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:nextToken:ListPrefetchSchedules'
, listPrefetchSchedules_nextToken
- (Optional) If the playback configuration has more than MaxResults
prefetch schedules, use NextToken to get the second and subsequent pages
of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
$sel:maxResults:ListPrefetchSchedules'
, listPrefetchSchedules_maxResults
- The maximum number of prefetch schedules that you want MediaTailor to
return in response to the current request. If the playback configuration
has more than MaxResults prefetch schedules, use the value of NextToken
in the response to get the next page of results.
$sel:streamId:ListPrefetchSchedules'
, listPrefetchSchedules_streamId
- An optional filtering parameter whereby MediaTailor filters the prefetch
schedules to include only specific streams.
$sel:playbackConfigurationName:ListPrefetchSchedules'
, listPrefetchSchedules_playbackConfigurationName
- The name of the playback configuration.
data ListPrefetchSchedulesResponse Source #
See: newListPrefetchSchedulesResponse
smart constructor.
Instances
newListPrefetchSchedulesResponse Source #
Create a value of ListPrefetchSchedulesResponse
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:items:ListPrefetchSchedulesResponse'
, listPrefetchSchedulesResponse_items
- Lists the prefetch schedules. An empty Items list doesn't mean there
aren't more items to fetch, just that that page was empty.
$sel:nextToken:ListPrefetchSchedules'
, listPrefetchSchedulesResponse_nextToken
- The value that you will use forNextToken in the next
ListPrefetchSchedulesRequest request.
$sel:httpStatus:ListPrefetchSchedulesResponse'
, listPrefetchSchedulesResponse_httpStatus
- The response's http status code.
DeletePrefetchSchedule
data DeletePrefetchSchedule Source #
See: newDeletePrefetchSchedule
smart constructor.
Instances
newDeletePrefetchSchedule Source #
:: Text | |
-> Text | |
-> DeletePrefetchSchedule |
Create a value of DeletePrefetchSchedule
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:name:DeletePrefetchSchedule'
, deletePrefetchSchedule_name
- The identifier for the playback configuration.
$sel:playbackConfigurationName:DeletePrefetchSchedule'
, deletePrefetchSchedule_playbackConfigurationName
- The name of the playback configuration.
data DeletePrefetchScheduleResponse Source #
See: newDeletePrefetchScheduleResponse
smart constructor.
Instances
Eq DeletePrefetchScheduleResponse Source # | |
Read DeletePrefetchScheduleResponse Source # | |
Show DeletePrefetchScheduleResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePrefetchSchedule | |
Generic DeletePrefetchScheduleResponse Source # | |
NFData DeletePrefetchScheduleResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePrefetchSchedule rnf :: DeletePrefetchScheduleResponse -> () # | |
type Rep DeletePrefetchScheduleResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePrefetchSchedule type Rep DeletePrefetchScheduleResponse = D1 ('MetaData "DeletePrefetchScheduleResponse" "Amazonka.MediaTailor.DeletePrefetchSchedule" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "DeletePrefetchScheduleResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeletePrefetchScheduleResponse Source #
Create a value of DeletePrefetchScheduleResponse
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:httpStatus:DeletePrefetchScheduleResponse'
, deletePrefetchScheduleResponse_httpStatus
- The response's http status code.
ListAlerts (Paginated)
data ListAlerts Source #
See: newListAlerts
smart constructor.
Instances
Create a value of ListAlerts
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:nextToken:ListAlerts'
, listAlerts_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:maxResults:ListAlerts'
, listAlerts_maxResults
- Upper bound on number of records to return. The maximum number of
results is 100.
$sel:resourceArn:ListAlerts'
, listAlerts_resourceArn
- The Amazon Resource Name (ARN) of the resource.
data ListAlertsResponse Source #
See: newListAlertsResponse
smart constructor.
Instances
newListAlertsResponse Source #
Create a value of ListAlertsResponse
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:items:ListAlertsResponse'
, listAlertsResponse_items
- An array of alerts that are associated with this resource.
$sel:nextToken:ListAlerts'
, listAlertsResponse_nextToken
- Pagination token from the list request. Use the token to fetch the next
page of results.
$sel:httpStatus:ListAlertsResponse'
, listAlertsResponse_httpStatus
- The response's http status code.
ListChannels (Paginated)
data ListChannels Source #
See: newListChannels
smart constructor.
Instances
newListChannels :: ListChannels Source #
Create a value of ListChannels
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:nextToken:ListChannels'
, listChannels_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:maxResults:ListChannels'
, listChannels_maxResults
- Upper bound on number of records to return. The maximum number of
results is 100.
data ListChannelsResponse Source #
See: newListChannelsResponse
smart constructor.
Instances
newListChannelsResponse Source #
Create a value of ListChannelsResponse
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:items:ListChannelsResponse'
, listChannelsResponse_items
- An array of channels that are associated with this account.
$sel:nextToken:ListChannels'
, listChannelsResponse_nextToken
- Pagination token returned by the list request when results exceed the
maximum allowed. Use the token to fetch the next page of results.
$sel:httpStatus:ListChannelsResponse'
, listChannelsResponse_httpStatus
- The response's http status code.
CreatePrefetchSchedule
data CreatePrefetchSchedule Source #
See: newCreatePrefetchSchedule
smart constructor.
Instances
newCreatePrefetchSchedule Source #
Create a value of CreatePrefetchSchedule
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:CreatePrefetchSchedule'
, createPrefetchSchedule_streamId
- An optional stream identifier that MediaTailor uses to prefetch ads for
multiple streams that use the same playback configuration. If StreamId
is specified, MediaTailor returns all of the prefetch schedules with an
exact match on StreamId. If not specified, MediaTailor returns all of
the prefetch schedules for the playback configuration, regardless of
StreamId.
$sel:name:CreatePrefetchSchedule'
, createPrefetchSchedule_name
- The identifier for the playback configuration.
$sel:playbackConfigurationName:CreatePrefetchSchedule'
, createPrefetchSchedule_playbackConfigurationName
- The name of the playback configuration.
$sel:consumption:CreatePrefetchSchedule'
, createPrefetchSchedule_consumption
- The configuration settings for MediaTailor's consumption of the
prefetched ads from the ad decision server. Each consumption
configuration contains an end time and an optional start time that
define the consumption window. Prefetch schedules automatically expire
no earlier than seven days after the end time.
$sel:retrieval:CreatePrefetchSchedule'
, createPrefetchSchedule_retrieval
- The configuration settings for retrieval of prefetched ads from the ad
decision server. Only one set of prefetched ads will be retrieved and
subsequently consumed for each ad break.
data CreatePrefetchScheduleResponse Source #
See: newCreatePrefetchScheduleResponse
smart constructor.
CreatePrefetchScheduleResponse' (Maybe Text) (Maybe Text) (Maybe PrefetchRetrieval) (Maybe Text) (Maybe PrefetchConsumption) (Maybe Text) Int |
Instances
newCreatePrefetchScheduleResponse Source #
Create a value of CreatePrefetchScheduleResponse
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:arn:CreatePrefetchScheduleResponse'
, createPrefetchScheduleResponse_arn
- The Amazon Resource Name (ARN) of the prefetch schedule.
$sel:playbackConfigurationName:CreatePrefetchSchedule'
, createPrefetchScheduleResponse_playbackConfigurationName
- The name of the playback configuration to create the prefetch schedule
for.
$sel:retrieval:CreatePrefetchSchedule'
, createPrefetchScheduleResponse_retrieval
- A complex type that contains settings for prefetch retrieval from the ad
decision server (ADS).
$sel:name:CreatePrefetchSchedule'
, createPrefetchScheduleResponse_name
- The name of the prefetch schedule. The name must be unique among all
prefetch schedules that are associated with the specified playback
configuration.
$sel:consumption:CreatePrefetchSchedule'
, createPrefetchScheduleResponse_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:streamId:CreatePrefetchSchedule'
, createPrefetchScheduleResponse_streamId
- An optional stream identifier that you can specify in order to prefetch
for multiple streams that use the same playback configuration.
$sel:httpStatus:CreatePrefetchScheduleResponse'
, createPrefetchScheduleResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) for the playback configuration. You can
get this from the response to any playback configuration request.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- A comma-separated list of tag key:value pairs.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
DeleteChannel
data DeleteChannel Source #
See: newDeleteChannel
smart constructor.
Instances
Create a value of DeleteChannel
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:channelName:DeleteChannel'
, deleteChannel_channelName
- The identifier for the channel you are working on.
data DeleteChannelResponse Source #
See: newDeleteChannelResponse
smart constructor.
Instances
newDeleteChannelResponse Source #
Create a value of DeleteChannelResponse
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:httpStatus:DeleteChannelResponse'
, deleteChannelResponse_httpStatus
- The response's http status code.
UpdateChannel
data UpdateChannel Source #
See: newUpdateChannel
smart constructor.
Instances
Create a value of UpdateChannel
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:channelName:UpdateChannel'
, updateChannel_channelName
- The identifier for the channel you are working on.
$sel:outputs:UpdateChannel'
, updateChannel_outputs
- The channel's output properties.
data UpdateChannelResponse Source #
See: newUpdateChannelResponse
smart constructor.
UpdateChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateChannelResponse Source #
Create a value of UpdateChannelResponse
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:UpdateChannelResponse'
, updateChannelResponse_creationTime
- The timestamp of when the channel was created.
$sel:arn:UpdateChannelResponse'
, updateChannelResponse_arn
- The ARN of the channel.
$sel:lastModifiedTime:UpdateChannelResponse'
, updateChannelResponse_lastModifiedTime
- The timestamp of when the channel was last modified.
$sel:playbackMode:UpdateChannelResponse'
, updateChannelResponse_playbackMode
- The channel's playback mode.
$sel:channelName:UpdateChannel'
, updateChannelResponse_channelName
- The name of the channel.
$sel:outputs:UpdateChannel'
, updateChannelResponse_outputs
- The channel's output properties.
$sel:channelState:UpdateChannelResponse'
, updateChannelResponse_channelState
- Indicates whether the channel is in a running state or not.
$sel:fillerSlate:UpdateChannelResponse'
, updateChannelResponse_fillerSlate
- Contains information about the slate used to fill gaps between programs
in the schedule.
$sel:tags:UpdateChannelResponse'
, updateChannelResponse_tags
- The tags assigned to the channel.
$sel:httpStatus:UpdateChannelResponse'
, updateChannelResponse_httpStatus
- The response's http status code.
GetChannelPolicy
data GetChannelPolicy Source #
See: newGetChannelPolicy
smart constructor.
Instances
Create a value of GetChannelPolicy
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:channelName:GetChannelPolicy'
, getChannelPolicy_channelName
- The identifier for the channel you are working on.
data GetChannelPolicyResponse Source #
See: newGetChannelPolicyResponse
smart constructor.
Instances
newGetChannelPolicyResponse Source #
Create a value of GetChannelPolicyResponse
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:policy:GetChannelPolicyResponse'
, getChannelPolicyResponse_policy
- The IAM policy for the channel.
$sel:httpStatus:GetChannelPolicyResponse'
, getChannelPolicyResponse_httpStatus
- The response's http status code.
DescribeVodSource
data DescribeVodSource Source #
See: newDescribeVodSource
smart constructor.
Instances
:: Text | |
-> Text | |
-> DescribeVodSource |
Create a value of DescribeVodSource
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:DescribeVodSource'
, describeVodSource_sourceLocationName
- The identifier for the source location you are working on.
$sel:vodSourceName:DescribeVodSource'
, describeVodSource_vodSourceName
- The identifier for the VOD source you are working on.
data DescribeVodSourceResponse Source #
See: newDescribeVodSourceResponse
smart constructor.
DescribeVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeVodSourceResponse Source #
Create a value of DescribeVodSourceResponse
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:DescribeVodSourceResponse'
, describeVodSourceResponse_creationTime
- The timestamp that indicates when the VOD source was created.
$sel:sourceLocationName:DescribeVodSource'
, describeVodSourceResponse_sourceLocationName
- The name of the source location associated with the VOD source.
$sel:arn:DescribeVodSourceResponse'
, describeVodSourceResponse_arn
- The ARN of the VOD source.
$sel:lastModifiedTime:DescribeVodSourceResponse'
, describeVodSourceResponse_lastModifiedTime
- The ARN for the VOD source.
$sel:httpPackageConfigurations:DescribeVodSourceResponse'
, describeVodSourceResponse_httpPackageConfigurations
- The HTTP package configurations.
$sel:vodSourceName:DescribeVodSource'
, describeVodSourceResponse_vodSourceName
- The name of the VOD source.
$sel:tags:DescribeVodSourceResponse'
, describeVodSourceResponse_tags
- The tags assigned to the VOD source.
$sel:httpStatus:DescribeVodSourceResponse'
, describeVodSourceResponse_httpStatus
- The response's http status code.
DescribeSourceLocation
data DescribeSourceLocation Source #
See: newDescribeSourceLocation
smart constructor.
Instances
newDescribeSourceLocation Source #
Create a value of DescribeSourceLocation
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:DescribeSourceLocation'
, describeSourceLocation_sourceLocationName
- The identifier for the source location you are working on.
data DescribeSourceLocationResponse Source #
See: newDescribeSourceLocationResponse
smart constructor.
Instances
newDescribeSourceLocationResponse Source #
Create a value of DescribeSourceLocationResponse
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:DescribeSourceLocationResponse'
, describeSourceLocationResponse_creationTime
- The timestamp that indicates when the source location was created.
$sel:sourceLocationName:DescribeSourceLocation'
, describeSourceLocationResponse_sourceLocationName
- The name of the source location.
$sel:arn:DescribeSourceLocationResponse'
, describeSourceLocationResponse_arn
- The ARN of the source location.
$sel:httpConfiguration:DescribeSourceLocationResponse'
, describeSourceLocationResponse_httpConfiguration
- The HTTP package configuration settings for the source location.
$sel:lastModifiedTime:DescribeSourceLocationResponse'
, describeSourceLocationResponse_lastModifiedTime
- The timestamp that indicates when the source location was last modified.
$sel:accessConfiguration:DescribeSourceLocationResponse'
, describeSourceLocationResponse_accessConfiguration
- The access configuration for the source location.
$sel:defaultSegmentDeliveryConfiguration:DescribeSourceLocationResponse'
, describeSourceLocationResponse_defaultSegmentDeliveryConfiguration
- The default segment delivery configuration settings.
$sel:tags:DescribeSourceLocationResponse'
, describeSourceLocationResponse_tags
- The tags assigned to the source location.
$sel:httpStatus:DescribeSourceLocationResponse'
, describeSourceLocationResponse_httpStatus
- The response's http status code.
GetPrefetchSchedule
data GetPrefetchSchedule Source #
See: newGetPrefetchSchedule
smart constructor.
Instances
newGetPrefetchSchedule Source #
:: Text | |
-> Text | |
-> GetPrefetchSchedule |
Create a value of GetPrefetchSchedule
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:name:GetPrefetchSchedule'
, getPrefetchSchedule_name
- The identifier for the playback configuration.
$sel:playbackConfigurationName:GetPrefetchSchedule'
, getPrefetchSchedule_playbackConfigurationName
- The name of the playback configuration.
data GetPrefetchScheduleResponse Source #
See: newGetPrefetchScheduleResponse
smart constructor.
GetPrefetchScheduleResponse' (Maybe Text) (Maybe Text) (Maybe PrefetchRetrieval) (Maybe Text) (Maybe PrefetchConsumption) (Maybe Text) Int |
Instances
newGetPrefetchScheduleResponse Source #
Create a value of GetPrefetchScheduleResponse
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:arn:GetPrefetchScheduleResponse'
, getPrefetchScheduleResponse_arn
- The Amazon Resource Name (ARN) of the prefetch schedule.
$sel:playbackConfigurationName:GetPrefetchSchedule'
, getPrefetchScheduleResponse_playbackConfigurationName
- The name of the playback configuration to create the prefetch schedule
for.
$sel:retrieval:GetPrefetchScheduleResponse'
, getPrefetchScheduleResponse_retrieval
- A complex type that contains settings for prefetch retrieval from the ad
decision server (ADS).
$sel:name:GetPrefetchSchedule'
, getPrefetchScheduleResponse_name
- The name of the prefetch schedule. The name must be unique among all
prefetch schedules that are associated with the specified playback
configuration.
$sel:consumption:GetPrefetchScheduleResponse'
, getPrefetchScheduleResponse_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:streamId:GetPrefetchScheduleResponse'
, getPrefetchScheduleResponse_streamId
- An optional stream identifier that you can specify in order to prefetch
for multiple streams that use the same playback configuration.
$sel:httpStatus:GetPrefetchScheduleResponse'
, getPrefetchScheduleResponse_httpStatus
- The response's http status code.
CreateProgram
data CreateProgram Source #
See: newCreateProgram
smart constructor.
Instances
:: Text | |
-> Text | |
-> Text | |
-> ScheduleConfiguration | |
-> Text | |
-> CreateProgram |
Create a value of CreateProgram
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:adBreaks:CreateProgram'
, createProgram_adBreaks
- The ad break configuration settings.
$sel:channelName:CreateProgram'
, createProgram_channelName
- The identifier for the channel you are working on.
$sel:programName:CreateProgram'
, createProgram_programName
- The identifier for the program you are working on.
$sel:vodSourceName:CreateProgram'
, createProgram_vodSourceName
- The name that's used to refer to a VOD source.
$sel:scheduleConfiguration:CreateProgram'
, createProgram_scheduleConfiguration
- The schedule configuration settings.
$sel:sourceLocationName:CreateProgram'
, createProgram_sourceLocationName
- The name of the source location.
data CreateProgramResponse Source #
See: newCreateProgramResponse
smart constructor.
CreateProgramResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [AdBreak]) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newCreateProgramResponse Source #
Create a value of CreateProgramResponse
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:CreateProgramResponse'
, createProgramResponse_creationTime
- The timestamp of when the program was created.
$sel:sourceLocationName:CreateProgram'
, createProgramResponse_sourceLocationName
- The source location name.
$sel:arn:CreateProgramResponse'
, createProgramResponse_arn
- The ARN of the program.
$sel:programName:CreateProgram'
, createProgramResponse_programName
- The name of the program.
$sel:adBreaks:CreateProgram'
, createProgramResponse_adBreaks
- The ad break configuration settings.
$sel:channelName:CreateProgram'
, createProgramResponse_channelName
- The name of the channel that the program belongs to.
$sel:scheduledStartTime:CreateProgramResponse'
, createProgramResponse_scheduledStartTime
- The date and time that the program is scheduled to start in ISO 8601
format and Coordinated Universal Time (UTC). For example, the value
2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
$sel:vodSourceName:CreateProgram'
, createProgramResponse_vodSourceName
- The name that's used to refer to a VOD source.
$sel:httpStatus:CreateProgramResponse'
, createProgramResponse_httpStatus
- The response's http status code.
StartChannel
data StartChannel Source #
See: newStartChannel
smart constructor.
Instances
Create a value of StartChannel
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:channelName:StartChannel'
, startChannel_channelName
- The identifier for the channel you are working on.
data StartChannelResponse Source #
See: newStartChannelResponse
smart constructor.
Instances
newStartChannelResponse Source #
Create a value of StartChannelResponse
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:httpStatus:StartChannelResponse'
, startChannelResponse_httpStatus
- The response's http status code.
ListPlaybackConfigurations (Paginated)
data ListPlaybackConfigurations Source #
See: newListPlaybackConfigurations
smart constructor.
Instances
newListPlaybackConfigurations :: ListPlaybackConfigurations Source #
Create a value of ListPlaybackConfigurations
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:nextToken:ListPlaybackConfigurations'
, listPlaybackConfigurations_nextToken
- Pagination token returned by the GET list request when results exceed
the maximum allowed. Use the token to fetch the next page of results.
$sel:maxResults:ListPlaybackConfigurations'
, listPlaybackConfigurations_maxResults
- Maximum number of records to return.
data ListPlaybackConfigurationsResponse Source #
See: newListPlaybackConfigurationsResponse
smart constructor.
Instances
newListPlaybackConfigurationsResponse Source #
Create a value of ListPlaybackConfigurationsResponse
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:items:ListPlaybackConfigurationsResponse'
, listPlaybackConfigurationsResponse_items
- Array of playback configurations. This might be all the available
configurations or a subset, depending on the settings that you provide
and the total number of configurations stored.
$sel:nextToken:ListPlaybackConfigurations'
, listPlaybackConfigurationsResponse_nextToken
- Pagination token returned by the GET list request when results exceed
the maximum allowed. Use the token to fetch the next page of results.
$sel:httpStatus:ListPlaybackConfigurationsResponse'
, listPlaybackConfigurationsResponse_httpStatus
- The response's http status code.
DeletePlaybackConfiguration
data DeletePlaybackConfiguration Source #
See: newDeletePlaybackConfiguration
smart constructor.
Instances
newDeletePlaybackConfiguration Source #
Create a value of DeletePlaybackConfiguration
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:name:DeletePlaybackConfiguration'
, deletePlaybackConfiguration_name
- The identifier for the playback configuration.
data DeletePlaybackConfigurationResponse Source #
See: newDeletePlaybackConfigurationResponse
smart constructor.
Instances
Eq DeletePlaybackConfigurationResponse Source # | |
Read DeletePlaybackConfigurationResponse Source # | |
Show DeletePlaybackConfigurationResponse Source # | |
Generic DeletePlaybackConfigurationResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePlaybackConfiguration type Rep DeletePlaybackConfigurationResponse :: Type -> Type # | |
NFData DeletePlaybackConfigurationResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePlaybackConfiguration rnf :: DeletePlaybackConfigurationResponse -> () # | |
type Rep DeletePlaybackConfigurationResponse Source # | |
Defined in Amazonka.MediaTailor.DeletePlaybackConfiguration type Rep DeletePlaybackConfigurationResponse = D1 ('MetaData "DeletePlaybackConfigurationResponse" "Amazonka.MediaTailor.DeletePlaybackConfiguration" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "DeletePlaybackConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDeletePlaybackConfigurationResponse Source #
Create a value of DeletePlaybackConfigurationResponse
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:httpStatus:DeletePlaybackConfigurationResponse'
, deletePlaybackConfigurationResponse_httpStatus
- The response's http status code.
PutPlaybackConfiguration
data PutPlaybackConfiguration Source #
See: newPutPlaybackConfiguration
smart constructor.
PutPlaybackConfiguration' (Maybe Natural) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfigurationForPut) (Maybe ManifestProcessingRules) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) |
Instances
newPutPlaybackConfiguration :: PutPlaybackConfiguration Source #
Create a value of PutPlaybackConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:personalizationThresholdSeconds:PutPlaybackConfiguration'
, putPlaybackConfiguration_personalizationThresholdSeconds
- Defines the maximum duration of underfilled ad time (in seconds) allowed
in an ad break. If the duration of underfilled ad time exceeds the
personalization threshold, then the personalization of the ad break is
abandoned and the underlying content is shown. This feature applies to
ad replacement in live and VOD streams, rather than ad insertion,
because it relies on an underlying content stream. For more information
about ad break behavior, including ad replacement and insertion, see
Ad Behavior in AWS Elemental MediaTailor.
$sel:availSuppression:PutPlaybackConfiguration'
, putPlaybackConfiguration_availSuppression
- The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
$sel:bumper:PutPlaybackConfiguration'
, putPlaybackConfiguration_bumper
- The configuration for bumpers. Bumpers are short audio or video clips
that play at the start or before the end of an ad break. To learn more
about bumpers, see
Bumpers.
$sel:adDecisionServerUrl:PutPlaybackConfiguration'
, putPlaybackConfiguration_adDecisionServerUrl
- The URL for the ad decision server (ADS). This includes the
specification of static parameters and placeholders for dynamic
parameters. AWS Elemental MediaTailor substitutes player-specific and
session-specific parameters as needed when calling the ADS. Alternately,
for testing you can provide a static VAST URL. The maximum length is
25,000 characters.
$sel:videoContentSourceUrl:PutPlaybackConfiguration'
, putPlaybackConfiguration_videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
$sel:dashConfiguration:PutPlaybackConfiguration'
, putPlaybackConfiguration_dashConfiguration
- The configuration for DASH content.
$sel:manifestProcessingRules:PutPlaybackConfiguration'
, putPlaybackConfiguration_manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
$sel:livePreRollConfiguration:PutPlaybackConfiguration'
, putPlaybackConfiguration_livePreRollConfiguration
- The configuration for pre-roll ad insertion.
$sel:name:PutPlaybackConfiguration'
, putPlaybackConfiguration_name
- The identifier for the playback configuration.
$sel:configurationAliases:PutPlaybackConfiguration'
, putPlaybackConfiguration_configurationAliases
- The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
$sel:transcodeProfileName:PutPlaybackConfiguration'
, putPlaybackConfiguration_transcodeProfileName
- The name that is used to associate this playback configuration with a
custom transcode profile. This overrides the dynamic transcoding
defaults of MediaTailor. Use this only if you have already set up custom
profiles with the help of AWS Support.
$sel:tags:PutPlaybackConfiguration'
, putPlaybackConfiguration_tags
- The tags to assign to the playback configuration.
$sel:slateAdUrl:PutPlaybackConfiguration'
, putPlaybackConfiguration_slateAdUrl
- The URL for a high-quality video asset to transcode and use to fill in
time that's not used by ads. AWS Elemental MediaTailor shows the slate
to fill in gaps in media content. Configuring the slate is optional for
non-VPAID configurations. For VPAID, the slate is required because
MediaTailor provides it in the slots that are designated for dynamic ad
content. The slate must be a high-quality asset that contains both audio
and video.
$sel:cdnConfiguration:PutPlaybackConfiguration'
, putPlaybackConfiguration_cdnConfiguration
- The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
data PutPlaybackConfigurationResponse Source #
See: newPutPlaybackConfigurationResponse
smart constructor.
PutPlaybackConfigurationResponse' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) Int |
Instances
newPutPlaybackConfigurationResponse Source #
Create a value of PutPlaybackConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:playbackEndpointPrefix:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_playbackEndpointPrefix
- The URL that the player accesses to get a manifest from AWS Elemental
MediaTailor. This session will use server-side reporting.
$sel:hlsConfiguration:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_hlsConfiguration
- The configuration for HLS content.
$sel:personalizationThresholdSeconds:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_personalizationThresholdSeconds
- Defines the maximum duration of underfilled ad time (in seconds) allowed
in an ad break. If the duration of underfilled ad time exceeds the
personalization threshold, then the personalization of the ad break is
abandoned and the underlying content is shown. This feature applies to
ad replacement in live and VOD streams, rather than ad insertion,
because it relies on an underlying content stream. For more information
about ad break behavior, including ad replacement and insertion, see
Ad Behavior in AWS Elemental MediaTailor.
$sel:playbackConfigurationArn:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_playbackConfigurationArn
- The Amazon Resource Name (ARN) for the playback configuration.
$sel:availSuppression:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_availSuppression
- The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
$sel:bumper:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_bumper
- The configuration for bumpers. Bumpers are short audio or video clips
that play at the start or before the end of an ad break. To learn more
about bumpers, see
Bumpers.
$sel:adDecisionServerUrl:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_adDecisionServerUrl
- The URL for the ad decision server (ADS). This includes the
specification of static parameters and placeholders for dynamic
parameters. AWS Elemental MediaTailor substitutes player-specific and
session-specific parameters as needed when calling the ADS. Alternately,
for testing, you can provide a static VAST URL. The maximum length is
25,000 characters.
$sel:videoContentSourceUrl:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
$sel:dashConfiguration:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_dashConfiguration
- The configuration for DASH content.
$sel:manifestProcessingRules:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
$sel:logConfiguration:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_logConfiguration
- The Amazon CloudWatch log settings for a playback configuration.
$sel:livePreRollConfiguration:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_livePreRollConfiguration
- The configuration for pre-roll ad insertion.
$sel:name:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_name
- The identifier for the playback configuration.
$sel:sessionInitializationEndpointPrefix:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_sessionInitializationEndpointPrefix
- The URL that the player uses to initialize a session that uses
client-side reporting.
$sel:configurationAliases:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_configurationAliases
- The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
$sel:transcodeProfileName:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_transcodeProfileName
- The name that is used to associate this playback configuration with a
custom transcode profile. This overrides the dynamic transcoding
defaults of MediaTailor. Use this only if you have already set up custom
profiles with the help of AWS Support.
$sel:tags:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_tags
- The tags assigned to the playback configuration.
$sel:slateAdUrl:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_slateAdUrl
- The URL for a high-quality video asset to transcode and use to fill in
time that's not used by ads. AWS Elemental MediaTailor shows the slate
to fill in gaps in media content. Configuring the slate is optional for
non-VPAID 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:PutPlaybackConfiguration'
, putPlaybackConfigurationResponse_cdnConfiguration
- The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
$sel:httpStatus:PutPlaybackConfigurationResponse'
, putPlaybackConfigurationResponse_httpStatus
- The response's http status code.
ListSourceLocations (Paginated)
data ListSourceLocations Source #
See: newListSourceLocations
smart constructor.
Instances
newListSourceLocations :: ListSourceLocations Source #
Create a value of ListSourceLocations
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:nextToken:ListSourceLocations'
, listSourceLocations_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:maxResults:ListSourceLocations'
, listSourceLocations_maxResults
- Upper bound on number of records to return. The maximum number of
results is 100.
data ListSourceLocationsResponse Source #
See: newListSourceLocationsResponse
smart constructor.
Instances
newListSourceLocationsResponse Source #
Create a value of ListSourceLocationsResponse
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:items:ListSourceLocationsResponse'
, listSourceLocationsResponse_items
- An array of source locations.
$sel:nextToken:ListSourceLocations'
, listSourceLocationsResponse_nextToken
- Pagination token from the list request. Use the token to fetch the next
page of results.
$sel:httpStatus:ListSourceLocationsResponse'
, listSourceLocationsResponse_httpStatus
- The response's http status code.
UpdateSourceLocation
data UpdateSourceLocation Source #
See: newUpdateSourceLocation
smart constructor.
UpdateSourceLocation' (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) Text HttpConfiguration |
Instances
newUpdateSourceLocation Source #
Create a value of UpdateSourceLocation
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:accessConfiguration:UpdateSourceLocation'
, updateSourceLocation_accessConfiguration
- Access configuration parameters. Configures the type of authentication
used to access content from your source location.
$sel:defaultSegmentDeliveryConfiguration:UpdateSourceLocation'
, updateSourceLocation_defaultSegmentDeliveryConfiguration
- The optional configuration for the host server that serves segments.
$sel:sourceLocationName:UpdateSourceLocation'
, updateSourceLocation_sourceLocationName
- The identifier for the source location you are working on.
$sel:httpConfiguration:UpdateSourceLocation'
, updateSourceLocation_httpConfiguration
- The HTTP configuration for the source location.
data UpdateSourceLocationResponse Source #
See: newUpdateSourceLocationResponse
smart constructor.
Instances
newUpdateSourceLocationResponse Source #
Create a value of UpdateSourceLocationResponse
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:UpdateSourceLocationResponse'
, updateSourceLocationResponse_creationTime
- The timestamp that indicates when the source location was created.
$sel:sourceLocationName:UpdateSourceLocation'
, updateSourceLocationResponse_sourceLocationName
- The name of the source location.
$sel:arn:UpdateSourceLocationResponse'
, updateSourceLocationResponse_arn
- The ARN of the source location.
$sel:httpConfiguration:UpdateSourceLocation'
, updateSourceLocationResponse_httpConfiguration
- The HTTP package configuration settings for the source location.
$sel:lastModifiedTime:UpdateSourceLocationResponse'
, updateSourceLocationResponse_lastModifiedTime
- The timestamp that indicates when the source location was last modified.
$sel:accessConfiguration:UpdateSourceLocation'
, updateSourceLocationResponse_accessConfiguration
- The access configuration for the source location.
$sel:defaultSegmentDeliveryConfiguration:UpdateSourceLocation'
, updateSourceLocationResponse_defaultSegmentDeliveryConfiguration
- The default segment delivery configuration settings.
$sel:tags:UpdateSourceLocationResponse'
, updateSourceLocationResponse_tags
- The tags assigned to the source location.
$sel:httpStatus:UpdateSourceLocationResponse'
, updateSourceLocationResponse_httpStatus
- The response's http status code.
DeleteSourceLocation
data DeleteSourceLocation Source #
See: newDeleteSourceLocation
smart constructor.
Instances
newDeleteSourceLocation Source #
Create a value of DeleteSourceLocation
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:DeleteSourceLocation'
, deleteSourceLocation_sourceLocationName
- The identifier for the source location you are working on.
data DeleteSourceLocationResponse Source #
See: newDeleteSourceLocationResponse
smart constructor.
Instances
newDeleteSourceLocationResponse Source #
Create a value of DeleteSourceLocationResponse
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:httpStatus:DeleteSourceLocationResponse'
, deleteSourceLocationResponse_httpStatus
- The response's http status code.
GetPlaybackConfiguration
data GetPlaybackConfiguration Source #
See: newGetPlaybackConfiguration
smart constructor.
Instances
newGetPlaybackConfiguration Source #
Create a value of GetPlaybackConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:GetPlaybackConfiguration'
, getPlaybackConfiguration_name
- The identifier for the playback configuration.
data GetPlaybackConfigurationResponse Source #
See: newGetPlaybackConfigurationResponse
smart constructor.
GetPlaybackConfigurationResponse' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) Int |
Instances
newGetPlaybackConfigurationResponse Source #
Create a value of GetPlaybackConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:playbackEndpointPrefix:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_playbackEndpointPrefix
- The URL that the player accesses to get a manifest from AWS Elemental
MediaTailor. This session will use server-side reporting.
$sel:hlsConfiguration:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_hlsConfiguration
- The configuration for HLS content.
$sel:personalizationThresholdSeconds:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_personalizationThresholdSeconds
- Defines the maximum duration of underfilled ad time (in seconds) allowed
in an ad break. If the duration of underfilled ad time exceeds the
personalization threshold, then the personalization of the ad break is
abandoned and the underlying content is shown. This feature applies to
ad replacement in live and VOD streams, rather than ad insertion,
because it relies on an underlying content stream. For more information
about ad break behavior, including ad replacement and insertion, see
Ad Behavior in AWS Elemental MediaTailor.
$sel:playbackConfigurationArn:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_playbackConfigurationArn
- The Amazon Resource Name (ARN) for the playback configuration.
$sel:availSuppression:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_availSuppression
- The configuration for avail suppression, also known as ad suppression.
For more information about ad suppression, see
Ad Suppression.
$sel:bumper:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_bumper
- The configuration for bumpers. Bumpers are short audio or video clips
that play at the start or before the end of an ad break. To learn more
about bumpers, see
Bumpers.
$sel:adDecisionServerUrl:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_adDecisionServerUrl
- The URL for the ad decision server (ADS). This includes the
specification of static parameters and placeholders for dynamic
parameters. AWS Elemental MediaTailor substitutes player-specific and
session-specific parameters as needed when calling the ADS. Alternately,
for testing, you can provide a static VAST URL. The maximum length is
25,000 characters.
$sel:videoContentSourceUrl:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset
ID. The maximum length is 512 characters.
$sel:dashConfiguration:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_dashConfiguration
- The configuration for DASH content.
$sel:manifestProcessingRules:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing
rules enable customization of the personalized manifests created by
MediaTailor.
$sel:logConfiguration:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_logConfiguration
- The Amazon CloudWatch log settings for a playback configuration.
$sel:livePreRollConfiguration:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_livePreRollConfiguration
- The configuration for pre-roll ad insertion.
$sel:name:GetPlaybackConfiguration'
, getPlaybackConfigurationResponse_name
- The identifier for the playback configuration.
$sel:sessionInitializationEndpointPrefix:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_sessionInitializationEndpointPrefix
- The URL that the player uses to initialize a session that uses
client-side reporting.
$sel:configurationAliases:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_configurationAliases
- The player parameters and aliases used as dynamic variables during
session initialization. For more information, see
Domain Variables.
$sel:transcodeProfileName:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_transcodeProfileName
- The name that is used to associate this playback configuration with a
custom transcode profile. This overrides the dynamic transcoding
defaults of MediaTailor. Use this only if you have already set up custom
profiles with the help of AWS Support.
$sel:tags:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_tags
- The tags assigned to the playback configuration.
$sel:slateAdUrl:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_slateAdUrl
- The URL for a high-quality video asset to transcode and use to fill in
time that's not used by ads. AWS Elemental MediaTailor shows the slate
to fill in gaps in media content. Configuring the slate is optional for
non-VPAID playback configurations. For VPAID, the slate is required
because MediaTailor provides it in the slots designated for dynamic ad
content. The slate must be a high-quality asset that contains both audio
and video.
$sel:cdnConfiguration:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_cdnConfiguration
- The configuration for using a content delivery network (CDN), like
Amazon CloudFront, for content and ad segment management.
$sel:httpStatus:GetPlaybackConfigurationResponse'
, getPlaybackConfigurationResponse_httpStatus
- The response's http status code.
DeleteVodSource
data DeleteVodSource Source #
See: newDeleteVodSource
smart constructor.
Instances
:: Text | |
-> Text | |
-> DeleteVodSource |
Create a value of DeleteVodSource
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:DeleteVodSource'
, deleteVodSource_sourceLocationName
- The identifier for the source location you are working on.
$sel:vodSourceName:DeleteVodSource'
, deleteVodSource_vodSourceName
- The identifier for the VOD source you are working on.
data DeleteVodSourceResponse Source #
See: newDeleteVodSourceResponse
smart constructor.
Instances
newDeleteVodSourceResponse Source #
Create a value of DeleteVodSourceResponse
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:httpStatus:DeleteVodSourceResponse'
, deleteVodSourceResponse_httpStatus
- The response's http status code.
UpdateVodSource
data UpdateVodSource Source #
See: newUpdateVodSource
smart constructor.
Instances
:: Text | |
-> Text | |
-> UpdateVodSource |
Create a value of UpdateVodSource
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:UpdateVodSource'
, updateVodSource_sourceLocationName
- The identifier for the source location you are working on.
$sel:vodSourceName:UpdateVodSource'
, updateVodSource_vodSourceName
- The identifier for the VOD source you are working on.
$sel:httpPackageConfigurations:UpdateVodSource'
, updateVodSource_httpPackageConfigurations
- An array of HTTP package configurations for the VOD source on this
account.
data UpdateVodSourceResponse Source #
See: newUpdateVodSourceResponse
smart constructor.
UpdateVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateVodSourceResponse Source #
Create a value of UpdateVodSourceResponse
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:UpdateVodSourceResponse'
, updateVodSourceResponse_creationTime
- The timestamp that indicates when the VOD source was created.
$sel:sourceLocationName:UpdateVodSource'
, updateVodSourceResponse_sourceLocationName
- The name of the source location associated with the VOD source.
$sel:arn:UpdateVodSourceResponse'
, updateVodSourceResponse_arn
- The ARN of the VOD source.
$sel:lastModifiedTime:UpdateVodSourceResponse'
, updateVodSourceResponse_lastModifiedTime
- The ARN for the VOD source.
$sel:httpPackageConfigurations:UpdateVodSource'
, updateVodSourceResponse_httpPackageConfigurations
- The HTTP package configurations.
$sel:vodSourceName:UpdateVodSource'
, updateVodSourceResponse_vodSourceName
- The name of the VOD source.
$sel:tags:UpdateVodSourceResponse'
, updateVodSourceResponse_tags
- The tags assigned to the VOD source.
$sel:httpStatus:UpdateVodSourceResponse'
, updateVodSourceResponse_httpStatus
- The response's http status code.
CreateVodSource
data CreateVodSource Source #
See: newCreateVodSource
smart constructor.
Instances
:: Text | |
-> Text | |
-> CreateVodSource |
Create a value of CreateVodSource
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:tags:CreateVodSource'
, createVodSource_tags
- The tags to assign to the VOD source.
$sel:sourceLocationName:CreateVodSource'
, createVodSource_sourceLocationName
- The identifier for the source location you are working on.
$sel:vodSourceName:CreateVodSource'
, createVodSource_vodSourceName
- The identifier for the VOD source you are working on.
$sel:httpPackageConfigurations:CreateVodSource'
, createVodSource_httpPackageConfigurations
- An array of HTTP package configuration parameters for this VOD source.
data CreateVodSourceResponse Source #
See: newCreateVodSourceResponse
smart constructor.
CreateVodSourceResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe [HttpPackageConfiguration]) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newCreateVodSourceResponse Source #
Create a value of CreateVodSourceResponse
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:CreateVodSourceResponse'
, createVodSourceResponse_creationTime
- The timestamp that indicates when the VOD source was created.
$sel:sourceLocationName:CreateVodSource'
, createVodSourceResponse_sourceLocationName
- The name of the source location associated with the VOD source.
$sel:arn:CreateVodSourceResponse'
, createVodSourceResponse_arn
- The ARN of the VOD source.
$sel:lastModifiedTime:CreateVodSourceResponse'
, createVodSourceResponse_lastModifiedTime
- The ARN for the VOD source.
$sel:httpPackageConfigurations:CreateVodSource'
, createVodSourceResponse_httpPackageConfigurations
- The HTTP package configurations.
$sel:vodSourceName:CreateVodSource'
, createVodSourceResponse_vodSourceName
- The name of the VOD source.
$sel:tags:CreateVodSource'
, createVodSourceResponse_tags
- The tags assigned to the VOD source.
$sel:httpStatus:CreateVodSourceResponse'
, createVodSourceResponse_httpStatus
- The response's http status code.
CreateChannel
data CreateChannel Source #
See: newCreateChannel
smart constructor.
CreateChannel' (Maybe SlateSource) (Maybe (HashMap Text Text)) Text [RequestOutputItem] PlaybackMode |
Instances
:: Text | |
-> PlaybackMode | |
-> CreateChannel |
Create a value of CreateChannel
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:fillerSlate:CreateChannel'
, createChannel_fillerSlate
- The slate used to fill gaps between programs in the schedule. You must
configure filler slate if your channel uses a LINEAR PlaybackMode.
$sel:tags:CreateChannel'
, createChannel_tags
- The tags to assign to the channel.
$sel:channelName:CreateChannel'
, createChannel_channelName
- The identifier for the channel you are working on.
$sel:outputs:CreateChannel'
, createChannel_outputs
- The channel's output properties.
$sel:playbackMode:CreateChannel'
, createChannel_playbackMode
- The type of playback mode to use for this channel.
LINEAR - The programs in the schedule play once back-to-back in the schedule.
LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.
data CreateChannelResponse Source #
See: newCreateChannelResponse
smart constructor.
CreateChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int |
Instances
newCreateChannelResponse Source #
Create a value of CreateChannelResponse
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:CreateChannelResponse'
, createChannelResponse_creationTime
- The timestamp of when the channel was created.
$sel:arn:CreateChannelResponse'
, createChannelResponse_arn
- The ARN of the channel.
$sel:lastModifiedTime:CreateChannelResponse'
, createChannelResponse_lastModifiedTime
- The timestamp of when the channel was last modified.
$sel:playbackMode:CreateChannel'
, createChannelResponse_playbackMode
- The channel's playback mode.
$sel:channelName:CreateChannel'
, createChannelResponse_channelName
- The name of the channel.
$sel:outputs:CreateChannel'
, createChannelResponse_outputs
- The channel's output properties.
$sel:channelState:CreateChannelResponse'
, createChannelResponse_channelState
- Indicates whether the channel is in a running state or not.
$sel:fillerSlate:CreateChannel'
, createChannelResponse_fillerSlate
- Contains information about the slate used to fill gaps between programs
in the schedule.
$sel:tags:CreateChannel'
, createChannelResponse_tags
- The tags assigned to the channel.
$sel:httpStatus:CreateChannelResponse'
, createChannelResponse_httpStatus
- The response's http status code.
DeleteChannelPolicy
data DeleteChannelPolicy Source #
See: newDeleteChannelPolicy
smart constructor.
Instances
newDeleteChannelPolicy Source #
Create a value of DeleteChannelPolicy
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:channelName:DeleteChannelPolicy'
, deleteChannelPolicy_channelName
- The identifier for the channel you are working on.
data DeleteChannelPolicyResponse Source #
See: newDeleteChannelPolicyResponse
smart constructor.
Instances
newDeleteChannelPolicyResponse Source #
Create a value of DeleteChannelPolicyResponse
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:httpStatus:DeleteChannelPolicyResponse'
, deleteChannelPolicyResponse_httpStatus
- The response's http status code.
PutChannelPolicy
data PutChannelPolicy Source #
See: newPutChannelPolicy
smart constructor.
Instances
Create a value of PutChannelPolicy
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:channelName:PutChannelPolicy'
, putChannelPolicy_channelName
- The identifier for the channel you are working on.
$sel:policy:PutChannelPolicy'
, putChannelPolicy_policy
- Adds an IAM role that determines the permissions of your channel.
data PutChannelPolicyResponse Source #
See: newPutChannelPolicyResponse
smart constructor.
Instances
newPutChannelPolicyResponse Source #
Create a value of PutChannelPolicyResponse
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:httpStatus:PutChannelPolicyResponse'
, putChannelPolicyResponse_httpStatus
- The response's http status code.
DeleteProgram
data DeleteProgram Source #
See: newDeleteProgram
smart constructor.
Instances
Create a value of DeleteProgram
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:channelName:DeleteProgram'
, deleteProgram_channelName
- The identifier for the channel you are working on.
$sel:programName:DeleteProgram'
, deleteProgram_programName
- The identifier for the program you are working on.
data DeleteProgramResponse Source #
See: newDeleteProgramResponse
smart constructor.
Instances
newDeleteProgramResponse Source #
Create a value of DeleteProgramResponse
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:httpStatus:DeleteProgramResponse'
, deleteProgramResponse_httpStatus
- The response's http status code.
GetChannelSchedule (Paginated)
data GetChannelSchedule Source #
See: newGetChannelSchedule
smart constructor.
Instances
newGetChannelSchedule Source #
Create a value of GetChannelSchedule
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:nextToken:GetChannelSchedule'
, getChannelSchedule_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:durationMinutes:GetChannelSchedule'
, getChannelSchedule_durationMinutes
- The schedule duration in minutes. The maximum duration is 4320 minutes
(three days).
$sel:maxResults:GetChannelSchedule'
, getChannelSchedule_maxResults
- Upper bound on number of records to return. The maximum number of
results is 100.
$sel:channelName:GetChannelSchedule'
, getChannelSchedule_channelName
- The identifier for the channel you are working on.
data GetChannelScheduleResponse Source #
See: newGetChannelScheduleResponse
smart constructor.
Instances
newGetChannelScheduleResponse Source #
Create a value of GetChannelScheduleResponse
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:items:GetChannelScheduleResponse'
, getChannelScheduleResponse_items
- An array of schedule entries for the channel.
$sel:nextToken:GetChannelSchedule'
, getChannelScheduleResponse_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:httpStatus:GetChannelScheduleResponse'
, getChannelScheduleResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) for the playback configuration. You can
get this from the response to any playback configuration request.
$sel:tags:TagResource'
, tagResource_tags
- A comma-separated list of tag key:value pairs.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
Eq TagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.TagResource (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool # | |
Read TagResourceResponse Source # | |
Show TagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.TagResource showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS # | |
Generic TagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.TagResource type Rep TagResourceResponse :: Type -> Type # from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse # | |
NFData TagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.TagResource rnf :: TagResourceResponse -> () # | |
type Rep TagResourceResponse Source # | |
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ConfigureLogsForPlaybackConfiguration
data ConfigureLogsForPlaybackConfiguration Source #
Configures Amazon CloudWatch log settings for a playback configuration.
See: newConfigureLogsForPlaybackConfiguration
smart constructor.
Instances
newConfigureLogsForPlaybackConfiguration Source #
:: Int | |
-> Text |
|
-> ConfigureLogsForPlaybackConfiguration |
Create a value of ConfigureLogsForPlaybackConfiguration
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:ConfigureLogsForPlaybackConfiguration'
, configureLogsForPlaybackConfiguration_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
$sel:playbackConfigurationName:ConfigureLogsForPlaybackConfiguration'
, configureLogsForPlaybackConfiguration_playbackConfigurationName
- The name of the playback configuration.
data ConfigureLogsForPlaybackConfigurationResponse Source #
See: newConfigureLogsForPlaybackConfigurationResponse
smart constructor.
Instances
newConfigureLogsForPlaybackConfigurationResponse Source #
:: Int |
|
-> ConfigureLogsForPlaybackConfigurationResponse |
Create a value of ConfigureLogsForPlaybackConfigurationResponse
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:playbackConfigurationName:ConfigureLogsForPlaybackConfiguration'
, configureLogsForPlaybackConfigurationResponse_playbackConfigurationName
- The name of the playback configuration.
$sel:percentEnabled:ConfigureLogsForPlaybackConfiguration'
, configureLogsForPlaybackConfigurationResponse_percentEnabled
- The percentage of session logs that MediaTailor sends to your Cloudwatch
Logs account.
$sel:httpStatus:ConfigureLogsForPlaybackConfigurationResponse'
, configureLogsForPlaybackConfigurationResponse_httpStatus
- The response's http status code.
StopChannel
data StopChannel Source #
See: newStopChannel
smart constructor.
Instances
Create a value of StopChannel
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:channelName:StopChannel'
, stopChannel_channelName
- The identifier for the channel you are working on.
data StopChannelResponse Source #
See: newStopChannelResponse
smart constructor.
Instances
newStopChannelResponse Source #
Create a value of StopChannelResponse
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:httpStatus:StopChannelResponse'
, stopChannelResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) for the playback configuration. You can
get this from the response to any playback configuration request.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A comma-separated list of the tag keys to remove from the playback
configuration.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Eq UntagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
Generic UntagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.UntagResource rnf :: UntagResourceResponse -> () # | |
type Rep UntagResourceResponse Source # | |
Defined in Amazonka.MediaTailor.UntagResource |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeChannel
data DescribeChannel Source #
See: newDescribeChannel
smart constructor.
Instances
Create a value of DescribeChannel
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:channelName:DescribeChannel'
, describeChannel_channelName
- The identifier for the channel you are working on.
data DescribeChannelResponse Source #
See: newDescribeChannelResponse
smart constructor.
DescribeChannelResponse' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [ResponseOutputItem]) (Maybe ChannelState) (Maybe SlateSource) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeChannelResponse Source #
Create a value of DescribeChannelResponse
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:DescribeChannelResponse'
, describeChannelResponse_creationTime
- The timestamp of when the channel was created.
$sel:arn:DescribeChannelResponse'
, describeChannelResponse_arn
- The ARN of the channel.
$sel:lastModifiedTime:DescribeChannelResponse'
, describeChannelResponse_lastModifiedTime
- The timestamp of when the channel was last modified.
$sel:playbackMode:DescribeChannelResponse'
, describeChannelResponse_playbackMode
- The channel's playback mode.
$sel:channelName:DescribeChannel'
, describeChannelResponse_channelName
- The name of the channel.
$sel:outputs:DescribeChannelResponse'
, describeChannelResponse_outputs
- The channel's output properties.
$sel:channelState:DescribeChannelResponse'
, describeChannelResponse_channelState
- Indicates whether the channel is in a running state or not.
$sel:fillerSlate:DescribeChannelResponse'
, describeChannelResponse_fillerSlate
- Contains information about the slate used to fill gaps between programs
in the schedule.
$sel:tags:DescribeChannelResponse'
, describeChannelResponse_tags
- The tags assigned to the channel.
$sel:httpStatus:DescribeChannelResponse'
, describeChannelResponse_httpStatus
- The response's http status code.
ListVodSources (Paginated)
data ListVodSources Source #
See: newListVodSources
smart constructor.
Instances
Create a value of ListVodSources
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:nextToken:ListVodSources'
, listVodSources_nextToken
- Pagination token from the GET list request. Use the token to fetch the
next page of results.
$sel:maxResults:ListVodSources'
, listVodSources_maxResults
- Upper bound on number of records to return. The maximum number of
results is 100.
$sel:sourceLocationName:ListVodSources'
, listVodSources_sourceLocationName
- The identifier for the source location you are working on.
data ListVodSourcesResponse Source #
See: newListVodSourcesResponse
smart constructor.
Instances
newListVodSourcesResponse Source #
Create a value of ListVodSourcesResponse
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:items:ListVodSourcesResponse'
, listVodSourcesResponse_items
- Lists the VOD sources.
$sel:nextToken:ListVodSources'
, listVodSourcesResponse_nextToken
- Pagination token from the list request. Use the token to fetch the next
page of results.
$sel:httpStatus:ListVodSourcesResponse'
, listVodSourcesResponse_httpStatus
- The response's http status code.
DescribeProgram
data DescribeProgram Source #
See: newDescribeProgram
smart constructor.
Instances
Create a value of DescribeProgram
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:channelName:DescribeProgram'
, describeProgram_channelName
- The identifier for the channel you are working on.
$sel:programName:DescribeProgram'
, describeProgram_programName
- The identifier for the program you are working on.
data DescribeProgramResponse Source #
See: newDescribeProgramResponse
smart constructor.
DescribeProgramResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [AdBreak]) (Maybe Text) (Maybe POSIX) (Maybe Text) Int |
Instances
newDescribeProgramResponse Source #
Create a value of DescribeProgramResponse
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:DescribeProgramResponse'
, describeProgramResponse_creationTime
- The timestamp of when the program was created.
$sel:sourceLocationName:DescribeProgramResponse'
, describeProgramResponse_sourceLocationName
- The source location name.
$sel:arn:DescribeProgramResponse'
, describeProgramResponse_arn
- The ARN of the program.
$sel:programName:DescribeProgram'
, describeProgramResponse_programName
- The name of the program.
$sel:adBreaks:DescribeProgramResponse'
, describeProgramResponse_adBreaks
- The ad break configuration settings.
$sel:channelName:DescribeProgram'
, describeProgramResponse_channelName
- The name of the channel that the program belongs to.
$sel:scheduledStartTime:DescribeProgramResponse'
, describeProgramResponse_scheduledStartTime
- The date and time that the program is scheduled to start in ISO 8601
format and Coordinated Universal Time (UTC). For example, the value
2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.
$sel:vodSourceName:DescribeProgramResponse'
, describeProgramResponse_vodSourceName
- The name that's used to refer to a VOD source.
$sel:httpStatus:DescribeProgramResponse'
, describeProgramResponse_httpStatus
- The response's http status code.
Types
AccessType
newtype AccessType Source #
pattern AccessType_S3_SIGV4 :: AccessType | |
pattern AccessType_SECRETS_MANAGER_ACCESS_TOKEN :: AccessType |
Instances
ChannelState
newtype ChannelState Source #
pattern ChannelState_RUNNING :: ChannelState | |
pattern ChannelState_STOPPED :: ChannelState |
Instances
MessageType
newtype MessageType Source #
pattern MessageType_SPLICE_INSERT :: MessageType |
Instances
Mode
pattern Mode_BEHIND_LIVE_EDGE :: Mode | |
pattern Mode_OFF :: Mode |
Instances
Operator
pattern Operator_EQUALS :: Operator |
Instances
OriginManifestType
newtype OriginManifestType Source #
pattern OriginManifestType_MULTI_PERIOD :: OriginManifestType | |
pattern OriginManifestType_SINGLE_PERIOD :: OriginManifestType |
Instances
PlaybackMode
newtype PlaybackMode Source #
pattern PlaybackMode_LINEAR :: PlaybackMode | |
pattern PlaybackMode_LOOP :: PlaybackMode |
Instances
RelativePosition
newtype RelativePosition Source #
pattern RelativePosition_AFTER_PROGRAM :: RelativePosition | |
pattern RelativePosition_BEFORE_PROGRAM :: RelativePosition |
Instances
ScheduleEntryType
newtype ScheduleEntryType Source #
pattern ScheduleEntryType_FILLER_SLATE :: ScheduleEntryType | |
pattern ScheduleEntryType_PROGRAM :: ScheduleEntryType |
Instances
Type
Instances
AccessConfiguration
data AccessConfiguration Source #
Access configuration parameters.
See: newAccessConfiguration
smart constructor.
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.
AdBreak
Ad break configuration parameters.
See: newAdBreak
smart constructor.
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.
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.
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.
Alert
Alert configuration parameters.
See: newAlert
smart constructor.
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.
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.
Instances
newAvailMatchingCriteria Source #
:: 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.
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.
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.
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.
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.
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.
Channel
The configuration parameters for a channel.
See: newChannel
smart constructor.
Channel' (Maybe POSIX) (Maybe POSIX) (Maybe SlateSource) (Maybe (HashMap Text Text)) Text Text [ResponseOutputItem] Text Text |
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.
DashConfiguration
data DashConfiguration Source #
The configuration for DASH content.
See: newDashConfiguration
smart constructor.
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.
DashConfigurationForPut
data DashConfigurationForPut Source #
The configuration for DASH PUT operations.
See: newDashConfigurationForPut
smart constructor.
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.
DashPlaylistSettings
data DashPlaylistSettings Source #
Dash manifest configuration parameters.
See: newDashPlaylistSettings
smart constructor.
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.
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.
Instances
Eq DefaultSegmentDeliveryConfiguration Source # | |
Read DefaultSegmentDeliveryConfiguration Source # | |
Show DefaultSegmentDeliveryConfiguration Source # | |
Generic DefaultSegmentDeliveryConfiguration Source # | |
NFData DefaultSegmentDeliveryConfiguration Source # | |
Hashable DefaultSegmentDeliveryConfiguration Source # | |
ToJSON DefaultSegmentDeliveryConfiguration Source # | |
FromJSON DefaultSegmentDeliveryConfiguration Source # | |
type Rep DefaultSegmentDeliveryConfiguration Source # | |
Defined in Amazonka.MediaTailor.Types.DefaultSegmentDeliveryConfiguration type Rep DefaultSegmentDeliveryConfiguration = D1 ('MetaData "DefaultSegmentDeliveryConfiguration" "Amazonka.MediaTailor.Types.DefaultSegmentDeliveryConfiguration" "libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor" 'False) (C1 ('MetaCons "DefaultSegmentDeliveryConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "baseUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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://.
HlsConfiguration
data HlsConfiguration Source #
The configuration for HLS content.
See: newHlsConfiguration
smart constructor.
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.
HlsPlaylistSettings
data HlsPlaylistSettings Source #
HLS playlist configuration parameters.
See: newHlsPlaylistSettings
smart constructor.
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.
HttpConfiguration
data HttpConfiguration Source #
The HTTP configuration for the source location.
See: newHttpConfiguration
smart constructor.
Instances
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://.
HttpPackageConfiguration
data HttpPackageConfiguration Source #
The HTTP package configuration properties for the requested VOD source.
See: newHttpPackageConfiguration
smart constructor.
Instances
newHttpPackageConfiguration Source #
:: 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.
LivePreRollConfiguration
data LivePreRollConfiguration Source #
The configuration for pre-roll ad insertion.
See: newLivePreRollConfiguration
smart constructor.
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.
LogConfiguration
data LogConfiguration Source #
Returns Amazon CloudWatch log settings for a playback configuration.
See: newLogConfiguration
smart constructor.
Instances
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
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.
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.
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.
PlaybackConfiguration' (Maybe Text) (Maybe HlsConfiguration) (Maybe Natural) (Maybe Text) (Maybe AvailSuppression) (Maybe Bumper) (Maybe Text) (Maybe Text) (Maybe DashConfiguration) (Maybe ManifestProcessingRules) (Maybe LogConfiguration) (Maybe LivePreRollConfiguration) (Maybe Text) (Maybe Text) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe CdnConfiguration) |
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.
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.
Instances
newPrefetchConsumption Source #
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.
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.
Instances
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.
PrefetchSchedule
data PrefetchSchedule Source #
A complex type that contains prefetch schedule information.
See: newPrefetchSchedule
smart constructor.
Instances
:: 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.
RequestOutputItem
data RequestOutputItem Source #
The output configuration for this channel.
See: newRequestOutputItem
smart constructor.
Instances
:: 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.
ResponseOutputItem
data ResponseOutputItem Source #
This response includes only the "property" : "type" property.
See: newResponseOutputItem
smart constructor.
Instances
newResponseOutputItem Source #
:: 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.
ScheduleAdBreak
data ScheduleAdBreak Source #
The schedule's ad break properties.
See: newScheduleAdBreak
smart constructor.
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.
ScheduleConfiguration
data ScheduleConfiguration Source #
Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
See: newScheduleConfiguration
smart constructor.
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.
ScheduleEntry
data ScheduleEntry Source #
The properties for a schedule.
See: newScheduleEntry
smart constructor.
ScheduleEntry' (Maybe [ScheduleAdBreak]) (Maybe Integer) (Maybe POSIX) (Maybe ScheduleEntryType) Text Text Text Text Text |
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.
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.
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.
SlateSource
data SlateSource Source #
Slate VOD source configuration.
See: newSlateSource
smart constructor.
SlateSource' (Maybe Text) (Maybe Text) |
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.
SourceLocation
data SourceLocation Source #
This response includes only the "type" : "object" property.
See: newSourceLocation
smart constructor.
SourceLocation' (Maybe POSIX) (Maybe POSIX) (Maybe AccessConfiguration) (Maybe DefaultSegmentDeliveryConfiguration) (Maybe (HashMap Text Text)) Text HttpConfiguration Text |
Instances
:: 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.
SpliceInsertMessage
data SpliceInsertMessage Source #
Splice insert message configuration.
See: newSpliceInsertMessage
smart constructor.
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.
Transition
data Transition Source #
Program transition configuration.
See: newTransition
smart constructor.
Instances
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.
VodSource
VOD source configuration parameters.
See: newVodSource
smart constructor.
VodSource' (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap Text Text)) Text Text [HttpPackageConfiguration] Text |
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.