aws-sdk-ivsrealtime 1.25.0 → 1.27.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -93,14 +93,15 @@ module Aws::IVSRealTime
93
93
  #
94
94
  # @!attribute [rw] tags
95
95
  # Tags attached to the resource. Array of maps, each of the form
96
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
97
- # details, including restrictions that apply to tags and "Tag naming
98
- # limits and requirements"; Amazon IVS has no constraints on tags
99
- # beyond what is documented there.
96
+ # `string:string (key:value)`. See [Best practices and strategies][1]
97
+ # in *Tagging AWS Resources and Tag Editor* for details, including
98
+ # restrictions that apply to tags and "Tag naming limits and
99
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
100
+ # documented there.
100
101
  #
101
102
  #
102
103
  #
103
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
104
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
104
105
  # @return [Hash<String,String>]
105
106
  #
106
107
  # @!attribute [rw] start_time
@@ -148,14 +149,15 @@ module Aws::IVSRealTime
148
149
  #
149
150
  # @!attribute [rw] tags
150
151
  # Tags attached to the resource. Array of maps, each of the form
151
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
152
- # details, including restrictions that apply to tags and "Tag naming
153
- # limits and requirements"; Amazon IVS has no constraints on tags
154
- # beyond what is documented there.
152
+ # `string:string (key:value)`. See [Best practices and strategies][1]
153
+ # in *Tagging AWS Resources and Tag Editor* for details, including
154
+ # restrictions that apply to tags and "Tag naming limits and
155
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
156
+ # documented there.
155
157
  #
156
158
  #
157
159
  #
158
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
160
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
159
161
  # @return [Hash<String,String>]
160
162
  #
161
163
  # @!attribute [rw] start_time
@@ -205,14 +207,15 @@ module Aws::IVSRealTime
205
207
  #
206
208
  # @!attribute [rw] tags
207
209
  # Tags attached to the resource. Array of maps, each of the form
208
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
209
- # details, including restrictions that apply to tags and "Tag naming
210
- # limits and requirements"; Amazon IVS has no constraints on tags
211
- # beyond what is documented there.
210
+ # `string:string (key:value)`. See [Best practices and strategies][1]
211
+ # in *Tagging AWS Resources and Tag Editor* for details, including
212
+ # restrictions that apply to tags and "Tag naming limits and
213
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
214
+ # documented there.
212
215
  #
213
216
  #
214
217
  #
215
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
218
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
216
219
  # @return [Hash<String,String>]
217
220
  #
218
221
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfigurationRequest AWS API Documentation
@@ -237,6 +240,81 @@ module Aws::IVSRealTime
237
240
  include Aws::Structure
238
241
  end
239
242
 
