libZSservicesZSamazonka-mediatailorZSamazonka-mediatailor
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MediaTailor.Lens

Description

 
Synopsis

Operations

CreateSourceLocation

createSourceLocation_accessConfiguration :: Lens' CreateSourceLocation (Maybe AccessConfiguration) Source #

Access configuration parameters. Configures the type of authentication used to access content from your source location.

createSourceLocation_tags :: Lens' CreateSourceLocation (Maybe (HashMap Text Text)) Source #

The tags to assign to the source location.

createSourceLocation_sourceLocationName :: Lens' CreateSourceLocation Text Source #

The identifier for the source location you are working on.

createSourceLocationResponse_creationTime :: Lens' CreateSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was created.

createSourceLocationResponse_httpConfiguration :: Lens' CreateSourceLocationResponse (Maybe HttpConfiguration) Source #

The HTTP package configuration settings for the source location.

createSourceLocationResponse_lastModifiedTime :: Lens' CreateSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was last modified.

ListPrefetchSchedules

listPrefetchSchedules_nextToken :: Lens' ListPrefetchSchedules (Maybe Text) Source #

(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.

listPrefetchSchedules_maxResults :: Lens' ListPrefetchSchedules (Maybe Natural) Source #

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.

listPrefetchSchedules_streamId :: Lens' ListPrefetchSchedules (Maybe Text) Source #

An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.

listPrefetchSchedulesResponse_items :: Lens' ListPrefetchSchedulesResponse (Maybe [PrefetchSchedule]) Source #

Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.

listPrefetchSchedulesResponse_nextToken :: Lens' ListPrefetchSchedulesResponse (Maybe Text) Source #

The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.

DeletePrefetchSchedule

deletePrefetchSchedule_name :: Lens' DeletePrefetchSchedule Text Source #

The identifier for the playback configuration.

ListAlerts

listAlerts_nextToken :: Lens' ListAlerts (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

listAlerts_maxResults :: Lens' ListAlerts (Maybe Natural) Source #

Upper bound on number of records to return. The maximum number of results is 100.

listAlerts_resourceArn :: Lens' ListAlerts Text Source #

The Amazon Resource Name (ARN) of the resource.

listAlertsResponse_items :: Lens' ListAlertsResponse (Maybe [Alert]) Source #

An array of alerts that are associated with this resource.

listAlertsResponse_nextToken :: Lens' ListAlertsResponse (Maybe Text) Source #

Pagination token from the list request. Use the token to fetch the next page of results.

ListChannels

listChannels_nextToken :: Lens' ListChannels (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

listChannels_maxResults :: Lens' ListChannels (Maybe Natural) Source #

Upper bound on number of records to return. The maximum number of results is 100.

listChannelsResponse_items :: Lens' ListChannelsResponse (Maybe [Channel]) Source #

An array of channels that are associated with this account.

listChannelsResponse_nextToken :: Lens' ListChannelsResponse (Maybe Text) Source #

Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

CreatePrefetchSchedule

createPrefetchSchedule_streamId :: Lens' CreatePrefetchSchedule (Maybe Text) Source #

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.

createPrefetchSchedule_name :: Lens' CreatePrefetchSchedule Text Source #

The identifier for the playback configuration.

createPrefetchSchedule_consumption :: Lens' CreatePrefetchSchedule PrefetchConsumption Source #

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.

createPrefetchSchedule_retrieval :: Lens' CreatePrefetchSchedule PrefetchRetrieval Source #

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.

createPrefetchScheduleResponse_arn :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the prefetch schedule.

createPrefetchScheduleResponse_playbackConfigurationName :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The name of the playback configuration to create the prefetch schedule for.

createPrefetchScheduleResponse_retrieval :: Lens' CreatePrefetchScheduleResponse (Maybe PrefetchRetrieval) Source #

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

createPrefetchScheduleResponse_name :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

createPrefetchScheduleResponse_consumption :: Lens' CreatePrefetchScheduleResponse (Maybe PrefetchConsumption) Source #

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

createPrefetchScheduleResponse_streamId :: Lens' CreatePrefetchScheduleResponse (Maybe Text) Source #

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A comma-separated list of tag key:value pairs.

DeleteChannel

deleteChannel_channelName :: Lens' DeleteChannel Text Source #

The identifier for the channel you are working on.

UpdateChannel

updateChannel_channelName :: Lens' UpdateChannel Text Source #

The identifier for the channel you are working on.

updateChannel_outputs :: Lens' UpdateChannel [RequestOutputItem] Source #

The channel's output properties.

updateChannelResponse_creationTime :: Lens' UpdateChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was created.

updateChannelResponse_lastModifiedTime :: Lens' UpdateChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was last modified.

updateChannelResponse_channelState :: Lens' UpdateChannelResponse (Maybe ChannelState) Source #

Indicates whether the channel is in a running state or not.

updateChannelResponse_fillerSlate :: Lens' UpdateChannelResponse (Maybe SlateSource) Source #

Contains information about the slate used to fill gaps between programs in the schedule.

GetChannelPolicy

getChannelPolicy_channelName :: Lens' GetChannelPolicy Text Source #

The identifier for the channel you are working on.

DescribeVodSource

describeVodSource_sourceLocationName :: Lens' DescribeVodSource Text Source #

The identifier for the source location you are working on.

describeVodSource_vodSourceName :: Lens' DescribeVodSource Text Source #

The identifier for the VOD source you are working on.

describeVodSourceResponse_creationTime :: Lens' DescribeVodSourceResponse (Maybe UTCTime) Source #

The timestamp that indicates when the VOD source was created.

describeVodSourceResponse_sourceLocationName :: Lens' DescribeVodSourceResponse (Maybe Text) Source #

The name of the source location associated with the VOD source.

DescribeSourceLocation

describeSourceLocation_sourceLocationName :: Lens' DescribeSourceLocation Text Source #

The identifier for the source location you are working on.

describeSourceLocationResponse_creationTime :: Lens' DescribeSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was created.

describeSourceLocationResponse_httpConfiguration :: Lens' DescribeSourceLocationResponse (Maybe HttpConfiguration) Source #

The HTTP package configuration settings for the source location.

describeSourceLocationResponse_lastModifiedTime :: Lens' DescribeSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was last modified.

GetPrefetchSchedule

getPrefetchSchedule_name :: Lens' GetPrefetchSchedule Text Source #

The identifier for the playback configuration.

getPrefetchScheduleResponse_arn :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the prefetch schedule.

getPrefetchScheduleResponse_playbackConfigurationName :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

The name of the playback configuration to create the prefetch schedule for.

getPrefetchScheduleResponse_retrieval :: Lens' GetPrefetchScheduleResponse (Maybe PrefetchRetrieval) Source #

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

getPrefetchScheduleResponse_name :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

getPrefetchScheduleResponse_consumption :: Lens' GetPrefetchScheduleResponse (Maybe PrefetchConsumption) Source #

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

getPrefetchScheduleResponse_streamId :: Lens' GetPrefetchScheduleResponse (Maybe Text) Source #

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

CreateProgram

createProgram_adBreaks :: Lens' CreateProgram (Maybe [AdBreak]) Source #

The ad break configuration settings.

createProgram_channelName :: Lens' CreateProgram Text Source #

The identifier for the channel you are working on.

createProgram_programName :: Lens' CreateProgram Text Source #

The identifier for the program you are working on.

createProgram_vodSourceName :: Lens' CreateProgram Text Source #

The name that's used to refer to a VOD source.

createProgramResponse_creationTime :: Lens' CreateProgramResponse (Maybe UTCTime) Source #

The timestamp of when the program was created.

createProgramResponse_channelName :: Lens' CreateProgramResponse (Maybe Text) Source #

The name of the channel that the program belongs to.

createProgramResponse_scheduledStartTime :: Lens' CreateProgramResponse (Maybe UTCTime) Source #

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.

createProgramResponse_vodSourceName :: Lens' CreateProgramResponse (Maybe Text) Source #

The name that's used to refer to a VOD source.

StartChannel

startChannel_channelName :: Lens' StartChannel Text Source #

The identifier for the channel you are working on.

ListPlaybackConfigurations

listPlaybackConfigurations_nextToken :: Lens' ListPlaybackConfigurations (Maybe Text) Source #

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

listPlaybackConfigurationsResponse_items :: Lens' ListPlaybackConfigurationsResponse (Maybe [PlaybackConfiguration]) Source #

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.

listPlaybackConfigurationsResponse_nextToken :: Lens' ListPlaybackConfigurationsResponse (Maybe Text) Source #

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

DeletePlaybackConfiguration

deletePlaybackConfiguration_name :: Lens' DeletePlaybackConfiguration Text Source #

The identifier for the playback configuration.

PutPlaybackConfiguration

putPlaybackConfiguration_personalizationThresholdSeconds :: Lens' PutPlaybackConfiguration (Maybe Natural) Source #

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

putPlaybackConfiguration_availSuppression :: Lens' PutPlaybackConfiguration (Maybe AvailSuppression) Source #

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

putPlaybackConfiguration_bumper :: Lens' PutPlaybackConfiguration (Maybe Bumper) Source #

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

putPlaybackConfiguration_adDecisionServerUrl :: Lens' PutPlaybackConfiguration (Maybe Text) Source #

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

putPlaybackConfiguration_videoContentSourceUrl :: Lens' PutPlaybackConfiguration (Maybe Text) Source #

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

putPlaybackConfiguration_manifestProcessingRules :: Lens' PutPlaybackConfiguration (Maybe ManifestProcessingRules) Source #

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

putPlaybackConfiguration_name :: Lens' PutPlaybackConfiguration (Maybe Text) Source #

The identifier for the playback configuration.

putPlaybackConfiguration_configurationAliases :: Lens' PutPlaybackConfiguration (Maybe (HashMap Text (HashMap Text Text))) Source #

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

putPlaybackConfiguration_transcodeProfileName :: Lens' PutPlaybackConfiguration (Maybe Text) Source #

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

putPlaybackConfiguration_tags :: Lens' PutPlaybackConfiguration (Maybe (HashMap Text Text)) Source #

The tags to assign to the playback configuration.

putPlaybackConfiguration_slateAdUrl :: Lens' PutPlaybackConfiguration (Maybe Text) Source #

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

putPlaybackConfiguration_cdnConfiguration :: Lens' PutPlaybackConfiguration (Maybe CdnConfiguration) Source #

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

putPlaybackConfigurationResponse_playbackEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

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

putPlaybackConfigurationResponse_personalizationThresholdSeconds :: Lens' PutPlaybackConfigurationResponse (Maybe Natural) Source #

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

putPlaybackConfigurationResponse_availSuppression :: Lens' PutPlaybackConfigurationResponse (Maybe AvailSuppression) Source #

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

putPlaybackConfigurationResponse_bumper :: Lens' PutPlaybackConfigurationResponse (Maybe Bumper) Source #

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

putPlaybackConfigurationResponse_adDecisionServerUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

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

putPlaybackConfigurationResponse_videoContentSourceUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

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

putPlaybackConfigurationResponse_manifestProcessingRules :: Lens' PutPlaybackConfigurationResponse (Maybe ManifestProcessingRules) Source #

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

putPlaybackConfigurationResponse_sessionInitializationEndpointPrefix :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

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

putPlaybackConfigurationResponse_configurationAliases :: Lens' PutPlaybackConfigurationResponse (Maybe (HashMap Text (HashMap Text Text))) Source #

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

putPlaybackConfigurationResponse_transcodeProfileName :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

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

putPlaybackConfigurationResponse_slateAdUrl :: Lens' PutPlaybackConfigurationResponse (Maybe Text) Source #

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID 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.

putPlaybackConfigurationResponse_cdnConfiguration :: Lens' PutPlaybackConfigurationResponse (Maybe CdnConfiguration) Source #

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

ListSourceLocations

listSourceLocations_nextToken :: Lens' ListSourceLocations (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

listSourceLocations_maxResults :: Lens' ListSourceLocations (Maybe Natural) Source #

Upper bound on number of records to return. The maximum number of results is 100.

listSourceLocationsResponse_nextToken :: Lens' ListSourceLocationsResponse (Maybe Text) Source #

Pagination token from the list request. Use the token to fetch the next page of results.

UpdateSourceLocation

updateSourceLocation_accessConfiguration :: Lens' UpdateSourceLocation (Maybe AccessConfiguration) Source #

Access configuration parameters. Configures the type of authentication used to access content from your source location.

updateSourceLocation_sourceLocationName :: Lens' UpdateSourceLocation Text Source #

The identifier for the source location you are working on.

updateSourceLocationResponse_creationTime :: Lens' UpdateSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was created.

updateSourceLocationResponse_httpConfiguration :: Lens' UpdateSourceLocationResponse (Maybe HttpConfiguration) Source #

The HTTP package configuration settings for the source location.

updateSourceLocationResponse_lastModifiedTime :: Lens' UpdateSourceLocationResponse (Maybe UTCTime) Source #

The timestamp that indicates when the source location was last modified.

DeleteSourceLocation

deleteSourceLocation_sourceLocationName :: Lens' DeleteSourceLocation Text Source #

The identifier for the source location you are working on.

GetPlaybackConfiguration

getPlaybackConfiguration_name :: Lens' GetPlaybackConfiguration Text Source #

The identifier for the playback configuration.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

DeleteVodSource

deleteVodSource_sourceLocationName :: Lens' DeleteVodSource Text Source #

The identifier for the source location you are working on.

deleteVodSource_vodSourceName :: Lens' DeleteVodSource Text Source #

The identifier for the VOD source you are working on.

UpdateVodSource

updateVodSource_sourceLocationName :: Lens' UpdateVodSource Text Source #

The identifier for the source location you are working on.

updateVodSource_vodSourceName :: Lens' UpdateVodSource Text Source #

The identifier for the VOD source you are working on.

updateVodSource_httpPackageConfigurations :: Lens' UpdateVodSource [HttpPackageConfiguration] Source #

An array of HTTP package configurations for the VOD source on this account.

updateVodSourceResponse_creationTime :: Lens' UpdateVodSourceResponse (Maybe UTCTime) Source #

The timestamp that indicates when the VOD source was created.

updateVodSourceResponse_sourceLocationName :: Lens' UpdateVodSourceResponse (Maybe Text) Source #

The name of the source location associated with the VOD source.

CreateVodSource

createVodSource_tags :: Lens' CreateVodSource (Maybe (HashMap Text Text)) Source #

The tags to assign to the VOD source.

createVodSource_sourceLocationName :: Lens' CreateVodSource Text Source #

The identifier for the source location you are working on.

createVodSource_vodSourceName :: Lens' CreateVodSource Text Source #

The identifier for the VOD source you are working on.

createVodSource_httpPackageConfigurations :: Lens' CreateVodSource [HttpPackageConfiguration] Source #

An array of HTTP package configuration parameters for this VOD source.

createVodSourceResponse_creationTime :: Lens' CreateVodSourceResponse (Maybe UTCTime) Source #

The timestamp that indicates when the VOD source was created.

createVodSourceResponse_sourceLocationName :: Lens' CreateVodSourceResponse (Maybe Text) Source #

The name of the source location associated with the VOD source.

CreateChannel

createChannel_fillerSlate :: Lens' CreateChannel (Maybe SlateSource) Source #

The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses a LINEAR PlaybackMode.

createChannel_tags :: Lens' CreateChannel (Maybe (HashMap Text Text)) Source #

The tags to assign to the channel.

createChannel_channelName :: Lens' CreateChannel Text Source #

The identifier for the channel you are working on.

createChannel_outputs :: Lens' CreateChannel [RequestOutputItem] Source #

The channel's output properties.

createChannel_playbackMode :: Lens' CreateChannel PlaybackMode Source #

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.

createChannelResponse_creationTime :: Lens' CreateChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was created.

createChannelResponse_lastModifiedTime :: Lens' CreateChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was last modified.

createChannelResponse_channelState :: Lens' CreateChannelResponse (Maybe ChannelState) Source #

Indicates whether the channel is in a running state or not.

createChannelResponse_fillerSlate :: Lens' CreateChannelResponse (Maybe SlateSource) Source #

Contains information about the slate used to fill gaps between programs in the schedule.

DeleteChannelPolicy

deleteChannelPolicy_channelName :: Lens' DeleteChannelPolicy Text Source #

The identifier for the channel you are working on.

PutChannelPolicy

putChannelPolicy_channelName :: Lens' PutChannelPolicy Text Source #

The identifier for the channel you are working on.

putChannelPolicy_policy :: Lens' PutChannelPolicy Text Source #

Adds an IAM role that determines the permissions of your channel.

DeleteProgram

deleteProgram_channelName :: Lens' DeleteProgram Text Source #

The identifier for the channel you are working on.

deleteProgram_programName :: Lens' DeleteProgram Text Source #

The identifier for the program you are working on.

GetChannelSchedule

getChannelSchedule_nextToken :: Lens' GetChannelSchedule (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

getChannelSchedule_durationMinutes :: Lens' GetChannelSchedule (Maybe Text) Source #

The schedule duration in minutes. The maximum duration is 4320 minutes (three days).

getChannelSchedule_maxResults :: Lens' GetChannelSchedule (Maybe Natural) Source #

Upper bound on number of records to return. The maximum number of results is 100.

getChannelSchedule_channelName :: Lens' GetChannelSchedule Text Source #

The identifier for the channel you are working on.

getChannelScheduleResponse_nextToken :: Lens' GetChannelScheduleResponse (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A comma-separated list of tag key:value pairs.

ConfigureLogsForPlaybackConfiguration

configureLogsForPlaybackConfiguration_percentEnabled :: Lens' ConfigureLogsForPlaybackConfiguration Int Source #

The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

Valid values: 0 - 100

configureLogsForPlaybackConfigurationResponse_percentEnabled :: Lens' ConfigureLogsForPlaybackConfigurationResponse (Maybe Int) Source #

The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.

StopChannel

stopChannel_channelName :: Lens' StopChannel Text Source #

The identifier for the channel you are working on.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A comma-separated list of the tag keys to remove from the playback configuration.

DescribeChannel

describeChannel_channelName :: Lens' DescribeChannel Text Source #

The identifier for the channel you are working on.

describeChannelResponse_creationTime :: Lens' DescribeChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was created.

describeChannelResponse_lastModifiedTime :: Lens' DescribeChannelResponse (Maybe UTCTime) Source #

The timestamp of when the channel was last modified.

describeChannelResponse_channelState :: Lens' DescribeChannelResponse (Maybe ChannelState) Source #

Indicates whether the channel is in a running state or not.

describeChannelResponse_fillerSlate :: Lens' DescribeChannelResponse (Maybe SlateSource) Source #

Contains information about the slate used to fill gaps between programs in the schedule.

ListVodSources

listVodSources_nextToken :: Lens' ListVodSources (Maybe Text) Source #

Pagination token from the GET list request. Use the token to fetch the next page of results.

listVodSources_maxResults :: Lens' ListVodSources (Maybe Natural) Source #

Upper bound on number of records to return. The maximum number of results is 100.

listVodSources_sourceLocationName :: Lens' ListVodSources Text Source #

The identifier for the source location you are working on.

listVodSourcesResponse_nextToken :: Lens' ListVodSourcesResponse (Maybe Text) Source #

Pagination token from the list request. Use the token to fetch the next page of results.

DescribeProgram

describeProgram_channelName :: Lens' DescribeProgram Text Source #

The identifier for the channel you are working on.

describeProgram_programName :: Lens' DescribeProgram Text Source #

The identifier for the program you are working on.

describeProgramResponse_creationTime :: Lens' DescribeProgramResponse (Maybe UTCTime) Source #

The timestamp of when the program was created.

describeProgramResponse_channelName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name of the channel that the program belongs to.

describeProgramResponse_scheduledStartTime :: Lens' DescribeProgramResponse (Maybe UTCTime) Source #

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.

describeProgramResponse_vodSourceName :: Lens' DescribeProgramResponse (Maybe Text) Source #

The name that's used to refer to a VOD source.

Types

AccessConfiguration

accessConfiguration_accessType :: Lens' AccessConfiguration (Maybe AccessType) Source #

The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

AdBreak

adBreak_spliceInsertMessage :: Lens' AdBreak (Maybe SpliceInsertMessage) Source #

This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

adBreak_messageType :: Lens' AdBreak (Maybe MessageType) Source #

The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.

adBreak_slate :: Lens' AdBreak (Maybe SlateSource) Source #

Ad break slate configuration.

adBreak_offsetMillis :: Lens' AdBreak (Maybe Integer) Source #

How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

AdMarkerPassthrough

adMarkerPassthrough_enabled :: Lens' AdMarkerPassthrough (Maybe Bool) Source #

Enables ad marker passthrough for your configuration.

Alert

alert_resourceArn :: Lens' Alert Text Source #

The Amazon Resource Name (ARN) of the resource.

alert_alertCode :: Lens' Alert Text Source #

The code for the alert. For example, NOT_PROCESSED.

alert_lastModifiedTime :: Lens' Alert UTCTime Source #

The timestamp when the alert was last modified.

alert_relatedResourceArns :: Lens' Alert [Text] Source #

The Amazon Resource Names (ARNs) related to this alert.

alert_alertMessage :: Lens' Alert Text Source #

If an alert is generated for a resource, an explanation of the reason for the alert.

AvailMatchingCriteria

availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator Source #

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text Source #

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

AvailSuppression

availSuppression_value :: Lens' AvailSuppression (Maybe Text) Source #

A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

availSuppression_mode :: Lens' AvailSuppression (Maybe Mode) Source #

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.

Bumper

bumper_endUrl :: Lens' Bumper (Maybe Text) Source #

The URL for the end bumper asset.

bumper_startUrl :: Lens' Bumper (Maybe Text) Source #

The URL for the start bumper asset.

CdnConfiguration

cdnConfiguration_adSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text) Source #

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

