AWS API Changes

2026/07/09 - Amazon Interactive Video Service - 4 updated api methods

Changes adds support for AWS IVS ad configuration APIs to allow for a postRollConfiguration object on the ad configuration resource

CreateAdConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'postRollConfiguration': {'durationSeconds': 'integer', 'enabled': 'boolean'}}

Response

{'adConfiguration': {'postRollConfiguration': {'durationSeconds': 'integer',
                                               'enabled': 'boolean'}}}

Creates a new ad configuration to be used for server-side ad insertion.

See also: AWS API Documentation

Request Syntax

client.create_ad_configuration(
    name='string',
    mediaTailorPlaybackConfigurations=[
        {
            'playbackConfigurationArn': 'string'
        },
    ],
    postRollConfiguration={
        'durationSeconds': 123,
        'enabled': True|False
    },
    tags={
        'string': 'string'
    }
)

type name:

string

param name:

Ad configuration name. Defaults to “”.

type mediaTailorPlaybackConfigurations:

list

param mediaTailorPlaybackConfigurations:

[REQUIRED]

List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.

(dict) --

Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
- playbackConfigurationArn (string) --
  
  ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.

type postRollConfiguration:

dict

param postRollConfiguration:

Configuration for the post-roll ad break to use for this ad configuration. Default: disabled ( enabled set to false, durationSeconds set to 15).

durationSeconds (integer) -- [REQUIRED]

Duration of the post-roll ad break, in seconds.
enabled (boolean) -- [REQUIRED]

Whether the post-roll ad configuration is enabled.

type tags:

dict

