AWS API Changes

2018/06/01 - AWS MediaTailor - 4 new api methods

Changes AWS Elemental MediaTailor is a personalization and monetization service that allows scalable server-side ad insertion. The service enables you to serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. This SDK allows user access to the AWS Elemental MediaTailor configuration interface.

PutPlaybackConfiguration (new)

Link ¶

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'
    },
    Name='string',
    SlateAdUrl='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 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 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'
    },
    'HlsConfiguration': {
        'ManifestEndpointPrefix': 'string'
    },
    'Name': 'string',
    'PlaybackEndpointPrefix': 'string',
    'SessionInitializationEndpointPrefix': 'string',
    'SlateAdUrl': '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.
- 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.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

DeletePlaybackConfiguration (new)

Link ¶

Deletes the configuration for the specified name.

See also: AWS API Documentation

Request Syntax

client.delete_playback_configuration(
    Name='string'
)

type Name

string

param Name

[REQUIRED]

The identifier for the configuration.

rtype

dict

returns

Response Syntax

{}

Response Structure

(dict) --

ListPlaybackConfigurations (new)

Link ¶

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

See also: AWS API Documentation

Request Syntax

client.list_playback_configurations(
    MaxResults=123,
    NextToken='string'
)

type MaxResults

integer

param MaxResults

Maximum number of records to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Items': [
        {
            'AdDecisionServerUrl': 'string',
            'CdnConfiguration': {
                'AdSegmentUrlPrefix': 'string',
                'ContentSegmentUrlPrefix': 'string'
            },
            'Name': 'string',
            'SlateAdUrl': 'string',
            'VideoContentSourceUrl': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Items (list) --
  
  Array of playback configurations. This may be all of the available configurations or a subset, depending on the settings you provide and on the total number of configurations stored.
  - (dict) --
    
    The AWSMediaTailor configuration.
    - 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.
    - Name (string) --
      
      The identifier for the configuration.
    - 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.
    - VideoContentSourceUrl (string) --
      
      The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
- NextToken (string) --
  
  Pagination token returned by the GET list request when results overrun the meximum allowed. Use the token to fetch the next page of results.

GetPlaybackConfiguration (new)

Link ¶

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'
    },
    'HlsConfiguration': {
        'ManifestEndpointPrefix': 'string'
    },
    'Name': 'string',
    'PlaybackEndpointPrefix': 'string',
    'SessionInitializationEndpointPrefix': 'string',
    'SlateAdUrl': '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.
- 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.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.