243
+ # @!attribute [rw] name
244
+ # Optional name that can be specified for the IngestConfiguration
245
+ # being created.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] stage_arn
249
+ # ARN of the stage with which the IngestConfiguration is associated.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] user_id
253
+ # Customer-assigned name to help identify the participant using the
254
+ # IngestConfiguration; this can be used to link a participant to a
255
+ # user in the customer’s own systems. This can be any UTF-8 encoded
256
+ # text. *This field is exposed to all stage participants and should
257
+ # not be used for personally identifying, confidential, or sensitive
258
+ # information.*
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] attributes
262
+ # Application-provided attributes to store in the IngestConfiguration
263
+ # and attach to a stage. Map keys and values can contain UTF-8 encoded
264
+ # text. The maximum length of this field is 1 KB total. *This field is
265
+ # exposed to all stage participants and should not be used for
266
+ # personally identifying, confidential, or sensitive information.*
267
+ # @return [Hash<String,String>]
268
+ #
269
+ # @!attribute [rw] ingest_protocol
270
+ # Type of ingest protocol that the user employs to broadcast. If this
271
+ # is set to `RTMP`, `insecureIngest` must be set to `true`.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] insecure_ingest
275
+ # Whether the stage allows insecure RTMP ingest. This must be set to
276
+ # `true`, if `ingestProtocol` is set to `RTMP`. Default: `false`.
277
+ # @return [Boolean]
278
+ #
279
+ # @!attribute [rw] tags
280
+ # Tags attached to the resource. Array of maps, each of the form
281
+ # `string:string (key:value)`. See [Best practices and strategies][1]
282
+ # in *Tagging AWS Resources and Tag Editor* for details, including
283
+ # restrictions that apply to tags and "Tag naming limits and
284
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
285
+ # documented there.
286
+ #
287
+ #
288
+ #
289
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
290
+ # @return [Hash<String,String>]
291
+ #
292
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateIngestConfigurationRequest AWS API Documentation
293
+ #
294
+ class CreateIngestConfigurationRequest < Struct.new(
295
+ :name,
296
+ :stage_arn,
297
+ :user_id,
298
+ :attributes,
299
+ :ingest_protocol,
300
+ :insecure_ingest,
301
+ :tags)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # @!attribute [rw] ingest_configuration
307
+ # The IngestConfiguration that was created.
308
+ # @return [Types::IngestConfiguration]
309
+ #
310
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateIngestConfigurationResponse AWS API Documentation
311
+ #
312
+ class CreateIngestConfigurationResponse < Struct.new(
313
+ :ingest_configuration)
314
+ SENSITIVE = []
315
+ include Aws::Structure
316
+ end
317
+
240
318
  # @!attribute [rw] stage_arn
241
319
  # ARN of the stage to which this token is scoped.
242
320
  # @return [String]
@@ -301,14 +379,15 @@ module Aws::IVSRealTime
301
379
  #
302
380
  # @!attribute [rw] tags
303
381
  # Tags attached to the resource. Array of maps, each of the form
304
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
305
- # details, including restrictions that apply to tags and "Tag naming
306
- # limits and requirements"; Amazon IVS has no constraints on tags
307
- # beyond what is documented there.
382
+ # `string:string (key:value)`. See [Best practices and strategies][1]
383
+ # in *Tagging AWS Resources and Tag Editor* for details, including
384
+ # restrictions that apply to tags and "Tag naming limits and
385
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
386
+ # documented there.
308
387
  #
309
388
  #
310
389
  #
311
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
390
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
312
391
  # @return [Hash<String,String>]
313
392
  #
314
393
  # @!attribute [rw] auto_participant_recording_configuration
@@ -356,14 +435,15 @@ module Aws::IVSRealTime
356
435
  #
357
436
  # @!attribute [rw] tags
358
437
  # Tags attached to the resource. Array of maps, each of the form
359
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
360
- # details, including restrictions that apply to tags and "Tag naming
361
- # limits and requirements"; Amazon IVS has no constraints on tags
362
- # beyond what is documented there.
438
+ # `string:string (key:value)`. See [Best practices and strategies][1]
439
+ # in *Tagging AWS Resources and Tag Editor* for details, including
440
+ # restrictions that apply to tags and "Tag naming limits and
441
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
442
+ # documented there.
363
443
  #
364
444
  #
365
445
  #
366
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
446
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
367
447
  # @return [Hash<String,String>]
368
448
  #
369
449
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStorageConfigurationRequest AWS API Documentation
@@ -404,6 +484,30 @@ module Aws::IVSRealTime
404
484
  #
405
485
  class DeleteEncoderConfigurationResponse < Aws::EmptyStructure; end
406
486
 
487
+ # @!attribute [rw] arn
488
+ # ARN of the IngestConfiguration.
489
+ # @return [String]
490
+ #
491
+ # @!attribute [rw] force
492
+ # Optional field to force deletion of the IngestConfiguration. If this
493
+ # is set to `true` when a participant is actively publishing, the
494
+ # participant is disconnected from the stage, followed by deletion of
495
+ # the IngestConfiguration. Default: `false`.
496
+ # @return [Boolean]
497
+ #
498
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteIngestConfigurationRequest AWS API Documentation
499
+ #
500
+ class DeleteIngestConfigurationRequest < Struct.new(
501
+ :arn,
502
+ :force)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
507
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteIngestConfigurationResponse AWS API Documentation
508
+ #
509
+ class DeleteIngestConfigurationResponse < Aws::EmptyStructure; end
510
+
407
511
  # @!attribute [rw] arn
