IVS / Client / create_ad_configuration

create_ad_configuration

IVS.Client.create_ad_configuration(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

  • name (string) – Ad configuration name. Defaults to “”.

  • mediaTailorPlaybackConfigurations (list) –

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

  • postRollConfiguration (dict) –

    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.

  • tags (dict) –

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

Return type:

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

Exceptions