aws-sdk-ivs 1.51.0 → 1.53.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.
@@ -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
- #
33
29
  # @!attribute [rw] codec
34
30
  # Codec used for the audio encoding.
35
31
  # @return [String]
36
32
  #
33
+ # @!attribute [rw] target_bitrate
34
+ # The expected ingest bitrate (bits per second). This is configured in
35
+ # the encoder.
36
+ # @return [Integer]
37
+ #
37
38
  # @!attribute [rw] sample_rate
38
39
  # Number of audio samples recorded per second.
39
40
  # @return [Integer]
40
41
  #
41
- # @!attribute [rw] target_bitrate
42
- # The expected ingest bitrate (bits per second). This is configured in
43
- # the encoder.
42
+ # @!attribute [rw] channels
43
+ # Number of audio channels.
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,
50
49
  :codec,
50
+ :target_bitrate,
51
51
  :sample_rate,
52
- :target_bitrate)
52
+ :channels)
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] errors
122
- # @return [Array<Types::BatchError>]
123
- #
124
121
  # @!attribute [rw] stream_keys
125
122
  # @return [Array<Types::StreamKey>]
126
123
  #
124
+ # @!attribute [rw] errors
125
+ # @return [Array<Types::BatchError>]
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
- :errors,
131
- :stream_keys)
130
+ :stream_keys,
131
+ :errors)
132
132
  SENSITIVE = []
133
133
  include Aws::Structure
134
134
  end
@@ -141,6 +141,10 @@ 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
+ #
144
148
  # @!attribute [rw] code
145
149
  # Error code.
146
150
  # @return [String]
@@ -149,17 +153,13 @@ module Aws::IVS
149
153
  # Error message, determined by the application.
150
154
  # @return [String]
151
155
  #
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,
160
161
  :code,
161
- :message,
162
- :viewer_id)
162
+ :message)
163
163
  SENSITIVE = []
164
164
  include Aws::Structure
165
165
  end
@@ -224,46 +224,25 @@ module Aws::IVS
224
224
  # Channel ARN.
225
225
  # @return [String]
226
226
  #
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.
227
+ # @!attribute [rw] name
228
+ # Channel name.
235
229
  # @return [String]
236
230
  #
237
- # @!attribute [rw] insecure_ingest
238
- # Whether the channel allows insecure RTMP ingest. Default: `false`.
239
- # @return [Boolean]
240
- #
241
231
  # @!attribute [rw] latency_mode
242
232
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
243
233
  # video up to Full HD. Use `LOW` for near-real-time interaction with
244
234
  # viewers. Default: `LOW`.
245
235
  # @return [String]
246
236
  #
247
- # @!attribute [rw] name
248
- # Channel name.
249
- # @return [String]
237
+ # @!attribute [rw] type
238
+ # Channel type, which determines the allowable resolution and bitrate.
239
+ # *If you exceed the allowable input resolution or bitrate, the stream
240
+ # probably will disconnect immediately.* Default: `STANDARD`. For
241
+ # details, see [Channel Types][1].
250
242
  #
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]
256
243
  #
257
- # @!attribute [rw] playback_url
258
- # Channel playback URL.
259
- # @return [String]
260
244
  #
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 (`""`).
245
+ # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
267
246
  # @return [String]
268
247
  #
269
248
  # @!attribute [rw] recording_configuration_arn
@@ -272,10 +251,19 @@ module Aws::IVS
272
251
  # recording is disabled).
273
252
  # @return [String]
274
253
  #
275
- # @!attribute [rw] srt
276
- # Specifies the endpoint and optional passphrase for streaming with
277
- # the SRT protocol.
278
- # @return [Types::Srt]
254
+ # @!attribute [rw] ingest_endpoint
255
+ # Channel ingest endpoint, part of the definition of an ingest server,
256
+ # used when you set up streaming software.
257
+ # @return [String]
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]
279
267
  #
280
268
  # @!attribute [rw] tags
281
269
  # Tags attached to the resource. Array of 1-50 maps, each of the form
@@ -289,33 +277,45 @@ module Aws::IVS
289
277
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
290
278
  # @return [Hash<String,String>]
291
279
  #
292
- # @!attribute [rw] type
293
- # Channel type, which determines the allowable resolution and bitrate.
294
- # *If you exceed the allowable input resolution or bitrate, the stream
295
- # probably will disconnect immediately.* Default: `STANDARD`. For
296
- # details, see [Channel Types][1].
280
+ # @!attribute [rw] insecure_ingest
281
+ # Whether the channel allows insecure RTMP ingest. Default: `false`.
282
+ # @return [Boolean]
297
283
  #
284
+ # @!attribute [rw] preset
285
+ # Optional transcode preset for the channel. This is selectable only
286
+ # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
287
+ # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
288
+ # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
289
+ # string (`""`).
290
+ # @return [String]
298
291
  #
292
+ # @!attribute [rw] srt
293
+ # Specifies the endpoint and optional passphrase for streaming with
294
+ # the SRT protocol.
295
+ # @return [Types::Srt]
299
296
  #
300
- # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
297
+ # @!attribute [rw] playback_restriction_policy_arn
298
+ # Playback-restriction-policy ARN. A valid ARN value here both
299
+ # specifies the ARN and enables playback restriction. Default: ""
300
+ # (empty string, no playback restriction policy is applied).
301
301
  # @return [String]
302
302
  #
303
303
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
304
304
  #
305
305
  class Channel < Struct.new(
306
306
  :arn,
307
- :authorized,
308
- :ingest_endpoint,
309
- :insecure_ingest,
310
- :latency_mode,
311
307
  :name,
312
- :playback_restriction_policy_arn,
308
+ :latency_mode,
309
+ :type,
310
+ :recording_configuration_arn,
311
+ :ingest_endpoint,
313
312
  :playback_url,
313
+ :authorized,
314
+ :tags,
315
+ :insecure_ingest,
314
316
  :preset,
315
- :recording_configuration_arn,
316
317
  :srt,
317
- :tags,
318
- :type)
318
+ :playback_restriction_policy_arn)
319
319
  SENSITIVE = []
320
320
  include Aws::Structure
321
321
  end
@@ -338,14 +338,9 @@ module Aws::IVS
338
338
  # Channel ARN.
339
339
  # @return [String]
340
340
  #
341
- # @!attribute [rw] authorized
342
- # Whether the channel is private (enabled for playback authorization).
343
- # Default: `false`.
344
- # @return [Boolean]
345
- #
346
- # @!attribute [rw] insecure_ingest
347
- # Whether the channel allows insecure RTMP ingest. Default: `false`.
348
- # @return [Boolean]
341
+ # @!attribute [rw] name
342
+ # Channel name.
343
+ # @return [String]
349
344
  #
350
345
  # @!attribute [rw] latency_mode
351
346
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -353,23 +348,10 @@ module Aws::IVS
353
348
  # viewers. Default: `LOW`.
354
349
  # @return [String]
355
350
  #
356
- # @!attribute [rw] name
357
- # Channel name.
358
- # @return [String]
359
- #
360
- # @!attribute [rw] playback_restriction_policy_arn
361
- # Playback-restriction-policy ARN. A valid ARN value here both
362
- # specifies the ARN and enables playback restriction. Default: ""
363
- # (empty string, no playback restriction policy is applied).
364
- # @return [String]
365
- #
366
- # @!attribute [rw] preset
367
- # Optional transcode preset for the channel. This is selectable only
368
- # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
369
- # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
370
- # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
371
- # string (`""`).
372
- # @return [String]
351
+ # @!attribute [rw] authorized
352
+ # Whether the channel is private (enabled for playback authorization).
353
+ # Default: `false`.
354
+ # @return [Boolean]
373
355
  #