cdnConfiguration_contentSegmentUrlPrefix :: Lens' CdnConfiguration (Maybe Text) Source #

A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

Channel

channel_creationTime :: Lens' Channel (Maybe UTCTime) Source #

The timestamp of when the channel was created.

channel_lastModifiedTime :: Lens' Channel (Maybe UTCTime) Source #

The timestamp of when the channel was last modified.

channel_fillerSlate :: Lens' Channel (Maybe SlateSource) Source #

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

channel_tags :: Lens' Channel (Maybe (HashMap Text Text)) Source #

The tags to assign to the channel.

channel_channelState :: Lens' Channel Text Source #

Returns the state whether the channel is running or not.

channel_channelName :: Lens' Channel Text Source #

The name of the channel.

channel_outputs :: Lens' Channel [ResponseOutputItem] Source #

The channel's output properties.

channel_arn :: Lens' Channel Text Source #

The ARN of the channel.

channel_playbackMode :: Lens' Channel Text Source #

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

DashConfiguration

dashConfiguration_manifestEndpointPrefix :: Lens' DashConfiguration (Maybe Text) Source #

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

dashConfiguration_originManifestType :: Lens' DashConfiguration (Maybe OriginManifestType) Source #

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

dashConfiguration_mpdLocation :: Lens' DashConfiguration (Maybe Text) Source #

