Skip to content

UpdatePlaybackRestrictionPolicyRequest

Source code in docs_src/capo_ivs/types/update_playback_restriction_policy_request.py
class UpdatePlaybackRestrictionPolicyRequest(TypedDict, closed=True):
    arn: "capo_ivs.types.playback_restriction_policy_arn.PlaybackRestrictionPolicyArn"
    """<p>ARN of the playback-restriction-policy to be updated.</p>"""
    allowed_countries: NotRequired[
        "capo_ivs.types.playback_restriction_policy_allowed_country_list.PlaybackRestrictionPolicyAllowedCountryList"
    ]
    """<p>A list of country codes that control geoblocking restriction. Allowed values are the officially assigned <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a> codes. Default: All countries (an empty array).</p>"""
    allowed_origins: NotRequired[
        "capo_ivs.types.playback_restriction_policy_allowed_origin_list.PlaybackRestrictionPolicyAllowedOriginList"
    ]
    """<p>A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All origins (an empty array).</p>"""
    enable_strict_origin_enforcement: NotRequired[
        "capo_ivs.types.playback_restriction_policy_enable_strict_origin_enforcement.PlaybackRestrictionPolicyEnableStrictOriginEnforcement"
    ]
    """<p>Whether channel playback is constrained by origin site. Default: <code>false</code>.</p>"""
    name: NotRequired[
        "capo_ivs.types.playback_restriction_policy_name.PlaybackRestrictionPolicyName"
    ]
    """<p>Playback-restriction-policy name. The value does not need to be unique.</p>"""

allowed_countries instance-attribute

allowed_countries: NotRequired[PlaybackRestrictionPolicyAllowedCountryList]

A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).

allowed_origins instance-attribute

allowed_origins: NotRequired[PlaybackRestrictionPolicyAllowedOriginList]

A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).

arn instance-attribute

ARN of the playback-restriction-policy to be updated.

enable_strict_origin_enforcement instance-attribute

enable_strict_origin_enforcement: NotRequired[
    PlaybackRestrictionPolicyEnableStrictOriginEnforcement
]

Whether channel playback is constrained by origin site. Default: false.

name instance-attribute

name: NotRequired[PlaybackRestrictionPolicyName]

Playback-restriction-policy name. The value does not need to be unique.