408
512
  # ARN of the public key to be deleted.
409
513
  # @return [String]
@@ -569,8 +673,10 @@ module Aws::IVSRealTime
569
673
  # @return [String]
570
674
  #
571
675
  # @!attribute [rw] participant_id
572
- # Identifier of the participant to be disconnected. This is assigned
573
- # by IVS and returned by CreateParticipantToken.
676
+ # Identifier of the participant to be disconnected. IVS assigns this;
677
+ # it is returned by CreateParticipantToken (for streams using WebRTC
678
+ # ingest) or CreateIngestConfiguration (for streams using RTMP
679
+ # ingest).
574
680
  # @return [String]
575
681
  #
576
682
  # @!attribute [rw] reason
@@ -608,14 +714,15 @@ module Aws::IVSRealTime
608
714
  #
609
715
  # @!attribute [rw] tags
610
716
  # Tags attached to the resource. Array of maps, each of the form
611
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
612
- # details, including restrictions that apply to tags and "Tag naming
613
- # limits and requirements"; Amazon IVS has no constraints on tags
614
- # beyond what is documented there.
717
+ # `string:string (key:value)`. See [Best practices and strategies][1]
718
+ # in *Tagging AWS Resources and Tag Editor* for details, including
719
+ # restrictions that apply to tags and "Tag naming limits and
720
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
721
+ # documented there.
615
722
  #
616
723
  #
617
724
  #
618
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
725
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
619
726
  # @return [Hash<String,String>]
620
727
  #
621
728
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/EncoderConfiguration AWS API Documentation
@@ -641,14 +748,15 @@ module Aws::IVSRealTime
641
748
  #
642
749
  # @!attribute [rw] tags
643
750
  # Tags attached to the resource. Array of maps, each of the form
644
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
645
- # details, including restrictions that apply to tags and "Tag naming
646
- # limits and requirements"; Amazon IVS has no constraints on tags
647
- # beyond what is documented there.
751
+ # `string:string (key:value)`. See [Best practices and strategies][1]
752
+ # in *Tagging AWS Resources and Tag Editor* for details, including
753
+ # restrictions that apply to tags and "Tag naming limits and
754
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
755
+ # documented there.
648
756
  #
649
757
  #
650
758
  #
651
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
759
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
652
760
  # @return [Hash<String,String>]
653
761
  #
654
762
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/EncoderConfigurationSummary AWS API Documentation
@@ -761,6 +869,30 @@ module Aws::IVSRealTime
761
869
  include Aws::Structure
762
870
  end
763
871
 
872
+ # @!attribute [rw] arn
873
+ # ARN of the ingest for which the information is to be retrieved.
874
+ # @return [String]
875
+ #
876
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetIngestConfigurationRequest AWS API Documentation
877
+ #
878
+ class GetIngestConfigurationRequest < Struct.new(
879
+ :arn)
880
+ SENSITIVE = []
881
+ include Aws::Structure
882
+ end
883
+
884
+ # @!attribute [rw] ingest_configuration
885
+ # The IngestConfiguration that was returned.
886
+ # @return [Types::IngestConfiguration]
887
+ #
888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetIngestConfigurationResponse AWS API Documentation
889
+ #
890
+ class GetIngestConfigurationResponse < Struct.new(
891
+ :ingest_configuration)
892
+ SENSITIVE = []
893
+ include Aws::Structure
894
+ end
895
+
764
896
  # @!attribute [rw] stage_arn
765
897
  # Stage ARN.
766
898
  # @return [String]
@@ -956,14 +1088,15 @@ module Aws::IVSRealTime
956
1088
  #
