AWS Elemental MediaTailor
API Reference

PlaybackConfiguration Name

Manages an existing playback configuration. For information about MediaTailor configurations, see Working with Configurations in AWS Elemental MediaTailor.

URI

/playbackConfiguration/Name

HTTP Methods

GET

Operation ID: GetPlaybackConfiguration

Returns the playback configuration for the specified name.

Example Request

GET /playbackConfiguration/testConfig

Example Response

Success: 200 { "Name": "testConfig", "AdDecisionServerUrl": "http://testAds.com", "VideoContentSourceUrl": "http://testOrigin.com", "PlaybackConfigurationArn": "arn:aws:mediatailor:us-east-1:111111111111:playbackConfiguration/testConfig", "tags": { "testKey": "testValue" } }

Path Parameters

Name Type Required Description
Name String True

The identifier for the playback configuration.

Responses

Status Code Response Model Description
200 GetPlaybackConfigurationResponse

Success.

DELETE

Operation ID: DeletePlaybackConfiguration

Deletes the playback configuration for the specified name.

Example Request

DELETE /playbackConfiguration/testConfig

Example Response

Success: 204 {}

Path Parameters

Name Type Required Description
Name String True

The identifier for the playback configuration.

Responses

Status Code Response Model Description
204 DeletePlaybackConfigurationResponse

The request was successful and there is no content in the response.

Schemas

Response Bodies

Example GetPlaybackConfigurationResponse

{ "SessionInitializationEndpointPrefix": "string", "DashConfiguration": { "ManifestEndpointPrefix": "string", "MpdLocation": "string" }, "CdnConfiguration": { "AdSegmentUrlPrefix": "string", "ContentSegmentUrlPrefix": "string" }, "PlaybackConfigurationArn": "string", "LivePreRollConfiguration": { "AdDecisionServerUrl": "string", "MaxDurationSeconds": integer }, "HlsConfiguration": { "ManifestEndpointPrefix": "string" }, "VideoContentSourceUrl": "string", "Name": "string", "tags": { }, "TranscodeProfileName": "string", "AdDecisionServerUrl": "string", "SlateAdUrl": "string", "PlaybackEndpointPrefix": "string" }

Example DeletePlaybackConfigurationResponse

{ }

Properties

CdnConfiguration

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Property Type Required Description
AdSegmentUrlPrefix

string

False

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

string

False

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.

DashConfiguration

The configuration for DASH content.

Property Type Required Description
ManifestEndpointPrefix

string

False

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

MpdLocation

string

False

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.

DeletePlaybackConfigurationResponse

GetPlaybackConfigurationResponse

Property Type Required Description
SessionInitializationEndpointPrefix

string

False

The URL that the player uses to initialize a session that uses client-side reporting.

DashConfiguration

DashConfiguration

False

The configuration for DASH content.

CdnConfiguration

CdnConfiguration

False

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

PlaybackConfigurationArn

string

False

The Amazon Resource Name (ARN) for the playback configuration.

LivePreRollConfiguration

LivePreRollConfiguration

False

The configuration for pre-roll ad insertion.

HlsConfiguration

HlsConfiguration

False

The configuration for HLS content.

VideoContentSourceUrl

string

False

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Name

string

False

The identifier for the playback configuration.

tags

object

False

The tags assigned to the playback configuration.

TranscodeProfileName

string

False

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.

AdDecisionServerUrl

string

False

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.

SlateAdUrl

string

False

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.

PlaybackEndpointPrefix

string

False

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

HlsConfiguration

The configuration for HLS content.

Property Type Required Description
ManifestEndpointPrefix

string

False

The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

LivePreRollConfiguration

The configuration for pre-roll ad insertion.

Property Type Required Description
AdDecisionServerUrl

string

False

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

integer

False

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.

See Also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

GetPlaybackConfiguration

DeletePlaybackConfiguration