The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

DashConfigurationForPut

dashConfigurationForPut_originManifestType :: Lens' DashConfigurationForPut (Maybe OriginManifestType) Source #

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

dashConfigurationForPut_mpdLocation :: Lens' DashConfigurationForPut (Maybe Text) Source #

The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

DashPlaylistSettings

dashPlaylistSettings_minBufferTimeSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #

Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.

dashPlaylistSettings_minUpdatePeriodSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #

Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

dashPlaylistSettings_suggestedPresentationDelaySeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #

Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.

dashPlaylistSettings_manifestWindowSeconds :: Lens' DashPlaylistSettings (Maybe Int) Source #

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

DefaultSegmentDeliveryConfiguration

defaultSegmentDeliveryConfiguration_baseUrl :: Lens' DefaultSegmentDeliveryConfiguration (Maybe Text) Source #

The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.

HlsConfiguration

hlsConfiguration_manifestEndpointPrefix :: Lens' HlsConfiguration (Maybe Text) Source #

The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

HlsPlaylistSettings

hlsPlaylistSettings_manifestWindowSeconds :: Lens' HlsPlaylistSettings (Maybe Int) Source #

The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.

HttpConfiguration

httpConfiguration_baseUrl :: Lens' HttpConfiguration Text Source #

The base URL for the source location host server. This string must include the protocol, such as https://.