957
1089
  # @!attribute [rw] tags
958
1090
  # Tags attached to the resource. Array of maps, each of the form
959
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
960
- # details, including restrictions that apply to tags and "Tag naming
961
- # limits and requirements"; Amazon IVS has no constraints on tags
962
- # beyond what is documented there.
1091
+ # `string:string (key:value)`. See [Best practices and strategies][1]
1092
+ # in *Tagging AWS Resources and Tag Editor* for details, including
1093
+ # restrictions that apply to tags and "Tag naming limits and
1094
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
1095
+ # documented there.
963
1096
  #
964
1097
  #
965
1098
  #
966
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1099
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
967
1100
  # @return [Hash<String,String>]
968
1101
  #
969
1102
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ImportPublicKeyRequest AWS API Documentation
@@ -988,6 +1121,137 @@ module Aws::IVSRealTime
988
1121
  include Aws::Structure
989
1122
  end
990
1123
 
1124
+ # Object specifying an ingest configuration.
1125
+ #
1126
+ # @!attribute [rw] name
1127
+ # Ingest name
1128
+ # @return [String]
1129
+ #
1130
+ # @!attribute [rw] arn
1131
+ # Ingest configuration ARN.
1132
+ # @return [String]
1133
+ #
1134
+ # @!attribute [rw] ingest_protocol
1135
+ # Type of ingest protocol that the user employs for broadcasting.
1136
+ # @return [String]
1137
+ #
1138
+ # @!attribute [rw] stream_key
1139
+ # Ingest-key value for the RTMP(S) protocol.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] stage_arn
1143
+ # ARN of the stage with which the IngestConfiguration is associated.
1144
+ # @return [String]
1145
+ #
1146
+ # @!attribute [rw] participant_id
1147
+ # ID of the participant within the stage.
1148
+ # @return [String]
1149
+ #
1150
+ # @!attribute [rw] state
1151
+ # State of the ingest configuration. It is `ACTIVE` if a publisher
1152
+ # currently is publishing to the stage associated with the ingest
1153
+ # configuration.
1154
+ # @return [String]
1155
+ #
1156
+ # @!attribute [rw] user_id
1157
+ # Customer-assigned name to help identify the participant using the
1158
+ # IngestConfiguration; this can be used to link a participant to a
1159
+ # user in the customer’s own systems. This can be any UTF-8 encoded
1160
+ # text. *This field is exposed to all stage participants and should
1161
+ # not be used for personally identifying, confidential, or sensitive
1162
+ # information.*
1163
+ # @return [String]
1164
+ #
1165
+ # @!attribute [rw] attributes
1166
+ # Application-provided attributes to to store in the
1167
+ # IngestConfiguration and attach to a stage. Map keys and values can
1168
+ # contain UTF-8 encoded text. The maximum length of this field is 1 KB
1169
+ # total. *This field is exposed to all stage participants and should
1170
+ # not be used for personally identifying, confidential, or sensitive
1171
+ # information.*
1172
+ # @return [Hash<String,String>]
1173
+ #
1174
+ # @!attribute [rw] tags
1175
+ # Tags attached to the resource. Array of maps, each of the form
1176
+ # `string:string (key:value)`. See [Best practices and strategies][1]
1177
+ # in *Tagging AWS Resources and Tag Editor* for details, including
1178
+ # restrictions that apply to tags and "Tag naming limits and
1179
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
1180
+ # documented there.
1181
+ #
1182
+ #
1183
+ #
1184
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1185
+ # @return [Hash<String,String>]
1186
+ #
1187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/IngestConfiguration AWS API Documentation
1188
+ #
1189
+ class IngestConfiguration < Struct.new(
1190
+ :name,
1191
+ :arn,
1192
+ :ingest_protocol,
1193
+ :stream_key,
1194
+ :stage_arn,
1195
+ :participant_id,
1196
+ :state,
1197
+ :user_id,
1198
+ :attributes,
1199
+ :tags)
1200
+ SENSITIVE = [:stream_key]
1201
+ include Aws::Structure
1202
+ end
1203
+
1204
+ # Summary information about an IngestConfiguration.
1205
+ #
1206
+ # @!attribute [rw] name
1207
+ # Ingest name.
1208
+ # @return [String]
1209
+ #
1210
+ # @!attribute [rw] arn
1211
+ # Ingest configuration ARN.
1212
+ # @return [String]
1213
+ #
1214
+ # @!attribute [rw] ingest_protocol
1215
+ # Type of ingest protocol that the user employs for broadcasting.
1216
+ # @return [String]
1217
+ #
1218
+ # @!attribute [rw] stage_arn
1219
+ # ARN of the stage with which the IngestConfiguration is associated.
1220
+ # @return [String]
1221
+ #
1222
+ # @!attribute [rw] participant_id
1223
+ # ID of the participant within the stage.
1224
+ # @return [String]
1225
+ #
1226
+ # @!attribute [rw] state
1227
+ # State of the ingest configuration. It is `ACTIVE` if a publisher
1228
+ # currently is publishing to the stage associated with the ingest
1229
+ # configuration.
1230
+ # @return [String]
1231
+ #
1232
+ # @!attribute [rw] user_id
1233
+ # Customer-assigned name to help identify the participant using the
1234
+ # IngestConfiguration; this can be used to link a participant to a
1235
+ # user in the customer’s own systems. This can be any UTF-8 encoded
1236
+ # text. *This field is exposed to all stage participants and should
1237
+ # not be used for personally identifying, confidential, or sensitive
1238
+ # information.*
1239
+ # @return [String]
1240
+ #
1241
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/IngestConfigurationSummary AWS API Documentation
1242
+ #
1243
+ class IngestConfigurationSummary < Struct.new(
1244
+ :name,
1245
+ :arn,
1246
+ :ingest_protocol,
1247
+ :stage_arn,
1248
+ :participant_id,
1249
+ :state,
1250
+ :user_id)
1251
+ SENSITIVE = []
1252
+ include Aws::Structure
1253
+ end
1254
+
991
1255
  # @!attribute [rw] exception_message