374
356
  # @!attribute [rw] recording_configuration_arn
375
357
  # Recording-configuration ARN. A valid ARN value here both specifies
@@ -389,6 +371,10 @@ module Aws::IVS
389
371
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
390
372
  # @return [Hash<String,String>]
391
373
  #
374
+ # @!attribute [rw] insecure_ingest
375
+ # Whether the channel allows insecure RTMP ingest. Default: `false`.
376
+ # @return [Boolean]
377
+ #
392
378
  # @!attribute [rw] type
393
379
  # Channel type, which determines the allowable resolution and bitrate.
394
380
  # *If you exceed the allowable input resolution or bitrate, the stream
@@ -400,19 +386,33 @@ module Aws::IVS
400
386
  # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
401
387
  # @return [String]
402
388
  #
389
+ # @!attribute [rw] preset
390
+ # Optional transcode preset for the channel. This is selectable only
391
+ # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
392
+ # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
393
+ # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
394
+ # string (`""`).
395
+ # @return [String]
396
+ #
397
+ # @!attribute [rw] playback_restriction_policy_arn
398
+ # Playback-restriction-policy ARN. A valid ARN value here both
399
+ # specifies the ARN and enables playback restriction. Default: ""
400
+ # (empty string, no playback restriction policy is applied).
401
+ # @return [String]
402
+ #
403
403
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ChannelSummary AWS API Documentation
404
404
  #
405
405
  class ChannelSummary < Struct.new(
406
406
  :arn,
407
- :authorized,
408
- :insecure_ingest,
409
- :latency_mode,
410
407
  :name,
411
- :playback_restriction_policy_arn,
412
- :preset,
408
+ :latency_mode,
409
+ :authorized,
413
410
  :recording_configuration_arn,
414
411
  :tags,
415
- :type)
412
+ :insecure_ingest,
413
+ :type,
414
+ :preset,
415
+ :playback_restriction_policy_arn)
416
416
  SENSITIVE = []
417
417
  include Aws::Structure
418
418
  end
@@ -429,15 +429,9 @@ module Aws::IVS
429
429
  include Aws::Structure
430
430
  end
431
431
 
432
- # @!attribute [rw] authorized
433
- # Whether the channel is private (enabled for playback authorization).
434
- # Default: `false`.
435
- # @return [Boolean]
436
- #
437
- # @!attribute [rw] insecure_ingest
438
- # Whether the channel allows insecure RTMP and SRT ingest. Default:
439
- # `false`.
440
- # @return [Boolean]
432
+ # @!attribute [rw] name
433
+ # Channel name.
434
+ # @return [String]
441
435
  #
442
436
  # @!attribute [rw] latency_mode
443
437
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -445,24 +439,22 @@ module Aws::IVS
445
439
  # viewers. Default: `LOW`.
446
440
  # @return [String]
447
441
  #
448
- # @!attribute [rw] name
449
- # Channel name.
450
- # @return [String]
442
+ # @!attribute [rw] type
443
+ # Channel type, which determines the allowable resolution and bitrate.
444
+ # *If you exceed the allowable input resolution or bitrate, the stream
445
+ # probably will disconnect immediately.* Default: `STANDARD`. For
446
+ # details, see [Channel Types][1].
451
447
  #
452
- # @!attribute [rw] playback_restriction_policy_arn
453
- # Playback-restriction-policy ARN. A valid ARN value here both
454
- # specifies the ARN and enables playback restriction. Default: ""
455
- # (empty string, no playback restriction policy is applied).
456
- # @return [String]
457
448
  #
458
- # @!attribute [rw] preset
459
- # Optional transcode preset for the channel. This is selectable only
460
- # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
461
- # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
462
- # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
463
- # string (`""`).
449
+ #
450
+ # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
464
451
  # @return [String]
465
452
  #
453
+ # @!attribute [rw] authorized
454
+ # Whether the channel is private (enabled for playback authorization).
455
+ # Default: `false`.
456
+ # @return [Boolean]
457
+ #
466
458
  # @!attribute [rw] recording_configuration_arn
467
459
  # Recording-configuration ARN. A valid ARN value here both specifies
468
460
  # the ARN and enables recording. Default: "" (empty string,
@@ -481,29 +473,37 @@ module Aws::IVS
481
473
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
482
474
  # @return [Hash<String,String>]
483
475
  #
484
- # @!attribute [rw] type
485
- # Channel type, which determines the allowable resolution and bitrate.
486
- # *If you exceed the allowable input resolution or bitrate, the stream
487
- # probably will disconnect immediately.* Default: `STANDARD`. For
488
- # details, see [Channel Types][1].
489
- #
476
+ # @!attribute [rw] insecure_ingest
477
+ # Whether the channel allows insecure RTMP and SRT ingest. Default:
478
+ # `false`.
479
+ # @return [Boolean]
490
480
  #
481
+ # @!attribute [rw] preset
482
+ # Optional transcode preset for the channel. This is selectable only
483
+ # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
484
+ # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
485
+ # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
486
+ # string (`""`).
487
+ # @return [String]
491
488
  #
492
- # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
489
+ # @!attribute [rw] playback_restriction_policy_arn
490
+ # Playback-restriction-policy ARN. A valid ARN value here both
491
+ # specifies the ARN and enables playback restriction. Default: ""
492
+ # (empty string, no playback restriction policy is applied).
493
493
  # @return [String]
494
494
  #
495
495
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
496
496
  #
497
497
  class CreateChannelRequest < Struct.new(
498
- :authorized,
499
- :insecure_ingest,
500
- :latency_mode,
501
498
  :name,
502
- :playback_restriction_policy_arn,
503
- :preset,
499
+ :latency_mode,
500
+ :type,
501
+ :authorized,
504
502
  :recording_configuration_arn,
505
503
  :tags,
506
- :type)
504
+ :insecure_ingest,
505
+ :preset,
506
+ :playback_restriction_policy_arn)
507
507
  SENSITIVE = []
508
508
  include Aws::Structure
509
509
  end
@@ -589,25 +589,14 @@ module Aws::IVS
589
589
  include Aws::Structure
590
590
  end
591
591
 
592
- # @!attribute [rw] destination_configuration
593
- # A complex type that contains a destination configuration for where
594
- # recorded video will be stored.
595
- # @return [Types::DestinationConfiguration]
596
- #
597
592
  # @!attribute [rw] name
598
593
  # Recording-configuration name. The value does not need to be unique.
599
594
  # @return [String]
600
595
  #
601
- # @!attribute [rw] recording_reconnect_window_seconds
602
- # If a broadcast disconnects and then reconnects within the specified
603
- # interval, the multiple streams will be considered a single broadcast
604
- # and merged together. Default: 0.
605
- # @return [Integer]
606
- #
607
- # @!attribute [rw] rendition_configuration
608
- # Object that describes which renditions should be recorded for a
609
- # stream.
610
- # @return [Types::RenditionConfiguration]
596
+ # @!attribute [rw] destination_configuration
597
+ # A complex type that contains a destination configuration for where
598
+ # recorded video will be stored.
599
+ # @return [Types::DestinationConfiguration]
611
600
  #
612
601
  # @!attribute [rw] tags
613
602
  # Array of 1-50 maps, each of the form `string:string (key:value)`.
@@ -627,15 +616,26 @@ module Aws::IVS
627
616
  # thumbnails are generated for the live session.
628
617
  # @return [Types::ThumbnailConfiguration]
