The configuration for creating a playback configuration.
Bumper
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.
Properties
Type: Bumper (p. 84) Required: False
DashConfiguration
The configuration for DASH content.
Type: DashConfigurationForPut (p. 86) Required: False
CdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Type: CdnConfiguration (p. 84) Required: False
ManifestProcessingRules
The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
Type: ManifestProcessingRules (p. 90) Required: False
PersonalizationThresholdSeconds
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.
Type: integer Required: False Minimum: 1
LivePreRollConfiguration
The configuration for pre-roll ad insertion.
Type: LivePreRollConfiguration (p. 89) Required: False
VideoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
Type: string Required: False
Properties
Name
The identifier for the playback configuration.
Type: string Required: False
tags
The tags to assign to the playback configuration.
Type: object Required: False
TranscodeProfileName
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.
Type: string Required: False
ConfigurationAliases
The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
Example Example
PUT /playbackConfiguration {"Name": "testConfig",
"AdDecisionServerUrl": "http://testAds.com",
"VideoContentSourceUrl": "http://testOrigin.com", ...
"ConfigurationAliases": {
"player_params.origin_domain": {
"pdx": "123456789.mediapackage.us-west-2.amazonaws.com", "iad": "987654321.mediapackage.us-east-1.amazonaws.com", },
"player_params.ad_type": {
"spec": "my-internal-ads-type",
"default": "default-internal-ads-type"
}, }, ...}
Type: ConfigurationAliasesRequest (p. 85) Required: False
AdDecisionServerUrl
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
See also
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 Required: False
SlateAdUrl
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.
Type: string Required: False
AvailSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
Type: AvailSuppression (p. 84) Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
PutPlaybackConfiguration
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
SourceLocation
Describes, creates, updates, and 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.
URI
/v1/sourceLocation/sourceLocationName
HTTP methods
HTTP methods
GET
Operation ID: DescribeSourceLocation
Retrieves the properties of the requested source location.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
Responses
Status code Response model Description
200 DescribeSourceLocationResponse (p. 96)Success.
POST
Operation ID: CreateSourceLocation Creates a source location on a specific channel.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
Responses
Status code Response model Description
200 DescribeSourceLocationResponse (p. 96)Success.
PUT
Operation ID: UpdateSourceLocation Updates a source location on a specific channel.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
Schemas
Responses
Status code Response model Description
200 DescribeSourceLocationResponse (p. 96)Success.
DELETE
Operation ID: DeleteSourceLocation Deletes a source location on a specific channel.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
Responses
Status code Response model Description
200 DeleteSourceLocationResponse (p. 97)Success.
OPTIONS
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
Responses
Status code Response model Description
200 None 200 response
Schemas
Request bodies
POST schema
{ "DefaultSegmentDeliveryConfiguration": {
Schemas
"BaseUrl": "string"
}, "HttpConfiguration": { "BaseUrl": "string"
}, "AccessConfiguration": {
"SecretsManagerAccessTokenConfiguration": { "SecretArn": "string",
"HeaderName": "string", "SecretStringKey": "string"
},
"AccessType": enum }, "tags": {
}}
PUT schema
{ "DefaultSegmentDeliveryConfiguration": { "BaseUrl": "string"
}, "HttpConfiguration": { "BaseUrl": "string"
}, "AccessConfiguration": {
"SecretsManagerAccessTokenConfiguration": { "SecretArn": "string",
"HeaderName": "string", "SecretStringKey": "string"
},
"AccessType": enum }
}
Response bodies
DescribeSourceLocationResponse schema
{
"SourceLocationName": "string",
"DefaultSegmentDeliveryConfiguration": { "BaseUrl": "string"
}, "CreationTime": integer, "LastModifiedTime": integer, "HttpConfiguration": { "BaseUrl": "string"
}, "Arn": "string",
"AccessConfiguration": {
"SecretsManagerAccessTokenConfiguration": { "SecretArn": "string",
"HeaderName": "string", "SecretStringKey": "string"
},
"AccessType": enum },
"tags": { }
Properties
}
DeleteSourceLocationResponse schema
{}
Properties
AccessConfiguration
Access configuration parameters.
SecretsManagerAccessTokenConfiguration
AWS Secrets Manager access token configuration parameters.
Type: SecretsManagerAccessTokenConfiguration (p. 100) Required: False
AccessType
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.
Type: string Required: False
Values: S3_SIGV4 | SECRETS_MANAGER_ACCESS_TOKEN
CreateSourceLocationRequest
Source location configuration parameters.
DefaultSegmentDeliveryConfiguration
The optional configuration for the server that serves segments.
Properties
Type: DefaultSegmentDeliveryConfiguration (p. 98) Required: False
HttpConfiguration
The source's HTTP package configurations.
Type: HttpConfiguration (p. 100) Required: True
AccessConfiguration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
Type: AccessConfiguration (p. 97) Required: False
tags
The tags to assign to the source location.
Type: object Required: False
DefaultSegmentDeliveryConfiguration
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.
BaseUrl
The hostname of the server that will be used to serve segments. This string must include the protocol, such as https://.
Type: string Required: False
DeleteSourceLocationResponse
This response includes only the "type" : "object" property.
DescribeSourceLocationResponse
This response includes only the "type" : "object" property.
SourceLocationName
The name of the source location.
Properties
Type: string Required: True
DefaultSegmentDeliveryConfiguration
The default segment delivery configuration settings.
Type: DefaultSegmentDeliveryConfiguration (p. 98) Required: False
CreationTime
The timestamp that indicates when the source location was created.
Type: integer Required: False Format: date-time
LastModifiedTime
The timestamp that indicates when the source location was last modified.
Type: integer Required: False Format: date-time
HttpConfiguration
The HTTP package configuration settings for the source location.
Type: HttpConfiguration (p. 100) Required: True
Arn
The ARN of the source location.
Type: string Required: True
AccessConfiguration
The access configuration for the source location.
Type: AccessConfiguration (p. 97) Required: False
tags
The tags assigned to the source location.
Type: object Required: False
Properties
HttpConfiguration
The HTTP configuration for the source location.
BaseUrl
The base URL for the source location host server. This string must include the protocol, such as https://.
Type: string Required: True
SecretsManagerAccessTokenConfiguration
AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see Working with AWS Secrets Manager access token authentication.
SecretArn
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.
Type: string Required: False
HeaderName
The name of the HTTP header used to supply the access token in requests to the source location.
Type: string Required: False
SecretStringKey
The AWS Secrets Manager SecretString key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.
Type: string Required: False
UpdateSourceLocationRequest
Source location configuration parameters.
DefaultSegmentDeliveryConfiguration
The optional configuration for the host server that serves segments.
Type: DefaultSegmentDeliveryConfiguration (p. 98) Required: False
HttpConfiguration
The HTTP configuration for the source location.
Type: HttpConfiguration (p. 100)
See also
Required: True
AccessConfiguration
Access configuration parameters. Configures the type of authentication used to access content from your source location.
Type: AccessConfiguration (p. 97) Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
DescribeSourceLocation
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateSourceLocation
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateSourceLocation
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
StartChannel
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteSourceLocation
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StartChannel
Starts a channel.
URI
/v1/channel/channelName/start
HTTP methods
PUT
Operation ID: StartChannel Starts a specific channel.
Path parameters
Name Type Required Description
channelName String True The identifier for
the channel you are working on.
Responses
Status code Response model Description
200 None Success.
See also
OPTIONS
Path parameters
Name Type Required Description
channelName String True The identifier for
the channel you are working on.
Responses
Status code Response model Description
200 None 200 response
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
StartChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
StopChannel
Stops a channel.
URI
/v1/channel/channelName/stop
HTTP methods
PUT
Operation ID: StopChannel
See also
Stops a specific channel.
Path parameters
Name Type Required Description
channelName String True The identifier for
the channel you are working on.
Responses
Status code Response model Description
200 None Success.
OPTIONS
Path parameters
Name Type Required Description
channelName String True The identifier for
the channel you are working on.
Responses
Status code Response model Description
200 None 200 response
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
StopChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Tags
Tags
Manages tags for MediaTailor playback configurations. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. MediaTailor offers tagging support for playback configuration resources. For more information, see Tagging AWS Elemental MediaTailor Resources.
URI
/v1/tags/ResourceArn
HTTP methods
GET
Operation ID: ListTagsForResource
Returns a list of the tags assigned to the specified playback configuration resource.
Example Request
GET /tags/arn:aws:mediatailor:us-east-1:111111111111:playbackConfiguration/testConfig
Example Response
Success: 200 { "tags": {
"testKey": "testValue", "newTestKey": "newTestValue"
}
Path parameters
Name Type Required Description
ResourceArn String True The Amazon Resource
Name (ARN) for the playback configuration.
You can get this from the response to any playback configuration request.
Responses
Status code Response model Description
200 TagsModel (p. 107) Success.
400 BadRequestException (p. 108)One or more parameters in this request aren't valid.
HTTP methods
POST
Operation ID: TagResource
Adds tags to the specified playback configuration resource. You can specify one or more tags to add.
Example Request
POST /tags/arn:aws:mediatailor:us-east-1:111111111111:playbackConfiguration/testConfig { "tags": {
"newTestKey": "newTestValue"
} }
Example Response
Success: 204 {}
Path parameters
Name Type Required Description
ResourceArn String True The Amazon Resource
Name (ARN) for the playback configuration.
You can get this from the response to any playback configuration request.
Responses
Status code Response model Description
204 None The request was successful
and there is no content in the response.
400 None One or more parameters in this
request aren't valid.
DELETE
Operation ID: UntagResource
Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.
Example Request
DELETE /tags/arn:aws:mediatailor:us-east-1:111111111111:playbackConfiguration/testConfig?
tagKeys="newTestKey"
Schemas
Example Response
Success: 204 {}
Path parameters
Name Type Required Description
ResourceArn String True The Amazon Resource
Name (ARN) for the playback configuration.
You can get this from the response to any playback configuration request.
Query parameters
Name Type Required Description
tagKeys String True A comma-separated
list of the tag keys to remove from the playback configuration.
Responses
Status code Response model Description
204 None The request was successful
and there is no content in the response.
400 None One or more parameters in this
request aren't valid.
Schemas
Request bodies
POST schema
{
"tags": { }}
Response bodies
TagsModel schema
{
Properties
"tags": { }}
BadRequestException schema
{
"Message": "string"
}
Properties
BadRequestException
A request contains unexpected data.
Message
Constructs a new BadRequestException with the specified error message.
Type: string Required: False
TagsModel
A set of tags assigned to a resource.
tags
A comma-separated list of tag key:value pairs.
Type: object Required: True
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
ListTagsForResource
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
VodSource
TagResource
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UntagResource
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
VodSource
Manages VOD sources within a source location.
URI
/v1/sourceLocation/sourceLocationName/vodSource/vodSourceName
HTTP methods
GET
Operation ID: DescribeVodSource
Provides details about a specific VOD source in a specific source location.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
HTTP methods
Name Type Required Description
vodSourceName String True The identifier for the
VOD source you are working on.
Responses
Status code Response model Description
200 DescribeVodSourceResponse (p. 112)Success.
POST
Operation ID: CreateVodSource
Creates name for a specific VOD source in a source location.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
vodSourceName String True The identifier for the
VOD source you are working on.
Responses
Status code Response model Description
200 DescribeVodSourceResponse (p. 112)Success.
PUT
Operation ID: UpdateVodSource
Updates a specific VOD source in a specific source location.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
vodSourceName String True The identifier for the
VOD source you are working on.
Schemas
Responses
Status code Response model Description
200 DescribeVodSourceResponse (p. 112)Success.
DELETE
Operation ID: DeleteVodSource
Deletes a specific VOD source in a specific source location.
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
vodSourceName String True The identifier for the
VOD source you are working on.
Responses
Status code Response model Description
200 DeleteVodSourceResponse (p. 112)Success.
OPTIONS
Path parameters
Name Type Required Description
sourceLocationName String True The identifier for the source location you are working on.
vodSourceName String True The identifier for the
VOD source you are working on.
Responses
Status code Response model Description
200 None 200 response
Schemas
Request bodies
Properties
POST schema
{ "HttpPackageConfigurations": [ {
"Path": "string", "Type": enum,
"SourceGroup": "string"
}
"HttpPackageConfigurations": [ {
"Path": "string", "Type": enum,
"SourceGroup": "string"
} ]}
Response bodies
DescribeVodSourceResponse schema
{ "VodSourceName": "string", "SourceLocationName": "string", "CreationTime": integer, "LastModifiedTime": integer, "HttpPackageConfigurations": [ {
"Path": "string", "Type": enum,
"SourceGroup": "string"
}
The VOD source configuration parameters.
Properties
HttpPackageConfigurations
An array of HTTP package configuration parameters for this VOD source.
Type: Array of type HttpPackageConfiguration (p. 114) Required: True
tags
The tags to assign to the VOD source.
Type: object Required: False
DeleteVodSourceResponse
This response includes only the "type" : "object" property.
DescribeVodSourceResponse
This response includes only the "type" : "object" property.
VodSourceName
The name of the VOD source.
Type: string Required: True
SourceLocationName
The name of the source location associated with the VOD source.
Type: string Required: True
CreationTime
The timestamp that indicates when the VOD source was created.
Type: integer Required: False Format: date-time
LastModifiedTime
The ARN for the VOD source.
Type: integer Required: False Format: date-time