aws-sdk-ivs 1.43.0 → 1.45.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -249,6 +249,12 @@ module Aws::IVS
249
249
  # Channel name.
250
250
  # @return [String]
251
251
  #
252
+ # @!attribute [rw] playback_restriction_policy_arn
253
+ # Playback-restriction-policy ARN. A valid ARN value here both
254
+ # specifies the ARN and enables playback restriction. Default: ""
255
+ # (empty string, no playback restriction policy is applied).
256
+ # @return [String]
257
+ #
252
258
  # @!attribute [rw] playback_url
253
259
  # Channel playback URL.
254
260
  # @return [String]
@@ -262,8 +268,8 @@ module Aws::IVS
262
268
  # @return [String]
263
269
  #
264
270
  # @!attribute [rw] recording_configuration_arn
265
- # Recording-configuration ARN. A value other than an empty string
266
- # indicates that recording is enabled. Default: "" (empty string,
271
+ # Recording-configuration ARN. A valid ARN value here both specifies
272
+ # the ARN and enables recording. Default: "" (empty string,
267
273
  # recording is disabled).
268
274
  # @return [String]
269
275
  #
@@ -299,6 +305,7 @@ module Aws::IVS
299
305
  :insecure_ingest,
300
306
  :latency_mode,
301
307
  :name,
308
+ :playback_restriction_policy_arn,
302
309
  :playback_url,
303
310
  :preset,
304
311
  :recording_configuration_arn,
@@ -346,6 +353,12 @@ module Aws::IVS
346
353
  # Channel name.
347
354
  # @return [String]
348
355
  #
356
+ # @!attribute [rw] playback_restriction_policy_arn
357
+ # Playback-restriction-policy ARN. A valid ARN value here both
358
+ # specifies the ARN and enables playback restriction. Default: ""
359
+ # (empty string, no playback restriction policy is applied).
360
+ # @return [String]
361
+ #
349
362
  # @!attribute [rw] preset
350
363
  # Optional transcode preset for the channel. This is selectable only
351
364
  # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
@@ -355,8 +368,8 @@ module Aws::IVS
355
368
  # @return [String]
356
369
  #
357
370
  # @!attribute [rw] recording_configuration_arn
358
- # Recording-configuration ARN. A value other than an empty string
359
- # indicates that recording is enabled. Default: "" (empty string,
371
+ # Recording-configuration ARN. A valid ARN value here both specifies
372
+ # the ARN and enables recording. Default: "" (empty string,
360
373
  # recording is disabled).
361
374
  # @return [String]
362
375
  #
@@ -391,6 +404,7 @@ module Aws::IVS
391
404
  :insecure_ingest,
392
405
  :latency_mode,
393
406
  :name,
407
+ :playback_restriction_policy_arn,
394
408
  :preset,
395
409
  :recording_configuration_arn,
396
410
  :tags,
@@ -431,6 +445,12 @@ module Aws::IVS
431
445
  # Channel name.
432
446
  # @return [String]
433
447
  #
448
+ # @!attribute [rw] playback_restriction_policy_arn
449
+ # Playback-restriction-policy ARN. A valid ARN value here both
450
+ # specifies the ARN and enables playback restriction. Default: ""
451
+ # (empty string, no playback restriction policy is applied).
452
+ # @return [String]
453
+ #
434
454
  # @!attribute [rw] preset
435
455
  # Optional transcode preset for the channel. This is selectable only
436
456
  # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
@@ -440,8 +460,9 @@ module Aws::IVS
440
460
  # @return [String]
441
461
  #
442
462
  # @!attribute [rw] recording_configuration_arn
443
- # Recording-configuration ARN. Default: "" (empty string, recording
444
- # is disabled).
463
+ # Recording-configuration ARN. A valid ARN value here both specifies
464
+ # the ARN and enables recording. Default: "" (empty string,
465
+ # recording is disabled).
445
466
  # @return [String]
446
467
  #
447
468
  # @!attribute [rw] tags
@@ -474,6 +495,7 @@ module Aws::IVS
474
495
  :insecure_ingest,
475
496
  :latency_mode,
476
497
  :name,
498
+ :playback_restriction_policy_arn,
477
499
  :preset,
478
500
  :recording_configuration_arn,
479
501
  :tags,
@@ -497,6 +519,72 @@ module Aws::IVS
497
519
  include Aws::Structure