629
618
  #
619
+ # @!attribute [rw] recording_reconnect_window_seconds
620
+ # If a broadcast disconnects and then reconnects within the specified
621
+ # interval, the multiple streams will be considered a single broadcast
622
+ # and merged together. Default: 0.
623
+ # @return [Integer]
624
+ #
625
+ # @!attribute [rw] rendition_configuration
626
+ # Object that describes which renditions should be recorded for a
627
+ # stream.
628
+ # @return [Types::RenditionConfiguration]
629
+ #
630
630
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationRequest AWS API Documentation
631
631
  #
632
632
  class CreateRecordingConfigurationRequest < Struct.new(
633
- :destination_configuration,
634
633
  :name,
635
- :recording_reconnect_window_seconds,
636
- :rendition_configuration,
634
+ :destination_configuration,
637
635
  :tags,
638
- :thumbnail_configuration)
636
+ :thumbnail_configuration,
637
+ :recording_reconnect_window_seconds,
638
+ :rendition_configuration)
639
639
  SENSITIVE = []
640
640
  include Aws::Structure
641
641
  end
@@ -951,14 +951,14 @@ module Aws::IVS
951
951
  include Aws::Structure
952
952
  end
953
953
 
954
- # @!attribute [rw] name
955
- # Playback-key-pair name. The value does not need to be unique.
956
- # @return [String]
957
- #
958
954
  # @!attribute [rw] public_key_material
959
955
  # The public portion of a customer-generated key pair.
960
956
  # @return [String]
961
957
  #
958
+ # @!attribute [rw] name
959
+ # Playback-key-pair name. The value does not need to be unique.
960
+ # @return [String]
961
+ #
962
962
  # @!attribute [rw] tags
963
963
  # Any tags provided with the request are added to the playback key
964
964
  # pair tags. See [Tagging Amazon Web Services Resources][1] for more
@@ -974,8 +974,8 @@ module Aws::IVS
974
974
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairRequest AWS API Documentation
975
975
  #
976
976
  class ImportPlaybackKeyPairRequest < Struct.new(
977
- :name,
978
977
  :public_key_material,
978
+ :name,
979
979
  :tags)
980
980
  SENSITIVE = []
981
981
  include Aws::Structure
@@ -995,19 +995,19 @@ module Aws::IVS
995
995
  # Object specifying the ingest configuration set up by the broadcaster,
996
996
  # usually in an encoder.
997
997
  #
998
- # @!attribute [rw] audio
999
- # Encoder settings for audio.
1000
- # @return [Types::AudioConfiguration]
1001
- #
1002
998
  # @!attribute [rw] video
1003
999
  # Encoder settings for video.
1004
1000
  # @return [Types::VideoConfiguration]
1005
1001
  #
1002
+ # @!attribute [rw] audio
1003
+ # Encoder settings for audio.
1004
+ # @return [Types::AudioConfiguration]
1005
+ #
1006
1006
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/IngestConfiguration AWS API Documentation
1007
1007
  #
1008
1008
  class IngestConfiguration < Struct.new(
1009
- :audio,
1010
- :video)
1009
+ :video,
1010
+ :audio)
1011
1011
  SENSITIVE = []
1012
1012
  include Aws::Structure
1013
1013
  end
@@ -1028,32 +1028,32 @@ module Aws::IVS
1028
1028
  # Filters the channel list to match the specified name.
1029
1029
  # @return [String]
1030
1030
  #
1031
- # @!attribute [rw] filter_by_playback_restriction_policy_arn
1032
- # Filters the channel list to match the specified policy.
1033
- # @return [String]
1034
- #
1035
1031
  # @!attribute [rw] filter_by_recording_configuration_arn
1036
1032
  # Filters the channel list to match the specified
1037
1033
  # recording-configuration ARN.
1038
1034
  # @return [String]
1039
1035
  #
1040
- # @!attribute [rw] max_results
1041
- # Maximum number of channels to return. Default: 100.
1042
- # @return [Integer]
1036
+ # @!attribute [rw] filter_by_playback_restriction_policy_arn
1037
+ # Filters the channel list to match the specified policy.
1038
+ # @return [String]
1043
1039
  #
1044
1040
  # @!attribute [rw] next_token
1045
1041
  # The first channel to retrieve. This is used for pagination; see the
1046
1042
  # `nextToken` response field.
1047
1043
  # @return [String]
1048
1044
  #
1045
+ # @!attribute [rw] max_results
1046
+ # Maximum number of channels to return. Default: 100.
1047
+ # @return [Integer]
1048
+ #
1049
1049
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation
1050
1050
  #
1051
1051
  class ListChannelsRequest < Struct.new(
1052
1052
  :filter_by_name,
1053
- :filter_by_playback_restriction_policy_arn,
1054
1053
  :filter_by_recording_configuration_arn,
1055
- :max_results,
1056
- :next_token)
1054
+ :filter_by_playback_restriction_policy_arn,
1055
+ :next_token,
1056
+ :max_results)
1057
1057
  SENSITIVE = []
1058
1058
  include Aws::Structure
1059
1059
  end
@@ -1076,21 +1076,21 @@ module Aws::IVS
1076
1076
  include Aws::Structure
1077
1077
  end
1078
1078
 
1079
- # @!attribute [rw] max_results
1080
- # Maximum number of key pairs to return. Default: your service quota
1081
- # or 100, whichever is smaller.
1082
- # @return [Integer]
1083
- #
1084
1079
  # @!attribute [rw] next_token
1085
1080
  # The first key pair to retrieve. This is used for pagination; see the
1086
1081
  # `nextToken` response field.
1087
1082
  # @return [String]
1088
1083
  #
1084
+ # @!attribute [rw] max_results
1085
+ # Maximum number of key pairs to return. Default: your service quota
1086
+ # or 100, whichever is smaller.
1087
+ # @return [Integer]
1088
+ #
1089
1089
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairsRequest AWS API Documentation
1090
1090
  #
1091
1091
  class ListPlaybackKeyPairsRequest < Struct.new(
1092
- :max_results,
1093
- :next_token)
1092
+ :next_token,
1093
+ :max_results)
1094
1094
  SENSITIVE = []
1095
1095
  include Aws::Structure
1096
1096
  end
@@ -1113,75 +1113,75 @@ module Aws::IVS
1113
1113
  include Aws::Structure
1114
1114
  end
1115
1115
 
1116
- # @!attribute [rw] max_results
1117
- # Maximum number of policies to return. Default: 1.
1118
- # @return [Integer]
1119
- #
1120
1116
  # @!attribute [rw] next_token
1121
1117
  # The first policy to retrieve. This is used for pagination; see the
1122
1118
  # `nextToken` response field.
1123
1119
  # @return [String]
1124
1120
  #
1121
+ # @!attribute [rw] max_results
1122
+ # Maximum number of policies to return. Default: 1.
1123
+ # @return [Integer]
1124
+ #
1125
1125
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesRequest AWS API Documentation
1126
1126
  #
1127
1127
  class ListPlaybackRestrictionPoliciesRequest < Struct.new(
1128
- :max_results,
1129
- :next_token)
1128
+ :next_token,
1129
+ :max_results)
1130
1130
  SENSITIVE = []
1131
1131
  include Aws::Structure
1132
1132
  end
1133
1133
 
1134
+ # @!attribute [rw] playback_restriction_policies
1135
+ # List of the matching policies.
1136
+ # @return [Array<Types::PlaybackRestrictionPolicySummary>]
1137
+ #
1134
1138
  # @!attribute [rw] next_token
