Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePlaybackRestrictionPolicy

Creates a new playback restriction policy, for constraining playback by countries and/or origins.

Request Syntax


POST /CreatePlaybackRestrictionPolicy HTTP/1.1
Content-type: application/json

{
   "allowedCountries": [ "string" ],
   "allowedOrigins": [ "string" ],
   "enableStrictOriginEnforcement": boolean,
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

allowedCountries

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

Type: Array of strings

Length Constraints: Fixed length of 2.

Required: No

allowedOrigins

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

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 128.

Required: No

enableStrictOriginEnforcement

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

Type: Boolean

Required: No

name

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: [a-zA-Z0-9-_]*

Required: No

tags

Array of 1-50 maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS 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.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "playbackRestrictionPolicy": { 
      "allowedCountries": [ "string" ],
      "allowedOrigins": [ "string" ],
      "arn": "string",
      "enableStrictOriginEnforcement": boolean,
      "name": "string",
      "tags": { 
         "string" : "string" 
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

playbackRestrictionPolicy

Type: PlaybackRestrictionPolicy object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

HTTP Status Code: 403

PendingVerification

HTTP Status Code: 403

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400