aws-sdk-ivs 1.95.0 → 1.97.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +257 -1
- data/lib/aws-sdk-ivs/client_api.rb +155 -0
- data/lib/aws-sdk-ivs/types.rb +335 -5
- data/lib/aws-sdk-ivs.rb +1 -1
- data/sig/client.rbs +61 -2
- data/sig/types.rbs +83 -0
- metadata +3 -3
data/lib/aws-sdk-ivs/types.rb
CHANGED
|
@@ -651,6 +651,12 @@ module Aws::IVS
|
|
|
651
651
|
# ARN of the ad configuration associated with the channel.
|
|
652
652
|
# @return [String]
|
|
653
653
|
#
|
|
654
|
+
# @!attribute [rw] failover_slate_configuration_arn
|
|
655
|
+
# Failover-slate-configuration ARN. A valid ARN value here both
|
|
656
|
+
# specifies the ARN and enables failover slate. Default: "" (empty
|
|
657
|
+
# string, no failover slate configuration is applied).
|
|
658
|
+
# @return [String]
|
|
659
|
+
#
|
|
654
660
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
|
|
655
661
|
#
|
|
656
662
|
class Channel < Struct.new(
|
|
@@ -669,7 +675,8 @@ module Aws::IVS
|
|
|
669
675
|
:playback_restriction_policy_arn,
|
|
670
676
|
:multitrack_input_configuration,
|
|
671
677
|
:container_format,
|
|
672
|
-
:ad_configuration_arn
|
|
678
|
+
:ad_configuration_arn,
|
|
679
|
+
:failover_slate_configuration_arn)
|
|
673
680
|
SENSITIVE = []
|
|
674
681
|
include Aws::Structure
|
|
675
682
|
end
|
|
@@ -793,6 +800,12 @@ module Aws::IVS
|
|
|
793
800
|
# ARN of the ad configuration associated with the channel.
|
|
794
801
|
# @return [String]
|
|
795
802
|
#
|
|
803
|
+
# @!attribute [rw] failover_slate_configuration_arn
|
|
804
|
+
# Failover-slate-configuration ARN. A valid ARN value here both
|
|
805
|
+
# specifies the ARN and enables failover slate. Default: "" (empty
|
|
806
|
+
# string, no failover slate configuration is applied).
|
|
807
|
+
# @return [String]
|
|
808
|
+
#
|
|
796
809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelSummary AWS API Documentation
|
|
797
810
|
#
|
|
798
811
|
class ChannelSummary < Struct.new(
|
|
@@ -806,7 +819,8 @@ module Aws::IVS
|
|
|
806
819
|
:type,
|
|
807
820
|
:preset,
|
|
808
821
|
:playback_restriction_policy_arn,
|
|
809
|
-
:ad_configuration_arn
|
|
822
|
+
:ad_configuration_arn,
|
|
823
|
+
:failover_slate_configuration_arn)
|
|
810
824
|
SENSITIVE = []
|
|
811
825
|
include Aws::Structure
|
|
812
826
|
end
|
|
@@ -994,6 +1008,12 @@ module Aws::IVS
|
|
|
994
1008
|
# ARN of the ad configuration associated with the channel.
|
|
995
1009
|
# @return [String]
|
|
996
1010
|
#
|
|
1011
|
+
# @!attribute [rw] failover_slate_configuration_arn
|
|
1012
|
+
# Failover-slate-configuration ARN. A valid ARN value here both
|
|
1013
|
+
# specifies the ARN and enables failover slate. Default: "" (empty
|
|
1014
|
+
# string, no failover slate configuration is applied).
|
|
1015
|
+
# @return [String]
|
|
1016
|
+
#
|
|
997
1017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
|
|
998
1018
|
#
|
|
999
1019
|
class CreateChannelRequest < Struct.new(
|
|
@@ -1008,7 +1028,8 @@ module Aws::IVS
|
|
|
1008
1028
|
:playback_restriction_policy_arn,
|
|
1009
1029
|
:multitrack_input_configuration,
|
|
1010
1030
|
:container_format,
|
|
1011
|
-
:ad_configuration_arn
|
|
1031
|
+
:ad_configuration_arn,
|
|
1032
|
+
:failover_slate_configuration_arn)
|
|
1012
1033
|
SENSITIVE = []
|
|
1013
1034
|
include Aws::Structure
|
|
1014
1035
|
end
|
|
@@ -1028,6 +1049,63 @@ module Aws::IVS
|
|
|
1028
1049
|
include Aws::Structure
|
|
1029
1050
|
end
|
|
1030
1051
|
|
|
1052
|
+
# @!attribute [rw] name
|
|
1053
|
+
# Failover-slate-configuration name. The value does not need to be
|
|
1054
|
+
# unique.
|
|
1055
|
+
# @return [String]
|
|
1056
|
+
#
|
|
1057
|
+
# @!attribute [rw] activation_threshold_seconds
|
|
1058
|
+
# Number of seconds of ingest interruption before the failover slate
|
|
1059
|
+
# activates. Minimum: `3`. Maximum: `5`. Default: `3`.
|
|
1060
|
+
# @return [Integer]
|
|
1061
|
+
#
|
|
1062
|
+
# @!attribute [rw] min_slate_display_seconds
|
|
1063
|
+
# Minimum number of seconds that the failover slate displays after
|
|
1064
|
+
# activation. Minimum: `3`. Maximum: `10`. Default: `3`.
|
|
1065
|
+
# @return [Integer]
|
|
1066
|
+
#
|
|
1067
|
+
# @!attribute [rw] max_slate_display_seconds
|
|
1068
|
+
# Maximum number of seconds that the failover slate displays. Minimum:
|
|
1069
|
+
# `60`. Maximum: `180`. Default: `60`.
|
|
1070
|
+
# @return [Integer]
|
|
1071
|
+
#
|
|
1072
|
+
# @!attribute [rw] tags
|
|
1073
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
|
1074
|
+
# See [Best practices and strategies][1] in *Tagging Amazon Web
|
|
1075
|
+
# Services Resources and Tag Editor* for details, including
|
|
1076
|
+
# restrictions that apply to tags and "Tag naming limits and
|
|
1077
|
+
# requirements"; Amazon IVS has no service-specific constraints
|
|
1078
|
+
# beyond what is documented there.
|
|
1079
|
+
#
|
|
1080
|
+
#
|
|
1081
|
+
#
|
|
1082
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
|
1083
|
+
# @return [Hash<String,String>]
|
|
1084
|
+
#
|
|
1085
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateFailoverSlateConfigurationRequest AWS API Documentation
|
|
1086
|
+
#
|
|
1087
|
+
class CreateFailoverSlateConfigurationRequest < Struct.new(
|
|
1088
|
+
:name,
|
|
1089
|
+
:activation_threshold_seconds,
|
|
1090
|
+
:min_slate_display_seconds,
|
|
1091
|
+
:max_slate_display_seconds,
|
|
1092
|
+
:tags)
|
|
1093
|
+
SENSITIVE = []
|
|
1094
|
+
include Aws::Structure
|
|
1095
|
+
end
|
|
1096
|
+
|
|
1097
|
+
# @!attribute [rw] failover_slate_configuration
|
|
1098
|
+
# The failover slate configuration that was created.
|
|
1099
|
+
# @return [Types::FailoverSlateConfiguration]
|
|
1100
|
+
#
|
|
1101
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateFailoverSlateConfigurationResponse AWS API Documentation
|
|
1102
|
+
#
|
|
1103
|
+
class CreateFailoverSlateConfigurationResponse < Struct.new(
|
|
1104
|
+
:failover_slate_configuration)
|
|
1105
|
+
SENSITIVE = []
|
|
1106
|
+
include Aws::Structure
|
|
1107
|
+
end
|
|
1108
|
+
|
|
1031
1109
|
# @!attribute [rw] allowed_countries
|
|
1032
1110
|
# A list of country codes that control geoblocking restriction.
|
|
1033
1111
|
# Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
|
|
@@ -1223,6 +1301,18 @@ module Aws::IVS
|
|
|
1223
1301
|
include Aws::Structure
|
|
1224
1302
|
end
|
|
1225
1303
|
|
|
1304
|
+
# @!attribute [rw] arn
|
|
1305
|
+
# ARN of the failover slate configuration to be deleted.
|
|
1306
|
+
# @return [String]
|
|
1307
|
+
#
|
|
1308
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/DeleteFailoverSlateConfigurationRequest AWS API Documentation
|
|
1309
|
+
#
|
|
1310
|
+
class DeleteFailoverSlateConfigurationRequest < Struct.new(
|
|
1311
|
+
:arn)
|
|
1312
|
+
SENSITIVE = []
|
|
1313
|
+
include Aws::Structure
|
|
1314
|
+
end
|
|
1315
|
+
|
|
1226
1316
|
# @!attribute [rw] arn
|
|
1227
1317
|
# ARN of the key pair to be deleted.
|
|
1228
1318
|
# @return [String]
|
|
@@ -1293,6 +1383,118 @@ module Aws::IVS
|
|
|
1293
1383
|
include Aws::Structure
|
|
1294
1384
|
end
|
|
1295
1385
|
|
|
1386
|
+
# Object specifying a failover slate configuration.
|
|
1387
|
+
#
|
|
1388
|
+
# @!attribute [rw] arn
|
|
1389
|
+
# Failover-slate-configuration ARN.
|
|
1390
|
+
# @return [String]
|
|
1391
|
+
#
|
|
1392
|
+
# @!attribute [rw] name
|
|
1393
|
+
# Failover-slate-configuration name.
|
|
1394
|
+
# @return [String]
|
|
1395
|
+
#
|
|
1396
|
+
# @!attribute [rw] activation_threshold_seconds
|
|
1397
|
+
# Number of seconds of ingest interruption before the failover slate
|
|
1398
|
+
# activates. Minimum: `3`. Maximum: `5`. Default: `3`.
|
|
1399
|
+
# @return [Integer]
|
|
1400
|
+
#
|
|
1401
|
+
# @!attribute [rw] min_slate_display_seconds
|
|
1402
|
+
# Minimum number of seconds that the failover slate displays after
|
|
1403
|
+
# activation. Minimum: `3`. Maximum: `10`. Default: `3`.
|
|
1404
|
+
# @return [Integer]
|
|
1405
|
+
#
|
|
1406
|
+
# @!attribute [rw] max_slate_display_seconds
|
|
1407
|
+
# Maximum number of seconds that the failover slate displays. Minimum:
|
|
1408
|
+
# `60`. Maximum: `180`. Default: `60`.
|
|
1409
|
+
# @return [Integer]
|
|
1410
|
+
#
|
|
1411
|
+
# @!attribute [rw] state
|
|
1412
|
+
# Current state of the failover slate configuration.
|
|
1413
|
+
# @return [String]
|
|
1414
|
+
#
|
|
1415
|
+
# @!attribute [rw] tags
|
|
1416
|
+
# Tags attached to the resource. Array of 1-50 maps, each of the form
|
|
1417
|
+
# `string:string (key:value)`. See [Best practices and strategies][1]
|
|
1418
|
+
# in *Tagging Amazon Web Services Resources and Tag Editor* for
|
|
1419
|
+
# details, including restrictions that apply to tags and "Tag naming
|
|
1420
|
+
# limits and requirements"; Amazon IVS has no service-specific
|
|
1421
|
+
# constraints beyond what is documented there.
|
|
1422
|
+
#
|
|
1423
|
+
#
|
|
1424
|
+
#
|
|
1425
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
|
1426
|
+
# @return [Hash<String,String>]
|
|
1427
|
+
#
|
|
1428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/FailoverSlateConfiguration AWS API Documentation
|
|
1429
|
+
#
|
|
1430
|
+
class FailoverSlateConfiguration < Struct.new(
|
|
1431
|
+
:arn,
|
|
1432
|
+
:name,
|
|
1433
|
+
:activation_threshold_seconds,
|
|
1434
|
+
:min_slate_display_seconds,
|
|
1435
|
+
:max_slate_display_seconds,
|
|
1436
|
+
:state,
|
|
1437
|
+
:tags)
|
|
1438
|
+
SENSITIVE = []
|
|
1439
|
+
include Aws::Structure
|
|
1440
|
+
end
|
|
1441
|
+
|
|
1442
|
+
# Summary information about a failover slate configuration.
|
|
1443
|
+
#
|
|
1444
|
+
# @!attribute [rw] arn
|
|
1445
|
+
# Failover-slate-configuration ARN.
|
|
1446
|
+
# @return [String]
|
|
1447
|
+
#
|
|
1448
|
+
# @!attribute [rw] name
|
|
1449
|
+
# Failover-slate-configuration name.
|
|
1450
|
+
# @return [String]
|
|
1451
|
+
#
|
|
1452
|
+
# @!attribute [rw] activation_threshold_seconds
|
|
1453
|
+
# Number of seconds of ingest interruption before the failover slate
|
|
1454
|
+
# activates. Minimum: `3`. Maximum: `5`. Default: `3`.
|
|
1455
|
+
# @return [Integer]
|
|
1456
|
+
#
|
|
1457
|
+
# @!attribute [rw] min_slate_display_seconds
|
|
1458
|
+
# Minimum number of seconds that the failover slate displays after
|
|
1459
|
+
# activation. Minimum: `3`. Maximum: `10`. Default: `3`.
|
|
1460
|
+
# @return [Integer]
|
|
1461
|
+
#
|
|
1462
|
+
# @!attribute [rw] max_slate_display_seconds
|
|
1463
|
+
# Maximum number of seconds that the failover slate displays. Minimum:
|
|
1464
|
+
# `60`. Maximum: `180`. Default: `60`.
|
|
1465
|
+
# @return [Integer]
|
|
1466
|
+
#
|
|
1467
|
+
# @!attribute [rw] state
|
|
1468
|
+
# Current state of the failover slate configuration.
|
|
1469
|
+
# @return [String]
|
|
1470
|
+
#
|
|
1471
|
+
# @!attribute [rw] tags
|
|
1472
|
+
# Tags attached to the resource. Array of 1-50 maps, each of the form
|
|
1473
|
+
# `string:string (key:value)`. See [Best practices and strategies][1]
|
|
1474
|
+
# in *Tagging Amazon Web Services Resources and Tag Editor* for
|
|
1475
|
+
# details, including restrictions that apply to tags and "Tag naming
|
|
1476
|
+
# limits and requirements"; Amazon IVS has no service-specific
|
|
1477
|
+
# constraints beyond what is documented there.
|
|
1478
|
+
#
|
|
1479
|
+
#
|
|
1480
|
+
#
|
|
1481
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
|
1482
|
+
# @return [Hash<String,String>]
|
|
1483
|
+
#
|
|
1484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/FailoverSlateConfigurationSummary AWS API Documentation
|
|
1485
|
+
#
|
|
1486
|
+
class FailoverSlateConfigurationSummary < Struct.new(
|
|
1487
|
+
:arn,
|
|
1488
|
+
:name,
|
|
1489
|
+
:activation_threshold_seconds,
|
|
1490
|
+
:min_slate_display_seconds,
|
|
1491
|
+
:max_slate_display_seconds,
|
|
1492
|
+
:state,
|
|
1493
|
+
:tags)
|
|
1494
|
+
SENSITIVE = []
|
|
1495
|
+
include Aws::Structure
|
|
1496
|
+
end
|
|
1497
|
+
|
|
1296
1498
|
# @!attribute [rw] arn
|
|
1297
1499
|
# ARN of the ad configuration to be retrieved.
|
|
1298
1500
|
# @return [String]
|
|
@@ -1339,6 +1541,30 @@ module Aws::IVS
|
|
|
1339
1541
|
include Aws::Structure
|
|
1340
1542
|
end
|
|
1341
1543
|
|
|
1544
|
+
# @!attribute [rw] arn
|
|
1545
|
+
# ARN of the failover slate configuration to be retrieved.
|
|
1546
|
+
# @return [String]
|
|
1547
|
+
#
|
|
1548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetFailoverSlateConfigurationRequest AWS API Documentation
|
|
1549
|
+
#
|
|
1550
|
+
class GetFailoverSlateConfigurationRequest < Struct.new(
|
|
1551
|
+
:arn)
|
|
1552
|
+
SENSITIVE = []
|
|
1553
|
+
include Aws::Structure
|
|
1554
|
+
end
|
|
1555
|
+
|
|
1556
|
+
# @!attribute [rw] failover_slate_configuration
|
|
1557
|
+
# The failover slate configuration that was retrieved.
|
|
1558
|
+
# @return [Types::FailoverSlateConfiguration]
|
|
1559
|
+
#
|
|
1560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetFailoverSlateConfigurationResponse AWS API Documentation
|
|
1561
|
+
#
|
|
1562
|
+
class GetFailoverSlateConfigurationResponse < Struct.new(
|
|
1563
|
+
:failover_slate_configuration)
|
|
1564
|
+
SENSITIVE = []
|
|
1565
|
+
include Aws::Structure
|
|
1566
|
+
end
|
|
1567
|
+
|
|
1342
1568
|
# @!attribute [rw] arn
|
|
1343
1569
|
# ARN of the key pair to be returned.
|
|
1344
1570
|
# @return [String]
|
|
@@ -1722,6 +1948,11 @@ module Aws::IVS
|
|
|
1722
1948
|
# ARN.
|
|
1723
1949
|
# @return [String]
|
|
1724
1950
|
#
|
|
1951
|
+
# @!attribute [rw] filter_by_failover_slate_configuration_arn
|
|
1952
|
+
# Filters the channel list to match the specified
|
|
1953
|
+
# failover-slate-configuration ARN.
|
|
1954
|
+
# @return [String]
|
|
1955
|
+
#
|
|
1725
1956
|
# @!attribute [rw] next_token
|
|
1726
1957
|
# The first channel to retrieve. This is used for pagination; see the
|
|
1727
1958
|
# `nextToken` response field.
|
|
@@ -1738,6 +1969,7 @@ module Aws::IVS
|
|
|
1738
1969
|
:filter_by_recording_configuration_arn,
|
|
1739
1970
|
:filter_by_playback_restriction_policy_arn,
|
|
1740
1971
|
:filter_by_ad_configuration_arn,
|
|
1972
|
+
:filter_by_failover_slate_configuration_arn,
|
|
1741
1973
|
:next_token,
|
|
1742
1974
|
:max_results)
|
|
1743
1975
|
SENSITIVE = []
|
|
@@ -1762,6 +1994,43 @@ module Aws::IVS
|
|
|
1762
1994
|
include Aws::Structure
|
|
1763
1995
|
end
|
|
1764
1996
|
|
|
1997
|
+
# @!attribute [rw] next_token
|
|
1998
|
+
# The first failover slate configuration to retrieve. This is used for
|
|
1999
|
+
# pagination; see the `nextToken` response field.
|
|
2000
|
+
# @return [String]
|
|
2001
|
+
#
|
|
2002
|
+
# @!attribute [rw] max_results
|
|
2003
|
+
# Maximum number of failover slate configurations to return. Default:
|
|
2004
|
+
# your service quota or 100, whichever is smaller.
|
|
2005
|
+
# @return [Integer]
|
|
2006
|
+
#
|
|
2007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListFailoverSlateConfigurationsRequest AWS API Documentation
|
|
2008
|
+
#
|
|
2009
|
+
class ListFailoverSlateConfigurationsRequest < Struct.new(
|
|
2010
|
+
:next_token,
|
|
2011
|
+
:max_results)
|
|
2012
|
+
SENSITIVE = []
|
|
2013
|
+
include Aws::Structure
|
|
2014
|
+
end
|
|
2015
|
+
|
|
2016
|
+
# @!attribute [rw] failover_slate_configurations
|
|
2017
|
+
# List of the matching failover slate configurations.
|
|
2018
|
+
# @return [Array<Types::FailoverSlateConfigurationSummary>]
|
|
2019
|
+
#
|
|
2020
|
+
# @!attribute [rw] next_token
|
|
2021
|
+
# If there are more failover slate configurations than `maxResults`,
|
|
2022
|
+
# use `nextToken` in the request to get the next set.
|
|
2023
|
+
# @return [String]
|
|
2024
|
+
#
|
|
2025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListFailoverSlateConfigurationsResponse AWS API Documentation
|
|
2026
|
+
#
|
|
2027
|
+
class ListFailoverSlateConfigurationsResponse < Struct.new(
|
|
2028
|
+
:failover_slate_configurations,
|
|
2029
|
+
:next_token)
|
|
2030
|
+
SENSITIVE = []
|
|
2031
|
+
include Aws::Structure
|
|
2032
|
+
end
|
|
2033
|
+
|
|
1765
2034
|
# @!attribute [rw] next_token
|
|
1766
2035
|
# The first key pair to retrieve. This is used for pagination; see the
|
|
1767
2036
|
# `nextToken` response field.
|
|
@@ -2988,6 +3257,11 @@ module Aws::IVS
|
|
|
2988
3257
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
|
|
2989
3258
|
# @return [Array<Types::StreamEvent>]
|
|
2990
3259
|
#
|
|
3260
|
+
# @!attribute [rw] failover_slate_configuration
|
|
3261
|
+
# The properties of the failover slate configuration at the time of
|
|
3262
|
+
# going live.
|
|
3263
|
+
# @return [Types::FailoverSlateConfiguration]
|
|
3264
|
+
#
|
|
2991
3265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSession AWS API Documentation
|
|
2992
3266
|
#
|
|
2993
3267
|
class StreamSession < Struct.new(
|
|
@@ -2998,7 +3272,8 @@ module Aws::IVS
|
|
|
2998
3272
|
:ingest_configuration,
|
|
2999
3273
|
:ingest_configurations,
|
|
3000
3274
|
:recording_configuration,
|
|
3001
|
-
:truncated_events
|
|
3275
|
+
:truncated_events,
|
|
3276
|
+
:failover_slate_configuration)
|
|
3002
3277
|
SENSITIVE = []
|
|
3003
3278
|
include Aws::Structure
|
|
3004
3279
|
end
|
|
@@ -3415,6 +3690,12 @@ module Aws::IVS
|
|
|
3415
3690
|
# ARN of the ad configuration associated with the channel.
|
|
3416
3691
|
# @return [String]
|
|
3417
3692
|
#
|
|
3693
|
+
# @!attribute [rw] failover_slate_configuration_arn
|
|
3694
|
+
# Failover-slate-configuration ARN. A valid ARN value here both
|
|
3695
|
+
# specifies the ARN and enables failover slate. If this is set to an
|
|
3696
|
+
# empty string, failover slate configuration is disabled.
|
|
3697
|
+
# @return [String]
|
|
3698
|
+
#
|
|
3418
3699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
|
|
3419
3700
|
#
|
|
3420
3701
|
class UpdateChannelRequest < Struct.new(
|
|
@@ -3429,7 +3710,8 @@ module Aws::IVS
|
|
|
3429
3710
|
:playback_restriction_policy_arn,
|
|
3430
3711
|
:multitrack_input_configuration,
|
|
3431
3712
|
:container_format,
|
|
3432
|
-
:ad_configuration_arn
|
|
3713
|
+
:ad_configuration_arn,
|
|
3714
|
+
:failover_slate_configuration_arn)
|
|
3433
3715
|
SENSITIVE = []
|
|
3434
3716
|
include Aws::Structure
|
|
3435
3717
|
end
|
|
@@ -3446,6 +3728,54 @@ module Aws::IVS
|
|
|
3446
3728
|
include Aws::Structure
|
|
3447
3729
|
end
|
|
3448
3730
|
|
|
3731
|
+
# @!attribute [rw] arn
|
|
3732
|
+
# ARN of the failover slate configuration to be updated.
|
|
3733
|
+
# @return [String]
|
|
3734
|
+
#
|
|
3735
|
+
# @!attribute [rw] name
|
|
3736
|
+
# Failover-slate-configuration name. The value does not need to be
|
|
3737
|
+
# unique.
|
|
3738
|
+
# @return [String]
|
|
3739
|
+
#
|
|
3740
|
+
# @!attribute [rw] activation_threshold_seconds
|
|
3741
|
+
# Number of seconds of ingest interruption before the failover slate
|
|
3742
|
+
# activates. Minimum: `3`. Maximum: `5`. Default: `3`.
|
|
3743
|
+
# @return [Integer]
|
|
3744
|
+
#
|
|
3745
|
+
# @!attribute [rw] min_slate_display_seconds
|
|
3746
|
+
# Minimum number of seconds that the failover slate displays after
|
|
3747
|
+
# activation. Minimum: `3`. Maximum: `10`. Default: `3`.
|
|
3748
|
+
# @return [Integer]
|
|
3749
|
+
#
|
|
3750
|
+
# @!attribute [rw] max_slate_display_seconds
|
|
3751
|
+
# Maximum number of seconds that the failover slate displays. Minimum:
|
|
3752
|
+
# `60`. Maximum: `180`. Default: `60`.
|
|
3753
|
+
# @return [Integer]
|
|
3754
|
+
#
|
|
3755
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateFailoverSlateConfigurationRequest AWS API Documentation
|
|
3756
|
+
#
|
|
3757
|
+
class UpdateFailoverSlateConfigurationRequest < Struct.new(
|
|
3758
|
+
:arn,
|
|
3759
|
+
:name,
|
|
3760
|
+
:activation_threshold_seconds,
|
|
3761
|
+
:min_slate_display_seconds,
|
|
3762
|
+
:max_slate_display_seconds)
|
|
3763
|
+
SENSITIVE = []
|
|
3764
|
+
include Aws::Structure
|
|
3765
|
+
end
|
|
3766
|
+
|
|
3767
|
+
# @!attribute [rw] failover_slate_configuration
|
|
3768
|
+
# Object specifying the updated failover slate configuration.
|
|
3769
|
+
# @return [Types::FailoverSlateConfiguration]
|
|
3770
|
+
#
|
|
3771
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateFailoverSlateConfigurationResponse AWS API Documentation
|
|
3772
|
+
#
|
|
3773
|
+
class UpdateFailoverSlateConfigurationResponse < Struct.new(
|
|
3774
|
+
:failover_slate_configuration)
|
|
3775
|
+
SENSITIVE = []
|
|
3776
|
+
include Aws::Structure
|
|
3777
|
+
end
|
|
3778
|
+
|
|
3449
3779
|
# @!attribute [rw] arn
|
|
3450
3780
|
# ARN of the playback-restriction-policy to be updated.
|
|
3451
3781
|
# @return [String]
|
data/lib/aws-sdk-ivs.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -180,10 +180,25 @@ module Aws
|
|
|
180
180
|
maximum_resolution: ("SD" | "HD" | "FULL_HD")?
|
|
181
181
|
},
|
|
182
182
|
?container_format: ("TS" | "FRAGMENTED_MP4"),
|
|
183
|
-
?ad_configuration_arn: ::String
|
|
183
|
+
?ad_configuration_arn: ::String,
|
|
184
|
+
?failover_slate_configuration_arn: ::String
|
|
184
185
|
) -> _CreateChannelResponseSuccess
|
|
185
186
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateChannelResponseSuccess
|
|
186
187
|
|
|
188
|
+
interface _CreateFailoverSlateConfigurationResponseSuccess
|
|
189
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateFailoverSlateConfigurationResponse]
|
|
190
|
+
def failover_slate_configuration: () -> Types::FailoverSlateConfiguration
|
|
191
|
+
end
|
|
192
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#create_failover_slate_configuration-instance_method
|
|
193
|
+
def create_failover_slate_configuration: (
|
|
194
|
+
?name: ::String,
|
|
195
|
+
?activation_threshold_seconds: ::Integer,
|
|
196
|
+
?min_slate_display_seconds: ::Integer,
|
|
197
|
+
?max_slate_display_seconds: ::Integer,
|
|
198
|
+
?tags: Hash[::String, ::String]
|
|
199
|
+
) -> _CreateFailoverSlateConfigurationResponseSuccess
|
|
200
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFailoverSlateConfigurationResponseSuccess
|
|
201
|
+
|
|
187
202
|
interface _CreatePlaybackRestrictionPolicyResponseSuccess
|
|
188
203
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreatePlaybackRestrictionPolicyResponse]
|
|
189
204
|
def playback_restriction_policy: () -> Types::PlaybackRestrictionPolicy
|
|
@@ -248,6 +263,12 @@ module Aws
|
|
|
248
263
|
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
249
264
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
250
265
|
|
|
266
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#delete_failover_slate_configuration-instance_method
|
|
267
|
+
def delete_failover_slate_configuration: (
|
|
268
|
+
arn: ::String
|
|
269
|
+
) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
270
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure]
|
|
271
|
+
|
|
251
272
|
interface _DeletePlaybackKeyPairResponseSuccess
|
|
252
273
|
include ::Seahorse::Client::_ResponseSuccess[Types::DeletePlaybackKeyPairResponse]
|
|
253
274
|
end
|
|
@@ -295,6 +316,16 @@ module Aws
|
|
|
295
316
|
) -> _GetChannelResponseSuccess
|
|
296
317
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetChannelResponseSuccess
|
|
297
318
|
|
|
319
|
+
interface _GetFailoverSlateConfigurationResponseSuccess
|
|
320
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFailoverSlateConfigurationResponse]
|
|
321
|
+
def failover_slate_configuration: () -> Types::FailoverSlateConfiguration
|
|
322
|
+
end
|
|
323
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#get_failover_slate_configuration-instance_method
|
|
324
|
+
def get_failover_slate_configuration: (
|
|
325
|
+
arn: ::String
|
|
326
|
+
) -> _GetFailoverSlateConfigurationResponseSuccess
|
|
327
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFailoverSlateConfigurationResponseSuccess
|
|
328
|
+
|
|
298
329
|
interface _GetPlaybackKeyPairResponseSuccess
|
|
299
330
|
include ::Seahorse::Client::_ResponseSuccess[Types::GetPlaybackKeyPairResponse]
|
|
300
331
|
def key_pair: () -> Types::PlaybackKeyPair
|
|
@@ -402,11 +433,24 @@ module Aws
|
|
|
402
433
|
?filter_by_recording_configuration_arn: ::String,
|
|
403
434
|
?filter_by_playback_restriction_policy_arn: ::String,
|
|
404
435
|
?filter_by_ad_configuration_arn: ::String,
|
|
436
|
+
?filter_by_failover_slate_configuration_arn: ::String,
|
|
405
437
|
?next_token: ::String,
|
|
406
438
|
?max_results: ::Integer
|
|
407
439
|
) -> _ListChannelsResponseSuccess
|
|
408
440
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListChannelsResponseSuccess
|
|
409
441
|
|
|
442
|
+
interface _ListFailoverSlateConfigurationsResponseSuccess
|
|
443
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListFailoverSlateConfigurationsResponse]
|
|
444
|
+
def failover_slate_configurations: () -> ::Array[Types::FailoverSlateConfigurationSummary]
|
|
445
|
+
def next_token: () -> ::String
|
|
446
|
+
end
|
|
447
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#list_failover_slate_configurations-instance_method
|
|
448
|
+
def list_failover_slate_configurations: (
|
|
449
|
+
?next_token: ::String,
|
|
450
|
+
?max_results: ::Integer
|
|
451
|
+
) -> _ListFailoverSlateConfigurationsResponseSuccess
|
|
452
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFailoverSlateConfigurationsResponseSuccess
|
|
453
|
+
|
|
410
454
|
interface _ListPlaybackKeyPairsResponseSuccess
|
|
411
455
|
include ::Seahorse::Client::_ResponseSuccess[Types::ListPlaybackKeyPairsResponse]
|
|
412
456
|
def key_pairs: () -> ::Array[Types::PlaybackKeyPairSummary]
|
|
@@ -582,10 +626,25 @@ module Aws
|
|
|
582
626
|
maximum_resolution: ("SD" | "HD" | "FULL_HD")?
|
|
583
627
|
},
|
|
584
628
|
?container_format: ("TS" | "FRAGMENTED_MP4"),
|
|
585
|
-
?ad_configuration_arn: ::String
|
|
629
|
+
?ad_configuration_arn: ::String,
|
|
630
|
+
?failover_slate_configuration_arn: ::String
|
|
586
631
|
) -> _UpdateChannelResponseSuccess
|
|
587
632
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateChannelResponseSuccess
|
|
588
633
|
|
|
634
|
+
interface _UpdateFailoverSlateConfigurationResponseSuccess
|
|
635
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateFailoverSlateConfigurationResponse]
|
|
636
|
+
def failover_slate_configuration: () -> Types::FailoverSlateConfiguration
|
|
637
|
+
end
|
|
638
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IVS/Client.html#update_failover_slate_configuration-instance_method
|
|
639
|
+
def update_failover_slate_configuration: (
|
|
640
|
+
arn: ::String,
|
|
641
|
+
?name: ::String,
|
|
642
|
+
?activation_threshold_seconds: ::Integer,
|
|
643
|
+
?min_slate_display_seconds: ::Integer,
|
|
644
|
+
?max_slate_display_seconds: ::Integer
|
|
645
|
+
) -> _UpdateFailoverSlateConfigurationResponseSuccess
|
|
646
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateFailoverSlateConfigurationResponseSuccess
|
|
647
|
+
|
|
589
648
|
interface _UpdatePlaybackRestrictionPolicyResponseSuccess
|
|
590
649
|
include ::Seahorse::Client::_ResponseSuccess[Types::UpdatePlaybackRestrictionPolicyResponse]
|
|
591
650
|
def playback_restriction_policy: () -> Types::PlaybackRestrictionPolicy
|