1135
1139
  # If there are more channels than `maxResults`, use `nextToken` in the
1136
1140
  # request to get the next set.
1137
1141
  # @return [String]
1138
1142
  #
1139
- # @!attribute [rw] playback_restriction_policies
1140
- # List of the matching policies.
1141
- # @return [Array<Types::PlaybackRestrictionPolicySummary>]
1142
- #
1143
1143
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackRestrictionPoliciesResponse AWS API Documentation
1144
1144
  #
1145
1145
  class ListPlaybackRestrictionPoliciesResponse < Struct.new(
1146
- :next_token,
1147
- :playback_restriction_policies)
1146
+ :playback_restriction_policies,
1147
+ :next_token)
1148
1148
  SENSITIVE = []
1149
1149
  include Aws::Structure
1150
1150
  end
1151
1151
 
1152
- # @!attribute [rw] max_results
1153
- # Maximum number of recording configurations to return. Default: your
1154
- # service quota or 100, whichever is smaller.
1155
- # @return [Integer]
1156
- #
1157
1152
  # @!attribute [rw] next_token
1158
1153
  # The first recording configuration to retrieve. This is used for
1159
1154
  # pagination; see the `nextToken` response field.
1160
1155
  # @return [String]
1161
1156
  #
1157
+ # @!attribute [rw] max_results
1158
+ # Maximum number of recording configurations to return. Default: your
1159
+ # service quota or 100, whichever is smaller.
1160
+ # @return [Integer]
1161
+ #
1162
1162
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsRequest AWS API Documentation
1163
1163
  #
1164
1164
  class ListRecordingConfigurationsRequest < Struct.new(
1165
- :max_results,
1166
- :next_token)
1165
+ :next_token,
1166
+ :max_results)
1167
1167
  SENSITIVE = []
1168
1168
  include Aws::Structure
1169
1169
  end
1170
1170
 
1171
+ # @!attribute [rw] recording_configurations
1172
+ # List of the matching recording configurations.
1173
+ # @return [Array<Types::RecordingConfigurationSummary>]
1174
+ #
1171
1175
  # @!attribute [rw] next_token
1172
1176
  # If there are more recording configurations than `maxResults`, use
1173
1177
  # `nextToken` in the request to get the next set.
1174
1178
  # @return [String]
1175
1179
  #
1176
- # @!attribute [rw] recording_configurations
1177
- # List of the matching recording configurations.
1178
- # @return [Array<Types::RecordingConfigurationSummary>]
1179
- #
1180
1180
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsResponse AWS API Documentation
1181
1181
  #
1182
1182
  class ListRecordingConfigurationsResponse < Struct.new(
1183
- :next_token,
1184
- :recording_configurations)
1183
+ :recording_configurations,
1184
+ :next_token)
1185
1185
  SENSITIVE = []
1186
1186
  include Aws::Structure
1187
1187
  end
@@ -1190,39 +1190,39 @@ module Aws::IVS
1190
1190
  # Channel ARN used to filter the list.
1191
1191
  # @return [String]
1192
1192
  #
1193
- # @!attribute [rw] max_results
1194
- # Maximum number of streamKeys to return. Default: 1.
1195
- # @return [Integer]
1196
- #
1197
1193
  # @!attribute [rw] next_token
1198
1194
  # The first stream key to retrieve. This is used for pagination; see
1199
1195
  # the `nextToken` response field.
1200
1196
  # @return [String]
1201
1197
  #
1198
+ # @!attribute [rw] max_results
1199
+ # Maximum number of streamKeys to return. Default: 1.
1200
+ # @return [Integer]
1201
+ #
1202
1202
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation
1203
1203
  #
1204
1204
  class ListStreamKeysRequest < Struct.new(
1205
1205
  :channel_arn,
1206
- :max_results,
1207
- :next_token)
1206
+ :next_token,
1207
+ :max_results)
1208
1208
  SENSITIVE = []
1209
1209
  include Aws::Structure
1210
1210
  end
1211
1211
 
1212
+ # @!attribute [rw] stream_keys
1213
+ # List of stream keys.
1214
+ # @return [Array<Types::StreamKeySummary>]
1215
+ #
1212
1216
  # @!attribute [rw] next_token
1213
1217
  # If there are more stream keys than `maxResults`, use `nextToken` in
1214
1218
  # the request to get the next set.
1215
1219
  # @return [String]
1216
1220
  #
1217
- # @!attribute [rw] stream_keys
1218
- # List of stream keys.
1219
- # @return [Array<Types::StreamKeySummary>]
1220
- #
1221
1221
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation
1222
1222
  #
1223
1223
  class ListStreamKeysResponse < Struct.new(
1224
- :next_token,
1225
- :stream_keys)
1224
+ :stream_keys,
1225
+ :next_token)
1226
1226
  SENSITIVE = []
1227
1227
  include Aws::Structure
1228
1228
  end
@@ -1231,39 +1231,39 @@ module Aws::IVS
1231
1231
  # Channel ARN used to filter the list.
1232
1232
  # @return [String]
1233
1233
  #
1234
- # @!attribute [rw] max_results
1235
- # Maximum number of streams to return. Default: 100.
1236
- # @return [Integer]
1237
- #
1238
1234
  # @!attribute [rw] next_token
1239
1235
  # The first stream to retrieve. This is used for pagination; see the
1240
1236
  # `nextToken` response field.
1241
1237
  # @return [String]
1242
1238
  #
1239
+ # @!attribute [rw] max_results
1240
+ # Maximum number of streams to return. Default: 100.
1241
+ # @return [Integer]
1242
+ #
1243
1243
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsRequest AWS API Documentation
1244
1244
  #
1245
1245
  class ListStreamSessionsRequest < Struct.new(
1246
1246
  :channel_arn,
1247
- :max_results,
1248
- :next_token)
1247
+ :next_token,
1248
+ :max_results)
1249
1249
  SENSITIVE = []
1250
1250
  include Aws::Structure
1251
1251
  end
1252
1252
 
1253
+ # @!attribute [rw] stream_sessions
1254
+ # List of stream sessions.
1255
+ # @return [Array<Types::StreamSessionSummary>]
1256
+ #
1253
1257
  # @!attribute [rw] next_token
1254
1258
  # If there are more streams than `maxResults`, use `nextToken` in the
1255
1259
  # request to get the next set.
1256
1260
  # @return [String]
1257
1261
  #
1258
- # @!attribute [rw] stream_sessions
1259
- # List of stream sessions.
1260
- # @return [Array<Types::StreamSessionSummary>]
1261
- #
1262
1262
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsResponse AWS API Documentation
1263
1263
  #
1264
1264
  class ListStreamSessionsResponse < Struct.new(
1265
- :next_token,
1266
- :stream_sessions)
1265
+ :stream_sessions,
1266
+ :next_token)
1267
1267
  SENSITIVE = []
1268
1268
  include Aws::Structure
1269
1269
  end
@@ -1272,39 +1272,39 @@ module Aws::IVS
1272
1272
  # Filters the stream list to match the specified criterion.
1273
1273
  # @return [Types::StreamFilters]
1274
1274
  #
1275
- # @!attribute [rw] max_results
1276
- # Maximum number of streams to return. Default: 100.
1277
- # @return [Integer]
1278
- #
1279
1275
  # @!attribute [rw] next_token
1280
1276
  # The first stream to retrieve. This is used for pagination; see the
1281
1277
  # `nextToken` response field.
1282
1278
  # @return [String]
1283
1279
  #
1280
+ # @!attribute [rw] max_results
1281
+ # Maximum number of streams to return. Default: 100.
1282
+ # @return [Integer]
1283
+ #
1284
1284
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation
1285
1285
  #