HttpPackageConfiguration

httpPackageConfiguration_path :: Lens' HttpPackageConfiguration Text Source #

The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.

httpPackageConfiguration_type :: Lens' HttpPackageConfiguration Type Source #

The streaming protocol for this package configuration. Supported values are HLS and DASH.

httpPackageConfiguration_sourceGroup :: Lens' HttpPackageConfiguration Text Source #

The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.

LivePreRollConfiguration

livePreRollConfiguration_adDecisionServerUrl :: Lens' LivePreRollConfiguration (Maybe Text) Source #

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

livePreRollConfiguration_maxDurationSeconds :: Lens' LivePreRollConfiguration (Maybe Int) Source #

The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.

LogConfiguration

logConfiguration_percentEnabled :: Lens' LogConfiguration Int Source #

The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to 60, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the debug log mode.

Valid values: 0 - 100

ManifestProcessingRules

manifestProcessingRules_adMarkerPassthrough :: Lens' ManifestProcessingRules (Maybe AdMarkerPassthrough) Source #

For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.

No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.

PlaybackConfiguration

playbackConfiguration_playbackEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text) Source #

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.

playbackConfiguration_personalizationThresholdSeconds :: Lens' PlaybackConfiguration (Maybe Natural) Source #

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

playbackConfiguration_playbackConfigurationArn :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_availSuppression :: Lens' PlaybackConfiguration (Maybe AvailSuppression) Source #

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