498
520
  end
499
521
 
522
+ # @!attribute [rw] allowed_countries
523
+ # A list of country codes that control geoblocking restriction.
524
+ # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
525
+ # codes. Default: All countries (an empty array).
526
+ #
527
+ #
528
+ #
529
+ # [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
530
+ # @return [Array<String>]
531
+ #
532
+ # @!attribute [rw] allowed_origins
533
+ # A list of origin sites that control CORS restriction. Allowed values
534
+ # are the same as valid values of the Origin header defined at
535
+ # [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin][1].
536
+ # Default: All origins (an empty array).
537
+ #
538
+ #
539
+ #
540
+ # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
541
+ # @return [Array<String>]
542
+ #
543
+ # @!attribute [rw] enable_strict_origin_enforcement
544
+ # Whether channel playback is constrained by origin site. Default:
545
+ # `false`.
546
+ # @return [Boolean]
547
+ #
548
+ # @!attribute [rw] name
549
+ # Playback-restriction-policy name. The value does not need to be
550
+ # unique.
551
+ # @return [String]
552
+ #
553
+ # @!attribute [rw] tags
554
+ # Array of 1-50 maps, each of the form `string:string (key:value)`.
555
+ # See [Tagging Amazon Web Services Resources][1] for more information,
556
+ # including restrictions that apply to tags and "Tag naming limits
557
+ # and requirements"; Amazon IVS has no service-specific constraints
558
+ # beyond what is documented there.
559
+ #
560
+ #
561
+ #
562
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
563
+ # @return [Hash<String,String>]
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreatePlaybackRestrictionPolicyRequest AWS API Documentation
566
+ #
567
+ class CreatePlaybackRestrictionPolicyRequest < Struct.new(
568
+ :allowed_countries,
569
+ :allowed_origins,
570
+ :enable_strict_origin_enforcement,
571
+ :name,
572
+ :tags)
573
+ SENSITIVE = []
574
+ include Aws::Structure
575
+ end
576
+
577
+ # @!attribute [rw] playback_restriction_policy
578
+ # @return [Types::PlaybackRestrictionPolicy]
579
+ #
580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreatePlaybackRestrictionPolicyResponse AWS API Documentation
581
+ #
582
+ class CreatePlaybackRestrictionPolicyResponse < Struct.new(
583
+ :playback_restriction_policy)
584
+ SENSITIVE = []
585
+ include Aws::Structure
586
+ end
587
+
500
588
  # @!attribute [rw] destination_configuration
501
589
  # A complex type that contains a destination configuration for where
502
590
  # recorded video will be stored.
@@ -627,6 +715,18 @@ module Aws::IVS
627
715
  #
628
716
  class DeletePlaybackKeyPairResponse < Aws::EmptyStructure; end
629
717
 
718
+ # @!attribute [rw] arn
719
+ # ARN of the playback restriction policy to be deleted.
720
+ # @return [String]
721
+ #
722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeletePlaybackRestrictionPolicyRequest AWS API Documentation
723
+ #
724
+ class DeletePlaybackRestrictionPolicyRequest < Struct.new(
725
+ :arn)
726
+ SENSITIVE = []
727
+ include Aws::Structure
728
+ end
729
+
630
730
  # @!attribute [rw] arn
631
731
  # ARN of the recording configuration to be deleted.
632
732
  # @return [String]
@@ -718,6 +818,29 @@ module Aws::IVS
718
818
  include Aws::Structure
719
819
  end
720
820
 
821
+ # @!attribute [rw] arn
822
+ # ARN of the playback restriction policy to be returned.
823
+ # @return [String]
824
+ #
825
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackRestrictionPolicyRequest AWS API Documentation
826
+ #
827
+ class GetPlaybackRestrictionPolicyRequest < Struct.new(
828
+ :arn)
829
+ SENSITIVE = []
830
+ include Aws::Structure
831
+ end
832
+
833
+ # @!attribute [rw] playback_restriction_policy
834
+ # @return [Types::PlaybackRestrictionPolicy]
835
+ #
836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackRestrictionPolicyResponse AWS API Documentation
837
+ #
838
+ class GetPlaybackRestrictionPolicyResponse < Struct.new(
839
+ :playback_restriction_policy)
840
+ SENSITIVE = []
841
+ include Aws::Structure
842
+ end
843
+
721
844
  # @!attribute [rw] arn