992
1256
  # Unexpected error during processing of request.
993
1257
  # @return [String]
@@ -1104,6 +1368,55 @@ module Aws::IVSRealTime
1104
1368
  include Aws::Structure
1105
1369
  end
1106
1370
 
1371
+ # @!attribute [rw] filter_by_stage_arn
1372
+ # Filters the response list to match the specified stage ARN. Only one
1373
+ # filter (by stage ARN or by state) can be used at a time.
1374
+ # @return [String]
1375
+ #
1376
+ # @!attribute [rw] filter_by_state
1377
+ # Filters the response list to match the specified state. Only one
1378
+ # filter (by stage ARN or by state) can be used at a time.
1379
+ # @return [String]
1380
+ #
1381
+ # @!attribute [rw] next_token
1382
+ # The first IngestConfiguration to retrieve. This is used for
1383
+ # pagination; see the `nextToken` response field.
1384
+ # @return [String]
1385
+ #
1386
+ # @!attribute [rw] max_results
1387
+ # Maximum number of results to return. Default: 50.
1388
+ # @return [Integer]
1389
+ #
1390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListIngestConfigurationsRequest AWS API Documentation
1391
+ #
1392
+ class ListIngestConfigurationsRequest < Struct.new(
1393
+ :filter_by_stage_arn,
1394
+ :filter_by_state,
1395
+ :next_token,
1396
+ :max_results)
1397
+ SENSITIVE = []
1398
+ include Aws::Structure
1399
+ end
1400
+
1401
+ # @!attribute [rw] ingest_configurations
1402
+ # List of the matching ingest configurations (summary information
1403
+ # only).
1404
+ # @return [Array<Types::IngestConfigurationSummary>]
1405
+ #
1406
+ # @!attribute [rw] next_token
1407
+ # If there are more IngestConfigurations than `maxResults`, use
1408
+ # `nextToken` in the request to get the next set.
1409
+ # @return [String]
1410
+ #
1411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListIngestConfigurationsResponse AWS API Documentation
1412
+ #
1413
+ class ListIngestConfigurationsResponse < Struct.new(
1414
+ :ingest_configurations,
1415
+ :next_token)
1416
+ SENSITIVE = []
1417
+ include Aws::Structure
1418
+ end
1419
+
1107
1420
  # @!attribute [rw] stage_arn