playbackConfiguration_bumper :: Lens' PlaybackConfiguration (Maybe Bumper) Source #

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

playbackConfiguration_adDecisionServerUrl :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_videoContentSourceUrl :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_manifestProcessingRules :: Lens' PlaybackConfiguration (Maybe ManifestProcessingRules) Source #

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

playbackConfiguration_logConfiguration :: Lens' PlaybackConfiguration (Maybe LogConfiguration) Source #

The Amazon CloudWatch log settings for a playback configuration.

playbackConfiguration_name :: Lens' PlaybackConfiguration (Maybe Text) Source #

The identifier for the playback configuration.

playbackConfiguration_sessionInitializationEndpointPrefix :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_configurationAliases :: Lens' PlaybackConfiguration (Maybe (HashMap Text (HashMap Text Text))) Source #

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

playbackConfiguration_transcodeProfileName :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_tags :: Lens' PlaybackConfiguration (Maybe (HashMap Text Text)) Source #

The tags to assign to the playback configuration.

playbackConfiguration_slateAdUrl :: Lens' PlaybackConfiguration (Maybe Text) Source #

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

playbackConfiguration_cdnConfiguration :: Lens' PlaybackConfiguration (Maybe CdnConfiguration) Source #

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

PrefetchConsumption

prefetchConsumption_startTime :: Lens' PrefetchConsumption (Maybe UTCTime) Source #

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