722
845
  # ARN of the recording configuration to be retrieved.
723
846
  # @return [String]
@@ -901,6 +1024,10 @@ module Aws::IVS
901
1024
  # Filters the channel list to match the specified name.
902
1025
  # @return [String]
903
1026
  #
1027
+ # @!attribute [rw] filter_by_playback_restriction_policy_arn
1028
+ # Filters the channel list to match the specified policy.
1029
+ # @return [String]
1030
+ #
904
1031
  # @!attribute [rw] filter_by_recording_configuration_arn
905
1032
  # Filters the channel list to match the specified
906
1033
  # recording-configuration ARN.
@@ -919,6 +1046,7 @@ module Aws::IVS
919
1046
  #
920
1047
  class ListChannelsRequest < Struct.new(
921
1048
  :filter_by_name,
1049
+ :filter_by_playback_restriction_policy_arn,
922
1050
  :filter_by_recording_configuration_arn,
923
1051
  :max_results,
924
1052
  :next_token)
@@ -981,6 +1109,42 @@ module Aws::IVS
981
1109
  include Aws::Structure
982
1110
  end
983
1111
 
1112
+ # @!attribute [rw] max_results
1113
+ # Maximum number of policies to return. Default: 1.
1114
+ # @return [Integer]
1115
+ #
1116
+ # @!attribute [rw] next_token
1117
+ # The first policy to retrieve. This is used for pagination; see the
1118
+ # `nextToken` response field.
1119
+ # @return [String]
1120
+ #
1121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesRequest AWS API Documentation
1122
+ #
1123
+ class ListPlaybackRestrictionPoliciesRequest < Struct.new(
1124
+ :max_results,
1125
+ :next_token)
1126
+ SENSITIVE = []
1127
+ include Aws::Structure
1128
+ end
1129
+
1130
+ # @!attribute [rw] next_token
1131
+ # If there are more channels than `maxResults`, use `nextToken` in the
1132
+ # request to get the next set.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] playback_restriction_policies
1136
+ # List of the matching policies.
1137
+ # @return [Array<Types::PlaybackRestrictionPolicySummary>]
1138
+ #
1139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesResponse AWS API Documentation
1140
+ #
1141
+ class ListPlaybackRestrictionPoliciesResponse < Struct.new(
1142
+ :next_token,
1143
+ :playback_restriction_policies)
1144
+ SENSITIVE = []
1145
+ include Aws::Structure
1146
+ end
1147
+
984
1148
  # @!attribute [rw] max_results
985
1149
  # Maximum number of recording configurations to return. Default: your
986
1150
  # service quota or 100, whichever is smaller.
@@ -1248,6 +1412,131 @@ module Aws::IVS
1248
1412
  include Aws::Structure
1249
1413
  end
1250
1414
 
