openapi: 3.0.0 info: version: 2018-04-23 x-release: v4 title: AWS MediaTailor Alerts#resourceArn Channel API 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).
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 Working with channels in the MediaTailor User Guide. 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: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.
MaxResults channel schedules, use the value of NextToken in the response to get the next page of results.
schema:
type: integer
minimum: 1
maximum: 100
- name: nextToken
in: query
required: false
description: (Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest 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 channel schedules to get.
RelativePosition.
RelativeProgram:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the program that this program will be inserted next to, as defined by RelativePosition.
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: 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.
segmentation_descriptor message(s) sent with the time_signal message.
description: The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.
The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).
See the time_signal() table of the 2022 SCTE-35 specification for more information.
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.
AvailsExpected:
allOf:
- $ref: '#/components/schemas/__integer'
- description: 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.
SpliceEventId:
allOf:
- $ref: '#/components/schemas/__integer'
- description: 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.
UniqueProgramId:
allOf:
- $ref: '#/components/schemas/__integer'
- description: 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.
description: Splice insert message configuration.
Integer:
type: integer
ScheduleEntryType:
type: string
enum:
- PROGRAM
- FILLER_SLATE
__long:
type: integer
SegmentationDescriptor:
type: object
properties:
SegmentNum:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The segment number to assign to the segmentation_descriptor.segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SegmentationEventId:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
SegmentationTypeId:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.
SegmentationUpid:
allOf:
- $ref: '#/components/schemas/String'
- description: The Upid to assign to the segmentation_descriptor.segmentation_upid message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).
SegmentationUpidType:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.
SegmentsExpected:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.
SubSegmentNum:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The sub-segment number to assign to the segmentation_descriptor.sub_segment_num message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.
SubSegmentsExpected:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of sub-segments expected, which is assigned to the segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
description: The segmentation_descriptor message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the EXT-X-DATERANGE or EventStream ad marker's SCTE-35 data.
segmentation_descriptor messages must be sent with the time_signal message type.
See the segmentation_descriptor() table of the 2022 SCTE-35 specification for more information.
PlaybackUrl.
SourceGroup:
allOf:
- $ref: '#/components/schemas/__string'
- description: A string used to match which HttpPackageConfiguration is used for each VodSource.
description: The output configuration for this channel.
DeleteChannelResponse:
type: object
properties: {}
SlateSource:
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.
description: Slate VOD source configuration.
DescribeProgramResponse:
type: object
properties:
AdBreaks:
allOf:
- $ref: '#/components/schemas/__listOfAdBreak'
- description: The ad break configuration settings.
Arn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The ARN of the program.
ChannelName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the channel that the program belongs to.
ClipRange:
allOf:
- $ref: '#/components/schemas/ClipRange'
- description: The clip range configuration settings.
CreationTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: The timestamp of when the program was created.
DurationMillis:
allOf:
- $ref: '#/components/schemas/Long'
- description: The duration of the live program in milliseconds.
LiveSourceName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the LiveSource for this Program.
ProgramName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the program.
ScheduledStartTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: 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.
SourceLocationName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The source location name.
VodSourceName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name that's used to refer to a VOD source.
UpdateProgramTransition:
type: object
properties:
DurationMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The duration of the live program in seconds.
ScheduledStartTimeMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The date and time that the program is scheduled to start, in epoch milliseconds.
description: Program transition configuration.
GetChannelScheduleResponse:
type: object
properties:
Items:
allOf:
- $ref: '#/components/schemas/__listOfScheduleEntry'
- description: A list of schedule entries for the channel.
NextToken:
allOf:
- $ref: '#/components/schemas/__string'
- description: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
StopChannelResponse:
type: object
properties: {}
GetChannelPolicyResponse:
type: object
properties:
Policy:
allOf:
- $ref: '#/components/schemas/__string'
- description: The IAM policy for the channel. IAM policies are used to control access to your channel.
CreateProgramResponse:
type: object
properties:
AdBreaks:
allOf:
- $ref: '#/components/schemas/__listOfAdBreak'
- description: The ad break configuration settings.
Arn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The ARN to assign to the program.
ChannelName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name to assign to the channel for this program.
ClipRange:
allOf:
- $ref: '#/components/schemas/ClipRange'
- description: The clip range configuration settings.
CreationTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: The time the program was created.
DurationMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: The duration of the live program in milliseconds.
LiveSourceName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the LiveSource for this Program.
ProgramName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name to assign to this program.
ScheduledStartTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: The scheduled start time for this Program.
SourceLocationName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name to assign to the source location for this program.
VodSourceName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name that's used to refer to a VOD source.
StartChannelResponse:
type: object
properties: {}
UpdateChannelResponse:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/__string'
- description: The Amazon Resource Name (ARN) associated with the channel.
ChannelName:
allOf:
- $ref: '#/components/schemas/__string'
- description: The name of the channel.
ChannelState:
allOf:
- $ref: '#/components/schemas/ChannelState'
- description: Returns the state whether the channel is running or not.
CreationTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: The timestamp of when the channel was created.
FillerSlate:
allOf:
- $ref: '#/components/schemas/SlateSource'
- description: 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.
LastModifiedTime:
allOf:
- $ref: '#/components/schemas/__timestampUnix'
- description: The timestamp that indicates when the channel was last modified.
Outputs:
allOf:
- $ref: '#/components/schemas/ResponseOutputs'
- description: The channel's output properties.
PlaybackMode:
allOf:
- $ref: '#/components/schemas/__string'
- description: 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.
30 seconds. Maximum value: 3600 seconds.'
description: HLS playlist configuration parameters.
__listOfAdBreak:
type: array
items:
$ref: '#/components/schemas/AdBreak'
DeleteChannelPolicyResponse:
type: object
properties: {}
RelativePosition:
type: string
enum:
- BEFORE_PROGRAM
- AFTER_PROGRAM
DeleteProgramResponse:
type: object
properties: {}
DashPlaylistSettings:
type: object
properties:
ManifestWindowSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- description: 'The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.'
MinBufferTimeSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- description: 'Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.'
MinUpdatePeriodSeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- description: '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.'
SuggestedPresentationDelaySeconds:
allOf:
- $ref: '#/components/schemas/__integer'
- description: '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.'
description: Dash manifest configuration parameters.
AdBreak:
type: object
properties:
MessageType:
allOf:
- $ref: '#/components/schemas/MessageType'
- description: 'The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.'
OffsetMillis:
allOf:
- $ref: '#/components/schemas/__long'
- description: 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.
Slate:
allOf:
- $ref: '#/components/schemas/SlateSource'
- description: Ad break slate configuration.
SpliceInsertMessage:
allOf:
- $ref: '#/components/schemas/SpliceInsertMessage'
- description: 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.
TimeSignalMessage:
allOf:
- $ref: '#/components/schemas/TimeSignalMessage'
- description: Defines the SCTE-35 time_signal message inserted around the ad.
Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.
See section 9.7.4 of the 2022 SCTE-35 specification for more information.
description: Ad break configuration parameters. LogTypes: type: array items: $ref: '#/components/schemas/LogType' MessageType: type: string enum: - SPLICE_INSERT - TIME_SIGNAL parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/mediatailor/ x-hasEquivalentPaths: true