prefetchConsumption_availMatchingCriteria :: Lens' PrefetchConsumption (Maybe [AvailMatchingCriteria]) Source #

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

prefetchConsumption_endTime :: Lens' PrefetchConsumption UTCTime Source #

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

PrefetchRetrieval

prefetchRetrieval_startTime :: Lens' PrefetchRetrieval (Maybe UTCTime) Source #

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

prefetchRetrieval_dynamicVariables :: Lens' PrefetchRetrieval (Maybe (HashMap Text Text)) Source #

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

prefetchRetrieval_endTime :: Lens' PrefetchRetrieval UTCTime Source #

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

PrefetchSchedule

prefetchSchedule_streamId :: Lens' PrefetchSchedule (Maybe Text) Source #

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

prefetchSchedule_retrieval :: Lens' PrefetchSchedule PrefetchRetrieval Source #

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

prefetchSchedule_consumption :: Lens' PrefetchSchedule PrefetchConsumption Source #

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

prefetchSchedule_arn :: Lens' PrefetchSchedule Text Source #

The Amazon Resource Name (ARN) of the prefetch schedule.

prefetchSchedule_playbackConfigurationName :: Lens' PrefetchSchedule Text Source #

The name of the playback configuration to create the prefetch schedule for.

prefetchSchedule_name :: Lens' PrefetchSchedule Text Source #

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

