Skip to content

AdConfiguration

Source code in docs_src/capo_ivs/types/ad_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class AdConfiguration(TypedDict, closed=True):
    arn: "capo_ivs.types.ad_configuration_arn.AdConfigurationArn"
    """<p>Ad configuration ARN.</p>"""
    name: NotRequired["capo_ivs.types.ad_configuration_name.AdConfigurationName"]
    """<p>Ad configuration name. Defaults to “”.</p>"""
    media_tailor_playback_configurations: "capo_ivs.types.media_tailor_playback_configurations_list.MediaTailorPlaybackConfigurationsList"
    """<p>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 <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/private-channels-generate-tokens.html">Generate and Sign IVS Playback Tokens</a>.</p>"""
    post_roll_configuration: NotRequired[
        "capo_ivs.types.post_roll_configuration.PostRollConfiguration"
    ]
    """<p>Configuration for the post-roll ad break to use for this ad configuration.</p>"""
    tags: NotRequired["capo_ivs.types.tags.Tags"]
    """<p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> 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.</p>"""

arn instance-attribute 

arn: AdConfigurationArn

Ad configuration ARN.

media_tailor_playback_configurations instance-attribute 

media_tailor_playback_configurations: MediaTailorPlaybackConfigurationsList

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.

name instance-attribute 

name: NotRequired[AdConfigurationName]

Ad configuration name. Defaults to “”.

post_roll_configuration instance-attribute 

post_roll_configuration: NotRequired[PostRollConfiguration]

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

tags instance-attribute 

tags: NotRequired[Tags]

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.