1415
+ # An object representing a policy to constrain playback by country
1416
+ # and/or origin sites.
1417
+ #
1418
+ # @!attribute [rw] allowed_countries
1419
+ # A list of country codes that control geoblocking restriction.
1420
+ # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
1421
+ # codes. Default: All countries (an empty array).
1422
+ #
1423
+ #
1424
+ #
1425
+ # [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
1426
+ # @return [Array<String>]
1427
+ #
1428
+ # @!attribute [rw] allowed_origins
1429
+ # A list of origin sites that control CORS restriction. Allowed values
1430
+ # are the same as valid values of the Origin header defined at
1431
+ # [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin][1].
1432
+ # Default: All origins (an empty array).
1433
+ #
1434
+ #
1435
+ #
1436
+ # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
1437
+ # @return [Array<String>]
1438
+ #
1439
+ # @!attribute [rw] arn
1440
+ # Playback-restriction-policy ARN
1441
+ # @return [String]
1442
+ #
1443
+ # @!attribute [rw] enable_strict_origin_enforcement
1444
+ # Whether channel playback is constrained by origin site. Default:
1445
+ # `false`.
1446
+ # @return [Boolean]
1447
+ #
1448
+ # @!attribute [rw] name
1449
+ # Playback-restriction-policy name. The value does not need to be
1450
+ # unique.
1451
+ # @return [String]
1452
+ #
1453
+ # @!attribute [rw] tags
1454
+ # Tags attached to the resource. Array of 1-50 maps, each of the form
1455
+ # `string:string (key:value)`. See [Tagging Amazon Web Services
1456
+ # Resources][1] for more information, including restrictions that
1457
+ # apply to tags and "Tag naming limits and requirements"; Amazon IVS
1458
+ # has no service-specific constraints beyond what is documented there.
1459
+ #
1460
+ #
1461
+ #
1462
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1463
+ # @return [Hash<String,String>]
1464
+ #
1465
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicy AWS API Documentation
1466
+ #
1467
+ class PlaybackRestrictionPolicy < Struct.new(
1468
+ :allowed_countries,
1469
+ :allowed_origins,
1470
+ :arn,
1471
+ :enable_strict_origin_enforcement,
1472
+ :name,
1473
+ :tags)
1474
+ SENSITIVE = []
1475
+ include Aws::Structure
1476
+ end
1477
+
1478
+ # Summary information about a PlaybackRestrictionPolicy.
1479
+ #
1480
+ # @!attribute [rw] allowed_countries
1481
+ # A list of country codes that control geoblocking restriction.
1482
+ # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
1483
+ # codes. Default: All countries (an empty array).
1484
+ #
1485
+ #
1486
+ #
1487
+ # [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
1488
+ # @return [Array<String>]
1489
+ #
1490
+ # @!attribute [rw] allowed_origins
1491
+ # A list of origin sites that control CORS restriction. Allowed values
1492
+ # are the same as valid values of the Origin header defined at
1493
+ # [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin][1].
1494
+ # Default: All origins (an empty array).
1495
+ #
1496
+ #
1497
+ #
1498
+ # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
1499
+ # @return [Array<String>]
1500
+ #
1501
+ # @!attribute [rw] arn
1502
+ # Playback-restriction-policy ARN
1503
+ # @return [String]
1504
+ #
1505
+ # @!attribute [rw] enable_strict_origin_enforcement
1506
+ # Whether channel playback is constrained by origin site. Default:
1507
+ # `false`.
1508
+ # @return [Boolean]
1509
+ #
1510
+ # @!attribute [rw] name
1511
+ # Playback-restriction-policy name. The value does not need to be
1512
+ # unique.
1513
+ # @return [String]
1514
+ #
1515
+ # @!attribute [rw] tags
1516
+ # Tags attached to the resource. Array of 1-50 maps, each of the form
1517
+ # `string:string (key:value)`. See [Tagging Amazon Web Services
1518
+ # Resources][1] for more information, including restrictions that
1519
+ # apply to tags and "Tag naming limits and requirements"; Amazon IVS
1520
+ # has no service-specific constraints beyond what is documented there.
1521
+ #
1522
+ #
1523
+ #
1524
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1525
+ # @return [Hash<String,String>]
1526
+ #
1527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicySummary AWS API Documentation
1528
+ #
1529
+ class PlaybackRestrictionPolicySummary < Struct.new(
1530
+ :allowed_countries,
1531
+ :allowed_origins,
1532
+ :arn,
1533
+ :enable_strict_origin_enforcement,
1534
+ :name,
1535
+ :tags)
1536
+ SENSITIVE = []
1537
+ include Aws::Structure
1538
+ end
1539
+
1251
1540
  # @!attribute [rw] channel_arn
1252
1541
  # ARN of the channel into which metadata is inserted. This channel
1253
1542
  # must have an active stream.
@@ -1918,7 +2207,7 @@ module Aws::IVS
1918
2207
  #
1919
2208
  # @!attribute [rw] tag_keys
1920
2209
  # Array of tags to be removed. Array of maps, each of the form
1921
- # s`tring:string (key:value)`. See [Tagging Amazon Web Services
2210
+ # `string:string (key:value)`. See [Tagging Amazon Web Services
1922
2211
  # Resources][1] for more information, including restrictions that
1923
2212
  # apply to tags and "Tag naming limits and requirements"; Amazon IVS
1924
2213
  # has no service-specific constraints beyond what is documented there.
@@ -1964,6 +2253,12 @@ module Aws::IVS
1964
2253
  # Channel name.
1965
2254
  # @return [String]
1966
2255
  #
2256
+ # @!attribute [rw] playback_restriction_policy_arn
2257
+ # Playback-restriction-policy ARN. A valid ARN value here both
2258
+ # specifies the ARN and enables playback restriction. If this is set
2259
+ # to an empty string, playback restriction policy is disabled.
2260
+ # @return [String]
2261
+ #
1967
2262
  # @!attribute [rw] preset