RequestOutputItem

requestOutputItem_manifestName :: Lens' RequestOutputItem Text Source #

The name of the manifest for the channel. The name appears in the PlaybackUrl.

requestOutputItem_sourceGroup :: Lens' RequestOutputItem Text Source #

A string used to match which HttpPackageConfiguration is used for each VodSource.

ResponseOutputItem

responseOutputItem_manifestName :: Lens' ResponseOutputItem Text Source #

The name of the manifest for the channel that will appear in the channel output's playback URL.

responseOutputItem_playbackUrl :: Lens' ResponseOutputItem Text Source #

The URL used for playback by content players.

responseOutputItem_sourceGroup :: Lens' ResponseOutputItem Text Source #

A string used to associate a package configuration source group with a channel output.

ScheduleAdBreak

scheduleAdBreak_sourceLocationName :: Lens' ScheduleAdBreak (Maybe Text) Source #

The name of the source location containing the VOD source used for the ad break.

scheduleAdBreak_approximateDurationSeconds :: Lens' ScheduleAdBreak (Maybe Integer) Source #

The approximate duration of the ad break, in seconds.

scheduleAdBreak_vodSourceName :: Lens' ScheduleAdBreak (Maybe Text) Source #

The name of the VOD source used for the ad break.

scheduleAdBreak_approximateStartTime :: Lens' ScheduleAdBreak (Maybe UTCTime) Source #

