aws-sdk-ivs 1.12.0 → 1.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivs/client.rb +265 -145
- data/lib/aws-sdk-ivs/client_api.rb +186 -85
- data/lib/aws-sdk-ivs/types.rb +577 -250
- data/lib/aws-sdk-ivs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-ivs/types.rb
CHANGED
@@ -22,6 +22,36 @@ module Aws::IVS
|
|
22
22
|
include Aws::Structure
|
23
23
|
end
|
24
24
|
|
25
|
+
# Object specifying a stream’s audio configuration.
|
26
|
+
#
|
27
|
+
# @!attribute [rw] channels
|
28
|
+
# Number of audio channels.
|
29
|
+
# @return [Integer]
|
30
|
+
#
|
31
|
+
# @!attribute [rw] codec
|
32
|
+
# Codec used for the audio encoding.
|
33
|
+
# @return [String]
|
34
|
+
#
|
35
|
+
# @!attribute [rw] sample_rate
|
36
|
+
# Number of audio samples recorded per second.
|
37
|
+
# @return [Integer]
|
38
|
+
#
|
39
|
+
# @!attribute [rw] target_bitrate
|
40
|
+
# The expected ingest bitrate (bits per second). This is configured in
|
41
|
+
# the encoder.
|
42
|
+
# @return [Integer]
|
43
|
+
#
|
44
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/AudioConfiguration AWS API Documentation
|
45
|
+
#
|
46
|
+
class AudioConfiguration < Struct.new(
|
47
|
+
:channels,
|
48
|
+
:codec,
|
49
|
+
:sample_rate,
|
50
|
+
:target_bitrate)
|
51
|
+
SENSITIVE = []
|
52
|
+
include Aws::Structure
|
53
|
+
end
|
54
|
+
|
25
55
|
# Error related to a specific channel, specified by its ARN.
|
26
56
|
#
|
27
57
|
# @!attribute [rw] arn
|
@@ -100,17 +130,17 @@ module Aws::IVS
|
|
100
130
|
include Aws::Structure
|
101
131
|
end
|
102
132
|
|
103
|
-
# @!attribute [rw] stream_keys
|
104
|
-
# @return [Array<Types::StreamKey>]
|
105
|
-
#
|
106
133
|
# @!attribute [rw] errors
|
107
134
|
# @return [Array<Types::BatchError>]
|
108
135
|
#
|
136
|
+
# @!attribute [rw] stream_keys
|
137
|
+
# @return [Array<Types::StreamKey>]
|
138
|
+
#
|
109
139
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/BatchGetStreamKeyResponse AWS API Documentation
|
110
140
|
#
|
111
141
|
class BatchGetStreamKeyResponse < Struct.new(
|
112
|
-
:
|
113
|
-
:
|
142
|
+
:errors,
|
143
|
+
:stream_keys)
|
114
144
|
SENSITIVE = []
|
115
145
|
include Aws::Structure
|
116
146
|
end
|
@@ -121,8 +151,14 @@ module Aws::IVS
|
|
121
151
|
# Channel ARN.
|
122
152
|
# @return [String]
|
123
153
|
#
|
124
|
-
# @!attribute [rw]
|
125
|
-
#
|
154
|
+
# @!attribute [rw] authorized
|
155
|
+
# Whether the channel is private (enabled for playback authorization).
|
156
|
+
# Default: `false`.
|
157
|
+
# @return [Boolean]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] ingest_endpoint
|
160
|
+
# Channel ingest endpoint, part of the definition of an ingest server,
|
161
|
+
# used when you set up streaming software.
|
126
162
|
# @return [String]
|
127
163
|
#
|
128
164
|
# @!attribute [rw] latency_mode
|
@@ -132,21 +168,12 @@ module Aws::IVS
|
|
132
168
|
# `NORMAL` correspond to Ultra-low and Standard, respectively.)
|
133
169
|
# @return [String]
|
134
170
|
#
|
135
|
-
# @!attribute [rw]
|
136
|
-
# Channel
|
137
|
-
#
|
138
|
-
# probably will disconnect immediately.* Default: `STANDARD`. Valid
|
139
|
-
# values:
|
140
|
-
#
|
141
|
-
# * `STANDARD`\: Multiple qualities are generated from the original
|
142
|
-
# input, to automatically give viewers the best experience for their
|
143
|
-
# devices and network conditions. Vertical resolution can be up to
|
144
|
-
# 1080 and bitrate can be up to 8.5 Mbps.
|
171
|
+
# @!attribute [rw] name
|
172
|
+
# Channel name.
|
173
|
+
# @return [String]
|
145
174
|
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
# Vertical resolution can be up to 480 and bitrate can be up to 1.5
|
149
|
-
# Mbps.
|
175
|
+
# @!attribute [rw] playback_url
|
176
|
+
# Channel playback URL.
|
150
177
|
# @return [String]
|
151
178
|
#
|
152
179
|
# @!attribute [rw] recording_configuration_arn
|
@@ -155,36 +182,39 @@ module Aws::IVS
|
|
155
182
|
# recording is disabled).
|
156
183
|
# @return [String]
|
157
184
|
#
|
158
|
-
# @!attribute [rw] ingest_endpoint
|
159
|
-
# Channel ingest endpoint, part of the definition of an ingest server,
|
160
|
-
# used when you set up streaming software.
|
161
|
-
# @return [String]
|
162
|
-
#
|
163
|
-
# @!attribute [rw] playback_url
|
164
|
-
# Channel playback URL.
|
165
|
-
# @return [String]
|
166
|
-
#
|
167
|
-
# @!attribute [rw] authorized
|
168
|
-
# Whether the channel is private (enabled for playback authorization).
|
169
|
-
# Default: `false`.
|
170
|
-
# @return [Boolean]
|
171
|
-
#
|
172
185
|
# @!attribute [rw] tags
|
173
186
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
174
187
|
# @return [Hash<String,String>]
|
175
188
|
#
|
189
|
+
# @!attribute [rw] type
|
190
|
+
# Channel type, which determines the allowable resolution and bitrate.
|
191
|
+
# *If you exceed the allowable resolution or bitrate, the stream
|
192
|
+
# probably will disconnect immediately.* Default: `STANDARD`. Valid
|
193
|
+
# values:
|
194
|
+
#
|
195
|
+
# * `STANDARD`\: Multiple qualities are generated from the original
|
196
|
+
# input, to automatically give viewers the best experience for their
|
197
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
198
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
199
|
+
# renditions 360p and below; above that, audio is passed through.
|
200
|
+
#
|
201
|
+
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
202
|
+
# viewer’s video-quality choice is limited to the original input.
|
203
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
204
|
+
# @return [String]
|
205
|
+
#
|
176
206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Channel AWS API Documentation
|
177
207
|
#
|
178
208
|
class Channel < Struct.new(
|
179
209
|
:arn,
|
180
|
-
:
|
181
|
-
:latency_mode,
|
182
|
-
:type,
|
183
|
-
:recording_configuration_arn,
|
210
|
+
:authorized,
|
184
211
|
:ingest_endpoint,
|
212
|
+
:latency_mode,
|
213
|
+
:name,
|
185
214
|
:playback_url,
|
186
|
-
:
|
187
|
-
:tags
|
215
|
+
:recording_configuration_arn,
|
216
|
+
:tags,
|
217
|
+
:type)
|
188
218
|
SENSITIVE = []
|
189
219
|
include Aws::Structure
|
190
220
|
end
|
@@ -207,9 +237,10 @@ module Aws::IVS
|
|
207
237
|
# Channel ARN.
|
208
238
|
# @return [String]
|
209
239
|
#
|
210
|
-
# @!attribute [rw]
|
211
|
-
#
|
212
|
-
#
|
240
|
+
# @!attribute [rw] authorized
|
241
|
+
# Whether the channel is private (enabled for playback authorization).
|
242
|
+
# Default: `false`.
|
243
|
+
# @return [Boolean]
|
213
244
|
#
|
214
245
|
# @!attribute [rw] latency_mode
|
215
246
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -218,10 +249,9 @@ module Aws::IVS
|
|
218
249
|
# `NORMAL` correspond to Ultra-low and Standard, respectively.)
|
219
250
|
# @return [String]
|
220
251
|
#
|
221
|
-
# @!attribute [rw]
|
222
|
-
#
|
223
|
-
#
|
224
|
-
# @return [Boolean]
|
252
|
+
# @!attribute [rw] name
|
253
|
+
# Channel name.
|
254
|
+
# @return [String]
|
225
255
|
#
|
226
256
|
# @!attribute [rw] recording_configuration_arn
|
227
257
|
# Recording-configuration ARN. A value other than an empty string
|
@@ -237,9 +267,9 @@ module Aws::IVS
|
|
237
267
|
#
|
238
268
|
class ChannelSummary < Struct.new(
|
239
269
|
:arn,
|
240
|
-
:name,
|
241
|
-
:latency_mode,
|
242
270
|
:authorized,
|
271
|
+
:latency_mode,
|
272
|
+
:name,
|
243
273
|
:recording_configuration_arn,
|
244
274
|
:tags)
|
245
275
|
SENSITIVE = []
|
@@ -262,19 +292,20 @@ module Aws::IVS
|
|
262
292
|
# data as a hash:
|
263
293
|
#
|
264
294
|
# {
|
265
|
-
# name: "ChannelName",
|
266
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
267
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
268
295
|
# authorized: false,
|
296
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
297
|
+
# name: "ChannelName",
|
269
298
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
270
299
|
# tags: {
|
271
300
|
# "TagKey" => "TagValue",
|
272
301
|
# },
|
302
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
273
303
|
# }
|
274
304
|
#
|
275
|
-
# @!attribute [rw]
|
276
|
-
#
|
277
|
-
#
|
305
|
+
# @!attribute [rw] authorized
|
306
|
+
# Whether the channel is private (enabled for playback authorization).
|
307
|
+
# Default: `false`.
|
308
|
+
# @return [Boolean]
|
278
309
|
#
|
279
310
|
# @!attribute [rw] latency_mode
|
280
311
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -283,6 +314,19 @@ module Aws::IVS
|
|
283
314
|
# correspond to Ultra-low and Standard, respectively.) Default: `LOW`.
|
284
315
|
# @return [String]
|
285
316
|
#
|
317
|
+
# @!attribute [rw] name
|
318
|
+
# Channel name.
|
319
|
+
# @return [String]
|
320
|
+
#
|
321
|
+
# @!attribute [rw] recording_configuration_arn
|
322
|
+
# Recording-configuration ARN. Default: "" (empty string, recording
|
323
|
+
# is disabled).
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] tags
|
327
|
+
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
328
|
+
# @return [Hash<String,String>]
|
329
|
+
#
|
286
330
|
# @!attribute [rw] type
|
287
331
|
# Channel type, which determines the allowable resolution and bitrate.
|
288
332
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -291,48 +335,32 @@ module Aws::IVS
|
|
291
335
|
#
|
292
336
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
293
337
|
# input, to automatically give viewers the best experience for their
|
294
|
-
# devices and network conditions.
|
295
|
-
#
|
338
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
339
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
340
|
+
# renditions 360p and below; above that, audio is passed through.
|
296
341
|
#
|
297
342
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
298
343
|
# viewer’s video-quality choice is limited to the original input.
|
299
|
-
#
|
300
|
-
# Mbps.
|
301
|
-
# @return [String]
|
302
|
-
#
|
303
|
-
# @!attribute [rw] authorized
|
304
|
-
# Whether the channel is private (enabled for playback authorization).
|
305
|
-
# Default: `false`.
|
306
|
-
# @return [Boolean]
|
307
|
-
#
|
308
|
-
# @!attribute [rw] recording_configuration_arn
|
309
|
-
# Recording-configuration ARN. Default: "" (empty string, recording
|
310
|
-
# is disabled).
|
344
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
311
345
|
# @return [String]
|
312
346
|
#
|
313
|
-
# @!attribute [rw] tags
|
314
|
-
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
315
|
-
# @return [Hash<String,String>]
|
316
|
-
#
|
317
347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelRequest AWS API Documentation
|
318
348
|
#
|
319
349
|
class CreateChannelRequest < Struct.new(
|
320
|
-
:name,
|
321
|
-
:latency_mode,
|
322
|
-
:type,
|
323
350
|
:authorized,
|
351
|
+
:latency_mode,
|
352
|
+
:name,
|
324
353
|
:recording_configuration_arn,
|
325
|
-
:tags
|
354
|
+
:tags,
|
355
|
+
:type)
|
326
356
|
SENSITIVE = []
|
327
357
|
include Aws::Structure
|
328
358
|
end
|
329
359
|
|
330
360
|
# @!attribute [rw] channel
|
331
|
-
# Object specifying a channel.
|
332
361
|
# @return [Types::Channel]
|
333
362
|
#
|
334
363
|
# @!attribute [rw] stream_key
|
335
|
-
# Object specifying a stream key.
|
336
364
|
# @return [Types::StreamKey]
|
337
365
|
#
|
338
366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateChannelResponse AWS API Documentation
|
@@ -348,27 +376,26 @@ module Aws::IVS
|
|
348
376
|
# data as a hash:
|
349
377
|
#
|
350
378
|
# {
|
351
|
-
# name: "RecordingConfigurationName",
|
352
379
|
# destination_configuration: { # required
|
353
380
|
# s3: {
|
354
381
|
# bucket_name: "S3DestinationBucketName", # required
|
355
382
|
# },
|
356
383
|
# },
|
384
|
+
# name: "RecordingConfigurationName",
|
357
385
|
# tags: {
|
358
386
|
# "TagKey" => "TagValue",
|
359
387
|
# },
|
360
388
|
# }
|
361
389
|
#
|
362
|
-
# @!attribute [rw] name
|
363
|
-
# An arbitrary string (a nickname) that helps the customer identify
|
364
|
-
# that resource. The value does not need to be unique.
|
365
|
-
# @return [String]
|
366
|
-
#
|
367
390
|
# @!attribute [rw] destination_configuration
|
368
391
|
# A complex type that contains a destination configuration for where
|
369
392
|
# recorded video will be stored.
|
370
393
|
# @return [Types::DestinationConfiguration]
|
371
394
|
#
|
395
|
+
# @!attribute [rw] name
|
396
|
+
# Recording-configuration name. The value does not need to be unique.
|
397
|
+
# @return [String]
|
398
|
+
#
|
372
399
|
# @!attribute [rw] tags
|
373
400
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
374
401
|
# @return [Hash<String,String>]
|
@@ -376,15 +403,17 @@ module Aws::IVS
|
|
376
403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationRequest AWS API Documentation
|
377
404
|
#
|
378
405
|
class CreateRecordingConfigurationRequest < Struct.new(
|
379
|
-
:name,
|
380
406
|
:destination_configuration,
|
407
|
+
:name,
|
381
408
|
:tags)
|
382
409
|
SENSITIVE = []
|
383
410
|
include Aws::Structure
|
384
411
|
end
|
385
412
|
|
386
413
|
# @!attribute [rw] recording_configuration
|
387
|
-
#
|
414
|
+
# <zonbook />
|
415
|
+
#
|
416
|
+
# <xhtml />
|
388
417
|
# @return [Types::RecordingConfiguration]
|
389
418
|
#
|
390
419
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/CreateRecordingConfigurationResponse AWS API Documentation
|
@@ -561,7 +590,6 @@ module Aws::IVS
|
|
561
590
|
end
|
562
591
|
|
563
592
|
# @!attribute [rw] channel
|
564
|
-
# Object specifying a channel.
|
565
593
|
# @return [Types::Channel]
|
566
594
|
#
|
567
595
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetChannelResponse AWS API Documentation
|
@@ -592,7 +620,9 @@ module Aws::IVS
|
|
592
620
|
end
|
593
621
|
|
594
622
|
# @!attribute [rw] key_pair
|
595
|
-
#
|
623
|
+
# <zonbook />
|
624
|
+
#
|
625
|
+
# <xhtml />
|
596
626
|
# @return [Types::PlaybackKeyPair]
|
597
627
|
#
|
598
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetPlaybackKeyPairResponse AWS API Documentation
|
@@ -623,7 +653,9 @@ module Aws::IVS
|
|
623
653
|
end
|
624
654
|
|
625
655
|
# @!attribute [rw] recording_configuration
|
626
|
-
#
|
656
|
+
# <zonbook />
|
657
|
+
#
|
658
|
+
# <xhtml />
|
627
659
|
# @return [Types::RecordingConfiguration]
|
628
660
|
#
|
629
661
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetRecordingConfigurationResponse AWS API Documentation
|
@@ -654,7 +686,9 @@ module Aws::IVS
|
|
654
686
|
end
|
655
687
|
|
656
688
|
# @!attribute [rw] stream_key
|
657
|
-
#
|
689
|
+
# <zonbook />
|
690
|
+
#
|
691
|
+
# <xhtml />
|
658
692
|
# @return [Types::StreamKey]
|
659
693
|
#
|
660
694
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamKeyResponse AWS API Documentation
|
@@ -685,8 +719,6 @@ module Aws::IVS
|
|
685
719
|
end
|
686
720
|
|
687
721
|
# @!attribute [rw] stream
|
688
|
-
# Specifies a live video stream that has been ingested and
|
689
|
-
# distributed.
|
690
722
|
# @return [Types::Stream]
|
691
723
|
#
|
692
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamResponse AWS API Documentation
|
@@ -697,25 +729,62 @@ module Aws::IVS
|
|
697
729
|
include Aws::Structure
|
698
730
|
end
|
699
731
|
|
732
|
+
# @note When making an API call, you may pass GetStreamSessionRequest
|
733
|
+
# data as a hash:
|
734
|
+
#
|
735
|
+
# {
|
736
|
+
# channel_arn: "ChannelArn", # required
|
737
|
+
# stream_id: "StreamId",
|
738
|
+
# }
|
739
|
+
#
|
740
|
+
# @!attribute [rw] channel_arn
|
741
|
+
# ARN of the channel resource
|
742
|
+
# @return [String]
|
743
|
+
#
|
744
|
+
# @!attribute [rw] stream_id
|
745
|
+
# Unique identifier for a live or previously live stream in the
|
746
|
+
# specified channel. If no `streamId` is provided, this returns the
|
747
|
+
# most recent stream session for the channel, if it exists.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSessionRequest AWS API Documentation
|
751
|
+
#
|
752
|
+
class GetStreamSessionRequest < Struct.new(
|
753
|
+
:channel_arn,
|
754
|
+
:stream_id)
|
755
|
+
SENSITIVE = []
|
756
|
+
include Aws::Structure
|
757
|
+
end
|
758
|
+
|
759
|
+
# @!attribute [rw] stream_session
|
760
|
+
# List of stream details.
|
761
|
+
# @return [Types::StreamSession]
|
762
|
+
#
|
763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSessionResponse AWS API Documentation
|
764
|
+
#
|
765
|
+
class GetStreamSessionResponse < Struct.new(
|
766
|
+
:stream_session)
|
767
|
+
SENSITIVE = []
|
768
|
+
include Aws::Structure
|
769
|
+
end
|
770
|
+
|
700
771
|
# @note When making an API call, you may pass ImportPlaybackKeyPairRequest
|
701
772
|
# data as a hash:
|
702
773
|
#
|
703
774
|
# {
|
704
|
-
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
705
775
|
# name: "PlaybackKeyPairName",
|
776
|
+
# public_key_material: "PlaybackPublicKeyMaterial", # required
|
706
777
|
# tags: {
|
707
778
|
# "TagKey" => "TagValue",
|
708
779
|
# },
|
709
780
|
# }
|
710
781
|
#
|
711
|
-
# @!attribute [rw]
|
712
|
-
# The
|
782
|
+
# @!attribute [rw] name
|
783
|
+
# Playback-key-pair name. The value does not need to be unique.
|
713
784
|
# @return [String]
|
714
785
|
#
|
715
|
-
# @!attribute [rw]
|
716
|
-
#
|
717
|
-
# that helps the customer identify that resource. The value does not
|
718
|
-
# need to be unique.
|
786
|
+
# @!attribute [rw] public_key_material
|
787
|
+
# The public portion of a customer-generated key pair.
|
719
788
|
# @return [String]
|
720
789
|
#
|
721
790
|
# @!attribute [rw] tags
|
@@ -726,15 +795,14 @@ module Aws::IVS
|
|
726
795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairRequest AWS API Documentation
|
727
796
|
#
|
728
797
|
class ImportPlaybackKeyPairRequest < Struct.new(
|
729
|
-
:public_key_material,
|
730
798
|
:name,
|
799
|
+
:public_key_material,
|
731
800
|
:tags)
|
732
801
|
SENSITIVE = []
|
733
802
|
include Aws::Structure
|
734
803
|
end
|
735
804
|
|
736
805
|
# @!attribute [rw] key_pair
|
737
|
-
# A key pair used to sign and validate a playback authorization token.
|
738
806
|
# @return [Types::PlaybackKeyPair]
|
739
807
|
#
|
740
808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ImportPlaybackKeyPairResponse AWS API Documentation
|
@@ -745,6 +813,26 @@ module Aws::IVS
|
|
745
813
|
include Aws::Structure
|
746
814
|
end
|
747
815
|
|
816
|
+
# Object specifying the ingest configuration set up by the broadcaster,
|
817
|
+
# usually in an encoder.
|
818
|
+
#
|
819
|
+
# @!attribute [rw] audio
|
820
|
+
# Encoder settings for audio.
|
821
|
+
# @return [Types::AudioConfiguration]
|
822
|
+
#
|
823
|
+
# @!attribute [rw] video
|
824
|
+
# Encoder settings for video.
|
825
|
+
# @return [Types::VideoConfiguration]
|
826
|
+
#
|
827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/IngestConfiguration AWS API Documentation
|
828
|
+
#
|
829
|
+
class IngestConfiguration < Struct.new(
|
830
|
+
:audio,
|
831
|
+
:video)
|
832
|
+
SENSITIVE = []
|
833
|
+
include Aws::Structure
|
834
|
+
end
|
835
|
+
|
748
836
|
# @!attribute [rw] exception_message
|
749
837
|
# Unexpected error during processing of request.
|
750
838
|
# @return [String]
|
@@ -763,8 +851,8 @@ module Aws::IVS
|
|
763
851
|
# {
|
764
852
|
# filter_by_name: "ChannelName",
|
765
853
|
# filter_by_recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
766
|
-
# next_token: "PaginationToken",
|
767
854
|
# max_results: 1,
|
855
|
+
# next_token: "PaginationToken",
|
768
856
|
# }
|
769
857
|
#
|
770
858
|
# @!attribute [rw] filter_by_name
|
@@ -776,22 +864,22 @@ module Aws::IVS
|
|
776
864
|
# recording-configuration ARN.
|
777
865
|
# @return [String]
|
778
866
|
#
|
867
|
+
# @!attribute [rw] max_results
|
868
|
+
# Maximum number of channels to return. Default: 50.
|
869
|
+
# @return [Integer]
|
870
|
+
#
|
779
871
|
# @!attribute [rw] next_token
|
780
872
|
# The first channel to retrieve. This is used for pagination; see the
|
781
873
|
# `nextToken` response field.
|
782
874
|
# @return [String]
|
783
875
|
#
|
784
|
-
# @!attribute [rw] max_results
|
785
|
-
# Maximum number of channels to return. Default: 50.
|
786
|
-
# @return [Integer]
|
787
|
-
#
|
788
876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListChannelsRequest AWS API Documentation
|
789
877
|
#
|
790
878
|
class ListChannelsRequest < Struct.new(
|
791
879
|
:filter_by_name,
|
792
880
|
:filter_by_recording_configuration_arn,
|
793
|
-
:
|
794
|
-
:
|
881
|
+
:max_results,
|
882
|
+
:next_token)
|
795
883
|
SENSITIVE = []
|
796
884
|
include Aws::Structure
|
797
885
|
end
|
@@ -818,24 +906,24 @@ module Aws::IVS
|
|
818
906
|
# data as a hash:
|
819
907
|
#
|
820
908
|
# {
|
821
|
-
# next_token: "PaginationToken",
|
822
909
|
# max_results: 1,
|
910
|
+
# next_token: "PaginationToken",
|
823
911
|
# }
|
824
912
|
#
|
825
|
-
# @!attribute [rw] next_token
|
826
|
-
# Maximum number of key pairs to return.
|
827
|
-
# @return [String]
|
828
|
-
#
|
829
913
|
# @!attribute [rw] max_results
|
830
914
|
# The first key pair to retrieve. This is used for pagination; see the
|
831
915
|
# `nextToken` response field. Default: 50.
|
832
916
|
# @return [Integer]
|
833
917
|
#
|
918
|
+
# @!attribute [rw] next_token
|
919
|
+
# Maximum number of key pairs to return.
|
920
|
+
# @return [String]
|
921
|
+
#
|
834
922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListPlaybackKeyPairsRequest AWS API Documentation
|
835
923
|
#
|
836
924
|
class ListPlaybackKeyPairsRequest < Struct.new(
|
837
|
-
:
|
838
|
-
:
|
925
|
+
:max_results,
|
926
|
+
:next_token)
|
839
927
|
SENSITIVE = []
|
840
928
|
include Aws::Structure
|
841
929
|
end
|
@@ -862,42 +950,42 @@ module Aws::IVS
|
|
862
950
|
# data as a hash:
|
863
951
|
#
|
864
952
|
# {
|
865
|
-
# next_token: "PaginationToken",
|
866
953
|
# max_results: 1,
|
954
|
+
# next_token: "PaginationToken",
|
867
955
|
# }
|
868
956
|
#
|
957
|
+
# @!attribute [rw] max_results
|
958
|
+
# Maximum number of recording configurations to return. Default: 50.
|
959
|
+
# @return [Integer]
|
960
|
+
#
|
869
961
|
# @!attribute [rw] next_token
|
870
962
|
# The first recording configuration to retrieve. This is used for
|
871
963
|
# pagination; see the `nextToken` response field.
|
872
964
|
# @return [String]
|
873
965
|
#
|
874
|
-
# @!attribute [rw] max_results
|
875
|
-
# Maximum number of recording configurations to return. Default: 50.
|
876
|
-
# @return [Integer]
|
877
|
-
#
|
878
966
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsRequest AWS API Documentation
|
879
967
|
#
|
880
968
|
class ListRecordingConfigurationsRequest < Struct.new(
|
881
|
-
:
|
882
|
-
:
|
969
|
+
:max_results,
|
970
|
+
:next_token)
|
883
971
|
SENSITIVE = []
|
884
972
|
include Aws::Structure
|
885
973
|
end
|
886
974
|
|
887
|
-
# @!attribute [rw] recording_configurations
|
888
|
-
# List of the matching recording configurations.
|
889
|
-
# @return [Array<Types::RecordingConfigurationSummary>]
|
890
|
-
#
|
891
975
|
# @!attribute [rw] next_token
|
892
976
|
# If there are more recording configurations than `maxResults`, use
|
893
977
|
# `nextToken` in the request to get the next set.
|
894
978
|
# @return [String]
|
895
979
|
#
|
980
|
+
# @!attribute [rw] recording_configurations
|
981
|
+
# List of the matching recording configurations.
|
982
|
+
# @return [Array<Types::RecordingConfigurationSummary>]
|
983
|
+
#
|
896
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListRecordingConfigurationsResponse AWS API Documentation
|
897
985
|
#
|
898
986
|
class ListRecordingConfigurationsResponse < Struct.new(
|
899
|
-
:
|
900
|
-
:
|
987
|
+
:next_token,
|
988
|
+
:recording_configurations)
|
901
989
|
SENSITIVE = []
|
902
990
|
include Aws::Structure
|
903
991
|
end
|
@@ -907,91 +995,148 @@ module Aws::IVS
|
|
907
995
|
#
|
908
996
|
# {
|
909
997
|
# channel_arn: "ChannelArn", # required
|
910
|
-
# next_token: "PaginationToken",
|
911
998
|
# max_results: 1,
|
999
|
+
# next_token: "PaginationToken",
|
912
1000
|
# }
|
913
1001
|
#
|
914
1002
|
# @!attribute [rw] channel_arn
|
915
1003
|
# Channel ARN used to filter the list.
|
916
1004
|
# @return [String]
|
917
1005
|
#
|
918
|
-
# @!attribute [rw] next_token
|
919
|
-
# The first stream key to retrieve. This is used for pagination; see
|
920
|
-
# the `nextToken` response field.
|
921
|
-
# @return [String]
|
922
|
-
#
|
923
1006
|
# @!attribute [rw] max_results
|
924
1007
|
# Maximum number of streamKeys to return. Default: 50.
|
925
1008
|
# @return [Integer]
|
926
1009
|
#
|
1010
|
+
# @!attribute [rw] next_token
|
1011
|
+
# The first stream key to retrieve. This is used for pagination; see
|
1012
|
+
# the `nextToken` response field.
|
1013
|
+
# @return [String]
|
1014
|
+
#
|
927
1015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysRequest AWS API Documentation
|
928
1016
|
#
|
929
1017
|
class ListStreamKeysRequest < Struct.new(
|
930
1018
|
:channel_arn,
|
931
|
-
:
|
932
|
-
:
|
1019
|
+
:max_results,
|
1020
|
+
:next_token)
|
933
1021
|
SENSITIVE = []
|
934
1022
|
include Aws::Structure
|
935
1023
|
end
|
936
1024
|
|
937
|
-
# @!attribute [rw] stream_keys
|
938
|
-
# List of stream keys.
|
939
|
-
# @return [Array<Types::StreamKeySummary>]
|
940
|
-
#
|
941
1025
|
# @!attribute [rw] next_token
|
942
1026
|
# If there are more stream keys than `maxResults`, use `nextToken` in
|
943
1027
|
# the request to get the next set.
|
944
1028
|
# @return [String]
|
945
1029
|
#
|
1030
|
+
# @!attribute [rw] stream_keys
|
1031
|
+
# List of stream keys.
|
1032
|
+
# @return [Array<Types::StreamKeySummary>]
|
1033
|
+
#
|
946
1034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamKeysResponse AWS API Documentation
|
947
1035
|
#
|
948
1036
|
class ListStreamKeysResponse < Struct.new(
|
949
|
-
:
|
950
|
-
:
|
1037
|
+
:next_token,
|
1038
|
+
:stream_keys)
|
951
1039
|
SENSITIVE = []
|
952
1040
|
include Aws::Structure
|
953
1041
|
end
|
954
1042
|
|
955
|
-
# @note When making an API call, you may pass
|
1043
|
+
# @note When making an API call, you may pass ListStreamSessionsRequest
|
956
1044
|
# data as a hash:
|
957
1045
|
#
|
958
1046
|
# {
|
959
|
-
#
|
1047
|
+
# channel_arn: "ChannelArn", # required
|
960
1048
|
# max_results: 1,
|
1049
|
+
# next_token: "PaginationToken",
|
961
1050
|
# }
|
962
1051
|
#
|
1052
|
+
# @!attribute [rw] channel_arn
|
1053
|
+
# Channel ARN used to filter the list.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] max_results
|
1057
|
+
# Maximum number of streams to return. Default: 50.
|
1058
|
+
# @return [Integer]
|
1059
|
+
#
|
963
1060
|
# @!attribute [rw] next_token
|
964
1061
|
# The first stream to retrieve. This is used for pagination; see the
|
965
1062
|
# `nextToken` response field.
|
966
1063
|
# @return [String]
|
967
1064
|
#
|
1065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsRequest AWS API Documentation
|
1066
|
+
#
|
1067
|
+
class ListStreamSessionsRequest < Struct.new(
|
1068
|
+
:channel_arn,
|
1069
|
+
:max_results,
|
1070
|
+
:next_token)
|
1071
|
+
SENSITIVE = []
|
1072
|
+
include Aws::Structure
|
1073
|
+
end
|
1074
|
+
|
1075
|
+
# @!attribute [rw] next_token
|
1076
|
+
# If there are more streams than `maxResults`, use `nextToken` in the
|
1077
|
+
# request to get the next set.
|
1078
|
+
# @return [String]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] stream_sessions
|
1081
|
+
# @return [Array<Types::StreamSessionSummary>]
|
1082
|
+
#
|
1083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessionsResponse AWS API Documentation
|
1084
|
+
#
|
1085
|
+
class ListStreamSessionsResponse < Struct.new(
|
1086
|
+
:next_token,
|
1087
|
+
:stream_sessions)
|
1088
|
+
SENSITIVE = []
|
1089
|
+
include Aws::Structure
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
# @note When making an API call, you may pass ListStreamsRequest
|
1093
|
+
# data as a hash:
|
1094
|
+
#
|
1095
|
+
# {
|
1096
|
+
# filter_by: {
|
1097
|
+
# health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
|
1098
|
+
# },
|
1099
|
+
# max_results: 1,
|
1100
|
+
# next_token: "PaginationToken",
|
1101
|
+
# }
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] filter_by
|
1104
|
+
# Filters the stream list to match the specified criterion.
|
1105
|
+
# @return [Types::StreamFilters]
|
1106
|
+
#
|
968
1107
|
# @!attribute [rw] max_results
|
969
1108
|
# Maximum number of streams to return. Default: 50.
|
970
1109
|
# @return [Integer]
|
971
1110
|
#
|
1111
|
+
# @!attribute [rw] next_token
|
1112
|
+
# The first stream to retrieve. This is used for pagination; see the
|
1113
|
+
# `nextToken` response field.
|
1114
|
+
# @return [String]
|
1115
|
+
#
|
972
1116
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsRequest AWS API Documentation
|
973
1117
|
#
|
974
1118
|
class ListStreamsRequest < Struct.new(
|
975
|
-
:
|
976
|
-
:max_results
|
1119
|
+
:filter_by,
|
1120
|
+
:max_results,
|
1121
|
+
:next_token)
|
977
1122
|
SENSITIVE = []
|
978
1123
|
include Aws::Structure
|
979
1124
|
end
|
980
1125
|
|
981
|
-
# @!attribute [rw] streams
|
982
|
-
# List of streams.
|
983
|
-
# @return [Array<Types::StreamSummary>]
|
984
|
-
#
|
985
1126
|
# @!attribute [rw] next_token
|
986
1127
|
# If there are more streams than `maxResults`, use `nextToken` in the
|
987
1128
|
# request to get the next set.
|
988
1129
|
# @return [String]
|
989
1130
|
#
|
1131
|
+
# @!attribute [rw] streams
|
1132
|
+
# List of streams.
|
1133
|
+
# @return [Array<Types::StreamSummary>]
|
1134
|
+
#
|
990
1135
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamsResponse AWS API Documentation
|
991
1136
|
#
|
992
1137
|
class ListStreamsResponse < Struct.new(
|
993
|
-
:
|
994
|
-
:
|
1138
|
+
:next_token,
|
1139
|
+
:streams)
|
995
1140
|
SENSITIVE = []
|
996
1141
|
include Aws::Structure
|
997
1142
|
end
|
@@ -1001,29 +1146,16 @@ module Aws::IVS
|
|
1001
1146
|
#
|
1002
1147
|
# {
|
1003
1148
|
# resource_arn: "ResourceArn", # required
|
1004
|
-
# next_token: "String",
|
1005
|
-
# max_results: 1,
|
1006
1149
|
# }
|
1007
1150
|
#
|
1008
1151
|
# @!attribute [rw] resource_arn
|
1009
1152
|
# The ARN of the resource to be retrieved.
|
1010
1153
|
# @return [String]
|
1011
1154
|
#
|
1012
|
-
# @!attribute [rw] next_token
|
1013
|
-
# The first tag to retrieve. This is used for pagination; see the
|
1014
|
-
# `nextToken` response field.
|
1015
|
-
# @return [String]
|
1016
|
-
#
|
1017
|
-
# @!attribute [rw] max_results
|
1018
|
-
# Maximum number of tags to return. Default: 50.
|
1019
|
-
# @return [Integer]
|
1020
|
-
#
|
1021
1155
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceRequest AWS API Documentation
|
1022
1156
|
#
|
1023
1157
|
class ListTagsForResourceRequest < Struct.new(
|
1024
|
-
:resource_arn
|
1025
|
-
:next_token,
|
1026
|
-
:max_results)
|
1158
|
+
:resource_arn)
|
1027
1159
|
SENSITIVE = []
|
1028
1160
|
include Aws::Structure
|
1029
1161
|
end
|
@@ -1031,16 +1163,10 @@ module Aws::IVS
|
|
1031
1163
|
# @!attribute [rw] tags
|
1032
1164
|
# @return [Hash<String,String>]
|
1033
1165
|
#
|
1034
|
-
# @!attribute [rw] next_token
|
1035
|
-
# If there are more tags than `maxResults`, use `nextToken` in the
|
1036
|
-
# request to get the next set.
|
1037
|
-
# @return [String]
|
1038
|
-
#
|
1039
1166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListTagsForResourceResponse AWS API Documentation
|
1040
1167
|
#
|
1041
1168
|
class ListTagsForResourceResponse < Struct.new(
|
1042
|
-
:tags
|
1043
|
-
:next_token)
|
1169
|
+
:tags)
|
1044
1170
|
SENSITIVE = []
|
1045
1171
|
include Aws::Structure
|
1046
1172
|
end
|
@@ -1063,16 +1189,14 @@ module Aws::IVS
|
|
1063
1189
|
# Key-pair ARN.
|
1064
1190
|
# @return [String]
|
1065
1191
|
#
|
1066
|
-
# @!attribute [rw] name
|
1067
|
-
# An arbitrary string (a nickname) assigned to a playback key pair
|
1068
|
-
# that helps the customer identify that resource. The value does not
|
1069
|
-
# need to be unique.
|
1070
|
-
# @return [String]
|
1071
|
-
#
|
1072
1192
|
# @!attribute [rw] fingerprint
|
1073
1193
|
# Key-pair identifier.
|
1074
1194
|
# @return [String]
|
1075
1195
|
#
|
1196
|
+
# @!attribute [rw] name
|
1197
|
+
# Playback-key-pair name. The value does not need to be unique.
|
1198
|
+
# @return [String]
|
1199
|
+
#
|
1076
1200
|
# @!attribute [rw] tags
|
1077
1201
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
1078
1202
|
# @return [Hash<String,String>]
|
@@ -1081,8 +1205,8 @@ module Aws::IVS
|
|
1081
1205
|
#
|
1082
1206
|
class PlaybackKeyPair < Struct.new(
|
1083
1207
|
:arn,
|
1084
|
-
:name,
|
1085
1208
|
:fingerprint,
|
1209
|
+
:name,
|
1086
1210
|
:tags)
|
1087
1211
|
SENSITIVE = []
|
1088
1212
|
include Aws::Structure
|
@@ -1095,9 +1219,7 @@ module Aws::IVS
|
|
1095
1219
|
# @return [String]
|
1096
1220
|
#
|
1097
1221
|
# @!attribute [rw] name
|
1098
|
-
#
|
1099
|
-
# that helps the customer identify that resource. The value does not
|
1100
|
-
# need to be unique.
|
1222
|
+
# Playback-key-pair name. The value does not need to be unique.
|
1101
1223
|
# @return [String]
|
1102
1224
|
#
|
1103
1225
|
# @!attribute [rw] tags
|
@@ -1136,7 +1258,7 @@ module Aws::IVS
|
|
1136
1258
|
class PutMetadataRequest < Struct.new(
|
1137
1259
|
:channel_arn,
|
1138
1260
|
:metadata)
|
1139
|
-
SENSITIVE = []
|
1261
|
+
SENSITIVE = [:metadata]
|
1140
1262
|
include Aws::Structure
|
1141
1263
|
end
|
1142
1264
|
|
@@ -1146,17 +1268,15 @@ module Aws::IVS
|
|
1146
1268
|
# Recording-configuration ARN.
|
1147
1269
|
# @return [String]
|
1148
1270
|
#
|
1149
|
-
# @!attribute [rw] name
|
1150
|
-
# An arbitrary string (a nickname) assigned to a recording
|
1151
|
-
# configuration that helps the customer identify that resource. The
|
1152
|
-
# value does not need to be unique.
|
1153
|
-
# @return [String]
|
1154
|
-
#
|
1155
1271
|
# @!attribute [rw] destination_configuration
|
1156
1272
|
# A complex type that contains information about where recorded video
|
1157
1273
|
# will be stored.
|
1158
1274
|
# @return [Types::DestinationConfiguration]
|
1159
1275
|
#
|
1276
|
+
# @!attribute [rw] name
|
1277
|
+
# Recording-configuration name. The value does not need to be unique.
|
1278
|
+
# @return [String]
|
1279
|
+
#
|
1160
1280
|
# @!attribute [rw] state
|
1161
1281
|
# Indicates the current state of the recording configuration. When the
|
1162
1282
|
# state is `ACTIVE`, the configuration is ready for recording a
|
@@ -1171,8 +1291,8 @@ module Aws::IVS
|
|
1171
1291
|
#
|
1172
1292
|
class RecordingConfiguration < Struct.new(
|
1173
1293
|
:arn,
|
1174
|
-
:name,
|
1175
1294
|
:destination_configuration,
|
1295
|
+
:name,
|
1176
1296
|
:state,
|
1177
1297
|
:tags)
|
1178
1298
|
SENSITIVE = []
|
@@ -1185,17 +1305,15 @@ module Aws::IVS
|
|
1185
1305
|
# Recording-configuration ARN.
|
1186
1306
|
# @return [String]
|
1187
1307
|
#
|
1188
|
-
# @!attribute [rw] name
|
1189
|
-
# An arbitrary string (a nickname) assigned to a recording
|
1190
|
-
# configuration that helps the customer identify that resource. The
|
1191
|
-
# value does not need to be unique.
|
1192
|
-
# @return [String]
|
1193
|
-
#
|
1194
1308
|
# @!attribute [rw] destination_configuration
|
1195
1309
|
# A complex type that contains information about where recorded video
|
1196
1310
|
# will be stored.
|
1197
1311
|
# @return [Types::DestinationConfiguration]
|
1198
1312
|
#
|
1313
|
+
# @!attribute [rw] name
|
1314
|
+
# Recording-configuration name. The value does not need to be unique.
|
1315
|
+
# @return [String]
|
1316
|
+
#
|
1199
1317
|
# @!attribute [rw] state
|
1200
1318
|
# Indicates the current state of the recording configuration. When the
|
1201
1319
|
# state is `ACTIVE`, the configuration is ready for recording a
|
@@ -1210,8 +1328,8 @@ module Aws::IVS
|
|
1210
1328
|
#
|
1211
1329
|
class RecordingConfigurationSummary < Struct.new(
|
1212
1330
|
:arn,
|
1213
|
-
:name,
|
1214
1331
|
:destination_configuration,
|
1332
|
+
:name,
|
1215
1333
|
:state,
|
1216
1334
|
:tags)
|
1217
1335
|
SENSITIVE = []
|
@@ -1293,51 +1411,107 @@ module Aws::IVS
|
|
1293
1411
|
# Channel ARN for the stream.
|
1294
1412
|
# @return [String]
|
1295
1413
|
#
|
1414
|
+
# @!attribute [rw] health
|
1415
|
+
# The stream’s health.
|
1416
|
+
# @return [String]
|
1417
|
+
#
|
1296
1418
|
# @!attribute [rw] playback_url
|
1297
1419
|
# URL of the master playlist, required by the video player to play the
|
1298
1420
|
# HLS stream.
|
1299
1421
|
# @return [String]
|
1300
1422
|
#
|
1301
1423
|
# @!attribute [rw] start_time
|
1302
|
-
#
|
1424
|
+
# Time of the stream’s start. This is an ISO 8601 timestamp returned
|
1425
|
+
# as a string.
|
1303
1426
|
# @return [Time]
|
1304
1427
|
#
|
1305
1428
|
# @!attribute [rw] state
|
1306
1429
|
# The stream’s state.
|
1307
1430
|
# @return [String]
|
1308
1431
|
#
|
1309
|
-
# @!attribute [rw]
|
1310
|
-
#
|
1432
|
+
# @!attribute [rw] stream_id
|
1433
|
+
# Unique identifier for a live or previously live stream in the
|
1434
|
+
# specified channel.
|
1311
1435
|
# @return [String]
|
1312
1436
|
#
|
1313
1437
|
# @!attribute [rw] viewer_count
|
1314
|
-
#
|
1315
|
-
#
|
1438
|
+
# A count of concurrent views of the stream. Typically, a new view
|
1439
|
+
# appears in `viewerCount` within 15 seconds of when video playback
|
1440
|
+
# starts and a view is removed from `viewerCount` within 1 minute of
|
1441
|
+
# when video playback ends. A value of -1 indicates that the request
|
1442
|
+
# timed out; in this case, retry.
|
1316
1443
|
# @return [Integer]
|
1317
1444
|
#
|
1318
1445
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/Stream AWS API Documentation
|
1319
1446
|
#
|
1320
1447
|
class Stream < Struct.new(
|
1321
1448
|
:channel_arn,
|
1449
|
+
:health,
|
1322
1450
|
:playback_url,
|
1323
1451
|
:start_time,
|
1324
1452
|
:state,
|
1325
|
-
:
|
1453
|
+
:stream_id,
|
1326
1454
|
:viewer_count)
|
1327
1455
|
SENSITIVE = []
|
1328
1456
|
include Aws::Structure
|
1329
1457
|
end
|
1330
1458
|
|
1459
|
+
# Object specifying a stream’s events. For a list of events, see [Using
|
1460
|
+
# Amazon EventBridge with Amazon IVS][1].
|
1461
|
+
#
|
1462
|
+
#
|
1463
|
+
#
|
1464
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
|
1465
|
+
#
|
1466
|
+
# @!attribute [rw] event_time
|
1467
|
+
# UTC ISO-8601 formatted timestamp of when the event occurred.
|
1468
|
+
# @return [Time]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] name
|
1471
|
+
# Name that identifies the stream event within a `type`.
|
1472
|
+
# @return [String]
|
1473
|
+
#
|
1474
|
+
# @!attribute [rw] type
|
1475
|
+
# Logical group for certain events.
|
1476
|
+
# @return [String]
|
1477
|
+
#
|
1478
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamEvent AWS API Documentation
|
1479
|
+
#
|
1480
|
+
class StreamEvent < Struct.new(
|
1481
|
+
:event_time,
|
1482
|
+
:name,
|
1483
|
+
:type)
|
1484
|
+
SENSITIVE = []
|
1485
|
+
include Aws::Structure
|
1486
|
+
end
|
1487
|
+
|
1488
|
+
# Object specifying the stream attribute on which to filter.
|
1489
|
+
#
|
1490
|
+
# @note When making an API call, you may pass StreamFilters
|
1491
|
+
# data as a hash:
|
1492
|
+
#
|
1493
|
+
# {
|
1494
|
+
# health: "HEALTHY", # accepts HEALTHY, STARVING, UNKNOWN
|
1495
|
+
# }
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] health
|
1498
|
+
# The stream’s health.
|
1499
|
+
# @return [String]
|
1500
|
+
#
|
1501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamFilters AWS API Documentation
|
1502
|
+
#
|
1503
|
+
class StreamFilters < Struct.new(
|
1504
|
+
:health)
|
1505
|
+
SENSITIVE = []
|
1506
|
+
include Aws::Structure
|
1507
|
+
end
|
1508
|
+
|
1331
1509
|
# Object specifying a stream key.
|
1332
1510
|
#
|
1333
1511
|
# @!attribute [rw] arn
|
1334
1512
|
# Stream-key ARN.
|
1335
1513
|
# @return [String]
|
1336
1514
|
#
|
1337
|
-
# @!attribute [rw] value
|
1338
|
-
# Stream-key value.
|
1339
|
-
# @return [String]
|
1340
|
-
#
|
1341
1515
|
# @!attribute [rw] channel_arn
|
1342
1516
|
# Channel ARN for the stream.
|
1343
1517
|
# @return [String]
|
@@ -1346,14 +1520,18 @@ module Aws::IVS
|
|
1346
1520
|
# Array of 1-50 maps, each of the form `string:string (key:value)`.
|
1347
1521
|
# @return [Hash<String,String>]
|
1348
1522
|
#
|
1523
|
+
# @!attribute [rw] value
|
1524
|
+
# Stream-key value.
|
1525
|
+
# @return [String]
|
1526
|
+
#
|
1349
1527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamKey AWS API Documentation
|
1350
1528
|
#
|
1351
1529
|
class StreamKey < Struct.new(
|
1352
1530
|
:arn,
|
1353
|
-
:value,
|
1354
1531
|
:channel_arn,
|
1355
|
-
:tags
|
1356
|
-
|
1532
|
+
:tags,
|
1533
|
+
:value)
|
1534
|
+
SENSITIVE = [:value]
|
1357
1535
|
include Aws::Structure
|
1358
1536
|
end
|
1359
1537
|
|
@@ -1381,37 +1559,133 @@ module Aws::IVS
|
|
1381
1559
|
include Aws::Structure
|
1382
1560
|
end
|
1383
1561
|
|
1562
|
+
# Object that captures the Amazon IVS configuration that the customer
|
1563
|
+
# provisioned, the ingest configurations that the broadcaster used, and
|
1564
|
+
# the most recent Amazon IVS stream events it encountered.
|
1565
|
+
#
|
1566
|
+
# @!attribute [rw] channel
|
1567
|
+
# The properties of the channel at the time of going live.
|
1568
|
+
# @return [Types::Channel]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] end_time
|
1571
|
+
# UTC ISO-8601 formatted timestamp of when the channel went offline.
|
1572
|
+
# For live streams, this is `NULL`.
|
1573
|
+
# @return [Time]
|
1574
|
+
#
|
1575
|
+
# @!attribute [rw] ingest_configuration
|
1576
|
+
# The properties of the incoming RTMP stream for the stream.
|
1577
|
+
# @return [Types::IngestConfiguration]
|
1578
|
+
#
|
1579
|
+
# @!attribute [rw] recording_configuration
|
1580
|
+
# The properties of recording the live stream.
|
1581
|
+
# @return [Types::RecordingConfiguration]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] start_time
|
1584
|
+
# UTC ISO-8601 formatted timestamp of when the channel went live.
|
1585
|
+
# @return [Time]
|
1586
|
+
#
|
1587
|
+
# @!attribute [rw] stream_id
|
1588
|
+
# Unique identifier for a live or previously live stream in the
|
1589
|
+
# specified channel.
|
1590
|
+
# @return [String]
|
1591
|
+
#
|
1592
|
+
# @!attribute [rw] truncated_events
|
1593
|
+
# List of Amazon IVS events that the stream encountered. The list is
|
1594
|
+
# sorted by most recent events and contains up to 500 events. For
|
1595
|
+
# Amazon IVS events, see [Using Amazon EventBridge with Amazon
|
1596
|
+
# IVS][1].
|
1597
|
+
#
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html
|
1601
|
+
# @return [Array<Types::StreamEvent>]
|
1602
|
+
#
|
1603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSession AWS API Documentation
|
1604
|
+
#
|
1605
|
+
class StreamSession < Struct.new(
|
1606
|
+
:channel,
|
1607
|
+
:end_time,
|
1608
|
+
:ingest_configuration,
|
1609
|
+
:recording_configuration,
|
1610
|
+
:start_time,
|
1611
|
+
:stream_id,
|
1612
|
+
:truncated_events)
|
1613
|
+
SENSITIVE = []
|
1614
|
+
include Aws::Structure
|
1615
|
+
end
|
1616
|
+
|
1617
|
+
# Summary information about a stream session.
|
1618
|
+
#
|
1619
|
+
# @!attribute [rw] end_time
|
1620
|
+
# UTC ISO-8601 formatted timestamp of when the channel went offline.
|
1621
|
+
# For live streams, this is `NULL`.
|
1622
|
+
# @return [Time]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] has_error_event
|
1625
|
+
# If `true`, this stream encountered a quota breach or failure.
|
1626
|
+
# @return [Boolean]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] start_time
|
1629
|
+
# UTC ISO-8601 formatted timestamp of when the channel went live.
|
1630
|
+
# @return [Time]
|
1631
|
+
#
|
1632
|
+
# @!attribute [rw] stream_id
|
1633
|
+
# Unique identifier for a live or previously live stream in the
|
1634
|
+
# specified channel.
|
1635
|
+
# @return [String]
|
1636
|
+
#
|
1637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSessionSummary AWS API Documentation
|
1638
|
+
#
|
1639
|
+
class StreamSessionSummary < Struct.new(
|
1640
|
+
:end_time,
|
1641
|
+
:has_error_event,
|
1642
|
+
:start_time,
|
1643
|
+
:stream_id)
|
1644
|
+
SENSITIVE = []
|
1645
|
+
include Aws::Structure
|
1646
|
+
end
|
1647
|
+
|
1384
1648
|
# Summary information about a stream.
|
1385
1649
|
#
|
1386
1650
|
# @!attribute [rw] channel_arn
|
1387
1651
|
# Channel ARN for the stream.
|
1388
1652
|
# @return [String]
|
1389
1653
|
#
|
1654
|
+
# @!attribute [rw] health
|
1655
|
+
# The stream’s health.
|
1656
|
+
# @return [String]
|
1657
|
+
#
|
1658
|
+
# @!attribute [rw] start_time
|
1659
|
+
# Time of the stream’s start. This is an ISO 8601 timestamp returned
|
1660
|
+
# as a string.
|
1661
|
+
# @return [Time]
|
1662
|
+
#
|
1390
1663
|
# @!attribute [rw] state
|
1391
1664
|
# The stream’s state.
|
1392
1665
|
# @return [String]
|
1393
1666
|
#
|
1394
|
-
# @!attribute [rw]
|
1395
|
-
#
|
1667
|
+
# @!attribute [rw] stream_id
|
1668
|
+
# Unique identifier for a live or previously live stream in the
|
1669
|
+
# specified channel.
|
1396
1670
|
# @return [String]
|
1397
1671
|
#
|
1398
1672
|
# @!attribute [rw] viewer_count
|
1399
|
-
#
|
1400
|
-
#
|
1673
|
+
# A count of concurrent views of the stream. Typically, a new view
|
1674
|
+
# appears in `viewerCount` within 15 seconds of when video playback
|
1675
|
+
# starts and a view is removed from `viewerCount` within 1 minute of
|
1676
|
+
# when video playback ends. A value of -1 indicates that the request
|
1677
|
+
# timed out; in this case, retry.
|
1401
1678
|
# @return [Integer]
|
1402
1679
|
#
|
1403
|
-
# @!attribute [rw] start_time
|
1404
|
-
# ISO-8601 formatted timestamp of the stream’s start.
|
1405
|
-
# @return [Time]
|
1406
|
-
#
|
1407
1680
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/StreamSummary AWS API Documentation
|
1408
1681
|
#
|
1409
1682
|
class StreamSummary < Struct.new(
|
1410
1683
|
:channel_arn,
|
1411
|
-
:state,
|
1412
1684
|
:health,
|
1413
|
-
:
|
1414
|
-
:
|
1685
|
+
:start_time,
|
1686
|
+
:state,
|
1687
|
+
:stream_id,
|
1688
|
+
:viewer_count)
|
1415
1689
|
SENSITIVE = []
|
1416
1690
|
include Aws::Structure
|
1417
1691
|
end
|
@@ -1505,20 +1779,20 @@ module Aws::IVS
|
|
1505
1779
|
#
|
1506
1780
|
# {
|
1507
1781
|
# arn: "ChannelArn", # required
|
1508
|
-
# name: "ChannelName",
|
1509
|
-
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1510
|
-
# type: "BASIC", # accepts BASIC, STANDARD
|
1511
1782
|
# authorized: false,
|
1783
|
+
# latency_mode: "NORMAL", # accepts NORMAL, LOW
|
1784
|
+
# name: "ChannelName",
|
1512
1785
|
# recording_configuration_arn: "ChannelRecordingConfigurationArn",
|
1786
|
+
# type: "BASIC", # accepts BASIC, STANDARD
|
1513
1787
|
# }
|
1514
1788
|
#
|
1515
1789
|
# @!attribute [rw] arn
|
1516
1790
|
# ARN of the channel to be updated.
|
1517
1791
|
# @return [String]
|
1518
1792
|
#
|
1519
|
-
# @!attribute [rw]
|
1520
|
-
#
|
1521
|
-
# @return [
|
1793
|
+
# @!attribute [rw] authorized
|
1794
|
+
# Whether the channel is private (enabled for playback authorization).
|
1795
|
+
# @return [Boolean]
|
1522
1796
|
#
|
1523
1797
|
# @!attribute [rw] latency_mode
|
1524
1798
|
# Channel latency mode. Use `NORMAL` to broadcast and deliver live
|
@@ -1527,6 +1801,16 @@ module Aws::IVS
|
|
1527
1801
|
# correspond to Ultra-low and Standard, respectively.)
|
1528
1802
|
# @return [String]
|
1529
1803
|
#
|
1804
|
+
# @!attribute [rw] name
|
1805
|
+
# Channel name.
|
1806
|
+
# @return [String]
|
1807
|
+
#
|
1808
|
+
# @!attribute [rw] recording_configuration_arn
|
1809
|
+
# Recording-configuration ARN. If this is set to an empty string,
|
1810
|
+
# recording is disabled. A value other than an empty string indicates
|
1811
|
+
# that recording is enabled
|
1812
|
+
# @return [String]
|
1813
|
+
#
|
1530
1814
|
# @!attribute [rw] type
|
1531
1815
|
# Channel type, which determines the allowable resolution and bitrate.
|
1532
1816
|
# *If you exceed the allowable resolution or bitrate, the stream
|
@@ -1534,34 +1818,24 @@ module Aws::IVS
|
|
1534
1818
|
#
|
1535
1819
|
# * `STANDARD`\: Multiple qualities are generated from the original
|
1536
1820
|
# input, to automatically give viewers the best experience for their
|
1537
|
-
# devices and network conditions.
|
1538
|
-
#
|
1821
|
+
# devices and network conditions. Resolution can be up to 1080p and
|
1822
|
+
# bitrate can be up to 8.5 Mbps. Audio is transcoded only for
|
1823
|
+
# renditions 360p and below; above that, audio is passed through.
|
1539
1824
|
#
|
1540
1825
|
# * `BASIC`\: Amazon IVS delivers the original input to viewers. The
|
1541
1826
|
# viewer’s video-quality choice is limited to the original input.
|
1542
|
-
#
|
1543
|
-
# Mbps.
|
1544
|
-
# @return [String]
|
1545
|
-
#
|
1546
|
-
# @!attribute [rw] authorized
|
1547
|
-
# Whether the channel is private (enabled for playback authorization).
|
1548
|
-
# @return [Boolean]
|
1549
|
-
#
|
1550
|
-
# @!attribute [rw] recording_configuration_arn
|
1551
|
-
# Recording-configuration ARN. If this is set to an empty string,
|
1552
|
-
# recording is disabled. A value other than an empty string indicates
|
1553
|
-
# that recording is enabled
|
1827
|
+
# Resolution can be up to 480p and bitrate can be up to 1.5 Mbps.
|
1554
1828
|
# @return [String]
|
1555
1829
|
#
|
1556
1830
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/UpdateChannelRequest AWS API Documentation
|
1557
1831
|
#
|
1558
1832
|
class UpdateChannelRequest < Struct.new(
|
1559
1833
|
:arn,
|
1560
|
-
:name,
|
1561
|
-
:latency_mode,
|
1562
|
-
:type,
|
1563
1834
|
:authorized,
|
1564
|
-
:
|
1835
|
+
:latency_mode,
|
1836
|
+
:name,
|
1837
|
+
:recording_configuration_arn,
|
1838
|
+
:type)
|
1565
1839
|
SENSITIVE = []
|
1566
1840
|
include Aws::Structure
|
1567
1841
|
end
|
@@ -1579,8 +1853,8 @@ module Aws::IVS
|
|
1579
1853
|
end
|
1580
1854
|
|
1581
1855
|
# @!attribute [rw] exception_message
|
1582
|
-
# The input fails to satisfy the constraints specified by an
|
1583
|
-
# service.
|
1856
|
+
# The input fails to satisfy the constraints specified by an Amazon
|
1857
|
+
# Web Services service.
|
1584
1858
|
# @return [String]
|
1585
1859
|
#
|
1586
1860
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ValidationException AWS API Documentation
|
@@ -1591,5 +1865,58 @@ module Aws::IVS
|
|
1591
1865
|
include Aws::Structure
|
1592
1866
|
end
|
1593
1867
|
|
1868
|
+
# Object specifying a stream’s video configuration.
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] avc_level
|
1871
|
+
# Indicates the degree of required decoder performance for a profile.
|
1872
|
+
# Normally this is set automatically by the encoder. For details, see
|
1873
|
+
# the H.264 specification.
|
1874
|
+
# @return [String]
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] avc_profile
|
1877
|
+
# Indicates to the decoder the requirements for decoding the stream.
|
1878
|
+
# For definitions of the valid values, see the H.264 specification.
|
1879
|
+
# @return [String]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] codec
|
1882
|
+
# Codec used for the video encoding.
|
1883
|
+
# @return [String]
|
1884
|
+
#
|
1885
|
+
# @!attribute [rw] encoder
|
1886
|
+
# Software or hardware used to encode the video.
|
1887
|
+
# @return [String]
|
1888
|
+
#
|
1889
|
+
# @!attribute [rw] target_bitrate
|
1890
|
+
# The expected ingest bitrate (bits per second). This is configured in
|
1891
|
+
# the encoder.
|
1892
|
+
# @return [Integer]
|
1893
|
+
#
|
1894
|
+
# @!attribute [rw] target_framerate
|
1895
|
+
# The expected ingest framerate. This is configured in the encoder.
|
1896
|
+
# @return [Integer]
|
1897
|
+
#
|
1898
|
+
# @!attribute [rw] video_height
|
1899
|
+
# Video-resolution height in pixels.
|
1900
|
+
# @return [Integer]
|
1901
|
+
#
|
1902
|
+
# @!attribute [rw] video_width
|
1903
|
+
# Video-resolution width in pixels.
|
1904
|
+
# @return [Integer]
|
1905
|
+
#
|
1906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/VideoConfiguration AWS API Documentation
|
1907
|
+
#
|
1908
|
+
class VideoConfiguration < Struct.new(
|
1909
|
+
:avc_level,
|
1910
|
+
:avc_profile,
|
1911
|
+
:codec,
|
1912
|
+
:encoder,
|
1913
|
+
:target_bitrate,
|
1914
|
+
:target_framerate,
|
1915
|
+
:video_height,
|
1916
|
+
:video_width)
|
1917
|
+
SENSITIVE = []
|
1918
|
+
include Aws::Structure
|
1919
|
+
end
|
1920
|
+
|
1594
1921
|
end
|
1595
1922
|
end
|