AWS API Changes

2019/02/13 - AWS MediaTailor - 3 new 3 updated api methods

Changes This release adds support for tagging AWS Elemental MediaTailor resources.

UntagResource (new)

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

type TagKeys

list

param TagKeys

[REQUIRED]

A comma-separated list of the tag keys to remove from the playback configuration.

(string) --

returns

None

ListTagsForResource (new)

Link ¶

Returns a list of the tags assigned to the specified playback configuration resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

rtype

dict

returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --

Success.
- Tags (dict) --
  
  A comma-separated list of tag key:value pairs. For example: { "Key1": "Value1", "Key2": "Value2" }
  - (string) --
    - (string) --

TagResource (new)

Link ¶

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

type Tags

dict

param Tags

[REQUIRED]

A comma-separated list of tag key:value pairs. For example: { "Key1": "Value1", "Key2": "Value2" }

(string) --
- (string) --

returns

None

GetPlaybackConfiguration (updated)

Link ¶
Changes (response)

{'PlaybackConfigurationArn': 'string', 'Tags': {'string': 'string'}}

Returns the playback 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 playback configuration.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --

Success.
- 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 25,000 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 for DASH content.
  - ManifestEndpointPrefix (string) --
    
    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) --
    
    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 playback configuration.
- PlaybackConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) for the playback 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) --
  
  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.
- Tags (dict) --
  
  The tags assigned to the playback configuration.
  - (string) --
    - (string) --
- TranscodeProfileName (string) --
  
  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.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

ListPlaybackConfigurations (updated)

Link ¶
Changes (response)

{'Items': {'DashConfiguration': {'ManifestEndpointPrefix': 'string',
                                 'MpdLocation': 'string'},
           'HlsConfiguration': {'ManifestEndpointPrefix': 'string'},
           'PlaybackConfigurationArn': 'string',
           'PlaybackEndpointPrefix': 'string',
           'SessionInitializationEndpointPrefix': 'string',
           'Tags': {'string': 'string'},
           'TranscodeProfileName': 'string'}}

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.

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 exceed the maximum allowed. Use the token to fetch the next page of results.

rtype

dict

returns

Response Syntax

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

Response Structure

(dict) --

Success.
- Items (list) --
  
  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.
  - (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 25,000 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 for DASH content.
      - ManifestEndpointPrefix (string) --
        
        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) --
        
        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 playback configuration.
    - PlaybackConfigurationArn (string) --
      
      The Amazon Resource Name (ARN) for the playback 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) --
      
      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.
    - Tags (dict) --
      
      The tags assigned to the playback configuration.
      - (string) --
        
        (string) --
    - TranscodeProfileName (string) --
      
      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.
    - 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 exceed the maximum allowed. Use the token to fetch the next page of results.

PutPlaybackConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'Tags': {'string': 'string'}}

Response

{'PlaybackConfigurationArn': 'string', 'Tags': {'string': 'string'}}

Adds a new playback 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',
    Tags={
        'string': '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 25,000 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 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 playback 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 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 Tags

dict

param Tags

The tags to assign to the playback configuration.

(string) --
- (string) --

type TranscodeProfileName

string

param 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 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',
    'PlaybackConfigurationArn': 'string',
    'PlaybackEndpointPrefix': 'string',
    'SessionInitializationEndpointPrefix': 'string',
    'SlateAdUrl': 'string',
    'Tags': {
        'string': 'string'
    },
    'TranscodeProfileName': 'string',
    'VideoContentSourceUrl': 'string'
}

Response Structure

(dict) --

Success.
- 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 25,000 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 for DASH content.
  - ManifestEndpointPrefix (string) --
    
    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) --
    
    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 playback configuration.
- PlaybackConfigurationArn (string) --
  
  The Amazon Resource Name (ARN) for the playback 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) --
  
  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.
- Tags (dict) --
  
  The tags assigned to the playback configuration.
  - (string) --
    - (string) --
- TranscodeProfileName (string) --
  
  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.
- VideoContentSourceUrl (string) --
  
  The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.