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 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: '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 60, 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 debug log mode.
Valid
values: 0 - 100
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.
scte.event_id, 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 DeletePrefetchSchedule.
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 StartTime, 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: The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
StreamId is specified,
MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback
configuration, regardless of StreamId.
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 DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404
status code. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User
Guide.
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 Using ad prefetching in the MediaTailor User Guide.
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 configuration.
schema:
type: string
- name: PlaybackConfigurationName
in: path
required: true
description: Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor
returns an HTTP 404 status code.
schema:
type: string
summary: Amazon MediaTailor Get Prefetch Schedule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/channel/{ChannelName}/program/{ProgramName}":
post:
operationId: CreateProgram
description: Creates a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
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
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: DeleteProgram
description: Deletes a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
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
get:
operationId: DescribeProgram
description: Describes a program within a channel. For information about programs, see Working with
programs in the MediaTailor User Guide.
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
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
"/sourceLocation/{SourceLocationName}":
post:
operationId: CreateSourceLocation
description: Creates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSourceLocationResponse"
examples:
CreateSourceLocation200Example:
summary: Default CreateSourceLocation 200 response
x-microcks-default: true
value:
AccessConfiguration: example-value
Arn: arn:aws:service:us-east-1:123456789012:resource/example
CreationTime: example-value
DefaultSegmentDeliveryConfiguration: example-value
HttpConfiguration: example-value
parameters:
- name: SourceLocationName
in: path
required: true
description: The name associated with the source location.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- HttpConfiguration
properties:
AccessConfiguration:
description: Access configuration parameters.
type: object
properties:
AccessType:
allOf:
- $ref: "#/components/schemas/AccessType"
- description: "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor
can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual
hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
" SecretsManagerAccessTokenConfiguration: allOf: - $ref: "#/components/schemas/SecretsManagerAccessTokenConfiguration" - description: AWS Secrets Manager access token configuration parameters. DefaultSegmentDeliveryConfiguration: description: 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. type: object properties: BaseUrl: allOf: - $ref: "#/components/schemas/__string" - description: The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://. HttpConfiguration: description: The HTTP configuration for the source location. type: object properties: BaseUrl: allOf: - $ref: "#/components/schemas/__string" - description: The base URL for the source location host server. This string must include the protocol, such as https://. SegmentDeliveryConfigurations: description: A list of the segment delivery configurations associated with this resource. type: array items: $ref: "#/components/schemas/SegmentDeliveryConfiguration" tags: description: The tags to assign to the source location. 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 Tagging AWS Elemental MediaTailor Resources. type: object additionalProperties: $ref: "#/components/schemas/__string" summary: Amazon MediaTailor Create Source Location 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: DeleteSourceLocation description: Deletes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteSourceLocationResponse" examples: DeleteSourceLocation200Example: summary: Default DeleteSourceLocation 200 response x-microcks-default: true value: {} parameters: - name: SourceLocationName in: path required: true description: The name of the source location. schema: type: string summary: Amazon MediaTailor Delete Source Location x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeSourceLocation description: Describes a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeSourceLocationResponse" examples: DescribeSourceLocation200Example: summary: Default DescribeSourceLocation 200 response x-microcks-default: true value: AccessConfiguration: example-value Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: example-value DefaultSegmentDeliveryConfiguration: example-value HttpConfiguration: example-value parameters: - name: SourceLocationName in: path required: true description: The name of the source location. schema: type: string summary: Amazon MediaTailor Describe Source Location x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateSourceLocation description: Updates a source location. A source location is a container for sources. For more information about source locations, see Working with source locations in the MediaTailor User Guide. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateSourceLocationResponse" examples: UpdateSourceLocation200Example: summary: Default UpdateSourceLocation 200 response x-microcks-default: true value: AccessConfiguration: example-value Arn: arn:aws:service:us-east-1:123456789012:resource/example CreationTime: example-value DefaultSegmentDeliveryConfiguration: example-value HttpConfiguration: example-value parameters: - 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: - HttpConfiguration properties: AccessConfiguration: description: Access configuration parameters. type: object properties: AccessType: allOf: - $ref: "#/components/schemas/AccessType" - description: "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor
can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual
hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
" SecretsManagerAccessTokenConfiguration: allOf: - $ref: "#/components/schemas/SecretsManagerAccessTokenConfiguration" - description: AWS Secrets Manager access token configuration parameters. DefaultSegmentDeliveryConfiguration: description: 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. type: object properties: BaseUrl: allOf: - $ref: "#/components/schemas/__string" - description: The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://. HttpConfiguration: description: The HTTP configuration for the source location. type: object properties: BaseUrl: allOf: - $ref: "#/components/schemas/__string" - description: The base URL for the source location host server. This string must include the protocol, such as https://. SegmentDeliveryConfigurations: description: A list of the segment delivery configurations associated with this resource. type: array items: $ref: "#/components/schemas/SegmentDeliveryConfiguration" summary: Amazon MediaTailor Update Source Location x-microcks-operation: delay: 0 dispatcher: FALLBACK "/sourceLocation/{SourceLocationName}/vodSource/{VodSourceName}": post: operationId: CreateVodSource description: The VOD source configuration parameters. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/CreateVodSourceResponse" examples: CreateVodSource200Example: summary: Default CreateVodSource 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 SourceLocationName: example-resource parameters: - name: SourceLocationName in: path required: true description: The name of the source location for this VOD source. schema: type: string - name: VodSourceName in: path required: true description: The name associated with the VOD 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" tags: description: The tags to assign to the VOD 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 Tagging AWS Elemental MediaTailor Resources. type: object additionalProperties: $ref: "#/components/schemas/__string" summary: Amazon MediaTailor Create Vod 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: DeleteVodSource description: The video on demand (VOD) source to delete. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DeleteVodSourceResponse" examples: DeleteVodSource200Example: summary: Default DeleteVodSource 200 response x-microcks-default: true value: {} parameters: - name: SourceLocationName in: path required: true description: The name of the source location associated with this VOD Source. schema: type: string - name: VodSourceName in: path required: true description: The name of the VOD source. schema: type: string summary: Amazon MediaTailor Delete Vod Source x-microcks-operation: delay: 0 dispatcher: FALLBACK get: operationId: DescribeVodSource description: Provides details about a specific video on demand (VOD) source in a specific source location. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/DescribeVodSourceResponse" examples: DescribeVodSource200Example: summary: Default DescribeVodSource 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 SourceLocationName: example-resource parameters: - name: SourceLocationName in: path required: true description: The name of the source location associated with this VOD Source. schema: type: string - name: VodSourceName in: path required: true description: The name of the VOD Source. schema: type: string summary: Amazon MediaTailor Describe Vod Source x-microcks-operation: delay: 0 dispatcher: FALLBACK put: operationId: UpdateVodSource description: Updates a VOD source's configuration. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/UpdateVodSourceResponse" examples: UpdateVodSource200Example: summary: Default UpdateVodSource 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 SourceLocationName: example-resource parameters: - name: SourceLocationName in: path required: true description: The name of the source location associated with this VOD Source. schema: type: string - name: VodSourceName in: path required: true description: The name of the VOD 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 Vod Source x-microcks-operation: delay: 0 dispatcher: FALLBACK "/channel/{ChannelName}/policy": 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 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: 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 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 "/playbackConfiguration/{Name}": delete: operationId: DeletePlaybackConfiguration description: Deletes a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor. responses: "204": description: Success content: application/json: schema: $ref: "#/components/schemas/DeletePlaybackConfigurationResponse" examples: DeletePlaybackConfiguration204Example: summary: Default DeletePlaybackConfiguration 204 response x-microcks-default: true value: {} parameters: - name: Name in: path required: true description: The name of the playback configuration. schema: type: string summary: Amazon MediaTailor Delete 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" get: operationId: GetPlaybackConfiguration description: Retrieves a playback configuration. For information about MediaTailor configurations, see Working with configurations in AWS Elemental MediaTailor. responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/GetPlaybackConfigurationResponse" examples: GetPlaybackConfiguration200Example: summary: Default GetPlaybackConfiguration 200 response x-microcks-default: true value: AdDecisionServerUrl: https://example.com AvailSuppression: example-value Bumper: example-value CdnConfiguration: example-value ConfigurationAliases: example-value parameters: - name: Name in: path required: true description: The identifier for the playback configuration. schema: type: string summary: Amazon MediaTailor Get Playback Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK "/channel/{ChannelName}/schedule": 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 thanMaxResults 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.
MaxResults alerts, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
schema:
type: string
- name: resourceArn
in: query
required: true
description: The Amazon Resource Name (ARN) of the resource.
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 List Alerts
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"
/channels:
get:
operationId: ListChannels
description: Retrieves information about the channels that are associated with the current AWS account.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListChannelsResponse"
examples:
ListChannels200Example:
summary: Default ListChannels 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than MaxResults channels, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
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 List Channels
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"
"/sourceLocation/{SourceLocationName}/liveSources":
get:
operationId: ListLiveSources
description: Lists the live sources contained in a source location. A source represents a piece of content.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListLiveSourcesResponse"
examples:
ListLiveSources200Example:
summary: Default ListLiveSources 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: maxResults
in: query
required: false
description: The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults live sources, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location associated with this Live Sources list.
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 List Live Sources
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"
/playbackConfigurations:
get:
operationId: ListPlaybackConfigurations
description: Retrieves existing playback configurations. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListPlaybackConfigurationsResponse"
examples:
ListPlaybackConfigurations200Example:
summary: Default ListPlaybackConfigurations 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: MaxResults
in: query
required: false
description: The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than MaxResults playback
configurations, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
schema:
type: string
summary: Amazon MediaTailor List Playback Configurations
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"
"/prefetchSchedule/{PlaybackConfigurationName}":
post:
operationId: ListPrefetchSchedules
description: Lists the prefetch schedules for a playback configuration.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListPrefetchSchedulesResponse"
examples:
ListPrefetchSchedules200Example:
summary: Default ListPrefetchSchedules 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: PlaybackConfigurationName
in: path
required: true
description: Retrieves the prefetch schedule(s) for a specific playback configuration.
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
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
MaxResults:
description: The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch
schedules, use the value of NextToken in the response to get the next page of results.
type: integer
minimum: 1
maximum: 100
NextToken:
description: (Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages
of results.
For the first ListPrefetchSchedulesRequest 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 prefetch schedules to get.
MaxResults source locations, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
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 List Source Locations
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"
"/tags/{ResourceArn}":
get:
operationId: ListTagsForResource
description: A 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 control, and cost
tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListTagsForResourceResponse"
examples:
ListTagsForResource200Example:
summary: Default ListTagsForResource 200 response
x-microcks-default: true
value:
Tags: example-value
"480":
description: BadRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
examples:
ListTagsForResource480Example:
summary: Default ListTagsForResource 480 response
x-microcks-default: true
value: {}
parameters:
- name: ResourceArn
in: path
required: true
description: The Amazon Resource Name (ARN) associated with this resource.
schema:
type: string
summary: Amazon MediaTailor List Tags for Resource
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"
post:
operationId: TagResource
description: The 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 more information, see Tagging AWS Elemental MediaTailor Resources.
responses:
"204":
description: Success
"480":
description: BadRequestException
content:
application/json:
schema:
$ref: "#/components/schemas/BadRequestException"
examples:
TagResource480Example:
summary: Default TagResource 480 response
x-microcks-default: true
value: {}
parameters:
- name: ResourceArn
in: path
required: true
description: The Amazon Resource Name (ARN) associated with the resource.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- tags
properties:
tags:
description: The tags to assign to the resource. 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 Tagging AWS Elemental MediaTailor Resources.
type: object
additionalProperties:
$ref: "#/components/schemas/__string"
summary: Amazon MediaTailor Tag Resource
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
"/sourceLocation/{SourceLocationName}/vodSources":
get:
operationId: ListVodSources
description: Lists the VOD sources contained in a source location. A source represents a piece of content.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListVodSourcesResponse"
examples:
ListVodSources200Example:
summary: Default ListVodSources 200 response
x-microcks-default: true
value:
Items: example-value
NextToken: example-value
parameters:
- name: maxResults
in: query
required: false
description: " The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than MaxResults VOD sources, 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: Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
schema:
type: string
- name: SourceLocationName
in: path
required: true
description: The name of the source location associated with this VOD Source list.
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 List Vod Sources
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"
/playbackConfiguration:
put:
operationId: PutPlaybackConfiguration
description: Creates a playback configuration. For information about MediaTailor configurations, see Working with
configurations in AWS Elemental MediaTailor.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/PutPlaybackConfigurationResponse"
examples:
PutPlaybackConfiguration200Example:
summary: Default PutPlaybackConfiguration 200 response
x-microcks-default: true
value:
AdDecisionServerUrl: https://example.com
AvailSuppression: example-value
Bumper: example-value
CdnConfiguration: example-value
ConfigurationAliases: example-value
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Name
properties:
AdDecisionServerUrl:
description: The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor
substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000
characters.
type: string
AvailSuppression:
description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
type: object
properties:
Mode:
allOf:
- $ref: "#/components/schemas/Mode"
- description: Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE,
ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
Value:
allOf:
- $ref: "#/components/schemas/__string"
- description: A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in
sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this
time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill
ad breaks on or behind 45 minutes behind the live edge.
Bumper:
description: 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.
type: object
properties:
EndUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the end bumper asset.
StartUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the start bumper asset.
CdnConfiguration:
description: The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
type: object
properties:
AdSegmentUrlPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its
CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in
this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
ContentSegmentUrlPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN
for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports
your CDN as the source for content segments.
ConfigurationAliases:
description: The predefined aliases for dynamic variables.
type: object
additionalProperties:
$ref: "#/components/schemas/__mapOf__string"
DashConfiguration:
description: The configuration for DASH PUT operations.
type: object
properties:
MpdLocation:
allOf:
- $ref: "#/components/schemas/__string"
- description: The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update
requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either
using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT
setting enables the inclusion of the tag and is the default value.
OriginManifestType:
allOf:
- $ref: "#/components/schemas/OriginManifestType"
- description: The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server
produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or
set it to MULTI_PERIOD.
LivePreRollConfiguration:
description: The configuration for pre-roll ad insertion.
type: object
properties:
AdDecisionServerUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS
Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL.
The maximum length is 25,000 characters.
MaxDurationSeconds:
allOf:
- $ref: "#/components/schemas/__integer"
- description: The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration
of ads that the ADS returns.
ManifestProcessingRules:
description: The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
type: object
properties:
AdMarkerPassthrough:
allOf:
- $ref: "#/components/schemas/AdMarkerPassthrough"
- description: 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.
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.
CreateLiveSourceResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN to assign to the live source.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time the live source was created.
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: A list of HTTP package configuration parameters for this live source.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time the live source was last modified.
LiveSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the live source.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the source location of the live source.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: 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 Tagging AWS Elemental MediaTailor Resources.
HttpPackageConfiguration:
type: object
required:
- Path
- SourceGroup
- Type
properties:
Path:
allOf:
- $ref: "#/components/schemas/__string"
- description: The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
SourceGroup:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.
Type:
allOf:
- $ref: "#/components/schemas/Type"
- description: The streaming protocol for this package configuration. Supported values are HLS and DASH.
description: The HTTP package configuration properties for the requested VOD source.
CreatePrefetchScheduleResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN to assign to the prefetch schedule.
Consumption:
allOf:
- $ref: "#/components/schemas/PrefetchConsumption"
- description: The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an
optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
Name:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the prefetch schedule.
PlaybackConfigurationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the playback configuration.
Retrieval:
allOf:
- $ref: "#/components/schemas/PrefetchRetrieval"
- description: The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad
break.
StreamId:
allOf:
- $ref: "#/components/schemas/__string"
- description: An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified,
MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback
configuration, regardless of StreamId.
__listOfAvailMatchingCriteria:
type: array
items:
$ref: "#/components/schemas/AvailMatchingCriteria"
__timestampUnix:
type: string
format: date-time
__mapOf__string:
type: object
additionalProperties:
$ref: "#/components/schemas/__string"
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.
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. 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 theRelativePosition.
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.
https://example.com/some/path. To use a relative URL specify the relative path, such as
/some/path*.
Name:
allOf:
- $ref: "#/components/schemas/__string"
- description: A unique identifier used to distinguish between multiple segment delivery configurations in a source location.
description: The segment delivery configuration settings.
CreateVodSourceResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN to assign to this VOD source.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time the VOD source was created.
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: A list of HTTP package configuration parameters for this VOD source.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The time the VOD source was last modified.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the source location for this VOD source.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags to assign to the VOD 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 Tagging AWS Elemental MediaTailor Resources.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name to assign to the VOD source.
DeleteChannelResponse:
type: object
properties: {}
DeleteChannelPolicyResponse:
type: object
properties: {}
DeleteLiveSourceResponse:
type: object
properties: {}
DeletePlaybackConfigurationResponse:
type: object
properties: {}
DeletePrefetchScheduleResponse:
type: object
properties: {}
DeleteProgramResponse:
type: object
properties: {}
DeleteSourceLocationResponse:
type: object
properties: {}
DeleteVodSourceResponse:
type: object
properties: {}
DescribeChannelResponse:
type: object
required:
- LogConfiguration
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN of the channel.
ChannelName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the channel.
ChannelState:
allOf:
- $ref: "#/components/schemas/ChannelState"
- description: Indicates whether the channel is in a running state or not.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp of when the channel was created.
FillerSlate:
allOf:
- $ref: "#/components/schemas/SlateSource"
- description: Contains information about the slate used to fill gaps between programs in the schedule.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp of when the channel was last modified.
LogConfiguration:
allOf:
- $ref: "#/components/schemas/LogConfigurationForChannel"
- description: The log configuration for the channel.
Outputs:
allOf:
- $ref: "#/components/schemas/ResponseOutputs"
- description: The channel's output properties.
PlaybackMode:
allOf:
- $ref: "#/components/schemas/__string"
- description: The channel's playback mode.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned 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 Tagging AWS Elemental MediaTailor Resources.
Tier:
allOf:
- $ref: "#/components/schemas/__string"
- description: The channel's tier.
DescribeLiveSourceResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN of the live source.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the live source was created.
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: The HTTP package configurations.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the live source was modified.
LiveSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the live source.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location associated with the live source.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned 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 Tagging AWS Elemental MediaTailor Resources.
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.
DescribeSourceLocationResponse:
type: object
properties:
AccessConfiguration:
allOf:
- $ref: "#/components/schemas/AccessConfiguration"
- description: The access configuration for the source location.
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN of the source location.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the source location was created.
DefaultSegmentDeliveryConfiguration:
allOf:
- $ref: "#/components/schemas/DefaultSegmentDeliveryConfiguration"
- description: The default segment delivery configuration settings.
HttpConfiguration:
allOf:
- $ref: "#/components/schemas/HttpConfiguration"
- description: The HTTP package configuration settings for the source location.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the source location was last modified.
SegmentDeliveryConfigurations:
allOf:
- $ref: "#/components/schemas/__listOfSegmentDeliveryConfiguration"
- description: A list of the segment delivery configurations associated with this resource.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned to the source location. 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 Tagging AWS Elemental MediaTailor Resources.
DescribeVodSourceResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN of the VOD source.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the VOD source was created.
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: The HTTP package configurations.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The last modified time of the VOD source.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location associated with the VOD source.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned to the VOD 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 Tagging AWS Elemental MediaTailor Resources.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the VOD source.
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.
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.
GetPlaybackConfigurationResponse:
type: object
properties:
AdDecisionServerUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes
player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
AvailSuppression:
allOf:
- $ref: "#/components/schemas/AvailSuppression"
- description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper:
allOf:
- $ref: "#/components/schemas/Bumper"
- description: 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:
allOf:
- $ref: "#/components/schemas/CdnConfiguration"
- description: The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
ConfigurationAliases:
allOf:
- $ref: "#/components/schemas/ConfigurationAliasesResponse"
- description: The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfiguration:
allOf:
- $ref: "#/components/schemas/DashConfiguration"
- description: The configuration for DASH content.
HlsConfiguration:
allOf:
- $ref: "#/components/schemas/HlsConfiguration"
- description: The configuration for HLS content.
LivePreRollConfiguration:
allOf:
- $ref: "#/components/schemas/LivePreRollConfiguration"
- description: The configuration for pre-roll ad insertion.
LogConfiguration:
allOf:
- $ref: "#/components/schemas/LogConfiguration"
- description: The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules:
allOf:
- $ref: "#/components/schemas/ManifestProcessingRules"
- description: The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Name:
allOf:
- $ref: "#/components/schemas/__string"
- description: The identifier for the playback configuration.
PersonalizationThresholdSeconds:
allOf:
- $ref: "#/components/schemas/__integerMin1"
- description: Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the
personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because
it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
PlaybackConfigurationArn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The Amazon Resource Name (ARN) for the playback configuration.
PlaybackEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
SessionInitializationEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL that the player uses to initialize a session that uses client-side reporting.
SlateAdUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content.
Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content.
The slate must be a high-quality asset that contains both audio and video.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned to the playback configuration. 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 Tagging AWS Elemental MediaTailor Resources.
TranscodeProfileName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only
if you have already set up custom profiles with the help of AWS Support.
VideoContentSourceUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
GetPrefetchScheduleResponse:
type: object
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The Amazon Resource Name (ARN) of the prefetch schedule.
Consumption:
allOf:
- $ref: "#/components/schemas/PrefetchConsumption"
- description: Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a
consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
Name:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
PlaybackConfigurationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the playback configuration to create the prefetch schedule for.
Retrieval:
allOf:
- $ref: "#/components/schemas/PrefetchRetrieval"
- description: A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
StreamId:
allOf:
- $ref: "#/components/schemas/__string"
- description: An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
ListAlertsResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfAlert"
- description: A list of alerts that are associated with this resource.
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.
ListChannelsResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfChannel"
- description: A list of channels that are associated with this account.
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.
ListLiveSourcesResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfLiveSource"
- description: Lists the live sources.
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.
ListPlaybackConfigurationsResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfPlaybackConfiguration"
- description: Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations
stored.
NextToken:
allOf:
- $ref: "#/components/schemas/__string"
- description: Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.
ListPrefetchSchedulesResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfPrefetchSchedule"
- description: Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
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.
ListSourceLocationsResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfSourceLocation"
- description: A list of source locations.
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.
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags associated with this resource. 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 Tagging AWS Elemental MediaTailor Resources.
BadRequestException: {}
ListVodSourcesResponse:
type: object
properties:
Items:
allOf:
- $ref: "#/components/schemas/__listOfVodSource"
- description: Lists the VOD sources.
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.
PutChannelPolicyResponse:
type: object
properties: {}
PutPlaybackConfigurationResponse:
type: object
properties:
AdDecisionServerUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes
player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
AvailSuppression:
allOf:
- $ref: "#/components/schemas/AvailSuppression"
- description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper:
allOf:
- $ref: "#/components/schemas/Bumper"
- description: 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:
allOf:
- $ref: "#/components/schemas/CdnConfiguration"
- description: The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
ConfigurationAliases:
allOf:
- $ref: "#/components/schemas/ConfigurationAliasesResponse"
- description: The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
DashConfiguration:
allOf:
- $ref: "#/components/schemas/DashConfiguration"
- description: The configuration for DASH content.
HlsConfiguration:
allOf:
- $ref: "#/components/schemas/HlsConfiguration"
- description: The configuration for HLS content.
LivePreRollConfiguration:
allOf:
- $ref: "#/components/schemas/LivePreRollConfiguration"
- description: The configuration for pre-roll ad insertion.
LogConfiguration:
allOf:
- $ref: "#/components/schemas/LogConfiguration"
- description: The Amazon CloudWatch log settings for a playback configuration.
ManifestProcessingRules:
allOf:
- $ref: "#/components/schemas/ManifestProcessingRules"
- description: The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Name:
allOf:
- $ref: "#/components/schemas/__string"
- description: The identifier for the playback configuration.
PersonalizationThresholdSeconds:
allOf:
- $ref: "#/components/schemas/__integerMin1"
- description: Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the
personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because
it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
PlaybackConfigurationArn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The Amazon Resource Name (ARN) associated with the playback configuration.
PlaybackEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The playback endpoint prefix associated with the playback configuration.
SessionInitializationEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The session initialization endpoint prefix associated with the playback configuration.
SlateAdUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content.
Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content.
The slate must be a high-quality asset that contains both audio and video.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags to assign to the playback configuration. 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 Tagging AWS Elemental MediaTailor Resources.
TranscodeProfileName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only
if you have already set up custom profiles with the help of AWS Support.
VideoContentSourceUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Mode:
type: string
enum:
- OFF
- BEHIND_LIVE_EDGE
OriginManifestType:
type: string
enum:
- SINGLE_PERIOD
- MULTI_PERIOD
__integer:
type: integer
AdMarkerPassthrough:
type: object
properties:
Enabled:
allOf:
- $ref: "#/components/schemas/__boolean"
- description: Enables ad marker passthrough for your configuration.
description: 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.
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.
The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
S3_SIGV4
- AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4)
authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
" SecretsManagerAccessTokenConfiguration: allOf: - $ref: "#/components/schemas/SecretsManagerAccessTokenConfiguration" - description: AWS Secrets Manager access token configuration parameters. description: Access configuration parameters. MessageType: type: string enum: - SPLICE_INSERT - TIME_SIGNAL __long: type: integer 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. SpliceInsertMessage: type: object properties: AvailNum: allOf: - $ref: "#/components/schemas/__integer" - description: This is written tosplice_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.
TimeSignalMessage:
type: object
properties:
SegmentationDescriptors:
allOf:
- $ref: "#/components/schemas/SegmentationDescriptorList"
- description: The configurations for the SCTE-35 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.
NOT_PROCESSED.
AlertMessage:
allOf:
- $ref: "#/components/schemas/__string"
- description: If an alert is generated for a resource, an explanation of the reason for the alert.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp when the alert was last modified.
RelatedResourceArns:
allOf:
- $ref: "#/components/schemas/__listOf__string"
- description: The Amazon Resource Names (ARNs) related to this alert.
ResourceArn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The Amazon Resource Name (ARN) of the resource.
description: Alert configuration parameters.
Operator:
type: string
enum:
- EQUALS
AvailMatchingCriteria:
type: object
required:
- DynamicVariable
- Operator
properties:
DynamicVariable:
allOf:
- $ref: "#/components/schemas/__string"
- description: The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
Operator: allOf: - $ref: "#/components/schemas/Operator" - description: For theDynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
description: MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and
your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And
the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the
prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can
specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can
model logical OR combinations by creating multiple prefetch schedules.
BEHIND_LIVE_EDGE, ad
suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
Value:
allOf:
- $ref: "#/components/schemas/__string"
- description: A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with
the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest
lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45
minutes behind the live edge.
description: The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Bumper:
type: object
properties:
EndUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the end bumper asset.
StartUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the start bumper asset.
description: 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:
type: object
properties:
AdSegmentUrlPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad
segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this
AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.
ContentSegmentUrlPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the
content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the
source for content segments.
description: The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
LogConfigurationForChannel:
type: object
properties:
LogTypes:
allOf:
- $ref: "#/components/schemas/LogTypes"
- description: The log types.
description: The log configuration for the channel.
ResponseOutputs:
type: array
items:
$ref: "#/components/schemas/ResponseOutputItem"
Channel:
type: object
required:
- Arn
- ChannelName
- ChannelState
- LogConfiguration
- Outputs
- PlaybackMode
- Tier
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN of the channel.
ChannelName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the channel.
ChannelState:
allOf:
- $ref: "#/components/schemas/__string"
- 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 of when the channel was last modified.
LogConfiguration:
allOf:
- $ref: "#/components/schemas/LogConfigurationForChannel"
- description: The log configuration.
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.
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 60, 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 debug log mode.
Valid values: 0
- 100
LINEAR PlaybackMode.
MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
Outputs:
allOf:
- $ref: "#/components/schemas/RequestOutputs"
- description: The channel's output properties.
PlaybackMode:
allOf:
- $ref: "#/components/schemas/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.
scte.event_id, 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 DeletePrefetchSchedule.
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 StartTime, the prefetched ads are available after MediaTailor retrives
them from the ad decision server.
description: A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
PrefetchRetrieval:
type: object
required:
- EndTime
properties:
DynamicVariables:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- description: The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify
DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
StreamId is specified,
MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback
configuration, regardless of StreamId.
__listOfAdBreak:
type: array
items:
$ref: "#/components/schemas/AdBreak"
ScheduleConfiguration:
type: object
required:
- Transition
properties:
ClipRange:
allOf:
- $ref: "#/components/schemas/ClipRange"
- description: Program clip range configuration.
Transition:
allOf:
- $ref: "#/components/schemas/Transition"
- description: Program transition configurations.
description: Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.
CreateProgramRequest:
type: object
required:
- ScheduleConfiguration
- SourceLocationName
title: CreateProgramRequest
properties:
AdBreaks:
allOf:
- $ref: "#/components/schemas/__listOfAdBreak"
- description: The ad break configuration settings.
LiveSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the LiveSource for this Program.
ScheduleConfiguration:
allOf:
- $ref: "#/components/schemas/ScheduleConfiguration"
- description: The schedule configuration settings.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name that's used to refer to a VOD source.
DefaultSegmentDeliveryConfiguration:
type: object
properties:
BaseUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
description: 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.
HttpConfiguration:
type: object
required:
- BaseUrl
properties:
BaseUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The base URL for the source location host server. This string must include the protocol, such as https://.
description: The HTTP configuration for the source location.
__listOfSegmentDeliveryConfiguration:
type: array
items:
$ref: "#/components/schemas/SegmentDeliveryConfiguration"
CreateSourceLocationRequest:
type: object
required:
- HttpConfiguration
title: CreateSourceLocationRequest
properties:
AccessConfiguration:
allOf:
- $ref: "#/components/schemas/AccessConfiguration"
- description: Access configuration parameters. Configures the type of authentication used to access content from your source location.
DefaultSegmentDeliveryConfiguration:
allOf:
- $ref: "#/components/schemas/DefaultSegmentDeliveryConfiguration"
- description: The optional configuration for the server that serves segments.
HttpConfiguration:
allOf:
- $ref: "#/components/schemas/HttpConfiguration"
- description: The source's HTTP package configurations.
SegmentDeliveryConfigurations:
allOf:
- $ref: "#/components/schemas/__listOfSegmentDeliveryConfiguration"
- description: A list of the segment delivery configurations associated with this resource.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags to assign to the source location. 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 Tagging AWS Elemental MediaTailor Resources.
CreateVodSourceRequest:
type: object
required:
- HttpPackageConfigurations
title: CreateVodSourceRequest
properties:
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: A list of HTTP package configuration parameters for this VOD source.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags to assign to the VOD 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 Tagging AWS Elemental MediaTailor Resources.
DashConfiguration:
type: object
properties:
ManifestEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.
MpdLocation:
allOf:
- $ref: "#/components/schemas/__string"
- description: The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to
be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side
reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion
of the tag and is the default value.
OriginManifestType:
allOf:
- $ref: "#/components/schemas/OriginManifestType"
- description: The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces
single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to
MULTI_PERIOD.
description: The configuration for DASH content.
DashConfigurationForPut:
type: object
properties:
MpdLocation:
allOf:
- $ref: "#/components/schemas/__string"
- description: The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to
be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side
reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion
of the tag and is the default value.
OriginManifestType:
allOf:
- $ref: "#/components/schemas/OriginManifestType"
- description: The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces
single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to
MULTI_PERIOD.
description: The configuration for DASH PUT operations.
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.
DeleteChannelPolicyRequest:
type: object
title: DeleteChannelPolicyRequest
properties: {}
DeleteChannelRequest:
type: object
title: DeleteChannelRequest
properties: {}
DeleteLiveSourceRequest:
type: object
title: DeleteLiveSourceRequest
properties: {}
DeletePlaybackConfigurationRequest:
type: object
title: DeletePlaybackConfigurationRequest
properties: {}
DeletePrefetchScheduleRequest:
type: object
title: DeletePrefetchScheduleRequest
properties: {}
DeleteProgramRequest:
type: object
title: DeleteProgramRequest
properties: {}
DeleteSourceLocationRequest:
type: object
title: DeleteSourceLocationRequest
properties: {}
DeleteVodSourceRequest:
type: object
title: DeleteVodSourceRequest
properties: {}
DescribeChannelRequest:
type: object
title: DescribeChannelRequest
properties: {}
DescribeLiveSourceRequest:
type: object
title: DescribeLiveSourceRequest
properties: {}
DescribeProgramRequest:
type: object
title: DescribeProgramRequest
properties: {}
Long:
type: integer
DescribeSourceLocationRequest:
type: object
title: DescribeSourceLocationRequest
properties: {}
DescribeVodSourceRequest:
type: object
title: DescribeVodSourceRequest
properties: {}
GetChannelPolicyRequest:
type: object
title: GetChannelPolicyRequest
properties: {}
MaxResults:
type: integer
minimum: 1
maximum: 100
GetChannelScheduleRequest:
type: object
title: GetChannelScheduleRequest
properties: {}
__listOfScheduleEntry:
type: array
items:
$ref: "#/components/schemas/ScheduleEntry"
GetPlaybackConfigurationRequest:
type: object
title: GetPlaybackConfigurationRequest
properties: {}
HlsConfiguration:
type: object
properties:
ManifestEndpointPrefix:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
description: The configuration for HLS content.
LivePreRollConfiguration:
type: object
properties:
AdDecisionServerUrl:
allOf:
- $ref: "#/components/schemas/__string"
- description: The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental
MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is
25,000 characters.
MaxDurationSeconds:
allOf:
- $ref: "#/components/schemas/__integer"
- description: The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that
the ADS returns.
description: The configuration for pre-roll ad insertion.
LogConfiguration:
type: object
required:
- PercentEnabled
properties:
PercentEnabled:
allOf:
- $ref: "#/components/schemas/__integer"
- description: '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 60, 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 debug log mode.
Valid values: 0
- 100
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.
30 seconds. Maximum value: 3600 seconds."
description: HLS playlist configuration parameters.
Type:
type: string
enum:
- DASH
- HLS
Integer:
type: integer
ListAlertsRequest:
type: object
title: ListAlertsRequest
properties: {}
__listOfAlert:
type: array
items:
$ref: "#/components/schemas/Alert"
ListChannelsRequest:
type: object
title: ListChannelsRequest
properties: {}
__listOfChannel:
type: array
items:
$ref: "#/components/schemas/Channel"
ListLiveSourcesRequest:
type: object
title: ListLiveSourcesRequest
properties: {}
__listOfLiveSource:
type: array
items:
$ref: "#/components/schemas/LiveSource"
ListPlaybackConfigurationsRequest:
type: object
title: ListPlaybackConfigurationsRequest
properties: {}
__listOfPlaybackConfiguration:
type: array
items:
$ref: "#/components/schemas/PlaybackConfiguration"
__integerMin1Max100:
type: integer
minimum: 1
maximum: 100
ListPrefetchSchedulesRequest:
type: object
title: ListPrefetchSchedulesRequest
properties:
MaxResults:
allOf:
- $ref: "#/components/schemas/__integerMin1Max100"
- description: The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than MaxResults prefetch
schedules, use the value of NextToken in the response to get the next page of results.
NextToken:
allOf:
- $ref: "#/components/schemas/__string"
- description: (Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of
results.
For the first ListPrefetchSchedulesRequest 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 prefetch schedules to get.
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.
LINEAR PlaybackMode.
MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
Outputs:
allOf:
- $ref: "#/components/schemas/RequestOutputs"
- description: The channel's output properties.
UpdateLiveSourceRequest:
type: object
required:
- HttpPackageConfigurations
title: UpdateLiveSourceRequest
properties:
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: A list of HTTP package configurations for the live source on this account.
UpdateProgramScheduleConfiguration:
type: object
properties:
ClipRange:
allOf:
- $ref: "#/components/schemas/ClipRange"
- description: Program clip range configuration.
Transition:
allOf:
- $ref: "#/components/schemas/UpdateProgramTransition"
- description: Program transition configuration.
description: Schedule configuration parameters.
UpdateProgramRequest:
type: object
required:
- ScheduleConfiguration
title: UpdateProgramRequest
properties:
AdBreaks:
allOf:
- $ref: "#/components/schemas/__listOfAdBreak"
- description: The ad break configuration settings.
ScheduleConfiguration:
allOf:
- $ref: "#/components/schemas/UpdateProgramScheduleConfiguration"
- description: The schedule configuration settings.
UpdateSourceLocationRequest:
type: object
required:
- HttpConfiguration
title: UpdateSourceLocationRequest
properties:
AccessConfiguration:
allOf:
- $ref: "#/components/schemas/AccessConfiguration"
- description: Access configuration parameters. Configures the type of authentication used to access content from your source location.
DefaultSegmentDeliveryConfiguration:
allOf:
- $ref: "#/components/schemas/DefaultSegmentDeliveryConfiguration"
- description: The optional configuration for the host server that serves segments.
HttpConfiguration:
allOf:
- $ref: "#/components/schemas/HttpConfiguration"
- description: The HTTP configuration for the source location.
SegmentDeliveryConfigurations:
allOf:
- $ref: "#/components/schemas/__listOfSegmentDeliveryConfiguration"
- description: A list of the segment delivery configurations associated with this resource.
UpdateVodSourceRequest:
type: object
required:
- HttpPackageConfigurations
title: UpdateVodSourceRequest
properties:
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: A list of HTTP package configurations for the VOD source on this account.
VodSource:
type: object
required:
- Arn
- HttpPackageConfigurations
- SourceLocationName
- VodSourceName
properties:
Arn:
allOf:
- $ref: "#/components/schemas/__string"
- description: The ARN for the VOD source.
CreationTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the VOD source was created.
HttpPackageConfigurations:
allOf:
- $ref: "#/components/schemas/HttpPackageConfigurations"
- description: The HTTP package configurations for the VOD source.
LastModifiedTime:
allOf:
- $ref: "#/components/schemas/__timestampUnix"
- description: The timestamp that indicates when the VOD source was last modified.
SourceLocationName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the source location that the VOD source is associated with.
Tags:
allOf:
- $ref: "#/components/schemas/__mapOf__string"
- xml:
name: tags
description: The tags assigned to the VOD 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 Tagging AWS Elemental MediaTailor Resources.
VodSourceName:
allOf:
- $ref: "#/components/schemas/__string"
- description: The name of the VOD source.
description: VOD source configuration parameters.
security:
- hmac: []