param tags:

Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'adConfiguration': {
        'arn': 'string',
        'name': 'string',
        'mediaTailorPlaybackConfigurations': [
            {
                'playbackConfigurationArn': 'string'
            },
        ],
        'postRollConfiguration': {
            'durationSeconds': 123,
            'enabled': True|False
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- adConfiguration (dict) --
  - arn (string) --
    
    Ad configuration ARN.
  - name (string) --
    
    Ad configuration name. Defaults to “”.
  - mediaTailorPlaybackConfigurations (list) --
    
    List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
    - (dict) --
      
      Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
      - playbackConfigurationArn (string) --
        
        ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
  - postRollConfiguration (dict) --
    
    Configuration for the post-roll ad break to use for this ad configuration.
    - durationSeconds (integer) --
      
      Duration of the post-roll ad break, in seconds.
    - enabled (boolean) --
      
      Whether the post-roll ad configuration is enabled.
  - tags (dict) --
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - (string) --
      - (string) --

GetAdConfiguration (updated)

Link ¶
Changes (response)

{'adConfiguration': {'postRollConfiguration': {'durationSeconds': 'integer',
                                               'enabled': 'boolean'}}}

Gets the ad configuration represented by the specified ARN.

See also: AWS API Documentation

Request Syntax

client.get_ad_configuration(
    arn='string'
)

type arn:

string

param arn:

[REQUIRED]

ARN of the ad configuration to be retrieved.

rtype:

dict

returns:

Response Syntax

{
    'adConfiguration': {
        'arn': 'string',
        'name': 'string',
        'mediaTailorPlaybackConfigurations': [
            {
                'playbackConfigurationArn': 'string'
            },
        ],
        'postRollConfiguration': {
            'durationSeconds': 123,
            'enabled': True|False
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- adConfiguration (dict) --
  - arn (string) --
    
    Ad configuration ARN.
  - name (string) --
    
    Ad configuration name. Defaults to “”.
  - mediaTailorPlaybackConfigurations (list) --
    
    List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
    - (dict) --
      
      Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
      - playbackConfigurationArn (string) --
        
        ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
  - postRollConfiguration (dict) --
    
    Configuration for the post-roll ad break to use for this ad configuration.
    - durationSeconds (integer) --
      
      Duration of the post-roll ad break, in seconds.
    - enabled (boolean) --
      
      Whether the post-roll ad configuration is enabled.
  - tags (dict) --
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - (string) --
      - (string) --

ListAdConfigurations (updated)

Link ¶
Changes (response)

{'adConfigurations': {'postRollConfiguration': {'durationSeconds': 'integer',
                                                'enabled': 'boolean'}}}

Gets summary information about all ad configurations in your account, in the AWS region where the API request is processed.

See also: AWS API Documentation

Request Syntax

client.list_ad_configurations(
    nextToken='string',
    maxResults=123
)

type nextToken:

string

param nextToken:

The first ad configuration to retrieve. This is used for pagination; see the nextToken response field.

type maxResults:

integer

param maxResults:

Maximum number of ad configurations to return. Default: your service quota or 100, whichever is smaller.

rtype:

dict

returns:

Response Syntax

{
    'adConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'mediaTailorPlaybackConfigurations': [
                {
                    'playbackConfigurationArn': 'string'
                },
            ],
            'postRollConfiguration': {
                'durationSeconds': 123,
                'enabled': True|False
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- adConfigurations (list) --
  
  List of the matching ad configurations.
  - (dict) --
    
    Summary information about an ad configuration.
    - arn (string) --
      
      Ad configuration ARN.
    - name (string) --
      
      Ad configuration name. Defaults to “”.
    - mediaTailorPlaybackConfigurations (list) --
      
      List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
      - (dict) --
        
        Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
        
        playbackConfigurationArn (string) --
        
        ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
    - postRollConfiguration (dict) --
      
      Configuration for the post-roll ad break to use for this ad configuration.
      - durationSeconds (integer) --
        
        Duration of the post-roll ad break, in seconds.
      - enabled (boolean) --
        
        Whether the post-roll ad configuration is enabled.
    - tags (dict) --
      
      Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
      - (string) --
        
        (string) --
- nextToken (string) --
  
  If there are more ad configurations than maxResults, use nextToken in the request to get the next set.

UpdateAdConfiguration (updated)

Link ¶
Changes (request, response)
Request

{'postRollConfiguration': {'durationSeconds': 'integer', 'enabled': 'boolean'}}

Response

{'adConfiguration': {'postRollConfiguration': {'durationSeconds': 'integer',
                                               'enabled': 'boolean'}}}

Updates a specified ad configuration.

See also: AWS API Documentation

Request Syntax

client.update_ad_configuration(
    arn='string',
    name='string',
    mediaTailorPlaybackConfigurations=[
        {
            'playbackConfigurationArn': 'string'
        },
    ],
    postRollConfiguration={
        'durationSeconds': 123,
        'enabled': True|False
    }
)

type arn:

string

param arn:

[REQUIRED]

ARN of the ad configuration to be updated.

type name:

string

param name:

Ad configuration name. The value does not need to be unique.

type mediaTailorPlaybackConfigurations:

list

param mediaTailorPlaybackConfigurations:

(dict) --

Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
- playbackConfigurationArn (string) --
  
  ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.

type postRollConfiguration:

dict

param postRollConfiguration:

Configuration for the post-roll ad break to use for this ad configuration.

durationSeconds (integer) -- [REQUIRED]

Duration of the post-roll ad break, in seconds.
enabled (boolean) -- [REQUIRED]

Whether the post-roll ad configuration is enabled.

rtype:

dict

returns:

Response Syntax

{
    'adConfiguration': {
        'arn': 'string',
        'name': 'string',
        'mediaTailorPlaybackConfigurations': [
            {
                'playbackConfigurationArn': 'string'
            },
        ],
        'postRollConfiguration': {
            'durationSeconds': 123,
            'enabled': True|False
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

(dict) --
- adConfiguration (dict) --
  
  Object specifying the updated ad configuration.
  - arn (string) --
    
    Ad configuration ARN.
  - name (string) --
    
    Ad configuration name. Defaults to “”.
  - mediaTailorPlaybackConfigurations (list) --
    
    List of integration configurations with MediaTailor resources. The first item in the list is the default playback configuration used for the ad configuration. To select a different configuration per viewing session, see Generate and Sign IVS Playback Tokens.
    - (dict) --
      
      Object specifying a configuration for integration with an AWS Elemental MediaTailor (EMT).
      - playbackConfigurationArn (string) --
        
        ARN of the customer-created EMT PlaybackConfiguration resource in the same region and account.
  - postRollConfiguration (dict) --
    
    Configuration for the post-roll ad break to use for this ad configuration.
    - durationSeconds (integer) --
      
      Duration of the post-roll ad break, in seconds.
    - enabled (boolean) --
      
      Whether the post-roll ad configuration is enabled.
  - tags (dict) --
    
    Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
    - (string) --
      - (string) --