aws-sdk-ivs 1.61.0 → 1.63.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +235 -234
- data/lib/aws-sdk-ivs/client_api.rb +70 -68
- data/lib/aws-sdk-ivs/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-ivs/endpoints.rb +2 -383
- data/lib/aws-sdk-ivs/plugins/endpoints.rb +1 -76
- data/lib/aws-sdk-ivs/types.rb +432 -413
- data/lib/aws-sdk-ivs.rb +1 -1
- data/sig/client.rbs +42 -42
- data/sig/types.rbs +69 -68
- metadata +4 -4
data/lib/aws-sdk-ivs/types.rb
CHANGED
@@ -26,30 +26,30 @@ module Aws::IVS
|
|
26
26
|
# broadcaster (usually in an encoder). This is part of the
|
27
27
|
# IngestConfiguration object and used for monitoring stream health.
|
28
28
|
#
|
29
|
+
# @!attribute [rw] channels
|
30
|
+
# Number of audio channels.
|
31
|
+
# @return [Integer]
|
32
|
+
#
|
29
33
|
# @!attribute [rw] codec
|
30
34
|
# Codec used for the audio encoding.
|
31
35
|
# @return [String]
|
32
36
|
#
|
33
|
-
# @!attribute [rw] target_bitrate
|
34
|
-
# The expected ingest bitrate (bits per second). This is configured in
|
35
|
-
# the encoder.
|
36
|
-
# @return [Integer]
|
37
|
-
#
|
38
37
|
# @!attribute [rw] sample_rate
|
39
38
|
# Number of audio samples recorded per second.
|
40
39
|
# @return [Integer]
|
41
40
|
#
|
42
|
-
# @!attribute [rw]
|
43
|
-
#
|
41
|
+
# @!attribute [rw] target_bitrate
|
42
|
+
# The expected ingest bitrate (bits per second). This is configured in
|
43
|
+
# the encoder.
|
44
44
|
# @return [Integer]
|
45
45
|
#
|
46
46
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/AudioConfiguration AWS API Documentation
|
47
47
|
#
|
48
48
|
class AudioConfiguration < Struct.new(
|
49
|
+
:channels,
|
49
50
|
:codec,
|
50
|
-
:target_bitrate,
|
51
51
|
:sample_rate,
|
52
|
-
:
|
52
|
+
:target_bitrate)
|
53
53
|
SENSITIVE = []
|
54
54
|
include Aws::Structure
|
55
55
|
end
|
@@ -118,17 +118,17 @@ module Aws::IVS
|
|
118
118
|
include Aws::Structure
|
119
119
|
end
|
120
120
|
|
121
|
-
# @!attribute [rw] stream_keys
|
122
|
-
# @return [Array<Types::StreamKey>]
|
123
|
-
#
|
124
121
|
# @!attribute [rw] errors
|
125
122
|
# @return [Array<Types::BatchError>]
|
126
123
|
#
|
124
|
+
# @!attribute [rw] stream_keys
|
125
|
+
# @return [Array<Types::StreamKey>]
|
126
|
+
#
|
127
127
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyResponse AWS API Documentation
|
128
128
|
#
|
129
129
|
class BatchGetStreamKeyResponse < Struct.new(
|
130
|
-
:
|
131
|
-
:
|
130
|
+
:errors,
|
131
|
+
:stream_keys)
|
132
132
|
SENSITIVE = []
|
133
133
|
include Aws::Structure
|
134
134
|
end
|
@@ -141,10 +141,6 @@ module Aws::IVS
|
|
141
141
|
# Channel ARN.
|
142
142
|
# @return [String]
|
143
143
|
#
|
144
|
-
# @!attribute [rw] viewer_id
|
145
|
-
# The ID of the viewer session to revoke.
|
146
|
-
# @return [String]
|
147
|
-
#
|
148
144
|
# @!attribute [rw] code
|
149
145
|
# Error code.
|
150
146
|
# @return [String]
|
@@ -153,13 +149,17 @@ module Aws::IVS
|
|
153
149
|
# Error message, determined by the application.
|
154
150
|
# @return [String]
|
155
151
|
#
|
152
|
+
# @!attribute [rw] viewer_id
|
153
|
+
# The ID of the viewer session to revoke.
|
154
|
+
# @return [String]
|
155
|
+
#
|
156
156
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchStartViewerSessionRevocationError AWS API Documentation
|
157
157
|
#
|
158
158
|
class BatchStartViewerSessionRevocationError < Struct.new(
|
159
159
|
:channel_arn,
|
160
|
-
:viewer_id,
|
161
160
|
:code,
|
162
|
-
:message
|
161
|
+
:message,
|
162
|
+
:viewer_id)
|
163
163
|
SENSITIVE = []
|
164
164
|
include Aws::Structure
|
165
165
|
end
|
@@ -224,25 +224,46 @@ module Aws::IVS
|
|
224
224
|
# Channel ARN.
|
225
225
|
# @return [String]
|
226
226
|
#
|
227
|
-
# @!attribute [rw]
|
228
|
-
#
|
227
|
+
# @!attribute [rw] authorized
|
228
|
+
# Whether the channel is private (enabled for playback authorization).
|
229
|
+
# Default: `false`.
|
230
|
+
# @return [Boolean]
|
231
|
+
#
|
232
|
+
# @!attribute [rw] ingest_endpoint
|
233
|
+
# Channel ingest endpoint, part of the definition of an ingest server,
|
234
|
+
# used when you set up streaming software.
|
229
235
|
# @return [String]
|
230
236
|
#
|
237
|
+
# @!attribute [rw] insecure_ingest
|
238
|
+
# Whether the channel allows insecure RTMP ingest. Default: `false`.
|
239
|
+
# @return [Boolean]
|
240
|
+
#
|
231
241
|
# @!attribute [rw] latency_mode
|
232
242
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
233
243
|
# video up to Full HD. Use `LOW` for near-real-time interaction with
|
234
244
|
# viewers. Default: `LOW`.
|
235
245
|
# @return [String]
|
236
246
|
#
|
237
|
-
# @!attribute [rw]
|
238
|
-
# Channel
|
239
|
-
#
|
240
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
241
|
-
# details, see [Channel Types][1].
|
247
|
+
# @!attribute [rw] name
|
248
|
+
# Channel name.
|
249
|
+
# @return [String]
|
242
250
|
#
|
251
|
+
# @!attribute [rw] playback_restriction_policy_arn
|
252
|
+
# Playback-restriction-policy ARN. A valid ARN value here both
|
253
|
+
# specifies the ARN and enables playback restriction. Default: ""
|
254
|
+
# (empty string, no playback restriction policy is applied).
|
255
|
+
# @return [String]
|
243
256
|
#
|
257
|
+
# @!attribute [rw] playback_url
|
258
|
+
# Channel playback URL.
|
259
|
+
# @return [String]
|
244
260
|
#
|
245
|
-
#
|
261
|
+
# @!attribute [rw] preset
|
262
|
+
# Optional transcode preset for the channel. This is selectable only
|
263
|
+
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
264
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
265
|
+
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
266
|
+
# string (`""`).
|
246
267
|
# @return [String]
|
247
268
|
#
|
248
269
|
# @!attribute [rw] recording_configuration_arn
|
@@ -251,19 +272,10 @@ module Aws::IVS
|
|
251
272
|
# recording is disabled).
|
252
273
|
# @return [String]
|
253
274
|
#
|
254
|
-
# @!attribute [rw]
|
255
|
-
#
|
256
|
-
#
|
257
|
-
# @return [
|
258
|
-
#
|
259
|
-
# @!attribute [rw] playback_url
|
260
|
-
# Channel playback URL.
|
261
|
-
# @return [String]
|
262
|
-
#
|
263
|
-
# @!attribute [rw] authorized
|
264
|
-
# Whether the channel is private (enabled for playback authorization).
|
265
|
-
# Default: `false`.
|
266
|
-
# @return [Boolean]
|
275
|
+
# @!attribute [rw] srt
|
276
|
+
# Specifies the endpoint and optional passphrase for streaming with
|
277
|
+
# the SRT protocol.
|
278
|
+
# @return [Types::Srt]
|
267
279
|
#
|
268
280
|
# @!attribute [rw] tags
|
269
281
|
# Tags attached to the resource. Array of 1-50 maps, each of the form
|
@@ -278,45 +290,33 @@ module Aws::IVS
|
|
278
290
|
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
279
291
|
# @return [Hash<String,String>]
|
280
292
|
#
|
281
|
-
# @!attribute [rw]
|
282
|
-
#
|
283
|
-
#
|
293
|
+
# @!attribute [rw] type
|
294
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
295
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
296
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
297
|
+
# details, see [Channel Types][1].
|
284
298
|
#
|
285
|
-
# @!attribute [rw] preset
|
286
|
-
# Optional transcode preset for the channel. This is selectable only
|
287
|
-
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
288
|
-
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
289
|
-
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
290
|
-
# string (`""`).
|
291
|
-
# @return [String]
|
292
299
|
#
|
293
|
-
# @!attribute [rw] srt
|
294
|
-
# Specifies the endpoint and optional passphrase for streaming with
|
295
|
-
# the SRT protocol.
|
296
|
-
# @return [Types::Srt]
|
297
300
|
#
|
298
|
-
#
|
299
|
-
# Playback-restriction-policy ARN. A valid ARN value here both
|
300
|
-
# specifies the ARN and enables playback restriction. Default: ""
|
301
|
-
# (empty string, no playback restriction policy is applied).
|
301
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
302
302
|
# @return [String]
|
303
303
|
#
|
304
304
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
|
305
305
|
#
|
306
306
|
class Channel < Struct.new(
|
307
307
|
:arn,
|
308
|
-
:name,
|
309
|
-
:latency_mode,
|
310
|
-
:type,
|
311
|
-
:recording_configuration_arn,
|
312
|
-
:ingest_endpoint,
|
313
|
-
:playback_url,
|
314
308
|
:authorized,
|
315
|
-
:
|
309
|
+
:ingest_endpoint,
|
316
310
|
:insecure_ingest,
|
311
|
+
:latency_mode,
|
312
|
+
:name,
|
313
|
+
:playback_restriction_policy_arn,
|
314
|
+
:playback_url,
|
317
315
|
:preset,
|
316
|
+
:recording_configuration_arn,
|
318
317
|
:srt,
|
319
|
-
:
|
318
|
+
:tags,
|
319
|
+
:type)
|
320
320
|
SENSITIVE = []
|
321
321
|
include Aws::Structure
|
322
322
|
end
|
@@ -339,9 +339,14 @@ module Aws::IVS
|
|
339
339
|
# Channel ARN.
|
340
340
|
# @return [String]
|
341
341
|
#
|
342
|
-
# @!attribute [rw]
|
343
|
-
#
|
344
|
-
#
|
342
|
+
# @!attribute [rw] authorized
|
343
|
+
# Whether the channel is private (enabled for playback authorization).
|
344
|
+
# Default: `false`.
|
345
|
+
# @return [Boolean]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] insecure_ingest
|
348
|
+
# Whether the channel allows insecure RTMP ingest. Default: `false`.
|
349
|
+
# @return [Boolean]
|
345
350
|
#
|
346
351
|
# @!attribute [rw] latency_mode
|
347
352
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -349,10 +354,23 @@ module Aws::IVS
|
|
349
354
|
# viewers. Default: `LOW`.
|
350
355
|
# @return [String]
|
351
356
|
#
|
352
|
-
# @!attribute [rw]
|
353
|
-
#
|
354
|
-
#
|
355
|
-
#
|
357
|
+
# @!attribute [rw] name
|
358
|
+
# Channel name.
|
359
|
+
# @return [String]
|
360
|
+
#
|
361
|
+
# @!attribute [rw] playback_restriction_policy_arn
|
362
|
+
# Playback-restriction-policy ARN. A valid ARN value here both
|
363
|
+
# specifies the ARN and enables playback restriction. Default: ""
|
364
|
+
# (empty string, no playback restriction policy is applied).
|
365
|
+
# @return [String]
|
366
|
+
#
|
367
|
+
# @!attribute [rw] preset
|
368
|
+
# Optional transcode preset for the channel. This is selectable only
|
369
|
+
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
370
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
371
|
+
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
372
|
+
# string (`""`).
|
373
|
+
# @return [String]
|
356
374
|
#
|
357
375
|
# @!attribute [rw] recording_configuration_arn
|
358
376
|
# Recording-configuration ARN. A valid ARN value here both specifies
|
@@ -373,10 +391,6 @@ module Aws::IVS
|
|
373
391
|
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
374
392
|
# @return [Hash<String,String>]
|
375
393
|
#
|
376
|
-
# @!attribute [rw] insecure_ingest
|
377
|
-
# Whether the channel allows insecure RTMP ingest. Default: `false`.
|
378
|
-
# @return [Boolean]
|
379
|
-
#
|
380
394
|
# @!attribute [rw] type
|
381
395
|
# Channel type, which determines the allowable resolution and bitrate.
|
382
396
|
# *If you exceed the allowable input resolution or bitrate, the stream
|
@@ -388,33 +402,19 @@ module Aws::IVS
|
|
388
402
|
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
389
403
|
# @return [String]
|
390
404
|
#
|
391
|
-
# @!attribute [rw] preset
|
392
|
-
# Optional transcode preset for the channel. This is selectable only
|
393
|
-
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
394
|
-
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
395
|
-
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
396
|
-
# string (`""`).
|
397
|
-
# @return [String]
|
398
|
-
#
|
399
|
-
# @!attribute [rw] playback_restriction_policy_arn
|
400
|
-
# Playback-restriction-policy ARN. A valid ARN value here both
|
401
|
-
# specifies the ARN and enables playback restriction. Default: ""
|
402
|
-
# (empty string, no playback restriction policy is applied).
|
403
|
-
# @return [String]
|
404
|
-
#
|
405
405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelSummary AWS API Documentation
|
406
406
|
#
|
407
407
|
class ChannelSummary < Struct.new(
|
408
408
|
:arn,
|
409
|
-
:name,
|
410
|
-
:latency_mode,
|
411
409
|
:authorized,
|
412
|
-
:recording_configuration_arn,
|
413
|
-
:tags,
|
414
410
|
:insecure_ingest,
|
415
|
-
:
|
411
|
+
:latency_mode,
|
412
|
+
:name,
|
413
|
+
:playback_restriction_policy_arn,
|
416
414
|
:preset,
|
417
|
-
:
|
415
|
+
:recording_configuration_arn,
|
416
|
+
:tags,
|
417
|
+
:type)
|
418
418
|
SENSITIVE = []
|
419
419
|
include Aws::Structure
|
420
420
|
end
|
@@ -431,9 +431,15 @@ module Aws::IVS
|
|
431
431
|
include Aws::Structure
|
432
432
|
end
|
433
433
|
|
434
|
-
# @!attribute [rw]
|
435
|
-
#
|
436
|
-
#
|
434
|
+
# @!attribute [rw] authorized
|
435
|
+
# Whether the channel is private (enabled for playback authorization).
|
436
|
+
# Default: `false`.
|
437
|
+
# @return [Boolean]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] insecure_ingest
|
440
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
441
|
+
# `false`.
|
442
|
+
# @return [Boolean]
|
437
443
|
#
|
438
444
|
# @!attribute [rw] latency_mode
|
439
445
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -441,21 +447,23 @@ module Aws::IVS
|
|
441
447
|
# viewers. Default: `LOW`.
|
442
448
|
# @return [String]
|
443
449
|
#
|
444
|
-
# @!attribute [rw]
|
445
|
-
# Channel
|
446
|
-
#
|
447
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
448
|
-
# details, see [Channel Types][1].
|
449
|
-
#
|
450
|
-
#
|
450
|
+
# @!attribute [rw] name
|
451
|
+
# Channel name.
|
452
|
+
# @return [String]
|
451
453
|
#
|
452
|
-
#
|
454
|
+
# @!attribute [rw] playback_restriction_policy_arn
|
455
|
+
# Playback-restriction-policy ARN. A valid ARN value here both
|
456
|
+
# specifies the ARN and enables playback restriction. Default: ""
|
457
|
+
# (empty string, no playback restriction policy is applied).
|
453
458
|
# @return [String]
|
454
459
|
#
|
455
|
-
# @!attribute [rw]
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
460
|
+
# @!attribute [rw] preset
|
461
|
+
# Optional transcode preset for the channel. This is selectable only
|
462
|
+
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
463
|
+
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
464
|
+
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
465
|
+
# string (`""`).
|
466
|
+
# @return [String]
|
459
467
|
#
|
460
468
|
# @!attribute [rw] recording_configuration_arn
|
461
469
|
# Recording-configuration ARN. A valid ARN value here both specifies
|
@@ -476,37 +484,29 @@ module Aws::IVS
|
|
476
484
|
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
477
485
|
# @return [Hash<String,String>]
|
478
486
|
#
|
479
|
-
# @!attribute [rw]
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
487
|
+
# @!attribute [rw] type
|
488
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
489
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
490
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
491
|
+
# details, see [Channel Types][1].
|
483
492
|
#
|
484
|
-
# @!attribute [rw] preset
|
485
|
-
# Optional transcode preset for the channel. This is selectable only
|
486
|
-
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
487
|
-
# types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
|
488
|
-
# other channel types (`BASIC` and `STANDARD`), `preset` is the empty
|
489
|
-
# string (`""`).
|
490
|
-
# @return [String]
|
491
493
|
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
# specifies the ARN and enables playback restriction. Default: ""
|
495
|
-
# (empty string, no playback restriction policy is applied).
|
494
|
+
#
|
495
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
496
496
|
# @return [String]
|
497
497
|
#
|
498
498
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
|
499
499
|
#
|
500
500
|
class CreateChannelRequest < Struct.new(
|
501
|
-
:name,
|
502
|
-
:latency_mode,
|
503
|
-
:type,
|
504
501
|
:authorized,
|
505
|
-
:recording_configuration_arn,
|
506
|
-
:tags,
|
507
502
|
:insecure_ingest,
|
503
|
+
:latency_mode,
|
504
|
+
:name,
|
505
|
+
:playback_restriction_policy_arn,
|
508
506
|
:preset,
|
509
|
-
:
|
507
|
+
:recording_configuration_arn,
|
508
|
+
:tags,
|
509
|
+
:type)
|
510
510
|
SENSITIVE = []
|
511
511
|
include Aws::Structure
|
512
512
|
end
|
@@ -593,15 +593,26 @@ module Aws::IVS
|
|
593
593
|
include Aws::Structure
|
594
594
|
end
|
595
595
|
|
596
|
-
# @!attribute [rw] name
|
597
|
-
# Recording-configuration name. The value does not need to be unique.
|
598
|
-
# @return [String]
|
599
|
-
#
|
600
596
|
# @!attribute [rw] destination_configuration
|
601
597
|
# A complex type that contains a destination configuration for where
|
602
598
|
# recorded video will be stored.
|
603
599
|
# @return [Types::DestinationConfiguration]
|
604
600
|
#
|
601
|
+
# @!attribute [rw] name
|
602
|
+
# Recording-configuration name. The value does not need to be unique.
|
603
|
+
# @return [String]
|
604
|
+
#
|
605
|
+
# @!attribute [rw] recording_reconnect_window_seconds
|
606
|
+
# If a broadcast disconnects and then reconnects within the specified
|
607
|
+
# interval, the multiple streams will be considered a single broadcast
|
608
|
+
# and merged together. Default: 0.
|
609
|
+
# @return [Integer]
|
610
|
+
#
|
611
|
+
# @!attribute [rw] rendition_configuration
|
612
|
+
# Object that describes which renditions should be recorded for a
|
613
|
+
# stream.
|
614
|
+
# @return [Types::RenditionConfiguration]
|
615
|
+
#
|
605
616
|
# @!attribute [rw] tags
|
606
617
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
607
618
|
# See [Best practices and strategies][1] in *Tagging Amazon Web
|
@@ -621,26 +632,15 @@ module Aws::IVS
|
|
621
632
|
# thumbnails are generated for the live session.
|
622
633
|
# @return [Types::ThumbnailConfiguration]
|
623
634
|
#
|
624
|
-
# @!attribute [rw] recording_reconnect_window_seconds
|
625
|
-
# If a broadcast disconnects and then reconnects within the specified
|
626
|
-
# interval, the multiple streams will be considered a single broadcast
|
627
|
-
# and merged together. Default: 0.
|
628
|
-
# @return [Integer]
|
629
|
-
#
|
630
|
-
# @!attribute [rw] rendition_configuration
|
631
|
-
# Object that describes which renditions should be recorded for a
|
632
|
-
# stream.
|
633
|
-
# @return [Types::RenditionConfiguration]
|
634
|
-
#
|
635
635
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationRequest AWS API Documentation
|
636
636
|
#
|
637
637
|
class CreateRecordingConfigurationRequest < Struct.new(
|
638
|
-
:name,
|
639
638
|
:destination_configuration,
|
640
|
-
:
|
641
|
-
:thumbnail_configuration,
|
639
|
+
:name,
|
642
640
|
:recording_reconnect_window_seconds,
|
643
|
-
:rendition_configuration
|
641
|
+
:rendition_configuration,
|
642
|
+
:tags,
|
643
|
+
:thumbnail_configuration)
|
644
644
|
SENSITIVE = []
|
645
645
|
include Aws::Structure
|
646
646
|
end
|
@@ -957,14 +957,14 @@ module Aws::IVS
|
|
957
957
|
include Aws::Structure
|
958
958
|
end
|
959
959
|
|
960
|
-
# @!attribute [rw] public_key_material
|
961
|
-
# The public portion of a customer-generated key pair.
|
962
|
-
# @return [String]
|
963
|
-
#
|
964
960
|
# @!attribute [rw] name
|
965
961
|
# Playback-key-pair name. The value does not need to be unique.
|
966
962
|
# @return [String]
|
967
963
|
#
|
964
|
+
# @!attribute [rw] public_key_material
|
965
|
+
# The public portion of a customer-generated key pair.
|
966
|
+
# @return [String]
|
967
|
+
#
|
968
968
|
# @!attribute [rw] tags
|
969
969
|
# Any tags provided with the request are added to the playback key
|
970
970
|
# pair tags. See [Best practices and strategies][1] in *Tagging Amazon
|
@@ -981,8 +981,8 @@ module Aws::IVS
|
|
981
981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairRequest AWS API Documentation
|
982
982
|
#
|
983
983
|
class ImportPlaybackKeyPairRequest < Struct.new(
|
984
|
-
:public_key_material,
|
985
984
|
:name,
|
985
|
+
:public_key_material,
|
986
986
|
:tags)
|
987
987
|
SENSITIVE = []
|
988
988
|
include Aws::Structure
|
@@ -1002,19 +1002,19 @@ module Aws::IVS
|
|
1002
1002
|
# Object specifying the ingest configuration set up by the broadcaster,
|
1003
1003
|
# usually in an encoder.
|
1004
1004
|
#
|
1005
|
-
# @!attribute [rw] video
|
1006
|
-
# Encoder settings for video.
|
1007
|
-
# @return [Types::VideoConfiguration]
|
1008
|
-
#
|
1009
1005
|
# @!attribute [rw] audio
|
1010
1006
|
# Encoder settings for audio.
|
1011
1007
|
# @return [Types::AudioConfiguration]
|
1012
1008
|
#
|
1009
|
+
# @!attribute [rw] video
|
1010
|
+
# Encoder settings for video.
|
1011
|
+
# @return [Types::VideoConfiguration]
|
1012
|
+
#
|
1013
1013
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/IngestConfiguration AWS API Documentation
|
1014
1014
|
#
|
1015
1015
|
class IngestConfiguration < Struct.new(
|
1016
|
-
:
|
1017
|
-
:
|
1016
|
+
:audio,
|
1017
|
+
:video)
|
1018
1018
|
SENSITIVE = []
|
1019
1019
|
include Aws::Structure
|
1020
1020
|
end
|
@@ -1035,32 +1035,32 @@ module Aws::IVS
|
|
1035
1035
|
# Filters the channel list to match the specified name.
|
1036
1036
|
# @return [String]
|
1037
1037
|
#
|
1038
|
+
# @!attribute [rw] filter_by_playback_restriction_policy_arn
|
1039
|
+
# Filters the channel list to match the specified policy.
|
1040
|
+
# @return [String]
|
1041
|
+
#
|
1038
1042
|
# @!attribute [rw] filter_by_recording_configuration_arn
|
1039
1043
|
# Filters the channel list to match the specified
|
1040
1044
|
# recording-configuration ARN.
|
1041
1045
|
# @return [String]
|
1042
1046
|
#
|
1043
|
-
# @!attribute [rw]
|
1044
|
-
#
|
1045
|
-
# @return [
|
1047
|
+
# @!attribute [rw] max_results
|
1048
|
+
# Maximum number of channels to return. Default: 100.
|
1049
|
+
# @return [Integer]
|
1046
1050
|
#
|
1047
1051
|
# @!attribute [rw] next_token
|
1048
1052
|
# The first channel to retrieve. This is used for pagination; see the
|
1049
1053
|
# `nextToken` response field.
|
1050
1054
|
# @return [String]
|
1051
1055
|
#
|
1052
|
-
# @!attribute [rw] max_results
|
1053
|
-
# Maximum number of channels to return. Default: 100.
|
1054
|
-
# @return [Integer]
|
1055
|
-
#
|
1056
1056
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation
|
1057
1057
|
#
|
1058
1058
|
class ListChannelsRequest < Struct.new(
|
1059
1059
|
:filter_by_name,
|
1060
|
-
:filter_by_recording_configuration_arn,
|
1061
1060
|
:filter_by_playback_restriction_policy_arn,
|
1062
|
-
:
|
1063
|
-
:max_results
|
1061
|
+
:filter_by_recording_configuration_arn,
|
1062
|
+
:max_results,
|
1063
|
+
:next_token)
|
1064
1064
|
SENSITIVE = []
|
1065
1065
|
include Aws::Structure
|
1066
1066
|
end
|
@@ -1083,21 +1083,21 @@ module Aws::IVS
|
|
1083
1083
|
include Aws::Structure
|
1084
1084
|
end
|
1085
1085
|
|
1086
|
-
# @!attribute [rw] next_token
|
1087
|
-
# The first key pair to retrieve. This is used for pagination; see the
|
1088
|
-
# `nextToken` response field.
|
1089
|
-
# @return [String]
|
1090
|
-
#
|
1091
1086
|
# @!attribute [rw] max_results
|
1092
1087
|
# Maximum number of key pairs to return. Default: your service quota
|
1093
1088
|
# or 100, whichever is smaller.
|
1094
1089
|
# @return [Integer]
|
1095
1090
|
#
|
1091
|
+
# @!attribute [rw] next_token
|
1092
|
+
# The first key pair to retrieve. This is used for pagination; see the
|
1093
|
+
# `nextToken` response field.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
1096
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairsRequest AWS API Documentation
|
1097
1097
|
#
|
1098
1098
|
class ListPlaybackKeyPairsRequest < Struct.new(
|
1099
|
-
:
|
1100
|
-
:
|
1099
|
+
:max_results,
|
1100
|
+
:next_token)
|
1101
1101
|
SENSITIVE = []
|
1102
1102
|
include Aws::Structure
|
1103
1103
|
end
|
@@ -1120,75 +1120,75 @@ module Aws::IVS
|
|
1120
1120
|
include Aws::Structure
|
1121
1121
|
end
|
1122
1122
|
|
1123
|
+
# @!attribute [rw] max_results
|
1124
|
+
# Maximum number of policies to return. Default: 1.
|
1125
|
+
# @return [Integer]
|
1126
|
+
#
|
1123
1127
|
# @!attribute [rw] next_token
|
1124
1128
|
# The first policy to retrieve. This is used for pagination; see the
|
1125
1129
|
# `nextToken` response field.
|
1126
1130
|
# @return [String]
|
1127
1131
|
#
|
1128
|
-
# @!attribute [rw] max_results
|
1129
|
-
# Maximum number of policies to return. Default: 1.
|
1130
|
-
# @return [Integer]
|
1131
|
-
#
|
1132
1132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesRequest AWS API Documentation
|
1133
1133
|
#
|
1134
1134
|
class ListPlaybackRestrictionPoliciesRequest < Struct.new(
|
1135
|
-
:
|
1136
|
-
:
|
1135
|
+
:max_results,
|
1136
|
+
:next_token)
|
1137
1137
|
SENSITIVE = []
|
1138
1138
|
include Aws::Structure
|
1139
1139
|
end
|
1140
1140
|
|
1141
|
-
# @!attribute [rw] playback_restriction_policies
|
1142
|
-
# List of the matching policies.
|
1143
|
-
# @return [Array<Types::PlaybackRestrictionPolicySummary>]
|
1144
|
-
#
|
1145
1141
|
# @!attribute [rw] next_token
|
1146
1142
|
# If there are more channels than `maxResults`, use `nextToken` in the
|
1147
1143
|
# request to get the next set.
|
1148
1144
|
# @return [String]
|
1149
1145
|
#
|
1146
|
+
# @!attribute [rw] playback_restriction_policies
|
1147
|
+
# List of the matching policies.
|
1148
|
+
# @return [Array<Types::PlaybackRestrictionPolicySummary>]
|
1149
|
+
#
|
1150
1150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesResponse AWS API Documentation
|
1151
1151
|
#
|
1152
1152
|
class ListPlaybackRestrictionPoliciesResponse < Struct.new(
|
1153
|
-
:
|
1154
|
-
:
|
1153
|
+
:next_token,
|
1154
|
+
:playback_restriction_policies)
|
1155
1155
|
SENSITIVE = []
|
1156
1156
|
include Aws::Structure
|
1157
1157
|
end
|
1158
1158
|
|
1159
|
-
# @!attribute [rw] next_token
|
1160
|
-
# The first recording configuration to retrieve. This is used for
|
1161
|
-
# pagination; see the `nextToken` response field.
|
1162
|
-
# @return [String]
|
1163
|
-
#
|
1164
1159
|
# @!attribute [rw] max_results
|
1165
1160
|
# Maximum number of recording configurations to return. Default: your
|
1166
1161
|
# service quota or 100, whichever is smaller.
|
1167
1162
|
# @return [Integer]
|
1168
1163
|
#
|
1164
|
+
# @!attribute [rw] next_token
|
1165
|
+
# The first recording configuration to retrieve. This is used for
|
1166
|
+
# pagination; see the `nextToken` response field.
|
1167
|
+
# @return [String]
|
1168
|
+
#
|
1169
1169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsRequest AWS API Documentation
|
1170
1170
|
#
|
1171
1171
|
class ListRecordingConfigurationsRequest < Struct.new(
|
1172
|
-
:
|
1173
|
-
:
|
1172
|
+
:max_results,
|
1173
|
+
:next_token)
|
1174
1174
|
SENSITIVE = []
|
1175
1175
|
include Aws::Structure
|
1176
1176
|
end
|
1177
1177
|
|
1178
|
-
# @!attribute [rw] recording_configurations
|
1179
|
-
# List of the matching recording configurations.
|
1180
|
-
# @return [Array<Types::RecordingConfigurationSummary>]
|
1181
|
-
#
|
1182
1178
|
# @!attribute [rw] next_token
|
1183
1179
|
# If there are more recording configurations than `maxResults`, use
|
1184
1180
|
# `nextToken` in the request to get the next set.
|
1185
1181
|
# @return [String]
|
1186
1182
|
#
|
1183
|
+
# @!attribute [rw] recording_configurations
|
1184
|
+
# List of the matching recording configurations.
|
1185
|
+
# @return [Array<Types::RecordingConfigurationSummary>]
|
1186
|
+
#
|
1187
1187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsResponse AWS API Documentation
|
1188
1188
|
#
|
1189
1189
|
class ListRecordingConfigurationsResponse < Struct.new(
|
1190
|
-
:
|
1191
|
-
:
|
1190
|
+
:next_token,
|
1191
|
+
:recording_configurations)
|
1192
1192
|
SENSITIVE = []
|
1193
1193
|
include Aws::Structure
|
1194
1194
|
end
|
@@ -1197,39 +1197,39 @@ module Aws::IVS
|
|
1197
1197
|
# Channel ARN used to filter the list.
|
1198
1198
|
# @return [String]
|
1199
1199
|
#
|
1200
|
+
# @!attribute [rw] max_results
|
1201
|
+
# Maximum number of streamKeys to return. Default: 1.
|
1202
|
+
# @return [Integer]
|
1203
|
+
#
|
1200
1204
|
# @!attribute [rw] next_token
|
1201
1205
|
# The first stream key to retrieve. This is used for pagination; see
|
1202
1206
|
# the `nextToken` response field.
|
1203
1207
|
# @return [String]
|
1204
1208
|
#
|
1205
|
-
# @!attribute [rw] max_results
|
1206
|
-
# Maximum number of streamKeys to return. Default: 1.
|
1207
|
-
# @return [Integer]
|
1208
|
-
#
|
1209
1209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation
|
1210
1210
|
#
|
1211
1211
|
class ListStreamKeysRequest < Struct.new(
|
1212
1212
|
:channel_arn,
|
1213
|
-
:
|
1214
|
-
:
|
1213
|
+
:max_results,
|
1214
|
+
:next_token)
|
1215
1215
|
SENSITIVE = []
|
1216
1216
|
include Aws::Structure
|
1217
1217
|
end
|
1218
1218
|
|
1219
|
-
# @!attribute [rw] stream_keys
|
1220
|
-
# List of stream keys.
|
1221
|
-
# @return [Array<Types::StreamKeySummary>]
|
1222
|
-
#
|
1223
1219
|
# @!attribute [rw] next_token
|
1224
1220
|
# If there are more stream keys than `maxResults`, use `nextToken` in
|
1225
1221
|
# the request to get the next set.
|
1226
1222
|
# @return [String]
|
1227
1223
|
#
|
1224
|
+
# @!attribute [rw] stream_keys
|
1225
|
+
# List of stream keys.
|
1226
|
+
# @return [Array<Types::StreamKeySummary>]
|
1227
|
+
#
|
1228
1228
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation
|
1229
1229
|
#
|
1230
1230
|
class ListStreamKeysResponse < Struct.new(
|
1231
|
-
:
|
1232
|
-
:
|
1231
|
+
:next_token,
|
1232
|
+
:stream_keys)
|
1233
1233
|
SENSITIVE = []
|
1234
1234
|
include Aws::Structure
|
1235
1235
|
end
|
@@ -1238,39 +1238,39 @@ module Aws::IVS
|
|
1238
1238
|
# Channel ARN used to filter the list.
|
1239
1239
|
# @return [String]
|
1240
1240
|
#
|
1241
|
+
# @!attribute [rw] max_results
|
1242
|
+
# Maximum number of streams to return. Default: 100.
|
1243
|
+
# @return [Integer]
|
1244
|
+
#
|
1241
1245
|
# @!attribute [rw] next_token
|
1242
1246
|
# The first stream to retrieve. This is used for pagination; see the
|
1243
1247
|
# `nextToken` response field.
|
1244
1248
|
# @return [String]
|
1245
1249
|
#
|
1246
|
-
# @!attribute [rw] max_results
|
1247
|
-
# Maximum number of streams to return. Default: 100.
|
1248
|
-
# @return [Integer]
|
1249
|
-
#
|
1250
1250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsRequest AWS API Documentation
|
1251
1251
|
#
|
1252
1252
|
class ListStreamSessionsRequest < Struct.new(
|
1253
1253
|
:channel_arn,
|
1254
|
-
:
|
1255
|
-
:
|
1254
|
+
:max_results,
|
1255
|
+
:next_token)
|
1256
1256
|
SENSITIVE = []
|
1257
1257
|
include Aws::Structure
|
1258
1258
|
end
|
1259
1259
|
|
1260
|
-
# @!attribute [rw] stream_sessions
|
1261
|
-
# List of stream sessions.
|
1262
|
-
# @return [Array<Types::StreamSessionSummary>]
|
1263
|
-
#
|
1264
1260
|
# @!attribute [rw] next_token
|
1265
1261
|
# If there are more streams than `maxResults`, use `nextToken` in the
|
1266
1262
|
# request to get the next set.
|
1267
1263
|
# @return [String]
|
1268
1264
|
#
|
1265
|
+
# @!attribute [rw] stream_sessions
|
1266
|
+
# List of stream sessions.
|
1267
|
+
# @return [Array<Types::StreamSessionSummary>]
|
1268
|
+
#
|
1269
1269
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsResponse AWS API Documentation
|
1270
1270
|
#
|
1271
1271
|
class ListStreamSessionsResponse < Struct.new(
|
1272
|
-
:
|
1273
|
-
:
|
1272
|
+
:next_token,
|
1273
|
+
:stream_sessions)
|
1274
1274
|
SENSITIVE = []
|
1275
1275
|
include Aws::Structure
|
1276
1276
|
end
|
@@ -1279,39 +1279,39 @@ module Aws::IVS
|
|
1279
1279
|
# Filters the stream list to match the specified criterion.
|
1280
1280
|
# @return [Types::StreamFilters]
|
1281
1281
|
#
|
1282
|
+
# @!attribute [rw] max_results
|
1283
|
+
# Maximum number of streams to return. Default: 100.
|
1284
|
+
# @return [Integer]
|
1285
|
+
#
|
1282
1286
|
# @!attribute [rw] next_token
|
1283
1287
|
# The first stream to retrieve. This is used for pagination; see the
|
1284
1288
|
# `nextToken` response field.
|
1285
1289
|
# @return [String]
|
1286
1290
|
#
|
1287
|
-
# @!attribute [rw] max_results
|
1288
|
-
# Maximum number of streams to return. Default: 100.
|
1289
|
-
# @return [Integer]
|
1290
|
-
#
|
1291
1291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation
|
1292
1292
|
#
|
1293
1293
|
class ListStreamsRequest < Struct.new(
|
1294
1294
|
:filter_by,
|
1295
|
-
:
|
1296
|
-
:
|
1295
|
+
:max_results,
|
1296
|
+
:next_token)
|
1297
1297
|
SENSITIVE = []
|
1298
1298
|
include Aws::Structure
|
1299
1299
|
end
|
1300
1300
|
|
1301
|
-
# @!attribute [rw] streams
|
1302
|
-
# List of streams.
|
1303
|
-
# @return [Array<Types::StreamSummary>]
|
1304
|
-
#
|
1305
1301
|
# @!attribute [rw] next_token
|
1306
1302
|
# If there are more streams than `maxResults`, use `nextToken` in the
|
1307
1303
|
# request to get the next set.
|
1308
1304
|
# @return [String]
|
1309
1305
|
#
|
1306
|
+
# @!attribute [rw] streams
|
1307
|
+
# List of streams.
|
1308
|
+
# @return [Array<Types::StreamSummary>]
|
1309
|
+
#
|
1310
1310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation
|
1311
1311
|
#
|
1312
1312
|
class ListStreamsResponse < Struct.new(
|
1313
|
-
:
|
1314
|
-
:
|
1313
|
+
:next_token,
|
1314
|
+
:streams)
|
1315
1315
|
SENSITIVE = []
|
1316
1316
|
include Aws::Structure
|
1317
1317
|
end
|
@@ -1360,14 +1360,14 @@ module Aws::IVS
|
|
1360
1360
|
# Key-pair ARN.
|
1361
1361
|
# @return [String]
|
1362
1362
|
#
|
1363
|
-
# @!attribute [rw] name
|
1364
|
-
# Playback-key-pair name. The value does not need to be unique.
|
1365
|
-
# @return [String]
|
1366
|
-
#
|
1367
1363
|
# @!attribute [rw] fingerprint
|
1368
1364
|
# Key-pair identifier.
|
1369
1365
|
# @return [String]
|
1370
1366
|
#
|
1367
|
+
# @!attribute [rw] name
|
1368
|
+
# Playback-key-pair name. The value does not need to be unique.
|
1369
|
+
# @return [String]
|
1370
|
+
#
|
1371
1371
|
# @!attribute [rw] tags
|
1372
1372
|
# Tags attached to the resource. Array of 1-50 maps, each of the form
|
1373
1373
|
# `string:string (key:value)`. See [Best practices and strategies][1]
|
@@ -1385,8 +1385,8 @@ module Aws::IVS
|
|
1385
1385
|
#
|
1386
1386
|
class PlaybackKeyPair < Struct.new(
|
1387
1387
|
:arn,
|
1388
|
-
:name,
|
1389
1388
|
:fingerprint,
|
1389
|
+
:name,
|
1390
1390
|
:tags)
|
1391
1391
|
SENSITIVE = []
|
1392
1392
|
include Aws::Structure
|
@@ -1428,10 +1428,6 @@ module Aws::IVS
|
|
1428
1428
|
# An object representing a policy to constrain playback by country
|
1429
1429
|
# and/or origin sites.
|
1430
1430
|
#
|
1431
|
-
# @!attribute [rw] arn
|
1432
|
-
# Playback-restriction-policy ARN
|
1433
|
-
# @return [String]
|
1434
|
-
#
|
1435
1431
|
# @!attribute [rw] allowed_countries
|
1436
1432
|
# A list of country codes that control geoblocking restriction.
|
1437
1433
|
# Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
|
@@ -1453,6 +1449,10 @@ module Aws::IVS
|
|
1453
1449
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
1454
1450
|
# @return [Array<String>]
|
1455
1451
|
#
|
1452
|
+
# @!attribute [rw] arn
|
1453
|
+
# Playback-restriction-policy ARN
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
1456
|
# @!attribute [rw] enable_strict_origin_enforcement
|
1457
1457
|
# Whether channel playback is constrained by origin site. Default:
|
1458
1458
|
# `false`.
|
@@ -1479,9 +1479,9 @@ module Aws::IVS
|
|
1479
1479
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicy AWS API Documentation
|
1480
1480
|
#
|
1481
1481
|
class PlaybackRestrictionPolicy < Struct.new(
|
1482
|
-
:arn,
|
1483
1482
|
:allowed_countries,
|
1484
1483
|
:allowed_origins,
|
1484
|
+
:arn,
|
1485
1485
|
:enable_strict_origin_enforcement,
|
1486
1486
|
:name,
|
1487
1487
|
:tags)
|
@@ -1491,10 +1491,6 @@ module Aws::IVS
|
|
1491
1491
|
|
1492
1492
|
# Summary information about a PlaybackRestrictionPolicy.
|
1493
1493
|
#
|
1494
|
-
# @!attribute [rw] arn
|
1495
|
-
# Playback-restriction-policy ARN
|
1496
|
-
# @return [String]
|
1497
|
-
#
|
1498
1494
|
# @!attribute [rw] allowed_countries
|
1499
1495
|
# A list of country codes that control geoblocking restriction.
|
1500
1496
|
# Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
|
@@ -1516,6 +1512,10 @@ module Aws::IVS
|
|
1516
1512
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
1517
1513
|
# @return [Array<String>]
|
1518
1514
|
#
|
1515
|
+
# @!attribute [rw] arn
|
1516
|
+
# Playback-restriction-policy ARN
|
1517
|
+
# @return [String]
|
1518
|
+
#
|
1519
1519
|
# @!attribute [rw] enable_strict_origin_enforcement
|
1520
1520
|
# Whether channel playback is constrained by origin site. Default:
|
1521
1521
|
# `false`.
|
@@ -1542,9 +1542,9 @@ module Aws::IVS
|
|
1542
1542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicySummary AWS API Documentation
|
1543
1543
|
#
|
1544
1544
|
class PlaybackRestrictionPolicySummary < Struct.new(
|
1545
|
-
:arn,
|
1546
1545
|
:allowed_countries,
|
1547
1546
|
:allowed_origins,
|
1547
|
+
:arn,
|
1548
1548
|
:enable_strict_origin_enforcement,
|
1549
1549
|
:name,
|
1550
1550
|
:tags)
|
@@ -1576,15 +1576,26 @@ module Aws::IVS
|
|
1576
1576
|
# Recording-configuration ARN.
|
1577
1577
|
# @return [String]
|
1578
1578
|
#
|
1579
|
-
# @!attribute [rw] name
|
1580
|
-
# Recording-configuration name. The value does not need to be unique.
|
1581
|
-
# @return [String]
|
1582
|
-
#
|
1583
1579
|
# @!attribute [rw] destination_configuration
|
1584
1580
|
# A complex type that contains information about where recorded video
|
1585
1581
|
# will be stored.
|
1586
1582
|
# @return [Types::DestinationConfiguration]
|
1587
1583
|
#
|
1584
|
+
# @!attribute [rw] name
|
1585
|
+
# Recording-configuration name. The value does not need to be unique.
|
1586
|
+
# @return [String]
|
1587
|
+
#
|
1588
|
+
# @!attribute [rw] recording_reconnect_window_seconds
|
1589
|
+
# If a broadcast disconnects and then reconnects within the specified
|
1590
|
+
# interval, the multiple streams will be considered a single broadcast
|
1591
|
+
# and merged together. Default: 0.
|
1592
|
+
# @return [Integer]
|
1593
|
+
#
|
1594
|
+
# @!attribute [rw] rendition_configuration
|
1595
|
+
# Object that describes which renditions should be recorded for a
|
1596
|
+
# stream.
|
1597
|
+
# @return [Types::RenditionConfiguration]
|
1598
|
+
#
|
1588
1599
|
# @!attribute [rw] state
|
1589
1600
|
# Indicates the current state of the recording configuration. When the
|
1590
1601
|
# state is `ACTIVE`, the configuration is ready for recording a
|
@@ -1610,40 +1621,25 @@ module Aws::IVS
|
|
1610
1621
|
# thumbnails are generated for the live session.
|
1611
1622
|
# @return [Types::ThumbnailConfiguration]
|
1612
1623
|
#
|
1613
|
-
# @!attribute [rw] recording_reconnect_window_seconds
|
1614
|
-
# If a broadcast disconnects and then reconnects within the specified
|
1615
|
-
# interval, the multiple streams will be considered a single broadcast
|
1616
|
-
# and merged together. Default: 0.
|
1617
|
-
# @return [Integer]
|
1618
|
-
#
|
1619
|
-
# @!attribute [rw] rendition_configuration
|
1620
|
-
# Object that describes which renditions should be recorded for a
|
1621
|
-
# stream.
|
1622
|
-
# @return [Types::RenditionConfiguration]
|
1623
|
-
#
|
1624
1624
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/RecordingConfiguration AWS API Documentation
|
1625
1625
|
#
|
1626
1626
|
class RecordingConfiguration < Struct.new(
|
1627
1627
|
:arn,
|
1628
|
-
:name,
|
1629
1628
|
:destination_configuration,
|
1629
|
+
:name,
|
1630
|
+
:recording_reconnect_window_seconds,
|
1631
|
+
:rendition_configuration,
|
1630
1632
|
:state,
|
1631
1633
|
:tags,
|
1632
|
-
:thumbnail_configuration
|
1633
|
-
:recording_reconnect_window_seconds,
|
1634
|
-
:rendition_configuration)
|
1634
|
+
:thumbnail_configuration)
|
1635
1635
|
SENSITIVE = []
|
1636
1636
|
include Aws::Structure
|
1637
1637
|
end
|
1638
1638
|
|
1639
1639
|
# Summary information about a RecordingConfiguration.
|
1640
|
-
#
|
1641
|
-
# @!attribute [rw] arn
|
1642
|
-
# Recording-configuration ARN.
|
1643
|
-
# @return [String]
|
1644
|
-
#
|
1645
|
-
# @!attribute [rw] name
|
1646
|
-
# Recording-configuration name. The value does not need to be unique.
|
1640
|
+
#
|
1641
|
+
# @!attribute [rw] arn
|
1642
|
+
# Recording-configuration ARN.
|
1647
1643
|
# @return [String]
|
1648
1644
|
#
|
1649
1645
|
# @!attribute [rw] destination_configuration
|
@@ -1651,6 +1647,10 @@ module Aws::IVS
|
|
1651
1647
|
# will be stored.
|
1652
1648
|
# @return [Types::DestinationConfiguration]
|
1653
1649
|
#
|
1650
|
+
# @!attribute [rw] name
|
1651
|
+
# Recording-configuration name. The value does not need to be unique.
|
1652
|
+
# @return [String]
|
1653
|
+
#
|
1654
1654
|
# @!attribute [rw] state
|
1655
1655
|
# Indicates the current state of the recording configuration. When the
|
1656
1656
|
# state is `ACTIVE`, the configuration is ready for recording a
|
@@ -1674,8 +1674,8 @@ module Aws::IVS
|
|
1674
1674
|
#
|
1675
1675
|
class RecordingConfigurationSummary < Struct.new(
|
1676
1676
|
:arn,
|
1677
|
-
:name,
|
1678
1677
|
:destination_configuration,
|
1678
|
+
:name,
|
1679
1679
|
:state,
|
1680
1680
|
:tags)
|
1681
1681
|
SENSITIVE = []
|
@@ -1828,9 +1828,8 @@ module Aws::IVS
|
|
1828
1828
|
# Channel ARN for the stream.
|
1829
1829
|
# @return [String]
|
1830
1830
|
#
|
1831
|
-
# @!attribute [rw]
|
1832
|
-
#
|
1833
|
-
# specified channel.
|
1831
|
+
# @!attribute [rw] health
|
1832
|
+
# The stream’s health.
|
1834
1833
|
# @return [String]
|
1835
1834
|
#
|
1836
1835
|
# @!attribute [rw] playback_url
|
@@ -1849,8 +1848,9 @@ module Aws::IVS
|
|
1849
1848
|
# indicate that the stream is not live.
|
1850
1849
|
# @return [String]
|
1851
1850
|
#
|
1852
|
-
# @!attribute [rw]
|
1853
|
-
#
|
1851
|
+
# @!attribute [rw] stream_id
|
1852
|
+
# Unique identifier for a live or previously live stream in the
|
1853
|
+
# specified channel.
|
1854
1854
|
# @return [String]
|
1855
1855
|
#
|
1856
1856
|
# @!attribute [rw] viewer_count
|
@@ -1865,11 +1865,11 @@ module Aws::IVS
|
|
1865
1865
|
#
|
1866
1866
|
class Stream < Struct.new(
|
1867
1867
|
:channel_arn,
|
1868
|
-
:
|
1868
|
+
:health,
|
1869
1869
|
:playback_url,
|
1870
1870
|
:start_time,
|
1871
1871
|
:state,
|
1872
|
-
:
|
1872
|
+
:stream_id,
|
1873
1873
|
:viewer_count)
|
1874
1874
|
SENSITIVE = []
|
1875
1875
|
include Aws::Structure
|
@@ -1882,12 +1882,22 @@ module Aws::IVS
|
|
1882
1882
|
#
|
1883
1883
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
|
1884
1884
|
#
|
1885
|
-
# @!attribute [rw]
|
1886
|
-
#
|
1887
|
-
#
|
1885
|
+
# @!attribute [rw] code
|
1886
|
+
# Provides additional details about the stream event. There are
|
1887
|
+
# several values; note that the long descriptions are provided in the
|
1888
|
+
# IVS console but not delivered through the IVS API or EventBridge:
|
1888
1889
|
#
|
1889
|
-
#
|
1890
|
-
#
|
1890
|
+
# * `StreamTakeoverMediaMismatch` — The broadcast client attempted to
|
1891
|
+
# take over with different media properties (e.g., codec,
|
1892
|
+
# resolution, or video track type) from the original stream.
|
1893
|
+
#
|
1894
|
+
# * `StreamTakeoverInvalidPriority` — The broadcast client attempted a
|
1895
|
+
# takeover with either a priority integer value equal to or lower
|
1896
|
+
# than the original stream's value or a value outside the allowed
|
1897
|
+
# range of 1 to 2,147,483,647.
|
1898
|
+
#
|
1899
|
+
# * `StreamTakeoverLimitBreached` — The broadcast client reached the
|
1900
|
+
# maximum allowed takeover attempts for this stream.
|
1891
1901
|
# @return [String]
|
1892
1902
|
#
|
1893
1903
|
# @!attribute [rw] event_time
|
@@ -1895,12 +1905,21 @@ module Aws::IVS
|
|
1895
1905
|
# that this is returned as a string*.
|
1896
1906
|
# @return [Time]
|
1897
1907
|
#
|
1908
|
+
# @!attribute [rw] name
|
1909
|
+
# Name that identifies the stream event within a `type`.
|
1910
|
+
# @return [String]
|
1911
|
+
#
|
1912
|
+
# @!attribute [rw] type
|
1913
|
+
# Logical group for certain events.
|
1914
|
+
# @return [String]
|
1915
|
+
#
|
1898
1916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamEvent AWS API Documentation
|
1899
1917
|
#
|
1900
1918
|
class StreamEvent < Struct.new(
|
1919
|
+
:code,
|
1920
|
+
:event_time,
|
1901
1921
|
:name,
|
1902
|
-
:type
|
1903
|
-
:event_time)
|
1922
|
+
:type)
|
1904
1923
|
SENSITIVE = []
|
1905
1924
|
include Aws::Structure
|
1906
1925
|
end
|
@@ -1925,10 +1944,6 @@ module Aws::IVS
|
|
1925
1944
|
# Stream-key ARN.
|
1926
1945
|
# @return [String]
|
1927
1946
|
#
|
1928
|
-
# @!attribute [rw] value
|
1929
|
-
# Stream-key value.
|
1930
|
-
# @return [String]
|
1931
|
-
#
|
1932
1947
|
# @!attribute [rw] channel_arn
|
1933
1948
|
# Channel ARN for the stream.
|
1934
1949
|
# @return [String]
|
@@ -1946,13 +1961,17 @@ module Aws::IVS
|
|
1946
1961
|
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
1947
1962
|
# @return [Hash<String,String>]
|
1948
1963
|
#
|
1964
|
+
# @!attribute [rw] value
|
1965
|
+
# Stream-key value.
|
1966
|
+
# @return [String]
|
1967
|
+
#
|
1949
1968
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation
|
1950
1969
|
#
|
1951
1970
|
class StreamKey < Struct.new(
|
1952
1971
|
:arn,
|
1953
|
-
:value,
|
1954
1972
|
:channel_arn,
|
1955
|
-
:tags
|
1973
|
+
:tags,
|
1974
|
+
:value)
|
1956
1975
|
SENSITIVE = [:value]
|
1957
1976
|
include Aws::Structure
|
1958
1977
|
end
|
@@ -1994,15 +2013,9 @@ module Aws::IVS
|
|
1994
2013
|
# provisioned, the ingest configurations that the broadcaster used, and
|
1995
2014
|
# the most recent Amazon IVS stream events it encountered.
|
1996
2015
|
#
|
1997
|
-
# @!attribute [rw]
|
1998
|
-
#
|
1999
|
-
#
|
2000
|
-
# @return [String]
|
2001
|
-
#
|
2002
|
-
# @!attribute [rw] start_time
|
2003
|
-
# Time when the channel went live. This is an ISO 8601 timestamp;
|
2004
|
-
# *note that this is returned as a string*.
|
2005
|
-
# @return [Time]
|
2016
|
+
# @!attribute [rw] channel
|
2017
|
+
# The properties of the channel at the time of going live.
|
2018
|
+
# @return [Types::Channel]
|
2006
2019
|
#
|
2007
2020
|
# @!attribute [rw] end_time
|
2008
2021
|
# Time when the channel went offline. This is an ISO 8601 timestamp;
|
@@ -2010,10 +2023,6 @@ module Aws::IVS
|
|
2010
2023
|
# `NULL`.
|
2011
2024
|
# @return [Time]
|
2012
2025
|
#
|
2013
|
-
# @!attribute [rw] channel
|
2014
|
-
# The properties of the channel at the time of going live.
|
2015
|
-
# @return [Types::Channel]
|
2016
|
-
#
|
2017
2026
|
# @!attribute [rw] ingest_configuration
|
2018
2027
|
# The properties of the incoming RTMP stream for the stream.
|
2019
2028
|
# @return [Types::IngestConfiguration]
|
@@ -2022,6 +2031,16 @@ module Aws::IVS
|
|
2022
2031
|
# The properties of recording the live stream.
|
2023
2032
|
# @return [Types::RecordingConfiguration]
|
2024
2033
|
#
|
2034
|
+
# @!attribute [rw] start_time
|
2035
|
+
# Time when the channel went live. This is an ISO 8601 timestamp;
|
2036
|
+
# *note that this is returned as a string*.
|
2037
|
+
# @return [Time]
|
2038
|
+
#
|
2039
|
+
# @!attribute [rw] stream_id
|
2040
|
+
# Unique identifier for a live or previously live stream in the
|
2041
|
+
# specified channel.
|
2042
|
+
# @return [String]
|
2043
|
+
#
|
2025
2044
|
# @!attribute [rw] truncated_events
|
2026
2045
|
# List of Amazon IVS events that the stream encountered. The list is
|
2027
2046
|
# sorted by most recent events and contains up to 500 events. For
|
@@ -2036,12 +2055,12 @@ module Aws::IVS
|
|
2036
2055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSession AWS API Documentation
|
2037
2056
|
#
|
2038
2057
|
class StreamSession < Struct.new(
|
2039
|
-
:stream_id,
|
2040
|
-
:start_time,
|
2041
|
-
:end_time,
|
2042
2058
|
:channel,
|
2059
|
+
:end_time,
|
2043
2060
|
:ingest_configuration,
|
2044
2061
|
:recording_configuration,
|
2062
|
+
:start_time,
|
2063
|
+
:stream_id,
|
2045
2064
|
:truncated_events)
|
2046
2065
|
SENSITIVE = []
|
2047
2066
|
include Aws::Structure
|
@@ -2049,16 +2068,6 @@ module Aws::IVS
|
|
2049
2068
|
|
2050
2069
|
# Summary information about a stream session.
|
2051
2070
|
#
|
2052
|
-
# @!attribute [rw] stream_id
|
2053
|
-
# Unique identifier for a live or previously live stream in the
|
2054
|
-
# specified channel.
|
2055
|
-
# @return [String]
|
2056
|
-
#
|
2057
|
-
# @!attribute [rw] start_time
|
2058
|
-
# Time when the channel went live. This is an ISO 8601 timestamp;
|
2059
|
-
# *note that this is returned as a string*.
|
2060
|
-
# @return [Time]
|
2061
|
-
#
|
2062
2071
|
# @!attribute [rw] end_time
|
2063
2072
|
# Time when the channel went offline. This is an ISO 8601 timestamp;
|
2064
2073
|
# *note that this is returned as a string*. For live streams, this is
|
@@ -2069,13 +2078,23 @@ module Aws::IVS
|
|
2069
2078
|
# If `true`, this stream encountered a quota breach or failure.
|
2070
2079
|
# @return [Boolean]
|
2071
2080
|
#
|
2081
|
+
# @!attribute [rw] start_time
|
2082
|
+
# Time when the channel went live. This is an ISO 8601 timestamp;
|
2083
|
+
# *note that this is returned as a string*.
|
2084
|
+
# @return [Time]
|
2085
|
+
#
|
2086
|
+
# @!attribute [rw] stream_id
|
2087
|
+
# Unique identifier for a live or previously live stream in the
|
2088
|
+
# specified channel.
|
2089
|
+
# @return [String]
|
2090
|
+
#
|
2072
2091
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSessionSummary AWS API Documentation
|
2073
2092
|
#
|
2074
2093
|
class StreamSessionSummary < Struct.new(
|
2075
|
-
:stream_id,
|
2076
|
-
:start_time,
|
2077
2094
|
:end_time,
|
2078
|
-
:has_error_event
|
2095
|
+
:has_error_event,
|
2096
|
+
:start_time,
|
2097
|
+
:stream_id)
|
2079
2098
|
SENSITIVE = []
|
2080
2099
|
include Aws::Structure
|
2081
2100
|
end
|
@@ -2086,19 +2105,24 @@ module Aws::IVS
|
|
2086
2105
|
# Channel ARN for the stream.
|
2087
2106
|
# @return [String]
|
2088
2107
|
#
|
2089
|
-
# @!attribute [rw]
|
2090
|
-
#
|
2091
|
-
# specified channel.
|
2108
|
+
# @!attribute [rw] health
|
2109
|
+
# The stream’s health.
|
2092
2110
|
# @return [String]
|
2093
2111
|
#
|
2112
|
+
# @!attribute [rw] start_time
|
2113
|
+
# Time of the stream’s start. This is an ISO 8601 timestamp; *note
|
2114
|
+
# that this is returned as a string*.
|
2115
|
+
# @return [Time]
|
2116
|
+
#
|
2094
2117
|
# @!attribute [rw] state
|
2095
2118
|
# The stream’s state. Do not rely on the `OFFLINE` state, as the API
|
2096
2119
|
# may not return it; instead, a "NotBroadcasting" error will
|
2097
2120
|
# indicate that the stream is not live.
|
2098
2121
|
# @return [String]
|
2099
2122
|
#
|
2100
|
-
# @!attribute [rw]
|
2101
|
-
#
|
2123
|
+
# @!attribute [rw] stream_id
|
2124
|
+
# Unique identifier for a live or previously live stream in the
|
2125
|
+
# specified channel.
|
2102
2126
|
# @return [String]
|
2103
2127
|
#
|
2104
2128
|
# @!attribute [rw] viewer_count
|
@@ -2109,20 +2133,15 @@ module Aws::IVS
|
|
2109
2133
|
# timed out; in this case, retry.
|
2110
2134
|
# @return [Integer]
|
2111
2135
|
#
|
2112
|
-
# @!attribute [rw] start_time
|
2113
|
-
# Time of the stream’s start. This is an ISO 8601 timestamp; *note
|
2114
|
-
# that this is returned as a string*.
|
2115
|
-
# @return [Time]
|
2116
|
-
#
|
2117
2136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation
|
2118
2137
|
#
|
2119
2138
|
class StreamSummary < Struct.new(
|
2120
2139
|
:channel_arn,
|
2121
|
-
:stream_id,
|
2122
|
-
:state,
|
2123
2140
|
:health,
|
2124
|
-
:
|
2125
|
-
:
|
2141
|
+
:start_time,
|
2142
|
+
:state,
|
2143
|
+
:stream_id,
|
2144
|
+
:viewer_count)
|
2126
2145
|
SENSITIVE = []
|
2127
2146
|
include Aws::Structure
|
2128
2147
|
end
|
@@ -2189,25 +2208,6 @@ module Aws::IVS
|
|
2189
2208
|
# Thumbnail recording mode. Default: `INTERVAL`.
|
2190
2209
|
# @return [String]
|
2191
2210
|
#
|
2192
|
-
# @!attribute [rw] target_interval_seconds
|
2193
|
-
# The targeted thumbnail-generation interval in seconds. This is
|
2194
|
-
# configurable (and required) only if `recordingMode` is `INTERVAL`.
|
2195
|
-
# Default: 60.
|
2196
|
-
#
|
2197
|
-
# **Important:** For the `BASIC` channel type, setting a value for
|
2198
|
-
# `targetIntervalSeconds` does not guarantee that thumbnails are
|
2199
|
-
# generated at the specified interval. For thumbnails to be generated
|
2200
|
-
# at the `targetIntervalSeconds` interval, the `IDR/Keyframe` value
|
2201
|
-
# for the input video must be less than the `targetIntervalSeconds`
|
2202
|
-
# value. See [ Amazon IVS Streaming Configuration][1] for information
|
2203
|
-
# on setting `IDR/Keyframe` to the recommended value in video-encoder
|
2204
|
-
# settings.
|
2205
|
-
#
|
2206
|
-
#
|
2207
|
-
#
|
2208
|
-
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html
|
2209
|
-
# @return [Integer]
|
2210
|
-
#
|
2211
2211
|
# @!attribute [rw] resolution
|
2212
2212
|
# Indicates the desired resolution of recorded thumbnails. Thumbnails
|
2213
2213
|
# are recorded at the selected resolution if the corresponding
|
@@ -2231,13 +2231,32 @@ module Aws::IVS
|
|
2231
2231
|
# `SEQUENTIAL` and `LATEST`. Default: `SEQUENTIAL`.
|
2232
2232
|
# @return [Array<String>]
|
2233
2233
|
#
|
2234
|
+
# @!attribute [rw] target_interval_seconds
|
2235
|
+
# The targeted thumbnail-generation interval in seconds. This is
|
2236
|
+
# configurable (and required) only if `recordingMode` is `INTERVAL`.
|
2237
|
+
# Default: 60.
|
2238
|
+
#
|
2239
|
+
# **Important:** For the `BASIC` channel type, setting a value for
|
2240
|
+
# `targetIntervalSeconds` does not guarantee that thumbnails are
|
2241
|
+
# generated at the specified interval. For thumbnails to be generated
|
2242
|
+
# at the `targetIntervalSeconds` interval, the `IDR/Keyframe` value
|
2243
|
+
# for the input video must be less than the `targetIntervalSeconds`
|
2244
|
+
# value. See [ Amazon IVS Streaming Configuration][1] for information
|
2245
|
+
# on setting `IDR/Keyframe` to the recommended value in video-encoder
|
2246
|
+
# settings.
|
2247
|
+
#
|
2248
|
+
#
|
2249
|
+
#
|
2250
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html
|
2251
|
+
# @return [Integer]
|
2252
|
+
#
|
2234
2253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ThumbnailConfiguration AWS API Documentation
|
2235
2254
|
#
|
2236
2255
|
class ThumbnailConfiguration < Struct.new(
|
2237
2256
|
:recording_mode,
|
2238
|
-
:target_interval_seconds,
|
2239
2257
|
:resolution,
|
2240
|
-
:storage
|
2258
|
+
:storage,
|
2259
|
+
:target_interval_seconds)
|
2241
2260
|
SENSITIVE = []
|
2242
2261
|
include Aws::Structure
|
2243
2262
|
end
|
@@ -2277,9 +2296,14 @@ module Aws::IVS
|
|
2277
2296
|
# ARN of the channel to be updated.
|
2278
2297
|
# @return [String]
|
2279
2298
|
#
|
2280
|
-
# @!attribute [rw]
|
2281
|
-
#
|
2282
|
-
# @return [
|
2299
|
+
# @!attribute [rw] authorized
|
2300
|
+
# Whether the channel is private (enabled for playback authorization).
|
2301
|
+
# @return [Boolean]
|
2302
|
+
#
|
2303
|
+
# @!attribute [rw] insecure_ingest
|
2304
|
+
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
2305
|
+
# `false`.
|
2306
|
+
# @return [Boolean]
|
2283
2307
|
#
|
2284
2308
|
# @!attribute [rw] latency_mode
|
2285
2309
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -2287,32 +2311,16 @@ module Aws::IVS
|
|
2287
2311
|
# viewers.
|
2288
2312
|
# @return [String]
|
2289
2313
|
#
|
2290
|
-
# @!attribute [rw]
|
2291
|
-
# Channel
|
2292
|
-
# *If you exceed the allowable input resolution or bitrate, the stream
|
2293
|
-
# probably will disconnect immediately.* Default: `STANDARD`. For
|
2294
|
-
# details, see [Channel Types][1].
|
2295
|
-
#
|
2296
|
-
#
|
2297
|
-
#
|
2298
|
-
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
2314
|
+
# @!attribute [rw] name
|
2315
|
+
# Channel name.
|
2299
2316
|
# @return [String]
|
2300
2317
|
#
|
2301
|
-
# @!attribute [rw]
|
2302
|
-
#
|
2303
|
-
#
|
2304
|
-
#
|
2305
|
-
# @!attribute [rw] recording_configuration_arn
|
2306
|
-
# Recording-configuration ARN. A valid ARN value here both specifies
|
2307
|
-
# the ARN and enables recording. If this is set to an empty string,
|
2308
|
-
# recording is disabled.
|
2318
|
+
# @!attribute [rw] playback_restriction_policy_arn
|
2319
|
+
# Playback-restriction-policy ARN. A valid ARN value here both
|
2320
|
+
# specifies the ARN and enables playback restriction. If this is set
|
2321
|
+
# to an empty string, playback restriction policy is disabled.
|
2309
2322
|
# @return [String]
|
2310
2323
|
#
|
2311
|
-
# @!attribute [rw] insecure_ingest
|
2312
|
-
# Whether the channel allows insecure RTMP and SRT ingest. Default:
|
2313
|
-
# `false`.
|
2314
|
-
# @return [Boolean]
|
2315
|
-
#
|
2316
2324
|
# @!attribute [rw] preset
|
2317
2325
|
# Optional transcode preset for the channel. This is selectable only
|
2318
2326
|
# for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
|
@@ -2321,24 +2329,35 @@ module Aws::IVS
|
|
2321
2329
|
# string (`""`).
|
2322
2330
|
# @return [String]
|
2323
2331
|
#
|
2324
|
-
# @!attribute [rw]
|
2325
|
-
#
|
2326
|
-
#
|
2327
|
-
#
|
2332
|
+
# @!attribute [rw] recording_configuration_arn
|
2333
|
+
# Recording-configuration ARN. A valid ARN value here both specifies
|
2334
|
+
# the ARN and enables recording. If this is set to an empty string,
|
2335
|
+
# recording is disabled.
|
2336
|
+
# @return [String]
|
2337
|
+
#
|
2338
|
+
# @!attribute [rw] type
|
2339
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
2340
|
+
# *If you exceed the allowable input resolution or bitrate, the stream
|
2341
|
+
# probably will disconnect immediately.* Default: `STANDARD`. For
|
2342
|
+
# details, see [Channel Types][1].
|
2343
|
+
#
|
2344
|
+
#
|
2345
|
+
#
|
2346
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
|
2328
2347
|
# @return [String]
|
2329
2348
|
#
|
2330
2349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
|
2331
2350
|
#
|
2332
2351
|
class UpdateChannelRequest < Struct.new(
|
2333
2352
|
:arn,
|
2334
|
-
:name,
|
2335
|
-
:latency_mode,
|
2336
|
-
:type,
|
2337
2353
|
:authorized,
|
2338
|
-
:recording_configuration_arn,
|
2339
2354
|
:insecure_ingest,
|
2355
|
+
:latency_mode,
|
2356
|
+
:name,
|
2357
|
+
:playback_restriction_policy_arn,
|
2340
2358
|
:preset,
|
2341
|
-
:
|
2359
|
+
:recording_configuration_arn,
|
2360
|
+
:type)
|
2342
2361
|
SENSITIVE = []
|
2343
2362
|
include Aws::Structure
|
2344
2363
|
end
|
@@ -2355,10 +2374,6 @@ module Aws::IVS
|
|
2355
2374
|
include Aws::Structure
|
2356
2375
|
end
|
2357
2376
|
|
2358
|
-
# @!attribute [rw] arn
|
2359
|
-
# ARN of the playback-restriction-policy to be updated.
|
2360
|
-
# @return [String]
|
2361
|
-
#
|
2362
2377
|
# @!attribute [rw] allowed_countries
|
2363
2378
|
# A list of country codes that control geoblocking restriction.
|
2364
2379
|
# Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
|
@@ -2380,6 +2395,10 @@ module Aws::IVS
|
|
2380
2395
|
# [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
|
2381
2396
|
# @return [Array<String>]
|
2382
2397
|
#
|
2398
|
+
# @!attribute [rw] arn
|
2399
|
+
# ARN of the playback-restriction-policy to be updated.
|
2400
|
+
# @return [String]
|
2401
|
+
#
|
2383
2402
|
# @!attribute [rw] enable_strict_origin_enforcement
|
2384
2403
|
# Whether channel playback is constrained by origin site. Default:
|
2385
2404
|
# `false`.
|
@@ -2393,9 +2412,9 @@ module Aws::IVS
|
|
2393
2412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicyRequest AWS API Documentation
|
2394
2413
|
#
|
2395
2414
|
class UpdatePlaybackRestrictionPolicyRequest < Struct.new(
|
2396
|
-
:arn,
|
2397
2415
|
:allowed_countries,
|
2398
2416
|
:allowed_origins,
|
2417
|
+
:arn,
|
2399
2418
|
:enable_strict_origin_enforcement,
|
2400
2419
|
:name)
|
2401
2420
|
SENSITIVE = []
|
@@ -2431,17 +2450,17 @@ module Aws::IVS
|
|
2431
2450
|
# broadcaster (usually in an encoder). This is part of the
|
2432
2451
|
# IngestConfiguration object and used for monitoring stream health.
|
2433
2452
|
#
|
2434
|
-
# @!attribute [rw] avc_profile
|
2435
|
-
# Indicates to the decoder the requirements for decoding the stream.
|
2436
|
-
# For definitions of the valid values, see the H.264 specification.
|
2437
|
-
# @return [String]
|
2438
|
-
#
|
2439
2453
|
# @!attribute [rw] avc_level
|
2440
2454
|
# Indicates the degree of required decoder performance for a profile.
|
2441
2455
|
# Normally this is set automatically by the encoder. For details, see
|
2442
2456
|
# the H.264 specification.
|
2443
2457
|
# @return [String]
|
2444
2458
|
#
|
2459
|
+
# @!attribute [rw] avc_profile
|
2460
|
+
# Indicates to the decoder the requirements for decoding the stream.
|
2461
|
+
# For definitions of the valid values, see the H.264 specification.
|
2462
|
+
# @return [String]
|
2463
|
+
#
|
2445
2464
|
# @!attribute [rw] codec
|
2446
2465
|
# Codec used for the video encoding.
|
2447
2466
|
# @return [String]
|
@@ -2470,8 +2489,8 @@ module Aws::IVS
|
|
2470
2489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/VideoConfiguration AWS API Documentation
|
2471
2490
|
#
|
2472
2491
|
class VideoConfiguration < Struct.new(
|
2473
|
-
:avc_profile,
|
2474
2492
|
:avc_level,
|
2493
|
+
:avc_profile,
|
2475
2494
|
:codec,
|
2476
2495
|
:encoder,
|
2477
2496
|
:target_bitrate,
|