1286
1286
  class ListStreamsRequest < Struct.new(
1287
1287
  :filter_by,
1288
- :max_results,
1289
- :next_token)
1288
+ :next_token,
1289
+ :max_results)
1290
1290
  SENSITIVE = []
1291
1291
  include Aws::Structure
1292
1292
  end
1293
1293
 
1294
+ # @!attribute [rw] streams
1295
+ # List of streams.
1296
+ # @return [Array<Types::StreamSummary>]
1297
+ #
1294
1298
  # @!attribute [rw] next_token
1295
1299
  # If there are more streams than `maxResults`, use `nextToken` in the
1296
1300
  # request to get the next set.
1297
1301
  # @return [String]
1298
1302
  #
1299
- # @!attribute [rw] streams
1300
- # List of streams.
1301
- # @return [Array<Types::StreamSummary>]
1302
- #
1303
1303
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation
1304
1304
  #
1305
1305
  class ListStreamsResponse < Struct.new(
1306
- :next_token,
1307
- :streams)
1306
+ :streams,
1307
+ :next_token)
1308
1308
  SENSITIVE = []
1309
1309
  include Aws::Structure
1310
1310
  end
@@ -1353,14 +1353,14 @@ module Aws::IVS
1353
1353
  # Key-pair ARN.
1354
1354
  # @return [String]
1355
1355
  #
1356
- # @!attribute [rw] fingerprint
1357
- # Key-pair identifier.
1358
- # @return [String]
1359
- #
1360
1356
  # @!attribute [rw] name
1361
1357
  # Playback-key-pair name. The value does not need to be unique.
1362
1358
  # @return [String]
1363
1359
  #
1360
+ # @!attribute [rw] fingerprint
1361
+ # Key-pair identifier.
1362
+ # @return [String]
1363
+ #
1364
1364
  # @!attribute [rw] tags
1365
1365
  # Tags attached to the resource. Array of 1-50 maps, each of the form
1366
1366
  # `string:string (key:value)`. See [Tagging Amazon Web Services
@@ -1377,8 +1377,8 @@ module Aws::IVS
1377
1377
  #
1378
1378
  class PlaybackKeyPair < Struct.new(
1379
1379
  :arn,
1380
- :fingerprint,
1381
1380
  :name,
1381
+ :fingerprint,
1382
1382
  :tags)
1383
1383
  SENSITIVE = []
1384
1384
  include Aws::Structure
@@ -1419,6 +1419,10 @@ module Aws::IVS
1419
1419
  # An object representing a policy to constrain playback by country
1420
1420
  # and/or origin sites.
1421
1421
  #
1422
+ # @!attribute [rw] arn
1423
+ # Playback-restriction-policy ARN
1424
+ # @return [String]
1425
+ #
1422
1426
  # @!attribute [rw] allowed_countries
1423
1427
  # A list of country codes that control geoblocking restriction.
1424
1428
  # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
@@ -1440,10 +1444,6 @@ module Aws::IVS
1440
1444
  # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
1441
1445
  # @return [Array<String>]
1442
1446
  #
1443
- # @!attribute [rw] arn
1444
- # Playback-restriction-policy ARN
1445
- # @return [String]
1446
- #
1447
1447
  # @!attribute [rw] enable_strict_origin_enforcement
1448
1448
  # Whether channel playback is constrained by origin site. Default:
1449
1449
  # `false`.
@@ -1469,9 +1469,9 @@ module Aws::IVS
1469
1469
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicy AWS API Documentation
1470
1470
  #
1471
1471
  class PlaybackRestrictionPolicy < Struct.new(
1472
+ :arn,
1472
1473
  :allowed_countries,
1473
1474
  :allowed_origins,
1474
- :arn,
1475
1475
  :enable_strict_origin_enforcement,
1476
1476
  :name,
1477
1477
  :tags)
@@ -1481,6 +1481,10 @@ module Aws::IVS
1481
1481
 
1482
1482
  # Summary information about a PlaybackRestrictionPolicy.
1483
1483
  #
1484
+ # @!attribute [rw] arn
1485
+ # Playback-restriction-policy ARN
1486
+ # @return [String]
1487
+ #
1484
1488
  # @!attribute [rw] allowed_countries
1485
1489
  # A list of country codes that control geoblocking restriction.
1486
1490
  # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
@@ -1502,10 +1506,6 @@ module Aws::IVS
1502
1506
  # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
1503
1507
  # @return [Array<String>]
1504
1508
  #
1505
- # @!attribute [rw] arn
1506
- # Playback-restriction-policy ARN
1507
- # @return [String]
1508
- #
1509
1509
  # @!attribute [rw] enable_strict_origin_enforcement
1510
1510
  # Whether channel playback is constrained by origin site. Default:
1511
1511
  # `false`.
@@ -1531,9 +1531,9 @@ module Aws::IVS
1531
1531
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/PlaybackRestrictionPolicySummary AWS API Documentation
1532
1532
  #
1533
1533
  class PlaybackRestrictionPolicySummary < Struct.new(
1534
+ :arn,
1534
1535
  :allowed_countries,
1535
1536
  :allowed_origins,
1536
- :arn,
1537
1537
  :enable_strict_origin_enforcement,
1538
1538
  :name,
1539
1539
  :tags)
@@ -1565,25 +1565,14 @@ module Aws::IVS
1565
1565
  # Recording-configuration ARN.
1566
1566
  # @return [String]
1567
1567
  #
1568
- # @!attribute [rw] destination_configuration
1569
- # A complex type that contains information about where recorded video
1570
- # will be stored.
1571
- # @return [Types::DestinationConfiguration]
1572
- #
1573
1568
  # @!attribute [rw] name
1574
1569
  # Recording-configuration name. The value does not need to be unique.
1575
1570
  # @return [String]
1576
1571
  #
1577
- # @!attribute [rw] recording_reconnect_window_seconds
1578
- # If a broadcast disconnects and then reconnects within the specified
1579
- # interval, the multiple streams will be considered a single broadcast
1580
- # and merged together. Default: 0.
1581
- # @return [Integer]
1582
- #
1583
- # @!attribute [rw] rendition_configuration
1584
- # Object that describes which renditions should be recorded for a
1585
- # stream.
1586
- # @return [Types::RenditionConfiguration]
1572
+ # @!attribute [rw] destination_configuration
1573
+ # A complex type that contains information about where recorded video
1574
+ # will be stored.
1575
+ # @return [Types::DestinationConfiguration]
1587
1576
  #
1588
1577
  # @!attribute [rw] state
1589
1578
  # Indicates the current state of the recording configuration. When the
@@ -1609,17 +1598,28 @@ module Aws::IVS
1609
1598
  # thumbnails are generated for the live session.
1610
1599
  # @return [Types::ThumbnailConfiguration]
1611
1600
  #
1601
+ # @!attribute [rw] recording_reconnect_window_seconds
1602
+ # If a broadcast disconnects and then reconnects within the specified
1603
+ # interval, the multiple streams will be considered a single broadcast
1604
+ # and merged together. Default: 0.
1605
+ # @return [Integer]
1606
+ #
1607
+ # @!attribute [rw] rendition_configuration
1608
+ # Object that describes which renditions should be recorded for a
1609
+ # stream.
1610
+ # @return [Types::RenditionConfiguration]
1611
+ #
1612
1612
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/RecordingConfiguration AWS API Documentation
1613
1613
  #
