AWS API Changes

2018/12/05 - AWS MediaTailor - 2 updated api methods

Changes AWS Elemental MediaTailor SDK now includes a new parameter to control the Location tag of DASH manifests.

GetPlaybackConfiguration (updated)

Link ¶
Changes (response)

{'DashConfiguration': {'MpdLocation': 'string'}}

Returns the configuration for the specified name.

See also: AWS API Documentation

Request Syntax

client.get_playback_configuration(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The identifier for the configuration.

rtype

dict

returns

Response Syntax

{
    'AdDecisionServerUrl': 'string',
    'CdnConfiguration': {
        'AdSegmentUrlPrefix': 'string',
        'ContentSegmentUrlPrefix': 'string'
    },
    'DashConfiguration': {
        'ManifestEndpointPrefix': 'string',
        'MpdLocation': 'string'
    },
    'HlsConfiguration': {
        'ManifestEndpointPrefix': 'string'
    },
    'Name': 'string',
    'PlaybackEndpointPrefix': 'string',
    'SessionInitializationEndpointPrefix': 'string',
    'SlateAdUrl': 'string',
    'TranscodeProfileName': 'string',
    'VideoContentSourceUrl': 'string'
}

Response Structure

(dict) --
- AdDecisionServerUrl (string) --
  
  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 25000 characters.
- CdnConfiguration (dict) --
  
  The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
  - AdSegmentUrlPrefix (string) --
    
    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) --
    
    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 (dict) --
  
  The configuration object for DASH content.
  - ManifestEndpointPrefix (string) --
    
    The URL that is used to initiate a playback session for devices that support DASH.
  - MpdLocation (string) --
    
    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.
- HlsConfiguration (dict) --
  
  The configuration for HLS content.
  - ManifestEndpointPrefix (string) --
    
    The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
- Name (string) --
  
  The identifier for the configuration.
- PlaybackEndpointPrefix (string) --
  
  The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
- SessionInitializationEndpointPrefix (string) --
  
  The URL that the player uses to initialize a session that uses client-side reporting.
- SlateAdUrl (string) --
  
  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 AWS Elemental 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.
- TranscodeProfileName (string) --
  
  Associate this playbackConfiguration with a custom transcode profile, overriding MediaTailor's dynamic transcoding defaults. Do not include this field if you have not setup custom profiles with the MediaTailor service team.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

PutPlaybackConfiguration (updated)

Link ¶
Changes (both)

{'DashConfiguration': {'MpdLocation': 'string'}}

Adds a new configuration to AWS Elemental MediaTailor.

See also: AWS API Documentation

Request Syntax

client.put_playback_configuration(
    AdDecisionServerUrl='string',
    CdnConfiguration={
        'AdSegmentUrlPrefix': 'string',
        'ContentSegmentUrlPrefix': 'string'
    },
    DashConfiguration={
        'MpdLocation': 'string'
    },
    Name='string',
    SlateAdUrl='string',
    TranscodeProfileName='string',
    VideoContentSourceUrl='string'
)

type AdDecisionServerUrl

string

param 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 session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25000 characters.

type CdnConfiguration

dict

param CdnConfiguration

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

AdSegmentUrlPrefix (string) --

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) --

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.

type DashConfiguration

dict

param DashConfiguration

The configuration object for DASH content.

MpdLocation (string) --

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.

type Name

string

param Name

The identifier for the configuration.

type SlateAdUrl

string

param 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 AWS Elemental 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 TranscodeProfileName

string

param TranscodeProfileName

Associate this playbackConfiguration with a custom transcode profile, overriding MediaTailor's dynamic transcoding defaults. Do not include this field if you have not setup custom profiles with the MediaTailor service team.

type VideoContentSourceUrl

string

param VideoContentSourceUrl

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

rtype

dict

returns

Response Syntax

{
    'AdDecisionServerUrl': 'string',
    'CdnConfiguration': {
        'AdSegmentUrlPrefix': 'string',
        'ContentSegmentUrlPrefix': 'string'
    },
    'DashConfiguration': {
        'ManifestEndpointPrefix': 'string',
        'MpdLocation': 'string'
    },
    'HlsConfiguration': {
        'ManifestEndpointPrefix': 'string'
    },
    'Name': 'string',
    'PlaybackEndpointPrefix': 'string',
    'SessionInitializationEndpointPrefix': 'string',
    'SlateAdUrl': 'string',
    'TranscodeProfileName': 'string',
    'VideoContentSourceUrl': 'string'
}

Response Structure

(dict) --
- AdDecisionServerUrl (string) --
  
  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 25000 characters.
- CdnConfiguration (dict) --
  
  The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
  - AdSegmentUrlPrefix (string) --
    
    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) --
    
    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 (dict) --
  
  The configuration object for DASH content.
  - ManifestEndpointPrefix (string) --
    
    The URL that is used to initiate a playback session for devices that support DASH.
  - MpdLocation (string) --
    
    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.
- HlsConfiguration (dict) --
  
  The configuration for HLS content.
  - ManifestEndpointPrefix (string) --
    
    The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.
- Name (string) --
  
  The identifier for the configuration.
- PlaybackEndpointPrefix (string) --
  
  The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.
- SessionInitializationEndpointPrefix (string) --
  
  The URL that the player uses to initialize a session that uses client-side reporting.
- SlateAdUrl (string) --
  
  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 AWS Elemental 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.
- TranscodeProfileName (string) --
  
  Associate this playbackConfiguration with a custom transcode profile, overriding MediaTailor's dynamic transcoding defaults. Do not include this field if you have not setup custom profiles with the MediaTailor service team.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.