AWS Elemental MediaTailor
API Reference

PlaybackConfigurations

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

URI

/playbackConfigurations

HTTP Methods

GET

Operation ID: ListPlaybackConfigurations

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

Example request

GET /playbackConfigurations

Example response

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

Query Parameters

Name Type Required Description
MaxResults String False

Maximum number of records to return.

NextToken String False

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Responses

Status Code Response Model Description
200 ListPlaybackConfigurationsResponse

Success.

Schemas

Response Bodies

Example ListPlaybackConfigurationsResponse

{ "NextToken": "string", "Items": [ { "TranscodeProfileName": "string", "SessionInitializationEndpointPrefix": "string", "DashConfiguration": { "ManifestEndpointPrefix": "string", "MpdLocation": "string", "OriginManifestType": enum }, "AdDecisionServerUrl": "string", "CdnConfiguration": { "AdSegmentUrlPrefix": "string", "ContentSegmentUrlPrefix": "string" }, "PlaybackConfigurationArn": "string", "SlateAdUrl": "string", "PlaybackEndpointPrefix": "string", "HlsConfiguration": { "ManifestEndpointPrefix": "string" }, "VideoContentSourceUrl": "string", "Name": "string", "tags": { } } ] }

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 following 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.

OriginManifestType

string

Values: SINGLE_PERIOD | MULTI_PERIOD

False

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.

GetPlaybackConfigurationResponse

Property Type Required Description
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.

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.

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.

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.

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

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.

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.

ListPlaybackConfigurationsResponse

Property Type Required Description
NextToken

string

False

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

Items

Array of type GetPlaybackConfigurationResponse

False

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.

See Also

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

ListPlaybackConfigurations