1614
1614
  class RecordingConfiguration < Struct.new(
1615
1615
  :arn,
1616
- :destination_configuration,
1617
1616
  :name,
1618
- :recording_reconnect_window_seconds,
1619
- :rendition_configuration,
1617
+ :destination_configuration,
1620
1618
  :state,
1621
1619
  :tags,
1622
- :thumbnail_configuration)
1620
+ :thumbnail_configuration,
1621
+ :recording_reconnect_window_seconds,
1622
+ :rendition_configuration)
1623
1623
  SENSITIVE = []
1624
1624
  include Aws::Structure
1625
1625
  end
@@ -1630,15 +1630,15 @@ module Aws::IVS
1630
1630
  # Recording-configuration ARN.
1631
1631
  # @return [String]
1632
1632
  #
1633
+ # @!attribute [rw] name
1634
+ # Recording-configuration name. The value does not need to be unique.
1635
+ # @return [String]
1636
+ #
1633
1637
  # @!attribute [rw] destination_configuration
1634
1638
  # A complex type that contains information about where recorded video
1635
1639
  # will be stored.
1636
1640
  # @return [Types::DestinationConfiguration]
1637
1641
  #
1638
- # @!attribute [rw] name
1639
- # Recording-configuration name. The value does not need to be unique.
1640
- # @return [String]
1641
- #
1642
1642
  # @!attribute [rw] state
1643
1643
  # Indicates the current state of the recording configuration. When the
1644
1644
  # state is `ACTIVE`, the configuration is ready for recording a
@@ -1661,8 +1661,8 @@ module Aws::IVS
1661
1661
  #
1662
1662
  class RecordingConfigurationSummary < Struct.new(
1663
1663
  :arn,
1664
- :destination_configuration,
1665
1664
  :name,
1665
+ :destination_configuration,
1666
1666
  :state,
1667
1667
  :tags)
1668
1668
  SENSITIVE = []
@@ -1815,8 +1815,9 @@ module Aws::IVS
1815
1815
  # Channel ARN for the stream.
1816
1816
  # @return [String]
1817
1817
  #
1818
- # @!attribute [rw] health
1819
- # The stream’s health.
1818
+ # @!attribute [rw] stream_id
1819
+ # Unique identifier for a live or previously live stream in the
1820
+ # specified channel.
1820
1821
  # @return [String]
1821
1822
  #
1822
1823
  # @!attribute [rw] playback_url
@@ -1835,9 +1836,8 @@ module Aws::IVS
1835
1836
  # indicate that the stream is not live.
1836
1837
  # @return [String]
1837
1838
  #
1838
- # @!attribute [rw] stream_id
1839
- # Unique identifier for a live or previously live stream in the
1840
- # specified channel.
1839
+ # @!attribute [rw] health
1840
+ # The stream’s health.
1841
1841
  # @return [String]
1842
1842
  #
1843
1843
  # @!attribute [rw] viewer_count
@@ -1852,11 +1852,11 @@ module Aws::IVS
1852
1852
  #
1853
1853
  class Stream < Struct.new(
1854
1854
  :channel_arn,
1855
- :health,
1855
+ :stream_id,
1856
1856
  :playback_url,
1857
1857
  :start_time,
1858
1858
  :state,
1859
- :stream_id,
1859
+ :health,
1860
1860
  :viewer_count)
1861
1861
  SENSITIVE = []
1862
1862
  include Aws::Structure
@@ -1869,11 +1869,6 @@ module Aws::IVS
1869
1869
  #
1870
1870
  # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
1871
1871
  #
1872
- # @!attribute [rw] event_time
1873
- # Time when the event occurred. This is an ISO 8601 timestamp; *note
1874
- # that this is returned as a string*.
1875
- # @return [Time]
1876
- #
1877
1872
  # @!attribute [rw] name
1878
1873
  # Name that identifies the stream event within a `type`.
1879
1874
  # @return [String]
@@ -1882,12 +1877,17 @@ module Aws::IVS
1882
1877
  # Logical group for certain events.
1883
1878
  # @return [String]
1884
1879
  #
1880
+ # @!attribute [rw] event_time
1881
+ # Time when the event occurred. This is an ISO 8601 timestamp; *note
1882
+ # that this is returned as a string*.
1883
+ # @return [Time]
1884
+ #
1885
1885
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamEvent AWS API Documentation
1886
1886
  #
1887
1887
  class StreamEvent < Struct.new(
1888
- :event_time,
1889
1888
  :name,
1890
- :type)
1889
+ :type,
1890
+ :event_time)
1891
1891
  SENSITIVE = []
1892
1892
  include Aws::Structure
1893
1893
  end
@@ -1912,6 +1912,10 @@ module Aws::IVS
1912
1912
  # Stream-key ARN.
1913
1913
  # @return [String]
1914
1914
  #
1915
+ # @!attribute [rw] value
1916
+ # Stream-key value.
1917
+ # @return [String]
1918
+ #
1915
1919
  # @!attribute [rw] channel_arn
1916
1920
  # Channel ARN for the stream.
1917
1921
  # @return [String]
@@ -1928,17 +1932,13 @@ module Aws::IVS
1928
1932
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1929
1933
  # @return [Hash<String,String>]
1930
1934
  #
1931
- # @!attribute [rw] value
1932
- # Stream-key value.
1933
- # @return [String]
1934
- #
1935
1935
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation
1936
1936
  #
1937
1937
  class StreamKey < Struct.new(
1938
1938
  :arn,
1939
+ :value,
1939
1940
  :channel_arn,
1940
- :tags,
1941
- :value)
1941
+ :tags)
1942
1942
  SENSITIVE = [:value]
1943
1943
  include Aws::Structure
1944
1944
  end
@@ -1979,9 +1979,15 @@ module Aws::IVS
1979
1979
  # provisioned, the ingest configurations that the broadcaster used, and
1980
1980
  # the most recent Amazon IVS stream events it encountered.
1981
1981
  #
1982
- # @!attribute [rw] channel
1983
- # The properties of the channel at the time of going live.
1984
- # @return [Types::Channel]
1982
+ # @!attribute [rw] stream_id
1983
+ # Unique identifier for a live or previously live stream in the
1984
+ # specified channel.
1985
+ # @return [String]
1986
+ #
1987
+ # @!attribute [rw] start_time
1988
+ # Time when the channel went live. This is an ISO 8601 timestamp;
1989
+ # *note that this is returned as a string*.
1990
+ # @return [Time]
1985
1991
  #
1986
1992
  # @!attribute [rw] end_time
1987
1993
  # Time when the channel went offline. This is an ISO 8601 timestamp;
@@ -1989,6 +1995,10 @@ module Aws::IVS
1989
1995
  # `NULL`.
1990
1996
  # @return [Time]
1991
1997
  #
1998
+ # @!attribute [rw] channel
1999
+ # The properties of the channel at the time of going live.
2000
+ # @return [Types::Channel]
2001
+ #
1992
2002
  # @!attribute [rw] ingest_configuration
1993
2003
  # The properties of the incoming RTMP stream for the stream.
1994
2004
  # @return [Types::IngestConfiguration]
@@ -1997,16 +2007,6 @@ module Aws::IVS
1997
2007
  # The properties of recording the live stream.
1998
2008
  # @return [Types::RecordingConfiguration]
1999
2009
  #
2000
- # @!attribute [rw] start_time
2001
- # Time when the channel went live. This is an ISO 8601 timestamp;
2002
- # *note that this is returned as a string*.
2003
- # @return [Time]
2004
- #
2005
- # @!attribute [rw] stream_id
2006
- # Unique identifier for a live or previously live stream in the
2007
- # specified channel.
2008
- # @return [String]
2009
- #
2010
2010
  # @!attribute [rw] truncated_events
