AWS Elemental MediaTailor is a channel assembly and personalized ad-insertion service that enables you to monetize your video content with server-side targeted advertising while maintaining broadcast-quality.
openapi: 3.0.0
info:
version: 2018-04-23
x-release: v4
title: AWS MediaTailor
description: <p>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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>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).</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: "#FFFFFF"
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: [email protected]
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: mediatailor
x-aws-signingName: mediatailor
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/mediatailor-2018-04-23.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/mediatailor/
servers:
- url: http://api.mediatailor.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaTailor multi-region endpoint
- url: https://api.mediatailor.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The MediaTailor multi-region endpoint
- url: http://api.mediatailor.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaTailor endpoint for China (Beijing) and China (Ningxia)
- url: https://api.mediatailor.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The MediaTailor endpoint for China (Beijing) and China (Ningxia)
x-hasEquivalentPaths: true
paths:
/configureLogs/channel:
put:
operationId: ConfigureLogsForChannel
description: Configures Amazon CloudWatch log settings for a channel.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigureLogsForChannelResponse"
examples:
ConfigureLogsForChannel200Example:
summary: Default ConfigureLogsForChannel 200 response
x-microcks-default: true
value:
ChannelName: example-resource
LogTypes: STANDARD
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ChannelName
- LogTypes
properties:
ChannelName:
description: The name of the channel.
type: string
LogTypes:
description: The types of logs to collect.
type: array
items:
$ref: "#/components/schemas/LogType"
summary: Amazon MediaTailor Configure Logs for Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
/configureLogs/playbackConfiguration:
put:
operationId: ConfigureLogsForPlaybackConfiguration
description: Amazon CloudWatch log settings for a playback configuration.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigureLogsForPlaybackConfigurationResponse"
examples:
ConfigureLogsForPlaybackConfiguration200Example:
summary: Default ConfigureLogsForPlaybackConfiguration 200 response
x-microcks-default: true
value:
PercentEnabled: example-value
PlaybackConfigurationName: example-resource
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- PercentEnabled
- PlaybackConfigurationName
properties:
PercentEnabled:
description: '<p>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 <code>60</code>, 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 <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p> <p>Valid
values: <code>0</code> - <code>100</code> </p>'
type: integer
PlaybackConfigurationName:
description: The name of the playback configuration.
type: string
summary: Amazon MediaTailor Configure Logs for Playback Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
"/channel/{ChannelName}":
post:
operationId: CreateChannel
description: Creates a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with
channels</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateChannelResponse"
examples:
CreateChannel200Example:
summary: Default CreateChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ChannelState: example-value
CreationTime: example-value
FillerSlate: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Outputs
- PlaybackMode
properties:
FillerSlate:
description: Slate VOD source configuration.
type: object
properties:
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location where the slate VOD source is stored.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
Outputs:
description: An object that represents an object in the CreateChannel request.
type: array
items:
$ref: "#/components/schemas/RequestOutputItem"
PlaybackMode:
description: <p>The type of playback mode to use for this channel.</p> <p> <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p> <p>
<code>LOOP</code> - 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.</p>
type: string
enum:
- LOOP
- LINEAR
tags:
description: The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking.
For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.
type: object
additionalProperties:
$ref: "#/components/schemas/__string"
Tier:
description: The tier of the channel.
type: string
enum:
- BASIC
- STANDARD
summary: Amazon MediaTailor Create Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteChannel
description: Deletes a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with
channels</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteChannelResponse"
examples:
DeleteChannel200Example:
summary: Default DeleteChannel 200 response
x-microcks-default: true
value: {}
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel.
schema:
type: string
summary: Amazon MediaTailor Delete Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeChannel
description: Describes a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with
channels</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeChannelResponse"
examples:
DescribeChannel200Example:
summary: Default DescribeChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ChannelState: example-value
CreationTime: example-value
FillerSlate: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel.
schema:
type: string
summary: Amazon MediaTailor Describe Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: UpdateChannel
description: Updates a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with
channels</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateChannelResponse"
examples:
UpdateChannel200Example:
summary: Default UpdateChannel 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ChannelState: example-value
CreationTime: example-value
FillerSlate: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Outputs
properties:
FillerSlate:
description: Slate VOD source configuration.
type: object
properties:
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location where the slate VOD source is stored.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.
Outputs:
description: An object that represents an object in the CreateChannel request.
type: array
items:
$ref: "#/components/schemas/RequestOutputItem"
summary: Amazon MediaTailor Update Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/sourceLocation/{SourceLocationName}/liveSource/{LiveSourceName}":
post:
operationId: CreateLiveSource
description: The live source configuration.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateLiveSourceResponse"
examples:
CreateLiveSource200Example:
summary: Default CreateLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
parameters:
- name: LiveSourceName
in: path
required: true
description: The name of the live source.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- HttpPackageConfigurations
properties:
HttpPackageConfigurations:
description: The VOD source's HTTP package configuration settings.
type: array
items:
$ref: "#/components/schemas/HttpPackageConfiguration"
tags:
description: The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost
tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.
type: object
additionalProperties:
$ref: "#/components/schemas/__string"
summary: Amazon MediaTailor Create Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeleteLiveSource
description: The live source to delete.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteLiveSourceResponse"
examples:
DeleteLiveSource200Example:
summary: Default DeleteLiveSource 200 response
x-microcks-default: true
value: {}
parameters:
- name: LiveSourceName
in: path
required: true
description: The name of the live source.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location associated with this Live Source.
schema:
type: string
summary: Amazon MediaTailor Delete Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: DescribeLiveSource
description: The live source to describe.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeLiveSourceResponse"
examples:
DescribeLiveSource200Example:
summary: Default DescribeLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
parameters:
- name: LiveSourceName
in: path
required: true
description: The name of the live source.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location associated with this Live Source.
schema:
type: string
summary: Amazon MediaTailor Describe Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
operationId: UpdateLiveSource
description: Updates a live source's configuration.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateLiveSourceResponse"
examples:
UpdateLiveSource200Example:
summary: Default UpdateLiveSource 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
HttpPackageConfigurations: example-value
LastModifiedTime: example-value
LiveSourceName: example-resource
parameters:
- name: LiveSourceName
in: path
required: true
description: The name of the live source.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location associated with this Live Source.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- HttpPackageConfigurations
properties:
HttpPackageConfigurations:
description: The VOD source's HTTP package configuration settings.
type: array
items:
$ref: "#/components/schemas/HttpPackageConfiguration"
summary: Amazon MediaTailor Update Live Source
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/prefetchSchedule/{PlaybackConfigurationName}/{Name}":
post:
operationId: CreatePrefetchSchedule
description: Creates a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more
information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreatePrefetchScheduleResponse"
examples:
CreatePrefetchSchedule200Example:
summary: Default CreatePrefetchSchedule 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
Consumption: example-value
Name: example-resource
PlaybackConfigurationName: example-resource
Retrieval: example-value
parameters:
- name: Name
in: path
required: true
description: The name to assign to the schedule request.
schema:
type: string
- name: PlaybackConfigurationName
in: path
required: true
description: The name to assign to the playback configuration.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Consumption
- Retrieval
properties:
Consumption:
description: A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
type: object
properties:
AvailMatchingCriteria:
allOf:
- $ref: "#/components/schemas/__listOfAvailMatchingCriteria"
- description: If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as <code>scte.event_id</code>, set the
avail matching criteria.
EndTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: 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 <code>DeletePrefetchSchedule</code>.
StartTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor
retrives them from the ad decision server.
Retrieval:
description: A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision
server.
type: object
properties:
DynamicVariables:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- description: <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p> <p>You initially configure <a
href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">dynamic variables</a> for the ADS URL when you set up your playback configuration. When you specify
<code>DynamicVariables</code> for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.</p>
EndTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
StartTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: 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.
StreamId:
description: An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified,
MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback
configuration, regardless of <code>StreamId</code>.
type: string
summary: Amazon MediaTailor Create Prefetch Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- $ref: "#/components/parameters/X-Amz-Content-Sha256"
- $ref: "#/components/parameters/X-Amz-Date"
- $ref: "#/components/parameters/X-Amz-Algorithm"
- $ref: "#/components/parameters/X-Amz-Credential"
- $ref: "#/components/parameters/X-Amz-Security-Token"
- $ref: "#/components/parameters/X-Amz-Signature"
- $ref: "#/components/parameters/X-Amz-SignedHeaders"
delete:
operationId: DeletePrefetchSchedule
description: Deletes a prefetch schedule for a specific playback configuration. If you call <code>DeletePrefetchSchedule</code> on an expired prefetch schedule, MediaTailor returns an HTTP 404
status code. For more information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User
Guide</i>.
responses:
"204":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeletePrefetchScheduleResponse"
examples:
DeletePrefetchSchedule204Example:
summary: Default DeletePrefetchSchedule 204 response
x-microcks-default: true
value: {}
parameters:
- name: Name
in: path
required: true
description: The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
schema:
type: string
- name: PlaybackConfigurationName
in: path
required: true
description: The name of the playback configuration for this prefetch schedule.
schema:
type: string
summary: Amazon MediaTailor Delete Prefetch Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
operationId: GetPrefetchSchedule
description: Retrieves a prefetch schedule for a playback configuration. A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more
information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetPrefetchScheduleResponse"
examples:
GetPrefetchSchedule200Example:
summary: Default GetPrefetchSchedule 200 response
x-microcks-default: true
value:
Arn: arn:aws:service:us-east-1:123456789012:resource/example
Consumption: example-value
Name: example-resource
PlaybackConfigurationName: example-resource
Retrieval: example-value
parameters:
- name: Name
in: path
required: true
description: The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configurati
# --- truncated at 32 KB (242 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediatailor/refs/heads/main/openapi/amazon-mediatailor-openapi-original.yml