String 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.
SecretsManagerAccessTokenConfiguration secretsManagerAccessTokenConfiguration
AWS Secrets Manager access token configuration parameters.
String messageType
The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.
Long 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.
SlateSource slate
Ad break slate configuration.
SpliceInsertMessage 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.
Boolean enabled
Enables ad marker passthrough for your configuration.
String alertCode
The code for the alert. For example, NOT_PROCESSED.
String alertMessage
If an alert is generated for a resource, an explanation of the reason for the alert.
Date lastModifiedTime
The timestamp when the alert was last modified.
List<E> relatedResourceArns
The Amazon Resource Names (ARNs) related to this alert.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String 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.
String operator
For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
String 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.
String 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.
String 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.
String 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.
String arn
The ARN of the channel.
String channelName
The name of the channel.
String channelState
Returns the state whether the channel is running or not.
Date creationTime
The timestamp of when the channel was created.
SlateSource fillerSlate
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
Date lastModifiedTime
The timestamp of when the channel was last modified.
List<E> outputs
The channel's output properties.
String 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.
Map<K,V> tags
The tags to assign to the channel.
String tier
The tier for this channel. STANDARD tier channels can contain live programs.
Integer 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
String playbackConfigurationName
The name of the playback configuration.
String channelName
The identifier for the channel you are working on.
SlateSource fillerSlate
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
List<E> outputs
The channel's output properties.
String 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.
Map<K,V> tags
The tags to assign to the channel.
String tier
The tier of the channel.
String arn
The ARN of the channel.
String channelName
The name of the channel.
String channelState
Indicates whether the channel is in a running state or not.
Date creationTime
The timestamp of when the channel was created.
SlateSource fillerSlate
Contains information about the slate used to fill gaps between programs in the schedule.
Date lastModifiedTime
The timestamp of when the channel was last modified.
List<E> outputs
The channel's output properties.
String playbackMode
The channel's playback mode.
Map<K,V> tags
The tags assigned to the channel.
String tier
The channel's tier.
List<E> httpPackageConfigurations
A list of HTTP package configuration parameters for this live source.
String liveSourceName
The identifier for the live source you are working on.
String sourceLocationName
The identifier for the source location you are working on.
Map<K,V> tags
The tags to assign to the live source.
String arn
The ARN of the live source.
Date creationTime
The timestamp that indicates when the live source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The timestamp that indicates when the live source was modified.
String liveSourceName
The name of the live source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the live source.
PrefetchConsumption 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.
String name
The identifier for the playback configuration.
String playbackConfigurationName
The name of the playback configuration.
PrefetchRetrieval 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.
String 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.
String arn
The Amazon Resource Name (ARN) of the prefetch schedule.
PrefetchConsumption 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.
String name
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
String playbackConfigurationName
The name of the playback configuration to create the prefetch schedule for.
PrefetchRetrieval retrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
String streamId
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
List<E> adBreaks
The ad break configuration settings.
String channelName
The identifier for the channel you are working on.
String liveSourceName
The name of the LiveSource for this Program.
String programName
The identifier for the program you are working on.
ScheduleConfiguration scheduleConfiguration
The schedule configuration settings.
String sourceLocationName
The name of the source location.
String vodSourceName
The name that's used to refer to a VOD source.
List<E> adBreaks
The ad break configuration settings.
String arn
The ARN of the program.
String channelName
The name of the channel that the program belongs to.
Date creationTime
The timestamp of when the program was created.
String liveSourceName
The name of the LiveSource for this Program.
String programName
The name of the program.
Date 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.
String sourceLocationName
The source location name.
String vodSourceName
The name that's used to refer to a VOD source.
AccessConfiguration accessConfiguration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The optional configuration for the server that serves segments.
HttpConfiguration httpConfiguration
The source's HTTP package configurations.
List<E> segmentDeliveryConfigurations
A list of the segment delivery configurations associated with this resource.
String sourceLocationName
The identifier for the source location you are working on.
Map<K,V> tags
The tags to assign to the source location.
AccessConfiguration accessConfiguration
The access configuration for the source location.
String arn
The ARN of the source location.
Date creationTime
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The default segment delivery configuration settings.
HttpConfiguration httpConfiguration
The HTTP package configuration settings for the source location.
Date lastModifiedTime
The timestamp that indicates when the source location was last modified.
List<E> segmentDeliveryConfigurations
A list of the segment delivery configurations associated with this resource.
String sourceLocationName
The name of the source location.
Map<K,V> tags
The tags assigned to the source location.
List<E> httpPackageConfigurations
A list of HTTP package configuration parameters for this VOD source.
String sourceLocationName
The identifier for the source location you are working on.
Map<K,V> tags
The tags to assign to the VOD source.
String vodSourceName
The identifier for the VOD source you are working on.
String arn
The ARN of the VOD source.
Date creationTime
The timestamp that indicates when the VOD source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The last modified time of the VOD source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the VOD source.
String vodSourceName
The name of the VOD source.
String manifestEndpointPrefix
The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
String 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.
String 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.
String 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.
String 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.
Integer manifestWindowSeconds
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
Integer 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.
Integer 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.
Integer 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.
String baseUrl
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
String channelName
The identifier for the channel you are working on.
String channelName
The identifier for the channel you are working on.
String name
The identifier for the playback configuration.
String sourceLocationName
The identifier for the source location you are working on.
String channelName
The identifier for the channel you are working on.
String arn
The ARN of the channel.
String channelName
The name of the channel.
String channelState
Indicates whether the channel is in a running state or not.
Date creationTime
The timestamp of when the channel was created.
SlateSource fillerSlate
Contains information about the slate used to fill gaps between programs in the schedule.
Date lastModifiedTime
The timestamp of when the channel was last modified.
List<E> outputs
The channel's output properties.
String playbackMode
The channel's playback mode.
Map<K,V> tags
The tags assigned to the channel.
String tier
The channel's tier.
String arn
The ARN of the live source.
Date creationTime
The timestamp that indicates when the live source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The timestamp that indicates when the live source was modified.
String liveSourceName
The name of the live source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the live source.
List<E> adBreaks
The ad break configuration settings.
String arn
The ARN of the program.
String channelName
The name of the channel that the program belongs to.
Date creationTime
The timestamp of when the program was created.
String liveSourceName
The name of the LiveSource for this Program.
String programName
The name of the program.
Date 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.
String sourceLocationName
The source location name.
String vodSourceName
The name that's used to refer to a VOD source.
String sourceLocationName
The identifier for the source location you are working on.
AccessConfiguration accessConfiguration
The access configuration for the source location.
String arn
The ARN of the source location.
Date creationTime
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The default segment delivery configuration settings.
HttpConfiguration httpConfiguration
The HTTP package configuration settings for the source location.
Date lastModifiedTime
The timestamp that indicates when the source location was last modified.
List<E> segmentDeliveryConfigurations
A list of the segment delivery configurations associated with this resource.
String sourceLocationName
The name of the source location.
Map<K,V> tags
The tags assigned to the source location.
String arn
The ARN of the VOD source.
Date creationTime
The timestamp that indicates when the VOD source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The last modified time of the VOD source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the VOD source.
String vodSourceName
The name of the VOD source.
String channelName
The identifier for the channel you are working on.
String policy
The IAM policy for the channel.
String channelName
The identifier for the channel you are working on.
String durationMinutes
The schedule duration in minutes. The maximum duration is 4320 minutes (three days).
Integer maxResults
Upper bound on number of records to return. The maximum number of results is 100.
String nextToken
Pagination token from the GET list request. Use the token to fetch the next page of results.
String name
The identifier for the playback configuration.
String 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.
AvailSuppression availSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
CdnConfiguration cdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<K,V> configurationAliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfiguration dashConfiguration
The configuration for DASH content.
HlsConfiguration hlsConfiguration
The configuration for HLS content.
LivePreRollConfiguration livePreRollConfiguration
The configuration for pre-roll ad insertion.
LogConfiguration logConfiguration
The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules manifestProcessingRules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
String name
The identifier for the playback configuration.
Integer 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.
String playbackConfigurationArn
The Amazon Resource Name (ARN) for the playback configuration.
String playbackEndpointPrefix
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
String sessionInitializationEndpointPrefix
The URL that the player uses to initialize a session that uses client-side reporting.
String 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.
Map<K,V> tags
The tags assigned to the playback configuration.
String 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.
String videoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
String arn
The Amazon Resource Name (ARN) of the prefetch schedule.
PrefetchConsumption 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.
String name
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
String playbackConfigurationName
The name of the playback configuration to create the prefetch schedule for.
PrefetchRetrieval retrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
String streamId
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
String manifestEndpointPrefix
The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
Integer manifestWindowSeconds
The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.
String baseUrl
The base URL for the source location host server. This string must include the protocol, such as https://.
String path
The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
String sourceGroup
The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
String type
The streaming protocol for this package configuration. Supported values are HLS and DASH.
Integer maxResults
Upper bound on number of records to return. The maximum number of results is 100.
String nextToken
Pagination token from the GET list request. Use the token to fetch the next page of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
Integer maxResults
Upper bound on number of records to return. The maximum number of results is 100.
String nextToken
Pagination token from the GET list request. Use the token to fetch the next page of results.
String sourceLocationName
The identifier for the source location you are working on.
List<E> 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.
String 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.
Integer 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.
String 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.
String playbackConfigurationName
The name of the playback configuration.
String streamId
An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
String resourceArn
The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.
Integer maxResults
Upper bound on number of records to return. The maximum number of results is 100.
String nextToken
Pagination token from the GET list request. Use the token to fetch the next page of results.
String sourceLocationName
The identifier for the source location you are working on.
String 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.
Integer maxDurationSeconds
String arn
The ARN for the live source.
Date creationTime
The timestamp that indicates when the live source was created.
List<E> httpPackageConfigurations
The HTTP package configurations for the live source.
Date lastModifiedTime
The timestamp that indicates when the live source was last modified.
String liveSourceName
The name that's used to refer to a live source.
String sourceLocationName
The name of the source location.
Map<K,V> tags
The tags assigned to the live source.
Integer 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
AdMarkerPassthrough 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.
String 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.
AvailSuppression availSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
CdnConfiguration cdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<K,V> configurationAliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfiguration dashConfiguration
The configuration for a DASH source.
HlsConfiguration hlsConfiguration
The configuration for HLS content.
LivePreRollConfiguration livePreRollConfiguration
The configuration for pre-roll ad insertion.
LogConfiguration logConfiguration
The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules manifestProcessingRules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
String name
The identifier for the playback configuration.
Integer 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.
String playbackConfigurationArn
The Amazon Resource Name (ARN) for the playback configuration.
String playbackEndpointPrefix
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.
String sessionInitializationEndpointPrefix
The URL that the player uses to initialize a session that uses client-side reporting.
String 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.
Map<K,V> tags
The tags to assign to the playback configuration.
String 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.
String videoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
List<E> 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.
Date 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.
Date 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.
Map<K,V> 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.
Date 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.
Date 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.
String arn
The Amazon Resource Name (ARN) of the prefetch schedule.
PrefetchConsumption 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.
String name
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
String playbackConfigurationName
The name of the playback configuration to create the prefetch schedule for.
PrefetchRetrieval retrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
String streamId
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
String 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.
AvailSuppression availSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
CdnConfiguration cdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<K,V> configurationAliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfigurationForPut dashConfiguration
The configuration for DASH content.
LivePreRollConfiguration livePreRollConfiguration
The configuration for pre-roll ad insertion.
ManifestProcessingRules manifestProcessingRules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
String name
The identifier for the playback configuration.
Integer 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.
String 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.
Map<K,V> tags
The tags to assign to the playback configuration.
String 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.
String videoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
String 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.
AvailSuppression availSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
CdnConfiguration cdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<K,V> configurationAliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfiguration dashConfiguration
The configuration for DASH content.
HlsConfiguration hlsConfiguration
The configuration for HLS content.
LivePreRollConfiguration livePreRollConfiguration
The configuration for pre-roll ad insertion.
LogConfiguration logConfiguration
The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules manifestProcessingRules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
String name
The identifier for the playback configuration.
Integer 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.
String playbackConfigurationArn
The Amazon Resource Name (ARN) for the playback configuration.
String playbackEndpointPrefix
The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
String sessionInitializationEndpointPrefix
The URL that the player uses to initialize a session that uses client-side reporting.
String 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.
Map<K,V> tags
The tags assigned to the playback configuration.
String 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.
String videoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
DashPlaylistSettings dashPlaylistSettings
DASH manifest configuration parameters.
HlsPlaylistSettings hlsPlaylistSettings
HLS playlist configuration parameters.
String manifestName
The name of the manifest for the channel. The name appears in the PlaybackUrl.
String sourceGroup
A string used to match which HttpPackageConfiguration is used for each VodSource.
DashPlaylistSettings dashPlaylistSettings
DASH manifest configuration settings.
HlsPlaylistSettings hlsPlaylistSettings
HLS manifest configuration settings.
String manifestName
The name of the manifest for the channel that will appear in the channel output's playback URL.
String playbackUrl
The URL used for playback by content players.
String sourceGroup
A string used to associate a package configuration source group with a channel output.
Long approximateDurationSeconds
The approximate duration of the ad break, in seconds.
Date approximateStartTime
The approximate time that the ad will start playing.
String sourceLocationName
The name of the source location containing the VOD source used for the ad break.
String vodSourceName
The name of the VOD source used for the ad break.
Transition transition
Program transition configurations.
Long approximateDurationSeconds
The approximate duration of this program, in seconds.
Date approximateStartTime
The approximate time that the program will start playing.
String arn
The ARN of the program.
String channelName
The name of the channel that uses this schedule.
String liveSourceName
The name of the live source used for the program.
String programName
The name of the program.
List<E> scheduleAdBreaks
The schedule's ad break properties.
String scheduleEntryType
The type of schedule entry.
Valid values: PROGRAM or FILLER_SLATE.
String sourceLocationName
The name of the source location.
String vodSourceName
The name of the VOD source.
String headerName
The name of the HTTP header used to supply the access token in requests to the source location.
String secretArn
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
String 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.
String baseUrl
The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as https://example.com/some/path. To use a relative URL specify the relative path, such as /some/path*.
String name
A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
AccessConfiguration accessConfiguration
The access configuration for the source location.
String arn
The ARN of the SourceLocation.
Date creationTime
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The default segment delivery configuration.
HttpConfiguration httpConfiguration
The HTTP configuration for the source location.
Date lastModifiedTime
The timestamp that indicates when the source location was last modified.
List<E> segmentDeliveryConfigurations
The segment delivery configurations for the source location.
String sourceLocationName
The name of the source location.
Map<K,V> tags
The tags assigned to the source location.
Integer 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.
Integer 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.
Integer 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.
Integer 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.
String channelName
The identifier for the channel you are working on.
String channelName
The identifier for the channel you are working on.
Long durationMillis
The duration of the live program in seconds.
String relativePosition
The position where this program will be inserted relative to the RelativePosition.
String relativeProgram
The name of the program that this program will be inserted next to, as defined by RelativePosition.
Long scheduledStartTimeMillis
The date and time that the program is scheduled to start, in epoch milliseconds.
String 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.
String channelName
The identifier for the channel you are working on.
SlateSource fillerSlate
The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
List<E> outputs
The channel's output properties.
String arn
The ARN of the channel.
String channelName
The name of the channel.
String channelState
Indicates whether the channel is in a running state or not.
Date creationTime
The timestamp of when the channel was created.
SlateSource fillerSlate
Contains information about the slate used to fill gaps between programs in the schedule.
Date lastModifiedTime
The timestamp of when the channel was last modified.
List<E> outputs
The channel's output properties.
String playbackMode
The channel's playback mode.
Map<K,V> tags
The tags assigned to the channel.
String tier
The channel's tier.
List<E> httpPackageConfigurations
A list of HTTP package configurations for the live source on this account.
String liveSourceName
The identifier for the live source you are working on.
String sourceLocationName
The identifier for the source location you are working on.
String arn
The ARN of the live source.
Date creationTime
The timestamp that indicates when the live source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The timestamp that indicates when the live source was modified.
String liveSourceName
The name of the live source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the live source.
AccessConfiguration accessConfiguration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The optional configuration for the host server that serves segments.
HttpConfiguration httpConfiguration
The HTTP configuration for the source location.
List<E> segmentDeliveryConfigurations
A list of the segment delivery configurations associated with this resource.
String sourceLocationName
The identifier for the source location you are working on.
AccessConfiguration accessConfiguration
The access configuration for the source location.
String arn
The ARN of the source location.
Date creationTime
The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration defaultSegmentDeliveryConfiguration
The default segment delivery configuration settings.
HttpConfiguration httpConfiguration
The HTTP package configuration settings for the source location.
Date lastModifiedTime
The timestamp that indicates when the source location was last modified.
List<E> segmentDeliveryConfigurations
A list of the segment delivery configurations associated with this resource.
String sourceLocationName
The name of the source location.
Map<K,V> tags
The tags assigned to the source location.
List<E> httpPackageConfigurations
A list of HTTP package configurations for the VOD source on this account.
String sourceLocationName
The identifier for the source location you are working on.
String vodSourceName
The identifier for the VOD source you are working on.
String arn
The ARN of the VOD source.
Date creationTime
The timestamp that indicates when the VOD source was created.
List<E> httpPackageConfigurations
The HTTP package configurations.
Date lastModifiedTime
The last modified time of the VOD source.
String sourceLocationName
The name of the source location associated with the VOD source.
Map<K,V> tags
The tags assigned to the VOD source.
String vodSourceName
The name of the VOD source.
String arn
The ARN for the VOD source.
Date creationTime
The timestamp that indicates when the VOD source was created.
List<E> httpPackageConfigurations
The HTTP package configurations for the VOD source.
Date lastModifiedTime
The timestamp that indicates when the VOD source was last modified.
String sourceLocationName
The name of the source location that the VOD source is associated with.
Map<K,V> tags
The tags assigned to the VOD source.
String vodSourceName
The name of the VOD source.
Copyright © 2022. All rights reserved.