Amazon Web Services, Inc.

AWS MediaTailor

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 48

Channel

  • PUTConfigure logs for channel/configureLogs/channelConfigures Amazon CloudWatch log settings for a channel.
  • GETDescribe channel/channel/:ChannelNameDescribes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
  • PUTUpdate channel/channel/:ChannelNameUpdates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
  • POSTCreate channel/channel/:ChannelNameCreates a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
  • DELETEDelete channel/channel/:ChannelNameDeletes a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
  • GETGet channel schedule/channel/:ChannelName/schedule?durationMinutes=string&maxResults=0&nextToken=string&audience=stringRetrieves information about your channel's schedule.
  • GETList channels/channels?maxResults=0&nextToken=stringRetrieves information about the channels that are associated with the current AWS account.
  • PUTStart channel/channel/:ChannelName/startStarts a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .
  • PUTStop channel/channel/:ChannelName/stopStops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide .

Live source

  • GETDescribe live source/sourceLocation/:SourceLocationName/liveSource/:LiveSourceNameThe live source to describe.
  • PUTUpdate live source/sourceLocation/:SourceLocationName/liveSource/:LiveSourceNameUpdates a live source's configuration.
  • POSTCreate live source/sourceLocation/:SourceLocationName/liveSource/:LiveSourceNameThe live source configuration.
  • DELETEDelete live source/sourceLocation/:SourceLocationName/liveSource/:LiveSourceNameThe live source to delete.
  • GETList live sources/sourceLocation/:SourceLocationName/liveSources?maxResults=0&nextToken=stringLists the live sources contained in a source location. A source represents a piece of content.

Prefetch schedule

  • GETGet prefetch schedule/prefetchSchedule/:PlaybackConfigurationName/:NameRetrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad…
  • POSTCreate prefetch schedule/prefetchSchedule/:PlaybackConfigurationName/:NameCreates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad…
  • DELETEDelete prefetch schedule/prefetchSchedule/:PlaybackConfigurationName/:NameDeletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an…
  • POSTList prefetch schedules/prefetchSchedule/:PlaybackConfigurationNameLists the prefetch schedules for a playback configuration.

Program

  • GETDescribe program/channel/:ChannelName/program/:ProgramNameDescribes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide .
  • PUTUpdate program/channel/:ChannelName/program/:ProgramNameUpdates a program within a channel.
  • POSTCreate program/channel/:ChannelName/program/:ProgramNameCreates a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide .
  • DELETEDelete program/channel/:ChannelName/program/:ProgramNameDeletes a program within a channel. For information about programs, see Working with programs in the MediaTailor User Guide .

Source location

  • GETDescribe source location/sourceLocation/:SourceLocationNameDescribes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in…
  • PUTUpdate source location/sourceLocation/:SourceLocationNameUpdates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the…
  • POSTCreate source location/sourceLocation/:SourceLocationNameCreates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the…
  • DELETEDelete source location/sourceLocation/:SourceLocationNameDeletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the…
  • GETList source locations/sourceLocations?maxResults=0&nextToken=stringLists the source locations for a channel. A source location defines the host server URL, and contains a list of sources.

Vod source

  • GETDescribe vod source/sourceLocation/:SourceLocationName/vodSource/:VodSourceNameProvides details about a specific video on demand (VOD) source in a specific source location.
  • PUTUpdate vod source/sourceLocation/:SourceLocationName/vodSource/:VodSourceNameUpdates a VOD source's configuration.
  • POSTCreate vod source/sourceLocation/:SourceLocationName/vodSource/:VodSourceNameThe VOD source configuration parameters.
  • DELETEDelete vod source/sourceLocation/:SourceLocationName/vodSource/:VodSourceNameThe video on demand (VOD) source to delete.
  • GETList vod sources/sourceLocation/:SourceLocationName/vodSources?maxResults=0&nextToken=stringLists the VOD sources contained in a source location. A source represents a piece of content.

Channel policy

  • GETGet channel policy/channel/:ChannelName/policyReturns the channel's IAM policy. IAM policies are used to control access to your channel.
  • PUTPut channel policy/channel/:ChannelName/policyCreates an IAM policy for the channel. IAM policies are used to control access to your channel.
  • DELETEDelete channel policy/channel/:ChannelName/policyThe channel policy to delete.

Function

  • GETGet function/function/:FunctionIdRetrieves the configuration and metadata for a function. For more information about functions, see Working with functions in the MediaTailor User Guide .
  • PUTPut function/function/:FunctionIdCreates or updates a function. A function defines reusable logic that MediaTailor executes at lifecycle hooks during ad insertion. For more information about…
  • DELETEDelete function/function/:FunctionIdDeletes a function. MediaTailor prevents deletion of a function that is still referenced by a playback configuration or by another function. Remove all…
  • GETList functions/functions?MaxResults=0&NextToken=stringRetrieves all functions associated with your AWS account in the current Region. For more information about functions, see Working with functions in the…

Playback configuration

  • GETGet playback configuration/playbackConfiguration/:NameRetrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor .
  • DELETEDelete playback configuration/playbackConfiguration/:NameDeletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor .
  • GETList playback configurations/playbackConfigurations?MaxResults=0&NextToken=stringRetrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor .
  • PUTPut playback configuration/playbackConfigurationCreates a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor .
  • PUTConfigure logs for playback configuration/configureLogs/playbackConfigurationDefines where AWS Elemental MediaTailor sends logs for the playback configuration.
  • GETList alerts/alerts?maxResults=0&nextToken=string&resourceArn=stringLists the alerts that are associated with a MediaTailor channel assembly resource.
  • GETList tags for resource/tags/:ResourceArnA list of tags that are associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access…
  • POSTTag resource/tags/:ResourceArnThe resource to tag. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For…
  • DELETEUntag resource/tags/:ResourceArn?tagKeys=The resource to untag.

API details

Base URL
https://api.mediatailor.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
48 operations on 24 pathsGET 18PUT 12DELETE 10POST 8
Main resources
Channel 9Live source 5Source location 5Vod source 5Function 4Playback configuration 4Prefetch schedule 4Program 4Channel policy 3
Description format
AWS Smithy model, API version 2018-04-23

How to test the AWS MediaTailor in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS MediaTailor collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Configure logs for channel” (PUT /configureLogs/channel), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS MediaTailor?

Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content… It is listed under Developer tools and has 48 endpoints.

Who publishes the AWS MediaTailor?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS MediaTailor?

Requests go to https://api.mediatailor.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS MediaTailor?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS MediaTailor have?

48 operations on 24 paths (18 GET, 12 PUT, 10 DELETE, 8 POST). The largest groups are Channel, Live source, Source location, Vod source.

Is forking the AWS MediaTailor free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.