2011
2011
  # List of Amazon IVS events that the stream encountered. The list is
2012
2012
  # sorted by most recent events and contains up to 500 events. For
@@ -2021,12 +2021,12 @@ module Aws::IVS
2021
2021
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSession AWS API Documentation
2022
2022
  #
2023
2023
  class StreamSession < Struct.new(
2024
- :channel,
2024
+ :stream_id,
2025
+ :start_time,
2025
2026
  :end_time,
2027
+ :channel,
2026
2028
  :ingest_configuration,
2027
2029
  :recording_configuration,
2028
- :start_time,
2029
- :stream_id,
2030
2030
  :truncated_events)
2031
2031
  SENSITIVE = []
2032
2032
  include Aws::Structure
@@ -2034,6 +2034,16 @@ module Aws::IVS
2034
2034
 
2035
2035
  # Summary information about a stream session.
2036
2036
  #
2037
+ # @!attribute [rw] stream_id
2038
+ # Unique identifier for a live or previously live stream in the
2039
+ # specified channel.
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] start_time
2043
+ # Time when the channel went live. This is an ISO 8601 timestamp;
2044
+ # *note that this is returned as a string*.
2045
+ # @return [Time]
2046
+ #
2037
2047
  # @!attribute [rw] end_time
2038
2048
  # Time when the channel went offline. This is an ISO 8601 timestamp;
2039
2049
  # *note that this is returned as a string*. For live streams, this is
@@ -2044,23 +2054,13 @@ module Aws::IVS
2044
2054
  # If `true`, this stream encountered a quota breach or failure.
2045
2055
  # @return [Boolean]
2046
2056
  #
2047
- # @!attribute [rw] start_time
2048
- # Time when the channel went live. This is an ISO 8601 timestamp;
2049
- # *note that this is returned as a string*.
2050
- # @return [Time]
2051
- #
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
2057
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSessionSummary AWS API Documentation
2058
2058
  #
2059
2059
  class StreamSessionSummary < Struct.new(
2060
- :end_time,
2061
- :has_error_event,
2060
+ :stream_id,
2062
2061
  :start_time,
2063
- :stream_id)
2062
+ :end_time,
2063
+ :has_error_event)
2064
2064
  SENSITIVE = []
2065
2065
  include Aws::Structure
2066
2066
  end
@@ -2071,24 +2071,19 @@ module Aws::IVS
2071
2071
  # Channel ARN for the stream.
2072
2072
  # @return [String]
2073
2073
  #
2074
- # @!attribute [rw] health
2075
- # The stream’s health.
2074
+ # @!attribute [rw] stream_id
2075
+ # Unique identifier for a live or previously live stream in the
2076
+ # specified channel.
2076
2077
  # @return [String]
2077
2078
  #
2078
- # @!attribute [rw] start_time
2079
- # Time of the stream’s start. This is an ISO 8601 timestamp; *note
2080
- # that this is returned as a string*.
2081
- # @return [Time]
2082
- #
2083
2079
  # @!attribute [rw] state
2084
2080
  # The stream’s state. Do not rely on the `OFFLINE` state, as the API
2085
2081
  # may not return it; instead, a "NotBroadcasting" error will
2086
2082
  # indicate that the stream is not live.
2087
2083
  # @return [String]
2088
2084
  #
2089
- # @!attribute [rw] stream_id
2090
- # Unique identifier for a live or previously live stream in the
2091
- # specified channel.
2085
+ # @!attribute [rw] health
2086
+ # The stream’s health.
2092
2087
  # @return [String]
2093
2088
  #
2094
2089
  # @!attribute [rw] viewer_count
@@ -2099,15 +2094,20 @@ module Aws::IVS
2099
2094
  # timed out; in this case, retry.
2100
2095
  # @return [Integer]
2101
2096
  #
2097
+ # @!attribute [rw] start_time
2098
+ # Time of the stream’s start. This is an ISO 8601 timestamp; *note
2099
+ # that this is returned as a string*.
2100
+ # @return [Time]
2101
+ #
2102
2102
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation
2103
2103
  #
2104
2104
  class StreamSummary < Struct.new(
2105
2105
  :channel_arn,
2106
- :health,
2107
- :start_time,
2108
- :state,
2109
2106
  :stream_id,
2110
- :viewer_count)
2107
+ :state,
2108
+ :health,
2109
+ :viewer_count,
2110
+ :start_time)
2111
2111
  SENSITIVE = []
2112
2112
  include Aws::Structure
2113
2113
  end
@@ -2173,6 +2173,25 @@ module Aws::IVS
2173
2173
  # Thumbnail recording mode. Default: `INTERVAL`.
2174
2174
  # @return [String]
2175
2175
  #
2176
+ # @!attribute [rw] target_interval_seconds
2177
+ # The targeted thumbnail-generation interval in seconds. This is
2178
+ # configurable (and required) only if `recordingMode` is `INTERVAL`.
2179
+ # Default: 60.
2180
+ #
2181
+ # **Important:** For the `BASIC` channel type, setting a value for
2182
+ # `targetIntervalSeconds` does not guarantee that thumbnails are
2183
+ # generated at the specified interval. For thumbnails to be generated
2184
+ # at the `targetIntervalSeconds` interval, the `IDR/Keyframe` value
2185
+ # for the input video must be less than the `targetIntervalSeconds`
2186
+ # value. See [ Amazon IVS Streaming Configuration][1] for information
2187
+ # on setting `IDR/Keyframe` to the recommended value in video-encoder
2188
+ # settings.
2189
+ #
2190
+ #
2191
+ #
2192
+ # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html
2193
+ # @return [Integer]
2194
+ #
2176
2195
  # @!attribute [rw] resolution
2177
2196
  # Indicates the desired resolution of recorded thumbnails. Thumbnails
2178
2197
  # are recorded at the selected resolution if the corresponding
@@ -2196,32 +2215,13 @@ module Aws::IVS
2196
2215
  # `SEQUENTIAL` and `LATEST`. Default: `SEQUENTIAL`.
2197
2216
  # @return [Array<String>]
2198
2217
  #
2199
- # @!attribute [rw] target_interval_seconds
2200
- # The targeted thumbnail-generation interval in seconds. This is
2201
- # configurable (and required) only if `recordingMode` is `INTERVAL`.
2202
- # Default: 60.
2203
- #
2204
- # **Important:** For the `BASIC` channel type, setting a value for
2205
- # `targetIntervalSeconds` does not guarantee that thumbnails are
2206
- # generated at the specified interval. For thumbnails to be generated
2207
- # at the `targetIntervalSeconds` interval, the `IDR/Keyframe` value
2208
- # for the input video must be less than the `targetIntervalSeconds`
2209
- # value. See [ Amazon IVS Streaming Configuration][1] for information
2210
- # on setting `IDR/Keyframe` to the recommended value in video-encoder
2211
- # settings.
2212
- #
2213
- #
2214
- #
2215
- # [1]: https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html
2216
- # @return [Integer]
2217
- #
2218
2218
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ThumbnailConfiguration AWS API Documentation
2219
2219
  #
2220
2220
  class ThumbnailConfiguration < Struct.new(
2221
2221
  :recording_mode,
2222
+ :target_interval_seconds,
2222
2223
  :resolution,
2223
- :storage,
2224
- :target_interval_seconds)
2224
+ :storage)
2225
2225
  SENSITIVE = []
2226
2226
  include Aws::Structure
2227
2227
  end