The approximate time that the ad will start playing.

ScheduleConfiguration

ScheduleEntry

scheduleEntry_approximateDurationSeconds :: Lens' ScheduleEntry (Maybe Integer) Source #

The approximate duration of this program, in seconds.

scheduleEntry_approximateStartTime :: Lens' ScheduleEntry (Maybe UTCTime) Source #

The approximate time that the program will start playing.

scheduleEntry_scheduleEntryType :: Lens' ScheduleEntry (Maybe ScheduleEntryType) Source #

The type of schedule entry.

Valid values: PROGRAM or FILLER_SLATE.

scheduleEntry_channelName :: Lens' ScheduleEntry Text Source #

The name of the channel that uses this schedule.

scheduleEntry_arn :: Lens' ScheduleEntry Text Source #

The ARN of the program.

SecretsManagerAccessTokenConfiguration

secretsManagerAccessTokenConfiguration_headerName :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #

The name of the HTTP header used to supply the access token in requests to the source location.

secretsManagerAccessTokenConfiguration_secretStringKey :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #

The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.

secretsManagerAccessTokenConfiguration_secretArn :: Lens' SecretsManagerAccessTokenConfiguration (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.

SlateSource

slateSource_sourceLocationName :: Lens' SlateSource (Maybe Text) Source #

The name of the source location where the slate VOD source is stored.

slateSource_vodSourceName :: Lens' SlateSource (Maybe Text) Source #

The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.

SourceLocation

sourceLocation_creationTime :: Lens' SourceLocation (Maybe UTCTime) Source #

The timestamp that indicates when the source location was created.

sourceLocation_lastModifiedTime :: Lens' SourceLocation (Maybe UTCTime) Source #

The timestamp that indicates when the source location was last modified.

sourceLocation_accessConfiguration :: Lens' SourceLocation (Maybe AccessConfiguration) Source #

The access configuration for the source location.

sourceLocation_tags :: Lens' SourceLocation (Maybe (HashMap Text Text)) Source #

The tags assigned to the source location.

sourceLocation_httpConfiguration :: Lens' SourceLocation HttpConfiguration Source #

The HTTP configuration for the source location.

sourceLocation_arn :: Lens' SourceLocation Text Source #

The ARN of the SourceLocation.

SpliceInsertMessage

spliceInsertMessage_availNum :: Lens' SpliceInsertMessage (Maybe Int) Source #

This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

spliceInsertMessage_uniqueProgramId :: Lens' SpliceInsertMessage (Maybe Int) Source #

This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

spliceInsertMessage_availsExpected :: Lens' SpliceInsertMessage (Maybe Int) Source #

This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.

spliceInsertMessage_spliceEventId :: Lens' SpliceInsertMessage (Maybe Int) Source #

This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.

Transition

transition_scheduledStartTimeMillis :: Lens' Transition (Maybe Integer) Source #

The date and time that the program is scheduled to start, in epoch milliseconds.

transition_relativeProgram :: Lens' Transition (Maybe Text) Source #

The name of the program that this program will be inserted next to, as defined by RelativePosition.

transition_type :: Lens' Transition Text Source #

Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.

ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.

Note the following considerations when using ABSOLUTE transitions:

If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.

If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.

RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.

transition_relativePosition :: Lens' Transition RelativePosition Source #

The position where this program will be inserted relative to the RelativePosition.

VodSource

vodSource_creationTime :: Lens' VodSource (Maybe UTCTime) Source #

The timestamp that indicates when the VOD source was created.

vodSource_lastModifiedTime :: Lens' VodSource (Maybe UTCTime) Source #

The timestamp that indicates when the VOD source was last modified.

vodSource_tags :: Lens' VodSource (Maybe (HashMap Text Text)) Source #

The tags assigned to the VOD source.

vodSource_vodSourceName :: Lens' VodSource Text Source #

The name of the VOD source.

vodSource_sourceLocationName :: Lens' VodSource Text Source #

The name of the source location that the VOD source is associated with.

vodSource_httpPackageConfigurations :: Lens' VodSource [HttpPackageConfiguration] Source #

The HTTP package configurations for the VOD source.

vodSource_arn :: Lens' VodSource Text Source #

The ARN for the VOD source.