Expand description
Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.
Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).
If you’re using the service, you’re probably looking for MediaTailorClient and MediaTailor.
Structs§
- Access
Configuration Access configuration parameters.
- AdBreak
Ad break configuration parameters.
- AdMarker
Passthrough 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.
- Avail
Suppression The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- 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
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- Channel
The configuration parameters for a channel.
- Create
Channel Request - Create
Channel Response - Create
Program Request - Create
Program Response - Create
Source Location Request - Create
Source Location Response - Create
VodSource Request - Create
VodSource Response - Dash
Configuration The configuration for DASH content.
- Dash
Configuration ForPut The configuration for DASH PUT operations.
- Dash
Playlist Settings Dash manifest configuration parameters.
- Default
Segment Delivery Configuration The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.
- Delete
Channel Policy Request - Delete
Channel Policy Response - Delete
Channel Request - Delete
Channel Response - Delete
Playback Configuration Request - Delete
Playback Configuration Response - Delete
Program Request - Delete
Program Response - Delete
Source Location Request - Delete
Source Location Response - Delete
VodSource Request - Delete
VodSource Response - Describe
Channel Request - Describe
Channel Response - Describe
Program Request - Describe
Program Response - Describe
Source Location Request - Describe
Source Location Response - Describe
VodSource Request - Describe
VodSource Response - GetChannel
Policy Request - GetChannel
Policy Response - GetChannel
Schedule Request - GetChannel
Schedule Response - GetPlayback
Configuration Request - GetPlayback
Configuration Response - HlsConfiguration
The configuration for HLS content.
- HlsPlaylist
Settings HLS playlist configuration parameters.
- Http
Configuration The HTTP configuration for the source location.
- Http
Package Configuration The HTTP package configuration properties for the requested VOD source.
- List
Channels Request - List
Channels Response - List
Playback Configurations Request - List
Playback Configurations Response - List
Source Locations Request - List
Source Locations Response - List
Tags ForResource Request - List
Tags ForResource Response - List
VodSources Request - List
VodSources Response - Live
PreRoll Configuration The configuration for pre-roll ad insertion.
- Manifest
Processing Rules The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Media
Tailor Client - A client for the MediaTailor API.
- Playback
Configuration Creates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor.
- PutChannel
Policy Request - PutChannel
Policy Response - PutPlayback
Configuration Request - PutPlayback
Configuration Response - Request
Output Item The ouput configuration for this channel.
- Response
Output Item This response includes only the "property" : "type" property.
- Schedule
AdBreak The schedule's ad break properties.
- Schedule
Configuration Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
- Schedule
Entry The properties for a schedule.
- Secrets
Manager Access Token Configuration AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
- Slate
Source Slate VOD source configuration.
- Source
Location This response includes only the "type" : "object" property.
- Splice
Insert Message Splice insert message configuration.
- Start
Channel Request - Start
Channel Response - Stop
Channel Request - Stop
Channel Response - TagResource
Request - Transition
Program transition configuration.
- Untag
Resource Request - Update
Channel Request - Update
Channel Response - Update
Source Location Request - Update
Source Location Response - Update
VodSource Request - Update
VodSource Response - VodSource
VOD source configuration parameters.
Enums§
- Create
Channel Error - Errors returned by CreateChannel
- Create
Program Error - Errors returned by CreateProgram
- Create
Source Location Error - Errors returned by CreateSourceLocation
- Create
VodSource Error - Errors returned by CreateVodSource
- Delete
Channel Error - Errors returned by DeleteChannel
- Delete
Channel Policy Error - Errors returned by DeleteChannelPolicy
- Delete
Playback Configuration Error - Errors returned by DeletePlaybackConfiguration
- Delete
Program Error - Errors returned by DeleteProgram
- Delete
Source Location Error - Errors returned by DeleteSourceLocation
- Delete
VodSource Error - Errors returned by DeleteVodSource
- Describe
Channel Error - Errors returned by DescribeChannel
- Describe
Program Error - Errors returned by DescribeProgram
- Describe
Source Location Error - Errors returned by DescribeSourceLocation
- Describe
VodSource Error - Errors returned by DescribeVodSource
- GetChannel
Policy Error - Errors returned by GetChannelPolicy
- GetChannel
Schedule Error - Errors returned by GetChannelSchedule
- GetPlayback
Configuration Error - Errors returned by GetPlaybackConfiguration
- List
Channels Error - Errors returned by ListChannels
- List
Playback Configurations Error - Errors returned by ListPlaybackConfigurations
- List
Source Locations Error - Errors returned by ListSourceLocations
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
VodSources Error - Errors returned by ListVodSources
- PutChannel
Policy Error - Errors returned by PutChannelPolicy
- PutPlayback
Configuration Error - Errors returned by PutPlaybackConfiguration
- Start
Channel Error - Errors returned by StartChannel
- Stop
Channel Error - Errors returned by StopChannel
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Channel Error - Errors returned by UpdateChannel
- Update
Source Location Error - Errors returned by UpdateSourceLocation
- Update
VodSource Error - Errors returned by UpdateVodSource
Traits§
- Media
Tailor - Trait representing the capabilities of the MediaTailor API. MediaTailor clients implement this trait.