1108
1421
  # Stage ARN.
1109
1422
  # @return [String]
@@ -1487,6 +1800,11 @@ module Aws::IVSRealTime
1487
1800
  # The participant’s recording state.
1488
1801
  # @return [String]
1489
1802
  #
1803
+ # @!attribute [rw] protocol
1804
+ # Type of ingest protocol that the participant employs for
1805
+ # broadcasting.
1806
+ # @return [String]
1807
+ #
1490
1808
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/Participant AWS API Documentation
1491
1809
  #
1492
1810
  class Participant < Struct.new(
@@ -1504,7 +1822,8 @@ module Aws::IVSRealTime
1504
1822
  :sdk_version,
1505
1823
  :recording_s3_bucket_name,
1506
1824
  :recording_s3_prefix,
1507
- :recording_state)
1825
+ :recording_state,
1826
+ :protocol)
1508
1827
  SENSITIVE = []
1509
1828
  include Aws::Structure
1510
1829
  end
@@ -1767,14 +2086,15 @@ module Aws::IVSRealTime
1767
2086
  #
1768
2087
  # @!attribute [rw] tags
1769
2088
  # Tags attached to the resource. Array of maps, each of the form
1770
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1771
- # details, including restrictions that apply to tags and "Tag naming
1772
- # limits and requirements"; Amazon IVS has no constraints on tags
1773
- # beyond what is documented there.
2089
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2090
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2091
+ # restrictions that apply to tags and "Tag naming limits and
2092
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2093
+ # documented there.
1774
2094
  #
1775
2095
  #
1776
2096
  #
1777
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2097
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1778
2098
  # @return [Hash<String,String>]
1779
2099
  #
1780
2100
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/PublicKey AWS API Documentation
@@ -1801,14 +2121,15 @@ module Aws::IVSRealTime
1801
2121
  #
1802
2122
  # @!attribute [rw] tags
1803
2123
  # Tags attached to the resource. Array of maps, each of the form
1804
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1805
- # details, including restrictions that apply to tags and "Tag naming
1806
- # limits and requirements"; Amazon IVS has no constraints on tags
1807
- # beyond what is documented there.
2124
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2125
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2126
+ # restrictions that apply to tags and "Tag naming limits and
2127
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2128
+ # documented there.
1808
2129
  #
1809
2130
  #
1810
2131
  #
1811
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2132
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1812
2133
  # @return [Hash<String,String>]
1813
2134
  #
1814
2135
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/PublicKeySummary AWS API Documentation
@@ -1935,14 +2256,15 @@ module Aws::IVSRealTime
1935
2256
  #
1936
2257
  # @!attribute [rw] tags
1937
2258
  # Tags attached to the resource. Array of maps, each of the form
1938
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1939
- # details, including restrictions that apply to tags and "Tag naming
1940
- # limits and requirements"; Amazon IVS has no constraints on tags
1941
- # beyond what is documented there.
2259
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2260
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2261
+ # restrictions that apply to tags and "Tag naming limits and
2262
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2263
+ # documented there.
1942
2264
  #
1943
2265
  #
1944
2266
  #
1945
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2267
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1946
2268
  # @return [Hash<String,String>]
1947
2269
  #
1948
2270
  # @!attribute [rw] auto_participant_recording_configuration
@@ -1967,21 +2289,36 @@ module Aws::IVSRealTime
1967
2289
  include Aws::Structure
