IVS / Client / get_playback_restriction_policy

get_playback_restriction_policy

IVS.Client.get_playback_restriction_policy(**kwargs)

Gets the specified playback restriction policy.

See also: AWS API Documentation

Request Syntax

response = client.get_playback_restriction_policy(
    arn='string'
)

Parameters:

arn (string) –

[REQUIRED]

ARN of the playback restriction policy to be returned.

Return type:

dict

Returns:

Response Syntax

{
    'playbackRestrictionPolicy': {
        'arn': 'string',
        'allowedCountries': [
            'string',
        ],
        'allowedOrigins': [
            'string',
        ],
        'enableStrictOriginEnforcement': True|False,
        'name': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • playbackRestrictionPolicy (dict) –

    • arn (string) –

      Playback-restriction-policy ARN

    • allowedCountries (list) –

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

      • (string) –

    • allowedOrigins (list) –

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

      • (string) –

    • enableStrictOriginEnforcement (boolean) –

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

    • name (string) –

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

    • 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

• IVS.Client.exceptions.ResourceNotFoundException

• IVS.Client.exceptions.AccessDeniedException

• IVS.Client.exceptions.ValidationException

• IVS.Client.exceptions.PendingVerification