1968
2263
  # Optional transcode preset for the channel. This is selectable only
1969
2264
  # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
@@ -1973,9 +2268,9 @@ module Aws::IVS
1973
2268
  # @return [String]
1974
2269
  #
1975
2270
  # @!attribute [rw] recording_configuration_arn
1976
- # Recording-configuration ARN. If this is set to an empty string,
1977
- # recording is disabled. A value other than an empty string indicates
1978
- # that recording is enabled
2271
+ # Recording-configuration ARN. A valid ARN value here both specifies
2272
+ # the ARN and enables recording. If this is set to an empty string,
2273
+ # recording is disabled.
1979
2274
  # @return [String]
1980
2275
  #
1981
2276
  # @!attribute [rw] type
@@ -1997,6 +2292,7 @@ module Aws::IVS
1997
2292
  :insecure_ingest,
1998
2293
  :latency_mode,
1999
2294
  :name,
2295
+ :playback_restriction_policy_arn,
2000
2296
  :preset,
2001
2297
  :recording_configuration_arn,
2002
2298
  :type)
@@ -2005,7 +2301,7 @@ module Aws::IVS
2005
2301
  end
2006
2302
 
2007
2303
  # @!attribute [rw] channel
2008
- # Object specifying a channel.
2304
+ # Object specifying the updated channel.
2009
2305
  # @return [Types::Channel]
2010
2306
  #
2011
2307
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelResponse AWS API Documentation
@@ -2016,6 +2312,65 @@ module Aws::IVS
2016
2312
  include Aws::Structure
2017
2313
  end
2018
2314
 
2315
+ # @!attribute [rw] allowed_countries
2316
+ # A list of country codes that control geoblocking restriction.
2317
+ # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
2318
+ # codes. Default: All countries (an empty array).
2319
+ #
2320
+ #
2321
+ #
2322
+ # [1]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
2323
+ # @return [Array<String>]
2324
+ #
2325
+ # @!attribute [rw] allowed_origins
2326
+ # A list of origin sites that control CORS restriction. Allowed values
2327
+ # are the same as valid values of the Origin header defined at
2328
+ # [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin][1].
2329
+ # Default: All origins (an empty array).
2330
+ #
2331
+ #
2332
+ #
2333
+ # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
2334
+ # @return [Array<String>]
2335
+ #
2336
+ # @!attribute [rw] arn
2337
+ # ARN of the playback-restriction-policy to be updated.
2338
+ # @return [String]
2339
+ #
2340
+ # @!attribute [rw] enable_strict_origin_enforcement
2341
+ # Whether channel playback is constrained by origin site. Default:
2342
+ # `false`.
2343
+ # @return [Boolean]
2344
+ #
2345
+ # @!attribute [rw] name
2346
+ # Playback-restriction-policy name. The value does not need to be
2347
+ # unique.
2348
+ # @return [String]
2349
+ #
2350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicyRequest AWS API Documentation
2351
+ #
2352
+ class UpdatePlaybackRestrictionPolicyRequest < Struct.new(
2353
+ :allowed_countries,
2354
+ :allowed_origins,
2355
+ :arn,
2356
+ :enable_strict_origin_enforcement,
2357
+ :name)
2358
+ SENSITIVE = []
2359
+ include Aws::Structure
2360
+ end
2361
+
2362
+ # @!attribute [rw] playback_restriction_policy
2363
+ # Object specifying the updated policy.
2364
+ # @return [Types::PlaybackRestrictionPolicy]
2365
+ #
2366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicyResponse AWS API Documentation
2367
+ #
2368
+ class UpdatePlaybackRestrictionPolicyResponse < Struct.new(
2369
+ :playback_restriction_policy)
2370
+ SENSITIVE = []
2371
+ include Aws::Structure
2372
+ end
2373
+
2019
2374
  # @!attribute [rw] exception_message
2020
2375
  # The input fails to satisfy the constraints specified by an Amazon
2021
2376
  # Web Services service.
data/lib/aws-sdk-ivs.rb CHANGED
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-ivs/customizations'
52
52
  # @!group service
53
53
  module Aws::IVS
54
54
 
55
- GEM_VERSION = '1.43.0'
55
+ GEM_VERSION = '1.45.0'
56
56
 
57
57
  end