The Channel API from Amazon MediaTailor — 6 operation(s) for channel.
openapi: 3.0.0
info:
version: 2018-04-23
x-release: v4
title: AWS MediaTailor Alerts#resourceArn Channel API
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: mike.ralphson@gmail.com
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
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)
security:
- hmac: []
tags:
- name: Channel
paths:
/channel/{ChannelName}:
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'
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
tags:
- Channel
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
tags:
- Channel
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
tags:
- Channel
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
tags:
- Channel
/channel/{ChannelName}/program/{ProgramName}:
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'
post:
operationId: CreateProgram
description: Creates a program within a channel. For information about programs, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html">Working with programs</a> in the <i>MediaTailor User Guide</i>.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProgramResponse'
examples:
CreateProgram200Example:
summary: Default CreateProgram 200 response
x-microcks-default: true
value:
AdBreaks: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ClipRange: example-value
CreationTime: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel for this Program.
schema:
type: string
- name: ProgramName
in: path
required: true
description: The name of the Program.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ScheduleConfiguration
- SourceLocationName
properties:
AdBreaks:
description: The ad break configuration settings.
type: array
items:
$ref: '#/components/schemas/AdBreak'
LiveSourceName:
description: The name of the LiveSource for this Program.
type: string
ScheduleConfiguration:
description: Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
type: object
properties:
ClipRange:
allOf:
- $ref: '#/components/schemas/ClipRange'
- description: Program clip range configuration.
Transition:
allOf:
- $ref: '#/components/schemas/Transition'
- description: Program transition configurations.
SourceLocationName:
description: The name of the source location.
type: string
VodSourceName:
description: The name that's used to refer to a VOD source.
type: string
summary: Amazon MediaTailor Create Program
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
delete:
operationId: DeleteProgram
description: Deletes a program within a channel. For information about programs, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html">Working with programs</a> in the <i>MediaTailor User Guide</i>.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteProgramResponse'
examples:
DeleteProgram200Example:
summary: Default DeleteProgram 200 response
x-microcks-default: true
value: {}
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel.
schema:
type: string
- name: ProgramName
in: path
required: true
description: The name of the program.
schema:
type: string
summary: Amazon MediaTailor Delete Program
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
get:
operationId: DescribeProgram
description: Describes a program within a channel. For information about programs, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html">Working with programs</a> in the <i>MediaTailor User Guide</i>.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeProgramResponse'
examples:
DescribeProgram200Example:
summary: Default DescribeProgram 200 response
x-microcks-default: true
value:
AdBreaks: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ClipRange: example-value
CreationTime: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel associated with this Program.
schema:
type: string
- name: ProgramName
in: path
required: true
description: The name of the program.
schema:
type: string
summary: Amazon MediaTailor Describe Program
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
put:
operationId: UpdateProgram
description: Updates a program within a channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProgramResponse'
examples:
UpdateProgram200Example:
summary: Default UpdateProgram 200 response
x-microcks-default: true
value:
AdBreaks: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
ChannelName: example-resource
ClipRange: example-value
CreationTime: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel for this Program.
schema:
type: string
- name: ProgramName
in: path
required: true
description: The name of the Program.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ScheduleConfiguration
properties:
AdBreaks:
description: The ad break configuration settings.
type: array
items:
$ref: '#/components/schemas/AdBreak'
ScheduleConfiguration:
description: Schedule configuration parameters.
type: object
properties:
ClipRange:
allOf:
- $ref: '#/components/schemas/ClipRange'
- description: Program clip range configuration.
Transition:
allOf:
- $ref: '#/components/schemas/UpdateProgramTransition'
- description: Program transition configuration.
summary: Amazon MediaTailor Update Program
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
/channel/{ChannelName}/policy:
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: DeleteChannelPolicy
description: The channel policy to delete.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteChannelPolicyResponse'
examples:
DeleteChannelPolicy200Example:
summary: Default DeleteChannelPolicy 200 response
x-microcks-default: true
value: {}
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel associated with this channel policy.
schema:
type: string
summary: Amazon MediaTailor Delete Channel Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
get:
operationId: GetChannelPolicy
description: Returns the channel's IAM policy. IAM policies are used to control access to your channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelPolicyResponse'
examples:
GetChannelPolicy200Example:
summary: Default GetChannelPolicy 200 response
x-microcks-default: true
value:
Policy: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel associated with this Channel Policy.
schema:
type: string
summary: Amazon MediaTailor Get Channel Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
put:
operationId: PutChannelPolicy
description: Creates an IAM policy for the channel. IAM policies are used to control access to your channel.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutChannelPolicyResponse'
examples:
PutChannelPolicy200Example:
summary: Default PutChannelPolicy 200 response
x-microcks-default: true
value: {}
parameters:
- name: ChannelName
in: path
required: true
description: The channel name associated with this Channel Policy.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Policy
properties:
Policy:
description: Adds an IAM role that determines the permissions of your channel.
type: string
summary: Amazon MediaTailor Put Channel Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
/channel/{ChannelName}/schedule:
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'
get:
operationId: GetChannelSchedule
description: Retrieves information about your channel's schedule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelScheduleResponse'
examples:
GetChannelSchedule200Example:
summary: Default GetChannelSchedule 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: ChannelName
in: path
required: true
description: The name of the channel associated with this Channel Schedule.
schema:
type: string
- name: durationMinutes
in: query
required: false
description: The duration in minutes of the channel schedule.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channel schedules, use the value of <code>NextToken</code> in the response to get the next page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: <p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p> <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>
schema:
type: string
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon MediaTailor Get Channel Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
/channel/{ChannelName}/start:
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'
put:
operationId: StartChannel
description: Starts 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/StartChannelResponse'
examples:
StartChannel200Example:
summary: Default StartChannel 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 Start Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
/channel/{ChannelName}/stop:
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'
put:
operationId: StopChannel
description: Stops 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/StopChannelResponse'
examples:
StopChannel200Example:
summary: Default StopChannel 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 Stop Channel
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Channel
components:
schemas:
ClipRange:
type: object
required:
- EndOffsetMillis
properties:
EndOffsetMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
description: Clip range configuration for the VOD source associated with the program.
Transition:
type: object
required:
- RelativePosition
- Type
properties:
DurationMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The duration of the live program in seconds.
RelativePosition:
allOf:
- $ref: '#/components/schemas/RelativePosition'
- description: The position where this program will be inserted relative to the <code>RelativePosition</code>.
RelativeProgram:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the program that this program will be inserted next to, as defined by <code>RelativePosition</code>.
ScheduledStartTimeMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The date and time that the program is scheduled to start, in epoch milliseconds.
Type:
allOf:
- $ref: '#/components/schemas/__string'
- description: <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p> <p> <code>ABSOLUTE</code> - The program plays at a specific wall clock time. This setting can only be used for channels using the <code>LINEAR</code> <code>PlaybackMode</code>.</p> <p>Note the following considerations when using <code>ABSOLUTE</code> transitions:</p> <p>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.</p> <p>If there are gaps in playback, MediaTailor plays the <code>FillerSlate</code> you configured for your linear channel.</p> <p> <code>RELATIVE</code> - The program is inserted into the schedule either before or after a program that you specify via <code>RelativePosition</code>.</p>
description: Program transition configuration.
ChannelState:
type: string
enum:
- RUNNING
- STOPPED
__mapOf__string:
type: object
# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-mediatailor/refs/heads/main/openapi/amazon-mediatailor-channel-api-openapi.yml