@@ -2260,14 +2260,9 @@ module Aws::IVS
2260
2260
  # ARN of the channel to be updated.
2261
2261
  # @return [String]
2262
2262
  #
2263
- # @!attribute [rw] authorized
2264
- # Whether the channel is private (enabled for playback authorization).
2265
- # @return [Boolean]
2266
- #
2267
- # @!attribute [rw] insecure_ingest
2268
- # Whether the channel allows insecure RTMP and SRT ingest. Default:
2269
- # `false`.
2270
- # @return [Boolean]
2263
+ # @!attribute [rw] name
2264
+ # Channel name.
2265
+ # @return [String]
2271
2266
  #
2272
2267
  # @!attribute [rw] latency_mode
2273
2268
  # Channel latency mode. Use `NORMAL` to broadcast and deliver live
@@ -2275,53 +2270,58 @@ module Aws::IVS
2275
2270
  # viewers.
2276
2271
  # @return [String]
2277
2272
  #
2278
- # @!attribute [rw] name
2279
- # Channel name.
2280
- # @return [String]
2273
+ # @!attribute [rw] type
2274
+ # Channel type, which determines the allowable resolution and bitrate.
2275
+ # *If you exceed the allowable input resolution or bitrate, the stream
2276
+ # probably will disconnect immediately.* Default: `STANDARD`. For
2277
+ # details, see [Channel Types][1].
2281
2278
  #
2282
- # @!attribute [rw] playback_restriction_policy_arn
2283
- # Playback-restriction-policy ARN. A valid ARN value here both
2284
- # specifies the ARN and enables playback restriction. If this is set
2285
- # to an empty string, playback restriction policy is disabled.
2286
- # @return [String]
2287
2279
  #
2288
- # @!attribute [rw] preset
2289
- # Optional transcode preset for the channel. This is selectable only
2290
- # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
2291
- # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
2292
- # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
2293
- # string (`""`).
2280
+ #
2281
+ # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
2294
2282
  # @return [String]
2295
2283
  #
2284
+ # @!attribute [rw] authorized
2285
+ # Whether the channel is private (enabled for playback authorization).
2286
+ # @return [Boolean]
2287
+ #
2296
2288
  # @!attribute [rw] recording_configuration_arn
2297
2289
  # Recording-configuration ARN. A valid ARN value here both specifies
2298
2290
  # the ARN and enables recording. If this is set to an empty string,
2299
2291
  # recording is disabled.
2300
2292
  # @return [String]
2301
2293
  #
2302
- # @!attribute [rw] type
2303
- # Channel type, which determines the allowable resolution and bitrate.
2304
- # *If you exceed the allowable input resolution or bitrate, the stream
2305
- # probably will disconnect immediately.* Default: `STANDARD`. For
2306
- # details, see [Channel Types][1].
2307
- #
2294
+ # @!attribute [rw] insecure_ingest
2295
+ # Whether the channel allows insecure RTMP and SRT ingest. Default:
2296
+ # `false`.
2297
+ # @return [Boolean]
2308
2298
  #
2299
+ # @!attribute [rw] preset
2300
+ # Optional transcode preset for the channel. This is selectable only
2301
+ # for `ADVANCED_HD` and `ADVANCED_SD` channel types. For those channel
2302
+ # types, the default `preset` is `HIGHER_BANDWIDTH_DELIVERY`. For
2303
+ # other channel types (`BASIC` and `STANDARD`), `preset` is the empty
2304
+ # string (`""`).
2305
+ # @return [String]
2309
2306
  #
2310
- # [1]: https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html
2307
+ # @!attribute [rw] playback_restriction_policy_arn
2308
+ # Playback-restriction-policy ARN. A valid ARN value here both
2309
+ # specifies the ARN and enables playback restriction. If this is set
2310
+ # to an empty string, playback restriction policy is disabled.
2311
2311
  # @return [String]
2312
2312
  #
2313
2313
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
2314
2314
  #
2315
2315
  class UpdateChannelRequest < Struct.new(
2316
2316
  :arn,
2317
+ :name,
2318
+ :latency_mode,
2319
+ :type,
2317
2320
  :authorized,
2321
+ :recording_configuration_arn,
2318
2322
  :insecure_ingest,
2319
- :latency_mode,
2320
- :name,
2321
- :playback_restriction_policy_arn,
2322
2323
  :preset,
2323
- :recording_configuration_arn,
2324
- :type)
2324
+ :playback_restriction_policy_arn)
2325
2325
  SENSITIVE = []
2326
2326
  include Aws::Structure
2327
2327
  end
@@ -2338,6 +2338,10 @@ module Aws::IVS
2338
2338
  include Aws::Structure
2339
2339
  end
2340
2340
 
2341
+ # @!attribute [rw] arn
2342
+ # ARN of the playback-restriction-policy to be updated.
2343
+ # @return [String]
2344
+ #
2341
2345
  # @!attribute [rw] allowed_countries
2342
2346
  # A list of country codes that control geoblocking restriction.
2343
2347
  # Allowed values are the officially assigned [ISO 3166-1 alpha-2][1]
@@ -2359,10 +2363,6 @@ module Aws::IVS
2359
2363
  # [1]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin
2360
2364
  # @return [Array<String>]
2361
2365
  #
2362
- # @!attribute [rw] arn
2363
- # ARN of the playback-restriction-policy to be updated.
2364
- # @return [String]
2365
- #
2366
2366
  # @!attribute [rw] enable_strict_origin_enforcement
2367
2367
  # Whether channel playback is constrained by origin site. Default:
2368
2368
  # `false`.
@@ -2376,9 +2376,9 @@ module Aws::IVS
2376
2376
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdatePlaybackRestrictionPolicyRequest AWS API Documentation
2377
2377
  #
2378
2378
  class UpdatePlaybackRestrictionPolicyRequest < Struct.new(
2379
+ :arn,
2379
2380
  :allowed_countries,
2380
2381
  :allowed_origins,
2381
- :arn,
2382
2382
  :enable_strict_origin_enforcement,
2383
2383
  :name)
2384
2384
  SENSITIVE = []
@@ -2414,17 +2414,17 @@ module Aws::IVS
2414
2414
  # broadcaster (usually in an encoder). This is part of the
2415
2415
  # IngestConfiguration object and used for monitoring stream health.
2416
2416
  #
2417
+ # @!attribute [rw] avc_profile
2418
+ # Indicates to the decoder the requirements for decoding the stream.
2419
+ # For definitions of the valid values, see the H.264 specification.
2420
+ # @return [String]
2421
+ #
2417
2422
  # @!attribute [rw] avc_level
2418
2423
  # Indicates the degree of required decoder performance for a profile.
2419
2424
  # Normally this is set automatically by the encoder. For details, see
2420
2425
  # the H.264 specification.
2421
2426
  # @return [String]
2422
2427
  #
2423
- # @!attribute [rw] avc_profile
2424
- # Indicates to the decoder the requirements for decoding the stream.
2425
- # For definitions of the valid values, see the H.264 specification.
2426
- # @return [String]
2427
- #
2428
2428
  # @!attribute [rw] codec
2429
2429
  # Codec used for the video encoding.
2430
2430
  # @return [String]
@@ -2453,8 +2453,8 @@ module Aws::IVS
2453
2453
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/VideoConfiguration AWS API Documentation
2454
2454
  #
2455
2455
  class VideoConfiguration < Struct.new(
2456
- :avc_level,
2457
2456
  :avc_profile,
2457
+ :avc_level,
2458
2458
  :codec,
2459
2459
  :encoder,
2460
2460
  :target_bitrate,