aws-sdk-ivsrealtime 1.10.0 → 1.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivsrealtime/client.rb +574 -5
- data/lib/aws-sdk-ivsrealtime/client_api.rb +455 -0
- data/lib/aws-sdk-ivsrealtime/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-ivsrealtime/endpoints.rb +168 -0
- data/lib/aws-sdk-ivsrealtime/plugins/endpoints.rb +24 -0
- data/lib/aws-sdk-ivsrealtime/types.rb +992 -42
- data/lib/aws-sdk-ivsrealtime.rb +2 -2
- metadata +2 -2
@@ -22,6 +22,142 @@ module Aws::IVSRealTime
|
|
22
22
|
include Aws::Structure
|
23
23
|
end
|
24
24
|
|
25
|
+
# Object specifying a channel as a destination.
|
26
|
+
#
|
27
|
+
# @!attribute [rw] channel_arn
|
28
|
+
# ARN of the channel to use for broadcasting. The channel and stage
|
29
|
+
# resources must be in the same AWS account and region. The channel
|
30
|
+
# must be offline (not broadcasting).
|
31
|
+
# @return [String]
|
32
|
+
#
|
33
|
+
# @!attribute [rw] encoder_configuration_arn
|
34
|
+
# ARN of the EncoderConfiguration resource. The encoder configuration
|
35
|
+
# and stage resources must be in the same AWS account and region.
|
36
|
+
# @return [String]
|
37
|
+
#
|
38
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ChannelDestinationConfiguration AWS API Documentation
|
39
|
+
#
|
40
|
+
class ChannelDestinationConfiguration < Struct.new(
|
41
|
+
:channel_arn,
|
42
|
+
:encoder_configuration_arn)
|
43
|
+
SENSITIVE = []
|
44
|
+
include Aws::Structure
|
45
|
+
end
|
46
|
+
|
47
|
+
# Object specifying a Composition resource.
|
48
|
+
#
|
49
|
+
# @!attribute [rw] arn
|
50
|
+
# ARN of the Composition resource.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] destinations
|
54
|
+
# Array of Destination objects. A Composition can contain either one
|
55
|
+
# destination (`channel` or `s3`) or two (one `channel` and one `s3`).
|
56
|
+
# @return [Array<Types::Destination>]
|
57
|
+
#
|
58
|
+
# @!attribute [rw] end_time
|
59
|
+
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
60
|
+
# *note that this is returned as a string*.
|
61
|
+
# @return [Time]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] layout
|
64
|
+
# Layout object to configure composition parameters.
|
65
|
+
# @return [Types::LayoutConfiguration]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] stage_arn
|
68
|
+
# ARN of the stage used as input
|
69
|
+
# @return [String]
|
70
|
+
#
|
71
|
+
# @!attribute [rw] start_time
|
72
|
+
# UTC time of the Composition start. This is an ISO 8601 timestamp;
|
73
|
+
# *note that this is returned as a string*.
|
74
|
+
# @return [Time]
|
75
|
+
#
|
76
|
+
# @!attribute [rw] state
|
77
|
+
# State of the Composition.
|
78
|
+
# @return [String]
|
79
|
+
#
|
80
|
+
# @!attribute [rw] tags
|
81
|
+
# Tags attached to the resource. Array of maps, each of the form
|
82
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
83
|
+
# details, including restrictions that apply to tags and "Tag naming
|
84
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
85
|
+
# beyond what is documented there.
|
86
|
+
#
|
87
|
+
#
|
88
|
+
#
|
89
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
90
|
+
# @return [Hash<String,String>]
|
91
|
+
#
|
92
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Composition AWS API Documentation
|
93
|
+
#
|
94
|
+
class Composition < Struct.new(
|
95
|
+
:arn,
|
96
|
+
:destinations,
|
97
|
+
:end_time,
|
98
|
+
:layout,
|
99
|
+
:stage_arn,
|
100
|
+
:start_time,
|
101
|
+
:state,
|
102
|
+
:tags)
|
103
|
+
SENSITIVE = []
|
104
|
+
include Aws::Structure
|
105
|
+
end
|
106
|
+
|
107
|
+
# Summary information about a Composition.
|
108
|
+
#
|
109
|
+
# @!attribute [rw] arn
|
110
|
+
# ARN of the Composition resource.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] destinations
|
114
|
+
# Array of Destination objects.
|
115
|
+
# @return [Array<Types::DestinationSummary>]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] end_time
|
118
|
+
# UTC time of the Composition end. This is an ISO 8601 timestamp;
|
119
|
+
# *note that this is returned as a string*.
|
120
|
+
# @return [Time]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] stage_arn
|
123
|
+
# ARN of the attached stage.
|
124
|
+
# @return [String]
|
125
|
+
#
|
126
|
+
# @!attribute [rw] start_time
|
127
|
+
# UTC time of the Composition start. This is an ISO 8601 timestamp;
|
128
|
+
# *note that this is returned as a string*.
|
129
|
+
# @return [Time]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] state
|
132
|
+
# State of the Composition resource.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] tags
|
136
|
+
# Tags attached to the resource. Array of maps, each of the form
|
137
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
138
|
+
# details, including restrictions that apply to tags and "Tag naming
|
139
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
140
|
+
# beyond what is documented there.
|
141
|
+
#
|
142
|
+
#
|
143
|
+
#
|
144
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
145
|
+
# @return [Hash<String,String>]
|
146
|
+
#
|
147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CompositionSummary AWS API Documentation
|
148
|
+
#
|
149
|
+
class CompositionSummary < Struct.new(
|
150
|
+
:arn,
|
151
|
+
:destinations,
|
152
|
+
:end_time,
|
153
|
+
:stage_arn,
|
154
|
+
:start_time,
|
155
|
+
:state,
|
156
|
+
:tags)
|
157
|
+
SENSITIVE = []
|
158
|
+
include Aws::Structure
|
159
|
+
end
|
160
|
+
|
25
161
|
# @!attribute [rw] exception_message
|
26
162
|
# Updating or deleting a resource can cause an inconsistent state.
|
27
163
|
# @return [String]
|
@@ -34,6 +170,49 @@ module Aws::IVSRealTime
|
|
34
170
|
include Aws::Structure
|
35
171
|
end
|
36
172
|
|
173
|
+
# @!attribute [rw] name
|
174
|
+
# Optional name to identify the resource.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] tags
|
178
|
+
# Tags attached to the resource. Array of maps, each of the form
|
179
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
180
|
+
# details, including restrictions that apply to tags and "Tag naming
|
181
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
182
|
+
# beyond what is documented there.
|
183
|
+
#
|
184
|
+
#
|
185
|
+
#
|
186
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
187
|
+
# @return [Hash<String,String>]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] video
|
190
|
+
# Video configuration. Default: video resolution 1280x720, bitrate
|
191
|
+
# 2500 kbps, 30 fps.
|
192
|
+
# @return [Types::Video]
|
193
|
+
#
|
194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfigurationRequest AWS API Documentation
|
195
|
+
#
|
196
|
+
class CreateEncoderConfigurationRequest < Struct.new(
|
197
|
+
:name,
|
198
|
+
:tags,
|
199
|
+
:video)
|
200
|
+
SENSITIVE = []
|
201
|
+
include Aws::Structure
|
202
|
+
end
|
203
|
+
|
204
|
+
# @!attribute [rw] encoder_configuration
|
205
|
+
# The EncoderConfiguration that was created.
|
206
|
+
# @return [Types::EncoderConfiguration]
|
207
|
+
#
|
208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfigurationResponse AWS API Documentation
|
209
|
+
#
|
210
|
+
class CreateEncoderConfigurationResponse < Struct.new(
|
211
|
+
:encoder_configuration)
|
212
|
+
SENSITIVE = []
|
213
|
+
include Aws::Structure
|
214
|
+
end
|
215
|
+
|
37
216
|
# @!attribute [rw] attributes
|
38
217
|
# Application-provided attributes to encode into the token and attach
|
39
218
|
# to a stage. Map keys and values can contain UTF-8 encoded text. The
|
@@ -136,6 +315,65 @@ module Aws::IVSRealTime
|
|
136
315
|
include Aws::Structure
|
137
316
|
end
|
138
317
|
|
318
|
+
# @!attribute [rw] name
|
319
|
+
# Storage configuration name. The value does not need to be unique.
|
320
|
+
# @return [String]
|
321
|
+
#
|
322
|
+
# @!attribute [rw] s3
|
323
|
+
# A complex type that contains a storage configuration for where
|
324
|
+
# recorded video will be stored.
|
325
|
+
# @return [Types::S3StorageConfiguration]
|
326
|
+
#
|
327
|
+
# @!attribute [rw] tags
|
328
|
+
# Tags attached to the resource. Array of maps, each of the form
|
329
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
330
|
+
# details, including restrictions that apply to tags and "Tag naming
|
331
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
332
|
+
# beyond what is documented there.
|
333
|
+
#
|
334
|
+
#
|
335
|
+
#
|
336
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
337
|
+
# @return [Hash<String,String>]
|
338
|
+
#
|
339
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStorageConfigurationRequest AWS API Documentation
|
340
|
+
#
|
341
|
+
class CreateStorageConfigurationRequest < Struct.new(
|
342
|
+
:name,
|
343
|
+
:s3,
|
344
|
+
:tags)
|
345
|
+
SENSITIVE = []
|
346
|
+
include Aws::Structure
|
347
|
+
end
|
348
|
+
|
349
|
+
# @!attribute [rw] storage_configuration
|
350
|
+
# The StorageConfiguration that was created.
|
351
|
+
# @return [Types::StorageConfiguration]
|
352
|
+
#
|
353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStorageConfigurationResponse AWS API Documentation
|
354
|
+
#
|
355
|
+
class CreateStorageConfigurationResponse < Struct.new(
|
356
|
+
:storage_configuration)
|
357
|
+
SENSITIVE = []
|
358
|
+
include Aws::Structure
|
359
|
+
end
|
360
|
+
|
361
|
+
# @!attribute [rw] arn
|
362
|
+
# ARN of the EncoderConfiguration.
|
363
|
+
# @return [String]
|
364
|
+
#
|
365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteEncoderConfigurationRequest AWS API Documentation
|
366
|
+
#
|
367
|
+
class DeleteEncoderConfigurationRequest < Struct.new(
|
368
|
+
:arn)
|
369
|
+
SENSITIVE = []
|
370
|
+
include Aws::Structure
|
371
|
+
end
|
372
|
+
|
373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteEncoderConfigurationResponse AWS API Documentation
|
374
|
+
#
|
375
|
+
class DeleteEncoderConfigurationResponse < Aws::EmptyStructure; end
|
376
|
+
|
139
377
|
# @!attribute [rw] arn
|
140
378
|
# ARN of the stage to be deleted.
|
141
379
|
# @return [String]
|
@@ -152,6 +390,134 @@ module Aws::IVSRealTime
|
|
152
390
|
#
|
153
391
|
class DeleteStageResponse < Aws::EmptyStructure; end
|
154
392
|
|
393
|
+
# @!attribute [rw] arn
|
394
|
+
# ARN of the storage configuration to be deleted.
|
395
|
+
# @return [String]
|
396
|
+
#
|
397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStorageConfigurationRequest AWS API Documentation
|
398
|
+
#
|
399
|
+
class DeleteStorageConfigurationRequest < Struct.new(
|
400
|
+
:arn)
|
401
|
+
SENSITIVE = []
|
402
|
+
include Aws::Structure
|
403
|
+
end
|
404
|
+
|
405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteStorageConfigurationResponse AWS API Documentation
|
406
|
+
#
|
407
|
+
class DeleteStorageConfigurationResponse < Aws::EmptyStructure; end
|
408
|
+
|
409
|
+
# Object specifying the status of a Destination.
|
410
|
+
#
|
411
|
+
# @!attribute [rw] configuration
|
412
|
+
# Configuration used to create this destination.
|
413
|
+
# @return [Types::DestinationConfiguration]
|
414
|
+
#
|
415
|
+
# @!attribute [rw] detail
|
416
|
+
# Optional details regarding the status of the destination.
|
417
|
+
# @return [Types::DestinationDetail]
|
418
|
+
#
|
419
|
+
# @!attribute [rw] end_time
|
420
|
+
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
421
|
+
# *note that this is returned as a string*.
|
422
|
+
# @return [Time]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] id
|
425
|
+
# Unique identifier for this destination, assigned by IVS.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] start_time
|
429
|
+
# UTC time of the destination start. This is an ISO 8601 timestamp;
|
430
|
+
# *note that this is returned as a string*.
|
431
|
+
# @return [Time]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] state
|
434
|
+
# State of the Composition Destination.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Destination AWS API Documentation
|
438
|
+
#
|
439
|
+
class Destination < Struct.new(
|
440
|
+
:configuration,
|
441
|
+
:detail,
|
442
|
+
:end_time,
|
443
|
+
:id,
|
444
|
+
:start_time,
|
445
|
+
:state)
|
446
|
+
SENSITIVE = []
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# Complex data type that defines destination-configuration objects.
|
451
|
+
#
|
452
|
+
# @!attribute [rw] channel
|
453
|
+
# An IVS channel to be used for broadcasting, for server-side
|
454
|
+
# composition. Either a `channel` or an `s3` must be specified.
|
455
|
+
# @return [Types::ChannelDestinationConfiguration]
|
456
|
+
#
|
457
|
+
# @!attribute [rw] name
|
458
|
+
# Name that can be specified to help identify the destination.
|
459
|
+
# @return [String]
|
460
|
+
#
|
461
|
+
# @!attribute [rw] s3
|
462
|
+
# An S3 storage configuration to be used for recording video data.
|
463
|
+
# Either a `channel` or an `s3` must be specified.
|
464
|
+
# @return [Types::S3DestinationConfiguration]
|
465
|
+
#
|
466
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DestinationConfiguration AWS API Documentation
|
467
|
+
#
|
468
|
+
class DestinationConfiguration < Struct.new(
|
469
|
+
:channel,
|
470
|
+
:name,
|
471
|
+
:s3)
|
472
|
+
SENSITIVE = []
|
473
|
+
include Aws::Structure
|
474
|
+
end
|
475
|
+
|
476
|
+
# Complex data type that defines destination-detail objects.
|
477
|
+
#
|
478
|
+
# @!attribute [rw] s3
|
479
|
+
# An S3 detail object to return information about the S3 destination.
|
480
|
+
# @return [Types::S3Detail]
|
481
|
+
#
|
482
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DestinationDetail AWS API Documentation
|
483
|
+
#
|
484
|
+
class DestinationDetail < Struct.new(
|
485
|
+
:s3)
|
486
|
+
SENSITIVE = []
|
487
|
+
include Aws::Structure
|
488
|
+
end
|
489
|
+
|
490
|
+
# Summary information about a Destination.
|
491
|
+
#
|
492
|
+
# @!attribute [rw] end_time
|
493
|
+
# UTC time of the destination end. This is an ISO 8601 timestamp;
|
494
|
+
# *note that this is returned as a string*.
|
495
|
+
# @return [Time]
|
496
|
+
#
|
497
|
+
# @!attribute [rw] id
|
498
|
+
# Unique identifier for this destination, assigned by IVS.
|
499
|
+
# @return [String]
|
500
|
+
#
|
501
|
+
# @!attribute [rw] start_time
|
502
|
+
# UTC time of the destination start. This is an ISO 8601 timestamp;
|
503
|
+
# *note that this is returned as a string*.
|
504
|
+
# @return [Time]
|
505
|
+
#
|
506
|
+
# @!attribute [rw] state
|
507
|
+
# State of the Composition Destination.
|
508
|
+
# @return [String]
|
509
|
+
#
|
510
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DestinationSummary AWS API Documentation
|
511
|
+
#
|
512
|
+
class DestinationSummary < Struct.new(
|
513
|
+
:end_time,
|
514
|
+
:id,
|
515
|
+
:start_time,
|
516
|
+
:state)
|
517
|
+
SENSITIVE = []
|
518
|
+
include Aws::Structure
|
519
|
+
end
|
520
|
+
|
155
521
|
# @!attribute [rw] participant_id
|
156
522
|
# Identifier of the participant to be disconnected. This is assigned
|
157
523
|
# by IVS and returned by CreateParticipantToken.
|
@@ -179,6 +545,76 @@ module Aws::IVSRealTime
|
|
179
545
|
#
|
180
546
|
class DisconnectParticipantResponse < Aws::EmptyStructure; end
|
181
547
|
|
548
|
+
# Settings for transcoding.
|
549
|
+
#
|
550
|
+
# @!attribute [rw] arn
|
551
|
+
# ARN of the EncoderConfiguration resource.
|
552
|
+
# @return [String]
|
553
|
+
#
|
554
|
+
# @!attribute [rw] name
|
555
|
+
# Optional name to identify the resource.
|
556
|
+
# @return [String]
|
557
|
+
#
|
558
|
+
# @!attribute [rw] tags
|
559
|
+
# Tags attached to the resource. Array of maps, each of the form
|
560
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
561
|
+
# details, including restrictions that apply to tags and "Tag naming
|
562
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
563
|
+
# beyond what is documented there.
|
564
|
+
#
|
565
|
+
#
|
566
|
+
#
|
567
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
568
|
+
# @return [Hash<String,String>]
|
569
|
+
#
|
570
|
+
# @!attribute [rw] video
|
571
|
+
# Video configuration. Default: video resolution 1280x720, bitrate
|
572
|
+
# 2500 kbps, 30 fps
|
573
|
+
# @return [Types::Video]
|
574
|
+
#
|
575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/EncoderConfiguration AWS API Documentation
|
576
|
+
#
|
577
|
+
class EncoderConfiguration < Struct.new(
|
578
|
+
:arn,
|
579
|
+
:name,
|
580
|
+
:tags,
|
581
|
+
:video)
|
582
|
+
SENSITIVE = []
|
583
|
+
include Aws::Structure
|
584
|
+
end
|
585
|
+
|
586
|
+
# Summary information about an EncoderConfiguration.
|
587
|
+
#
|
588
|
+
# @!attribute [rw] arn
|
589
|
+
# ARN of the EncoderConfiguration resource.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @!attribute [rw] name
|
593
|
+
# Optional name to identify the resource.
|
594
|
+
# @return [String]
|
595
|
+
#
|
596
|
+
# @!attribute [rw] tags
|
597
|
+
# Tags attached to the resource. Array of maps, each of the form
|
598
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
599
|
+
# details, including restrictions that apply to tags and "Tag naming
|
600
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
601
|
+
# beyond what is documented there.
|
602
|
+
#
|
603
|
+
#
|
604
|
+
#
|
605
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
606
|
+
# @return [Hash<String,String>]
|
607
|
+
#
|
608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/EncoderConfigurationSummary AWS API Documentation
|
609
|
+
#
|
610
|
+
class EncoderConfigurationSummary < Struct.new(
|
611
|
+
:arn,
|
612
|
+
:name,
|
613
|
+
:tags)
|
614
|
+
SENSITIVE = []
|
615
|
+
include Aws::Structure
|
616
|
+
end
|
617
|
+
|
182
618
|
# An occurrence during a stage session.
|
183
619
|
#
|
184
620
|
# @!attribute [rw] error_code
|
@@ -231,6 +667,54 @@ module Aws::IVSRealTime
|
|
231
667
|
include Aws::Structure
|
232
668
|
end
|
233
669
|
|
670
|
+
# @!attribute [rw] arn
|
671
|
+
# ARN of the Composition resource.
|
672
|
+
# @return [String]
|
673
|
+
#
|
674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetCompositionRequest AWS API Documentation
|
675
|
+
#
|
676
|
+
class GetCompositionRequest < Struct.new(
|
677
|
+
:arn)
|
678
|
+
SENSITIVE = []
|
679
|
+
include Aws::Structure
|
680
|
+
end
|
681
|
+
|
682
|
+
# @!attribute [rw] composition
|
683
|
+
# The Composition that was returned.
|
684
|
+
# @return [Types::Composition]
|
685
|
+
#
|
686
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetCompositionResponse AWS API Documentation
|
687
|
+
#
|
688
|
+
class GetCompositionResponse < Struct.new(
|
689
|
+
:composition)
|
690
|
+
SENSITIVE = []
|
691
|
+
include Aws::Structure
|
692
|
+
end
|
693
|
+
|
694
|
+
# @!attribute [rw] arn
|
695
|
+
# ARN of the EncoderConfiguration resource.
|
696
|
+
# @return [String]
|
697
|
+
#
|
698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetEncoderConfigurationRequest AWS API Documentation
|
699
|
+
#
|
700
|
+
class GetEncoderConfigurationRequest < Struct.new(
|
701
|
+
:arn)
|
702
|
+
SENSITIVE = []
|
703
|
+
include Aws::Structure
|
704
|
+
end
|
705
|
+
|
706
|
+
# @!attribute [rw] encoder_configuration
|
707
|
+
# The EncoderConfiguration that was returned.
|
708
|
+
# @return [Types::EncoderConfiguration]
|
709
|
+
#
|
710
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetEncoderConfigurationResponse AWS API Documentation
|
711
|
+
#
|
712
|
+
class GetEncoderConfigurationResponse < Struct.new(
|
713
|
+
:encoder_configuration)
|
714
|
+
SENSITIVE = []
|
715
|
+
include Aws::Structure
|
716
|
+
end
|
717
|
+
|
234
718
|
# @!attribute [rw] participant_id
|
235
719
|
# Unique identifier for the participant. This is assigned by IVS and
|
236
720
|
# returned by CreateParticipantToken.
|
@@ -260,73 +744,217 @@ module Aws::IVSRealTime
|
|
260
744
|
#
|
261
745
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipantResponse AWS API Documentation
|
262
746
|
#
|
263
|
-
class GetParticipantResponse < Struct.new(
|
264
|
-
:participant)
|
747
|
+
class GetParticipantResponse < Struct.new(
|
748
|
+
:participant)
|
749
|
+
SENSITIVE = []
|
750
|
+
include Aws::Structure
|
751
|
+
end
|
752
|
+
|
753
|
+
# @!attribute [rw] arn
|
754
|
+
# ARN of the stage for which the information is to be retrieved.
|
755
|
+
# @return [String]
|
756
|
+
#
|
757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageRequest AWS API Documentation
|
758
|
+
#
|
759
|
+
class GetStageRequest < Struct.new(
|
760
|
+
:arn)
|
761
|
+
SENSITIVE = []
|
762
|
+
include Aws::Structure
|
763
|
+
end
|
764
|
+
|
765
|
+
# @!attribute [rw] stage
|
766
|
+
# The stage that is returned.
|
767
|
+
# @return [Types::Stage]
|
768
|
+
#
|
769
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageResponse AWS API Documentation
|
770
|
+
#
|
771
|
+
class GetStageResponse < Struct.new(
|
772
|
+
:stage)
|
773
|
+
SENSITIVE = []
|
774
|
+
include Aws::Structure
|
775
|
+
end
|
776
|
+
|
777
|
+
# @!attribute [rw] session_id
|
778
|
+
# ID of a session within the stage.
|
779
|
+
# @return [String]
|
780
|
+
#
|
781
|
+
# @!attribute [rw] stage_arn
|
782
|
+
# ARN of the stage for which the information is to be retrieved.
|
783
|
+
# @return [String]
|
784
|
+
#
|
785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSessionRequest AWS API Documentation
|
786
|
+
#
|
787
|
+
class GetStageSessionRequest < Struct.new(
|
788
|
+
:session_id,
|
789
|
+
:stage_arn)
|
790
|
+
SENSITIVE = []
|
791
|
+
include Aws::Structure
|
792
|
+
end
|
793
|
+
|
794
|
+
# @!attribute [rw] stage_session
|
795
|
+
# The stage session that is returned.
|
796
|
+
# @return [Types::StageSession]
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSessionResponse AWS API Documentation
|
799
|
+
#
|
800
|
+
class GetStageSessionResponse < Struct.new(
|
801
|
+
:stage_session)
|
802
|
+
SENSITIVE = []
|
803
|
+
include Aws::Structure
|
804
|
+
end
|
805
|
+
|
806
|
+
# @!attribute [rw] arn
|
807
|
+
# ARN of the storage configuration to be retrieved.
|
808
|
+
# @return [String]
|
809
|
+
#
|
810
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStorageConfigurationRequest AWS API Documentation
|
811
|
+
#
|
812
|
+
class GetStorageConfigurationRequest < Struct.new(
|
813
|
+
:arn)
|
814
|
+
SENSITIVE = []
|
815
|
+
include Aws::Structure
|
816
|
+
end
|
817
|
+
|
818
|
+
# @!attribute [rw] storage_configuration
|
819
|
+
# The StorageConfiguration that was returned.
|
820
|
+
# @return [Types::StorageConfiguration]
|
821
|
+
#
|
822
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStorageConfigurationResponse AWS API Documentation
|
823
|
+
#
|
824
|
+
class GetStorageConfigurationResponse < Struct.new(
|
825
|
+
:storage_configuration)
|
826
|
+
SENSITIVE = []
|
827
|
+
include Aws::Structure
|
828
|
+
end
|
829
|
+
|
830
|
+
# Configuration information specific to Grid layout, for server-side
|
831
|
+
# composition. See "Layouts" in [Server-Side Composition][1].
|
832
|
+
#
|
833
|
+
#
|
834
|
+
#
|
835
|
+
# [1]: https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html
|
836
|
+
#
|
837
|
+
# @!attribute [rw] featured_participant_attribute
|
838
|
+
# This attribute name identifies the featured slot. A participant with
|
839
|
+
# this attribute set to `"true"` (as a string value) in
|
840
|
+
# ParticipantTokenConfiguration is placed in the featured slot.
|
841
|
+
# @return [String]
|
842
|
+
#
|
843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GridConfiguration AWS API Documentation
|
844
|
+
#
|
845
|
+
class GridConfiguration < Struct.new(
|
846
|
+
:featured_participant_attribute)
|
265
847
|
SENSITIVE = []
|
266
848
|
include Aws::Structure
|
267
849
|
end
|
268
850
|
|
269
|
-
# @!attribute [rw]
|
270
|
-
#
|
851
|
+
# @!attribute [rw] exception_message
|
852
|
+
# Unexpected error during processing of request.
|
271
853
|
# @return [String]
|
272
854
|
#
|
273
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/
|
855
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/InternalServerException AWS API Documentation
|
274
856
|
#
|
275
|
-
class
|
276
|
-
:
|
857
|
+
class InternalServerException < Struct.new(
|
858
|
+
:exception_message)
|
277
859
|
SENSITIVE = []
|
278
860
|
include Aws::Structure
|
279
861
|
end
|
280
862
|
|
281
|
-
#
|
282
|
-
#
|
283
|
-
# @return [Types::Stage]
|
863
|
+
# Configuration information of supported layouts for server-side
|
864
|
+
# composition.
|
284
865
|
#
|
285
|
-
#
|
866
|
+
# @!attribute [rw] grid
|
867
|
+
# Configuration related to grid layout. Default: Grid layout.
|
868
|
+
# @return [Types::GridConfiguration]
|
286
869
|
#
|
287
|
-
|
288
|
-
|
870
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/LayoutConfiguration AWS API Documentation
|
871
|
+
#
|
872
|
+
class LayoutConfiguration < Struct.new(
|
873
|
+
:grid)
|
289
874
|
SENSITIVE = []
|
290
875
|
include Aws::Structure
|
291
876
|
end
|
292
877
|
|
293
|
-
# @!attribute [rw]
|
294
|
-
#
|
878
|
+
# @!attribute [rw] filter_by_encoder_configuration_arn
|
879
|
+
# Filters the Composition list to match the specified
|
880
|
+
# EncoderConfiguration attached to at least one of its output.
|
295
881
|
# @return [String]
|
296
882
|
#
|
297
|
-
# @!attribute [rw]
|
298
|
-
#
|
883
|
+
# @!attribute [rw] filter_by_stage_arn
|
884
|
+
# Filters the Composition list to match the specified Stage ARN.
|
299
885
|
# @return [String]
|
300
886
|
#
|
301
|
-
#
|
887
|
+
# @!attribute [rw] max_results
|
888
|
+
# Maximum number of results to return. Default: 100.
|
889
|
+
# @return [Integer]
|
302
890
|
#
|
303
|
-
|
304
|
-
|
305
|
-
|
891
|
+
# @!attribute [rw] next_token
|
892
|
+
# The first Composition to retrieve. This is used for pagination; see
|
893
|
+
# the `nextToken` response field.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositionsRequest AWS API Documentation
|
897
|
+
#
|
898
|
+
class ListCompositionsRequest < Struct.new(
|
899
|
+
:filter_by_encoder_configuration_arn,
|
900
|
+
:filter_by_stage_arn,
|
901
|
+
:max_results,
|
902
|
+
:next_token)
|
306
903
|
SENSITIVE = []
|
307
904
|
include Aws::Structure
|
308
905
|
end
|
309
906
|
|
310
|
-
# @!attribute [rw]
|
311
|
-
#
|
312
|
-
# @return [Types::
|
907
|
+
# @!attribute [rw] compositions
|
908
|
+
# List of the matching Compositions (summary information only).
|
909
|
+
# @return [Array<Types::CompositionSummary>]
|
313
910
|
#
|
314
|
-
#
|
911
|
+
# @!attribute [rw] next_token
|
912
|
+
# If there are more compositions than `maxResults`, use `nextToken` in
|
913
|
+
# the request to get the next set.
|
914
|
+
# @return [String]
|
315
915
|
#
|
316
|
-
|
317
|
-
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositionsResponse AWS API Documentation
|
917
|
+
#
|
918
|
+
class ListCompositionsResponse < Struct.new(
|
919
|
+
:compositions,
|
920
|
+
:next_token)
|
318
921
|
SENSITIVE = []
|
319
922
|
include Aws::Structure
|
320
923
|
end
|
321
924
|
|
322
|
-
# @!attribute [rw]
|
323
|
-
#
|
925
|
+
# @!attribute [rw] max_results
|
926
|
+
# Maximum number of results to return. Default: 100.
|
927
|
+
# @return [Integer]
|
928
|
+
#
|
929
|
+
# @!attribute [rw] next_token
|
930
|
+
# The first encoder configuration to retrieve. This is used for
|
931
|
+
# pagination; see the `nextToken` response field.
|
324
932
|
# @return [String]
|
325
933
|
#
|
326
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListEncoderConfigurationsRequest AWS API Documentation
|
327
935
|
#
|
328
|
-
class
|
329
|
-
:
|
936
|
+
class ListEncoderConfigurationsRequest < Struct.new(
|
937
|
+
:max_results,
|
938
|
+
:next_token)
|
939
|
+
SENSITIVE = []
|
940
|
+
include Aws::Structure
|
941
|
+
end
|
942
|
+
|
943
|
+
# @!attribute [rw] encoder_configurations
|
944
|
+
# List of the matching EncoderConfigurations (summary information
|
945
|
+
# only).
|
946
|
+
# @return [Array<Types::EncoderConfigurationSummary>]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] next_token
|
949
|
+
# If there are more encoder configurations than `maxResults`, use
|
950
|
+
# `nextToken` in the request to get the next set.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListEncoderConfigurationsResponse AWS API Documentation
|
954
|
+
#
|
955
|
+
class ListEncoderConfigurationsResponse < Struct.new(
|
956
|
+
:encoder_configurations,
|
957
|
+
:next_token)
|
330
958
|
SENSITIVE = []
|
331
959
|
include Aws::Structure
|
332
960
|
end
|
@@ -336,8 +964,8 @@ module Aws::IVSRealTime
|
|
336
964
|
# @return [Integer]
|
337
965
|
#
|
338
966
|
# @!attribute [rw] next_token
|
339
|
-
# The first participant to retrieve. This is used for
|
340
|
-
# the `nextToken` response field.
|
967
|
+
# The first participant event to retrieve. This is used for
|
968
|
+
# pagination; see the `nextToken` response field.
|
341
969
|
# @return [String]
|
342
970
|
#
|
343
971
|
# @!attribute [rw] participant_id
|
@@ -370,7 +998,7 @@ module Aws::IVSRealTime
|
|
370
998
|
# @return [Array<Types::Event>]
|
371
999
|
#
|
372
1000
|
# @!attribute [rw] next_token
|
373
|
-
# If there are more
|
1001
|
+
# If there are more events than `maxResults`, use `nextToken` in the
|
374
1002
|
# request to get the next set.
|
375
1003
|
# @return [String]
|
376
1004
|
#
|
@@ -435,8 +1063,8 @@ module Aws::IVSRealTime
|
|
435
1063
|
end
|
436
1064
|
|
437
1065
|
# @!attribute [rw] next_token
|
438
|
-
# If there are more
|
439
|
-
# request to get the next set.
|
1066
|
+
# If there are more participants than `maxResults`, use `nextToken` in
|
1067
|
+
# the request to get the next set.
|
440
1068
|
# @return [String]
|
441
1069
|
#
|
442
1070
|
# @!attribute [rw] participants
|
@@ -457,8 +1085,8 @@ module Aws::IVSRealTime
|
|
457
1085
|
# @return [Integer]
|
458
1086
|
#
|
459
1087
|
# @!attribute [rw] next_token
|
460
|
-
# The first stage to retrieve. This is used for pagination;
|
461
|
-
# `nextToken` response field.
|
1088
|
+
# The first stage session to retrieve. This is used for pagination;
|
1089
|
+
# see the `nextToken` response field.
|
462
1090
|
# @return [String]
|
463
1091
|
#
|
464
1092
|
# @!attribute [rw] stage_arn
|
@@ -476,8 +1104,8 @@ module Aws::IVSRealTime
|
|
476
1104
|
end
|
477
1105
|
|
478
1106
|
# @!attribute [rw] next_token
|
479
|
-
# If there are more
|
480
|
-
# request to get the next set.
|
1107
|
+
# If there are more stage sessions than `maxResults`, use `nextToken`
|
1108
|
+
# in the request to get the next set.
|
481
1109
|
# @return [String]
|
482
1110
|
#
|
483
1111
|
# @!attribute [rw] stage_sessions
|
@@ -512,7 +1140,7 @@ module Aws::IVSRealTime
|
|
512
1140
|
end
|
513
1141
|
|
514
1142
|
# @!attribute [rw] next_token
|
515
|
-
# If there are more
|
1143
|
+
# If there are more stages than `maxResults`, use `nextToken` in the
|
516
1144
|
# request to get the next set.
|
517
1145
|
# @return [String]
|
518
1146
|
#
|
@@ -529,6 +1157,43 @@ module Aws::IVSRealTime
|
|
529
1157
|
include Aws::Structure
|
530
1158
|
end
|
531
1159
|
|
1160
|
+
# @!attribute [rw] max_results
|
1161
|
+
# Maximum number of storage configurations to return. Default: your
|
1162
|
+
# service quota or 100, whichever is smaller.
|
1163
|
+
# @return [Integer]
|
1164
|
+
#
|
1165
|
+
# @!attribute [rw] next_token
|
1166
|
+
# The first storage configuration to retrieve. This is used for
|
1167
|
+
# pagination; see the `nextToken` response field.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurationsRequest AWS API Documentation
|
1171
|
+
#
|
1172
|
+
class ListStorageConfigurationsRequest < Struct.new(
|
1173
|
+
:max_results,
|
1174
|
+
:next_token)
|
1175
|
+
SENSITIVE = []
|
1176
|
+
include Aws::Structure
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# @!attribute [rw] next_token
|
1180
|
+
# If there are more storage configurations than `maxResults`, use
|
1181
|
+
# `nextToken` in the request to get the next set.
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] storage_configurations
|
1185
|
+
# List of the matching storage configurations.
|
1186
|
+
# @return [Array<Types::StorageConfigurationSummary>]
|
1187
|
+
#
|
1188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurationsResponse AWS API Documentation
|
1189
|
+
#
|
1190
|
+
class ListStorageConfigurationsResponse < Struct.new(
|
1191
|
+
:next_token,
|
1192
|
+
:storage_configurations)
|
1193
|
+
SENSITIVE = []
|
1194
|
+
include Aws::Structure
|
1195
|
+
end
|
1196
|
+
|
532
1197
|
# @!attribute [rw] resource_arn
|
533
1198
|
# The ARN of the resource to be retrieved. The ARN must be
|
534
1199
|
# URL-encoded.
|
@@ -565,11 +1230,31 @@ module Aws::IVSRealTime
|
|
565
1230
|
# identifying, confidential, or sensitive information*.
|
566
1231
|
# @return [Hash<String,String>]
|
567
1232
|
#
|
1233
|
+
# @!attribute [rw] browser_name
|
1234
|
+
# The participant’s browser.
|
1235
|
+
# @return [String]
|
1236
|
+
#
|
1237
|
+
# @!attribute [rw] browser_version
|
1238
|
+
# The participant’s browser version.
|
1239
|
+
# @return [String]
|
1240
|
+
#
|
568
1241
|
# @!attribute [rw] first_join_time
|
569
1242
|
# ISO 8601 timestamp (returned as a string) when the participant first
|
570
1243
|
# joined the stage session.
|
571
1244
|
# @return [Time]
|
572
1245
|
#
|
1246
|
+
# @!attribute [rw] isp_name
|
1247
|
+
# The participant’s Internet Service Provider.
|
1248
|
+
# @return [String]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] os_name
|
1251
|
+
# The participant’s operating system.
|
1252
|
+
# @return [String]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] os_version
|
1255
|
+
# The participant’s operating system version.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
573
1258
|
# @!attribute [rw] participant_id
|
574
1259
|
# Unique identifier for this participant, assigned by IVS.
|
575
1260
|
# @return [String]
|
@@ -578,6 +1263,10 @@ module Aws::IVSRealTime
|
|
578
1263
|
# Whether the participant ever published to the stage session.
|
579
1264
|
# @return [Boolean]
|
580
1265
|
#
|
1266
|
+
# @!attribute [rw] sdk_version
|
1267
|
+
# The participant’s SDK version.
|
1268
|
+
# @return [String]
|
1269
|
+
#
|
581
1270
|
# @!attribute [rw] state
|
582
1271
|
# Whether the participant is connected to or disconnected from the
|
583
1272
|
# stage.
|
@@ -595,9 +1284,15 @@ module Aws::IVSRealTime
|
|
595
1284
|
#
|
596
1285
|
class Participant < Struct.new(
|
597
1286
|
:attributes,
|
1287
|
+
:browser_name,
|
1288
|
+
:browser_version,
|
598
1289
|
:first_join_time,
|
1290
|
+
:isp_name,
|
1291
|
+
:os_name,
|
1292
|
+
:os_version,
|
599
1293
|
:participant_id,
|
600
1294
|
:published,
|
1295
|
+
:sdk_version,
|
601
1296
|
:state,
|
602
1297
|
:user_id)
|
603
1298
|
SENSITIVE = []
|
@@ -754,6 +1449,20 @@ module Aws::IVSRealTime
|
|
754
1449
|
include Aws::Structure
|
755
1450
|
end
|
756
1451
|
|
1452
|
+
# An object representing a configuration to record a stage stream.
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] format
|
1455
|
+
# The recording format for storing a recording in Amazon S3.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1458
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/RecordingConfiguration AWS API Documentation
|
1459
|
+
#
|
1460
|
+
class RecordingConfiguration < Struct.new(
|
1461
|
+
:format)
|
1462
|
+
SENSITIVE = []
|
1463
|
+
include Aws::Structure
|
1464
|
+
end
|
1465
|
+
|
757
1466
|
# @!attribute [rw] exception_message
|
758
1467
|
# Request references a resource which does not exist.
|
759
1468
|
# @return [String]
|
@@ -766,6 +1475,66 @@ module Aws::IVSRealTime
|
|
766
1475
|
include Aws::Structure
|
767
1476
|
end
|
768
1477
|
|
1478
|
+
# A complex type that describes an S3 location where recorded videos
|
1479
|
+
# will be stored.
|
1480
|
+
#
|
1481
|
+
# @!attribute [rw] encoder_configuration_arns
|
1482
|
+
# ARNs of the EncoderConfiguration resource. The encoder configuration
|
1483
|
+
# and stage resources must be in the same AWS account and region.
|
1484
|
+
# @return [Array<String>]
|
1485
|
+
#
|
1486
|
+
# @!attribute [rw] recording_configuration
|
1487
|
+
# Array of maps, each of the form `string:string (key:value)`. This is
|
1488
|
+
# an optional customer specification, currently used only to specify
|
1489
|
+
# the recording format for storing a recording in Amazon S3.
|
1490
|
+
# @return [Types::RecordingConfiguration]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] storage_configuration_arn
|
1493
|
+
# ARN of the StorageConfiguration where recorded videos will be
|
1494
|
+
# stored.
|
1495
|
+
# @return [String]
|
1496
|
+
#
|
1497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/S3DestinationConfiguration AWS API Documentation
|
1498
|
+
#
|
1499
|
+
class S3DestinationConfiguration < Struct.new(
|
1500
|
+
:encoder_configuration_arns,
|
1501
|
+
:recording_configuration,
|
1502
|
+
:storage_configuration_arn)
|
1503
|
+
SENSITIVE = []
|
1504
|
+
include Aws::Structure
|
1505
|
+
end
|
1506
|
+
|
1507
|
+
# Complex data type that defines S3Detail objects.
|
1508
|
+
#
|
1509
|
+
# @!attribute [rw] recording_prefix
|
1510
|
+
# The S3 bucket prefix under which the recording is stored.
|
1511
|
+
# @return [String]
|
1512
|
+
#
|
1513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/S3Detail AWS API Documentation
|
1514
|
+
#
|
1515
|
+
class S3Detail < Struct.new(
|
1516
|
+
:recording_prefix)
|
1517
|
+
SENSITIVE = []
|
1518
|
+
include Aws::Structure
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# A complex type that describes an S3 location where recorded videos
|
1522
|
+
# will be stored.
|
1523
|
+
#
|
1524
|
+
# @!attribute [rw] bucket_name
|
1525
|
+
# Location (S3 bucket name) where recorded videos will be stored. Note
|
1526
|
+
# that the StorageConfiguration and S3 bucket must be in the same
|
1527
|
+
# region as the Composition.
|
1528
|
+
# @return [String]
|
1529
|
+
#
|
1530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/S3StorageConfiguration AWS API Documentation
|
1531
|
+
#
|
1532
|
+
class S3StorageConfiguration < Struct.new(
|
1533
|
+
:bucket_name)
|
1534
|
+
SENSITIVE = []
|
1535
|
+
include Aws::Structure
|
1536
|
+
end
|
1537
|
+
|
769
1538
|
# @!attribute [rw] exception_message
|
770
1539
|
# Request would cause a service quota to be exceeded.
|
771
1540
|
# @return [String]
|
@@ -908,6 +1677,154 @@ module Aws::IVSRealTime
|
|
908
1677
|
include Aws::Structure
|
909
1678
|
end
|
910
1679
|
|
1680
|
+
# @!attribute [rw] destinations
|
1681
|
+
# Array of destination configuration.
|
1682
|
+
# @return [Array<Types::DestinationConfiguration>]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] idempotency_token
|
1685
|
+
# Idempotency token.
|
1686
|
+
#
|
1687
|
+
# **A suitable default value is auto-generated.** You should normally
|
1688
|
+
# not need to pass this option.
|
1689
|
+
# @return [String]
|
1690
|
+
#
|
1691
|
+
# @!attribute [rw] layout
|
1692
|
+
# Layout object to configure composition parameters.
|
1693
|
+
# @return [Types::LayoutConfiguration]
|
1694
|
+
#
|
1695
|
+
# @!attribute [rw] stage_arn
|
1696
|
+
# ARN of the stage to be used for compositing.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] tags
|
1700
|
+
# Tags attached to the resource. Array of maps, each of the form
|
1701
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
1702
|
+
# details, including restrictions that apply to tags and "Tag naming
|
1703
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
1704
|
+
# beyond what is documented there.
|
1705
|
+
#
|
1706
|
+
#
|
1707
|
+
#
|
1708
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1709
|
+
# @return [Hash<String,String>]
|
1710
|
+
#
|
1711
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartCompositionRequest AWS API Documentation
|
1712
|
+
#
|
1713
|
+
class StartCompositionRequest < Struct.new(
|
1714
|
+
:destinations,
|
1715
|
+
:idempotency_token,
|
1716
|
+
:layout,
|
1717
|
+
:stage_arn,
|
1718
|
+
:tags)
|
1719
|
+
SENSITIVE = []
|
1720
|
+
include Aws::Structure
|
1721
|
+
end
|
1722
|
+
|
1723
|
+
# @!attribute [rw] composition
|
1724
|
+
# The Composition that was created.
|
1725
|
+
# @return [Types::Composition]
|
1726
|
+
#
|
1727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartCompositionResponse AWS API Documentation
|
1728
|
+
#
|
1729
|
+
class StartCompositionResponse < Struct.new(
|
1730
|
+
:composition)
|
1731
|
+
SENSITIVE = []
|
1732
|
+
include Aws::Structure
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# @!attribute [rw] arn
|
1736
|
+
# ARN of the Composition.
|
1737
|
+
# @return [String]
|
1738
|
+
#
|
1739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StopCompositionRequest AWS API Documentation
|
1740
|
+
#
|
1741
|
+
class StopCompositionRequest < Struct.new(
|
1742
|
+
:arn)
|
1743
|
+
SENSITIVE = []
|
1744
|
+
include Aws::Structure
|
1745
|
+
end
|
1746
|
+
|
1747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StopCompositionResponse AWS API Documentation
|
1748
|
+
#
|
1749
|
+
class StopCompositionResponse < Aws::EmptyStructure; end
|
1750
|
+
|
1751
|
+
# A complex type that describes a location where recorded videos will be
|
1752
|
+
# stored.
|
1753
|
+
#
|
1754
|
+
# @!attribute [rw] arn
|
1755
|
+
# ARN of the storage configuration.
|
1756
|
+
# @return [String]
|
1757
|
+
#
|
1758
|
+
# @!attribute [rw] name
|
1759
|
+
# Name of the storage configuration.
|
1760
|
+
# @return [String]
|
1761
|
+
#
|
1762
|
+
# @!attribute [rw] s3
|
1763
|
+
# An S3 destination configuration where recorded videos will be
|
1764
|
+
# stored.
|
1765
|
+
# @return [Types::S3StorageConfiguration]
|
1766
|
+
#
|
1767
|
+
# @!attribute [rw] tags
|
1768
|
+
# Tags attached to the resource. Array of maps, each of the form
|
1769
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
1770
|
+
# details, including restrictions that apply to tags and "Tag naming
|
1771
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
1772
|
+
# beyond what is documented there.
|
1773
|
+
#
|
1774
|
+
#
|
1775
|
+
#
|
1776
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1777
|
+
# @return [Hash<String,String>]
|
1778
|
+
#
|
1779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StorageConfiguration AWS API Documentation
|
1780
|
+
#
|
1781
|
+
class StorageConfiguration < Struct.new(
|
1782
|
+
:arn,
|
1783
|
+
:name,
|
1784
|
+
:s3,
|
1785
|
+
:tags)
|
1786
|
+
SENSITIVE = []
|
1787
|
+
include Aws::Structure
|
1788
|
+
end
|
1789
|
+
|
1790
|
+
# Summary information about a storage configuration.
|
1791
|
+
#
|
1792
|
+
# @!attribute [rw] arn
|
1793
|
+
# ARN of the storage configuration.
|
1794
|
+
# @return [String]
|
1795
|
+
#
|
1796
|
+
# @!attribute [rw] name
|
1797
|
+
# Name of the storage configuration.
|
1798
|
+
# @return [String]
|
1799
|
+
#
|
1800
|
+
# @!attribute [rw] s3
|
1801
|
+
# An S3 destination configuration where recorded videos will be
|
1802
|
+
# stored.
|
1803
|
+
# @return [Types::S3StorageConfiguration]
|
1804
|
+
#
|
1805
|
+
# @!attribute [rw] tags
|
1806
|
+
# Tags attached to the resource. Array of maps, each of the form
|
1807
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
1808
|
+
# details, including restrictions that apply to tags and "Tag naming
|
1809
|
+
# limits and requirements"; Amazon IVS has no constraints on tags
|
1810
|
+
# beyond what is documented there.
|
1811
|
+
#
|
1812
|
+
#
|
1813
|
+
#
|
1814
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1815
|
+
# @return [Hash<String,String>]
|
1816
|
+
#
|
1817
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StorageConfigurationSummary AWS API Documentation
|
1818
|
+
#
|
1819
|
+
class StorageConfigurationSummary < Struct.new(
|
1820
|
+
:arn,
|
1821
|
+
:name,
|
1822
|
+
:s3,
|
1823
|
+
:tags)
|
1824
|
+
SENSITIVE = []
|
1825
|
+
include Aws::Structure
|
1826
|
+
end
|
1827
|
+
|
911
1828
|
# @!attribute [rw] resource_arn
|
912
1829
|
# The ARN of the resource to be tagged. The ARN must be URL-encoded.
|
913
1830
|
# @return [String]
|
@@ -1008,5 +1925,38 @@ module Aws::IVSRealTime
|
|
1008
1925
|
include Aws::Structure
|
1009
1926
|
end
|
1010
1927
|
|
1928
|
+
# Settings for video.
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] bitrate
|
1931
|
+
# Bitrate for generated output, in bps. Default: 2500000.
|
1932
|
+
# @return [Integer]
|
1933
|
+
#
|
1934
|
+
# @!attribute [rw] framerate
|
1935
|
+
# Video frame rate, in fps. Default: 30.
|
1936
|
+
# @return [Float]
|
1937
|
+
#
|
1938
|
+
# @!attribute [rw] height
|
1939
|
+
# Video-resolution height. Note that the maximum value is determined
|
1940
|
+
# by `width` times `height`, such that the maximum total pixels is
|
1941
|
+
# 2073600 (1920x1080 or 1080x1920). Default: 720.
|
1942
|
+
# @return [Integer]
|
1943
|
+
#
|
1944
|
+
# @!attribute [rw] width
|
1945
|
+
# Video-resolution width. Note that the maximum value is determined by
|
1946
|
+
# `width` times `height`, such that the maximum total pixels is
|
1947
|
+
# 2073600 (1920x1080 or 1080x1920). Default: 1280.
|
1948
|
+
# @return [Integer]
|
1949
|
+
#
|
1950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Video AWS API Documentation
|
1951
|
+
#
|
1952
|
+
class Video < Struct.new(
|
1953
|
+
:bitrate,
|
1954
|
+
:framerate,
|
1955
|
+
:height,
|
1956
|
+
:width)
|
1957
|
+
SENSITIVE = []
|
1958
|
+
include Aws::Structure
|
1959
|
+
end
|
1960
|
+
|
1011
1961
|
end
|
1012
1962
|
end
|