1968
2290
  end
1969
2291
 
1970
- # Summary information about various endpoints for a stage.
2292
+ # Summary information about various endpoints for a stage. We recommend
2293
+ # that you cache these values at stage creation; the values can be
2294
+ # cached for up to 14 days.
1971
2295
  #
1972
2296
  # @!attribute [rw] events
1973
2297
  # Events endpoint.
1974
2298
  # @return [String]
1975
2299
  #
1976
2300
  # @!attribute [rw] whip
1977
- # WHIP endpoint.
2301
+ # The endpoint to be used for IVS real-time streaming using the WHIP
2302
+ # protocol.
2303
+ # @return [String]
2304
+ #
2305
+ # @!attribute [rw] rtmp
2306
+ # The endpoint to be used for IVS real-time streaming using the RTMP
2307
+ # protocol.
2308
+ # @return [String]
2309
+ #
2310
+ # @!attribute [rw] rtmps
2311
+ # The endpoint to be used for IVS real-time streaming using the RTMPS
2312
+ # protocol.
1978
2313
  # @return [String]
1979
2314
  #
1980
2315
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StageEndpoints AWS API Documentation
1981
2316
  #
1982
2317
  class StageEndpoints < Struct.new(
1983
2318
  :events,
1984
- :whip)
2319
+ :whip,
2320
+ :rtmp,
2321
+ :rtmps)
1985
2322
  SENSITIVE = []
1986
2323
  include Aws::Structure
1987
2324
  end
@@ -2058,14 +2395,15 @@ module Aws::IVSRealTime
2058
2395
  #
2059
2396
  # @!attribute [rw] tags
2060
2397
  # Tags attached to the resource. Array of maps, each of the form
2061
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
2062
- # details, including restrictions that apply to tags and "Tag naming
2063
- # limits and requirements"; Amazon IVS has no constraints on tags
2064
- # beyond what is documented there.
2398
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2399
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2400
+ # restrictions that apply to tags and "Tag naming limits and
2401
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2402
+ # documented there.
2065
2403
  #
2066
2404
  #
2067
2405
  #
2068
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2406
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2069
2407
  # @return [Hash<String,String>]
2070
2408
  #
2071
2409
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StageSummary AWS API Documentation
@@ -2100,14 +2438,15 @@ module Aws::IVSRealTime
2100
2438
  #
2101
2439
  # @!attribute [rw] tags
2102
2440
  # Tags attached to the resource. Array of maps, each of the form
2103
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
2104
- # details, including restrictions that apply to tags and "Tag naming
2105
- # limits and requirements"; Amazon IVS has no constraints on tags
2106
- # beyond what is documented there.
2441
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2442
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2443
+ # restrictions that apply to tags and "Tag naming limits and
2444
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2445
+ # documented there.
2107
2446
  #
2108
2447
  #
2109
2448
  #
2110
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2449
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2111
2450
  # @return [Hash<String,String>]
2112
2451
  #
2113
2452
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartCompositionRequest AWS API Documentation
@@ -2168,14 +2507,15 @@ module Aws::IVSRealTime
2168
2507
  #
2169
2508
  # @!attribute [rw] tags
2170
2509
  # Tags attached to the resource. Array of maps, each of the form
2171
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
2172
- # details, including restrictions that apply to tags and "Tag naming
2173
- # limits and requirements"; Amazon IVS has no constraints on tags
2174
- # beyond what is documented there.
2510
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2511
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2512
+ # restrictions that apply to tags and "Tag naming limits and
2513
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2514
+ # documented there.
2175
2515
  #
2176
2516
  #
2177
2517
  #
2178
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2518
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2179
2519
  # @return [Hash<String,String>]
2180
2520
  #
2181
2521
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StorageConfiguration AWS API Documentation
@@ -2206,14 +2546,15 @@ module Aws::IVSRealTime
2206
2546
  #
2207
2547
  # @!attribute [rw] tags
2208
2548
  # Tags attached to the resource. Array of maps, each of the form
