IVS / Client / list_playback_restriction_policies

list_playback_restriction_policies#

IVS.Client.list_playback_restriction_policies(**kwargs)#

Gets summary information about playback restriction policies.

See also: AWS API Documentation

Request Syntax

response = client.list_playback_restriction_policies(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – Maximum number of policies to return. Default: 1.

  • nextToken (string) – The first policy to retrieve. This is used for pagination; see the nextToken response field.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      If there are more channels than maxResults, use nextToken in the request to get the next set.

    • playbackRestrictionPolicies (list) –

      List of the matching policies.

      • (dict) –

        Summary information about a PlaybackRestrictionPolicy.

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

        • arn (string) –

          Playback-restriction-policy ARN

        • 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 Tagging Amazon Web Services Resources for more information, 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.AccessDeniedException

  • IVS.Client.exceptions.ValidationException

  • IVS.Client.exceptions.PendingVerification

  • IVS.Client.exceptions.ConflictException