2209
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
2210
- # details, including restrictions that apply to tags and "Tag naming
2211
- # limits and requirements"; Amazon IVS has no constraints on tags
2212
- # beyond what is documented there.
2549
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2550
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2551
+ # restrictions that apply to tags and "Tag naming limits and
2552
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2553
+ # documented there.
2213
2554
  #
2214
2555
  #
2215
2556
  #
2216
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2557
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2217
2558
  # @return [Hash<String,String>]
2218
2559
  #
2219
2560
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StorageConfigurationSummary AWS API Documentation
@@ -2233,14 +2574,15 @@ module Aws::IVSRealTime
2233
2574
  #
2234
2575
  # @!attribute [rw] tags
2235
2576
  # Array of tags to be added or updated. Array of maps, each of the
2236
- # form `string:string (key:value)`. See [Tagging AWS Resources][1] for
2577
+ # form `string:string (key:value)`. See [Best practices and
2578
+ # strategies][1] in *Tagging AWS Resources and Tag Editor* for
2237
2579
  # details, including restrictions that apply to tags and "Tag naming
2238
- # limits and requirements"; Amazon IVS has no constraints beyond what
2239
- # is documented there.
2580
+ # limits and requirements"; Amazon IVS has no constraints on tags
2581
+ # beyond what is documented there.
2240
2582
  #
2241
2583
  #
2242
2584
  #
2243
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2585
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2244
2586
  # @return [Hash<String,String>]
2245
2587
  #
2246
2588
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/TagResourceRequest AWS API Documentation
@@ -2262,14 +2604,15 @@ module Aws::IVSRealTime
2262
2604
  #
2263
2605
  # @!attribute [rw] tag_keys
2264
2606
  # Array of tags to be removed. Array of maps, each of the form
2265
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
2266
- # details, including restrictions that apply to tags and "Tag naming
2267
- # limits and requirements"; Amazon IVS has no constraints beyond what
2268
- # is documented there.
2607
+ # `string:string (key:value)`. See [Best practices and strategies][1]
2608
+ # in *Tagging AWS Resources and Tag Editor* for details, including
2609
+ # restrictions that apply to tags and "Tag naming limits and
2610
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2611
+ # documented there.
2269
2612
  #
2270
2613
  #
2271
2614
  #
2272
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2615
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
2273
2616
  # @return [Array<String>]
2274
2617
  #
2275
2618
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UntagResourceRequest AWS API Documentation
@@ -2285,6 +2628,36 @@ module Aws::IVSRealTime
2285
2628
  #
2286
2629
  class UntagResourceResponse < Aws::EmptyStructure; end
2287
2630
 
2631
+ # @!attribute [rw] arn
2632
+ # ARN of the IngestConfiguration, for which the related stage ARN
2633
+ # needs to be updated.
2634
+ # @return [String]
2635
+ #
2636
+ # @!attribute [rw] stage_arn
2637
+ # Stage ARN that needs to be updated.
2638
+ # @return [String]
2639
+ #
2640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateIngestConfigurationRequest AWS API Documentation
2641
+ #
2642
+ class UpdateIngestConfigurationRequest < Struct.new(
2643
+ :arn,
2644
+ :stage_arn)
2645
+ SENSITIVE = []
2646
+ include Aws::Structure
2647
+ end
2648
+
2649
+ # @!attribute [rw] ingest_configuration
2650
+ # The updated IngestConfiguration.
2651
+ # @return [Types::IngestConfiguration]
2652
+ #
2653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateIngestConfigurationResponse AWS API Documentation
2654
+ #
2655
+ class UpdateIngestConfigurationResponse < Struct.new(
2656
+ :ingest_configuration)
2657
+ SENSITIVE = []
2658
+ include Aws::Structure
2659
+ end
2660
+
2288
2661
  # @!attribute [rw] arn
2289
2662
  # ARN of the stage to be updated.
2290
2663
  # @return [String]