aws-sdk-ivsrealtime 1.26.0 → 1.27.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivsrealtime/client.rb +325 -44
- data/lib/aws-sdk-ivsrealtime/client_api.rb +156 -1
- data/lib/aws-sdk-ivsrealtime/endpoints.rb +70 -0
- data/lib/aws-sdk-ivsrealtime/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-ivsrealtime/types.rb +463 -90
- data/lib/aws-sdk-ivsrealtime.rb +1 -1
- data/sig/client.rbs +61 -0
- data/sig/types.rbs +89 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 662e519299034296d19947169e061c2b72aa36f0920daa4b49c2a6d71d6a3066
|
4
|
+
data.tar.gz: '08446d6e3835fd3b619d85f659ac28ca599552c1b5068ee42298551dbbf34a2d'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e97ef51242cf205dbd37d1395829a29816a723865b839ad3794c0d927432acb0afd186bdcf04a79ba04f021b9b03bb3430a82c606e61ba02a0f5e7df8a51ffe9
|
7
|
+
data.tar.gz: 03f6ba8e03f9723426440dd17cdc50844fd7b5f0405d9412560f9f518618f7b48ee3b39be137b89c98e25ab54146499ba9839b2585f1648ac5be46739c1a7954
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.27.0
|
@@ -448,14 +448,15 @@ module Aws::IVSRealTime
|
|
448
448
|
#
|
449
449
|
# @option params [Hash<String,String>] :tags
|
450
450
|
# Tags attached to the resource. Array of maps, each of the form
|
451
|
-
# `string:string (key:value)`. See [
|
452
|
-
#
|
453
|
-
#
|
454
|
-
# beyond what is
|
451
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
452
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
453
|
+
# restrictions that apply to tags and "Tag naming limits and
|
454
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
455
|
+
# documented there.
|
455
456
|
#
|
456
457
|
#
|
457
458
|
#
|
458
|
-
# [1]: https://docs.aws.amazon.com/
|
459
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
459
460
|
#
|
460
461
|
# @return [Types::CreateEncoderConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
461
462
|
#
|
@@ -496,6 +497,95 @@ module Aws::IVSRealTime
|
|
496
497
|
req.send_request(options)
|
497
498
|
end
|
498
499
|
|
500
|
+
# Creates a new IngestConfiguration resource, used to specify the ingest
|
501
|
+
# protocol for a stage.
|
502
|
+
#
|
503
|
+
# @option params [String] :name
|
504
|
+
# Optional name that can be specified for the IngestConfiguration being
|
505
|
+
# created.
|
506
|
+
#
|
507
|
+
# @option params [String] :stage_arn
|
508
|
+
# ARN of the stage with which the IngestConfiguration is associated.
|
509
|
+
#
|
510
|
+
# @option params [String] :user_id
|
511
|
+
# Customer-assigned name to help identify the participant using the
|
512
|
+
# IngestConfiguration; this can be used to link a participant to a user
|
513
|
+
# in the customer’s own systems. This can be any UTF-8 encoded text.
|
514
|
+
# *This field is exposed to all stage participants and should not be
|
515
|
+
# used for personally identifying, confidential, or sensitive
|
516
|
+
# information.*
|
517
|
+
#
|
518
|
+
# @option params [Hash<String,String>] :attributes
|
519
|
+
# Application-provided attributes to store in the IngestConfiguration
|
520
|
+
# and attach to a stage. Map keys and values can contain UTF-8 encoded
|
521
|
+
# text. The maximum length of this field is 1 KB total. *This field is
|
522
|
+
# exposed to all stage participants and should not be used for
|
523
|
+
# personally identifying, confidential, or sensitive information.*
|
524
|
+
#
|
525
|
+
# @option params [required, String] :ingest_protocol
|
526
|
+
# Type of ingest protocol that the user employs to broadcast. If this is
|
527
|
+
# set to `RTMP`, `insecureIngest` must be set to `true`.
|
528
|
+
#
|
529
|
+
# @option params [Boolean] :insecure_ingest
|
530
|
+
# Whether the stage allows insecure RTMP ingest. This must be set to
|
531
|
+
# `true`, if `ingestProtocol` is set to `RTMP`. Default: `false`.
|
532
|
+
#
|
533
|
+
# @option params [Hash<String,String>] :tags
|
534
|
+
# Tags attached to the resource. Array of maps, each of the form
|
535
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
536
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
537
|
+
# restrictions that apply to tags and "Tag naming limits and
|
538
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
539
|
+
# documented there.
|
540
|
+
#
|
541
|
+
#
|
542
|
+
#
|
543
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
544
|
+
#
|
545
|
+
# @return [Types::CreateIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
546
|
+
#
|
547
|
+
# * {Types::CreateIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
|
548
|
+
#
|
549
|
+
# @example Request syntax with placeholder values
|
550
|
+
#
|
551
|
+
# resp = client.create_ingest_configuration({
|
552
|
+
# name: "IngestConfigurationName",
|
553
|
+
# stage_arn: "IngestConfigurationStageArn",
|
554
|
+
# user_id: "UserId",
|
555
|
+
# attributes: {
|
556
|
+
# "String" => "String",
|
557
|
+
# },
|
558
|
+
# ingest_protocol: "RTMP", # required, accepts RTMP, RTMPS
|
559
|
+
# insecure_ingest: false,
|
560
|
+
# tags: {
|
561
|
+
# "TagKey" => "TagValue",
|
562
|
+
# },
|
563
|
+
# })
|
564
|
+
#
|
565
|
+
# @example Response structure
|
566
|
+
#
|
567
|
+
# resp.ingest_configuration.name #=> String
|
568
|
+
# resp.ingest_configuration.arn #=> String
|
569
|
+
# resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
|
570
|
+
# resp.ingest_configuration.stream_key #=> String
|
571
|
+
# resp.ingest_configuration.stage_arn #=> String
|
572
|
+
# resp.ingest_configuration.participant_id #=> String
|
573
|
+
# resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
|
574
|
+
# resp.ingest_configuration.user_id #=> String
|
575
|
+
# resp.ingest_configuration.attributes #=> Hash
|
576
|
+
# resp.ingest_configuration.attributes["String"] #=> String
|
577
|
+
# resp.ingest_configuration.tags #=> Hash
|
578
|
+
# resp.ingest_configuration.tags["TagKey"] #=> String
|
579
|
+
#
|
580
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateIngestConfiguration AWS API Documentation
|
581
|
+
#
|
582
|
+
# @overload create_ingest_configuration(params = {})
|
583
|
+
# @param [Hash] params ({})
|
584
|
+
def create_ingest_configuration(params = {}, options = {})
|
585
|
+
req = build_request(:create_ingest_configuration, params)
|
586
|
+
req.send_request(options)
|
587
|
+
end
|
588
|
+
|
499
589
|
# Creates an additional token for a specified stage. This can be done
|
500
590
|
# after stage creation or when tokens expire. Tokens always are scoped
|
501
591
|
# to the stage for which they are created.
|
@@ -575,14 +665,15 @@ module Aws::IVSRealTime
|
|
575
665
|
#
|
576
666
|
# @option params [Hash<String,String>] :tags
|
577
667
|
# Tags attached to the resource. Array of maps, each of the form
|
578
|
-
# `string:string (key:value)`. See [
|
579
|
-
#
|
580
|
-
#
|
581
|
-
# beyond what is
|
668
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
669
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
670
|
+
# restrictions that apply to tags and "Tag naming limits and
|
671
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
672
|
+
# documented there.
|
582
673
|
#
|
583
674
|
#
|
584
675
|
#
|
585
|
-
# [1]: https://docs.aws.amazon.com/
|
676
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
586
677
|
#
|
587
678
|
# @option params [Types::AutoParticipantRecordingConfiguration] :auto_participant_recording_configuration
|
588
679
|
# Configuration object for individual participant recording, to attach
|
@@ -628,6 +719,8 @@ module Aws::IVSRealTime
|
|
628
719
|
# resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
|
629
720
|
# resp.stage.endpoints.events #=> String
|
630
721
|
# resp.stage.endpoints.whip #=> String
|
722
|
+
# resp.stage.endpoints.rtmp #=> String
|
723
|
+
# resp.stage.endpoints.rtmps #=> String
|
631
724
|
# resp.participant_tokens #=> Array
|
632
725
|
# resp.participant_tokens[0].participant_id #=> String
|
633
726
|
# resp.participant_tokens[0].token #=> String
|
@@ -662,14 +755,15 @@ module Aws::IVSRealTime
|
|
662
755
|
#
|
663
756
|
# @option params [Hash<String,String>] :tags
|
664
757
|
# Tags attached to the resource. Array of maps, each of the form
|
665
|
-
# `string:string (key:value)`. See [
|
666
|
-
#
|
667
|
-
#
|
668
|
-
# beyond what is
|
758
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
759
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
760
|
+
# restrictions that apply to tags and "Tag naming limits and
|
761
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
762
|
+
# documented there.
|
669
763
|
#
|
670
764
|
#
|
671
765
|
#
|
672
|
-
# [1]: https://docs.aws.amazon.com/
|
766
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
673
767
|
#
|
674
768
|
# @return [Types::CreateStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
675
769
|
#
|
@@ -727,6 +821,38 @@ module Aws::IVSRealTime
|
|
727
821
|
req.send_request(options)
|
728
822
|
end
|
729
823
|
|
824
|
+
# Deletes a specified IngestConfiguration, so it can no longer be used
|
825
|
+
# to broadcast. An IngestConfiguration cannot be deleted if the
|
826
|
+
# publisher is actively streaming to a stage, unless `force` is set to
|
827
|
+
# `true`.
|
828
|
+
#
|
829
|
+
# @option params [required, String] :arn
|
830
|
+
# ARN of the IngestConfiguration.
|
831
|
+
#
|
832
|
+
# @option params [Boolean] :force
|
833
|
+
# Optional field to force deletion of the IngestConfiguration. If this
|
834
|
+
# is set to `true` when a participant is actively publishing, the
|
835
|
+
# participant is disconnected from the stage, followed by deletion of
|
836
|
+
# the IngestConfiguration. Default: `false`.
|
837
|
+
#
|
838
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
839
|
+
#
|
840
|
+
# @example Request syntax with placeholder values
|
841
|
+
#
|
842
|
+
# resp = client.delete_ingest_configuration({
|
843
|
+
# arn: "IngestConfigurationArn", # required
|
844
|
+
# force: false,
|
845
|
+
# })
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteIngestConfiguration AWS API Documentation
|
848
|
+
#
|
849
|
+
# @overload delete_ingest_configuration(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def delete_ingest_configuration(params = {}, options = {})
|
852
|
+
req = build_request(:delete_ingest_configuration, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
730
856
|
# Deletes the specified public key used to sign stage participant
|
731
857
|
# tokens. This invalidates future participant tokens generated using the
|
732
858
|
# key pair’s private key.
|
@@ -752,7 +878,9 @@ module Aws::IVSRealTime
|
|
752
878
|
end
|
753
879
|
|
754
880
|
# Shuts down and deletes the specified stage (disconnecting all
|
755
|
-
# participants).
|
881
|
+
# participants). This operation also removes the `stageArn` from the
|
882
|
+
# associated IngestConfiguration, if there are participants using the
|
883
|
+
# IngestConfiguration to publish to the stage.
|
756
884
|
#
|
757
885
|
# @option params [required, String] :arn
|
758
886
|
# ARN of the stage to be deleted.
|
@@ -802,15 +930,18 @@ module Aws::IVSRealTime
|
|
802
930
|
req.send_request(options)
|
803
931
|
end
|
804
932
|
|
805
|
-
# Disconnects a specified participant
|
806
|
-
#
|
933
|
+
# Disconnects a specified participant from a specified stage. If the
|
934
|
+
# participant is publishing using an IngestConfiguration,
|
935
|
+
# DisconnectParticipant also updates the `stageArn` in the
|
936
|
+
# IngestConfiguration to be an empty string.
|
807
937
|
#
|
808
938
|
# @option params [required, String] :stage_arn
|
809
939
|
# ARN of the stage to which the participant is attached.
|
810
940
|
#
|
811
941
|
# @option params [required, String] :participant_id
|
812
|
-
# Identifier of the participant to be disconnected.
|
813
|
-
#
|
942
|
+
# Identifier of the participant to be disconnected. IVS assigns this; it
|
943
|
+
# is returned by CreateParticipantToken (for streams using WebRTC
|
944
|
+
# ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
|
814
945
|
#
|
815
946
|
# @option params [String] :reason
|
816
947
|
# Description of why this participant is being disconnected.
|
@@ -931,6 +1062,45 @@ module Aws::IVSRealTime
|
|
931
1062
|
req.send_request(options)
|
932
1063
|
end
|
933
1064
|
|
1065
|
+
# Gets information about the specified IngestConfiguration.
|
1066
|
+
#
|
1067
|
+
# @option params [required, String] :arn
|
1068
|
+
# ARN of the ingest for which the information is to be retrieved.
|
1069
|
+
#
|
1070
|
+
# @return [Types::GetIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1071
|
+
#
|
1072
|
+
# * {Types::GetIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
|
1073
|
+
#
|
1074
|
+
# @example Request syntax with placeholder values
|
1075
|
+
#
|
1076
|
+
# resp = client.get_ingest_configuration({
|
1077
|
+
# arn: "IngestConfigurationArn", # required
|
1078
|
+
# })
|
1079
|
+
#
|
1080
|
+
# @example Response structure
|
1081
|
+
#
|
1082
|
+
# resp.ingest_configuration.name #=> String
|
1083
|
+
# resp.ingest_configuration.arn #=> String
|
1084
|
+
# resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
|
1085
|
+
# resp.ingest_configuration.stream_key #=> String
|
1086
|
+
# resp.ingest_configuration.stage_arn #=> String
|
1087
|
+
# resp.ingest_configuration.participant_id #=> String
|
1088
|
+
# resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
|
1089
|
+
# resp.ingest_configuration.user_id #=> String
|
1090
|
+
# resp.ingest_configuration.attributes #=> Hash
|
1091
|
+
# resp.ingest_configuration.attributes["String"] #=> String
|
1092
|
+
# resp.ingest_configuration.tags #=> Hash
|
1093
|
+
# resp.ingest_configuration.tags["TagKey"] #=> String
|
1094
|
+
#
|
1095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetIngestConfiguration AWS API Documentation
|
1096
|
+
#
|
1097
|
+
# @overload get_ingest_configuration(params = {})
|
1098
|
+
# @param [Hash] params ({})
|
1099
|
+
def get_ingest_configuration(params = {}, options = {})
|
1100
|
+
req = build_request(:get_ingest_configuration, params)
|
1101
|
+
req.send_request(options)
|
1102
|
+
end
|
1103
|
+
|
934
1104
|
# Gets information about the specified participant token.
|
935
1105
|
#
|
936
1106
|
# @option params [required, String] :stage_arn
|
@@ -973,6 +1143,7 @@ module Aws::IVSRealTime
|
|
973
1143
|
# resp.participant.recording_s3_bucket_name #=> String
|
974
1144
|
# resp.participant.recording_s3_prefix #=> String
|
975
1145
|
# resp.participant.recording_state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "STOPPED", "FAILED", "DISABLED"
|
1146
|
+
# resp.participant.protocol #=> String, one of "UNKNOWN", "WHIP", "RTMP", "RTMPS"
|
976
1147
|
#
|
977
1148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipant AWS API Documentation
|
978
1149
|
#
|
@@ -1043,6 +1214,8 @@ module Aws::IVSRealTime
|
|
1043
1214
|
# resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
|
1044
1215
|
# resp.stage.endpoints.events #=> String
|
1045
1216
|
# resp.stage.endpoints.whip #=> String
|
1217
|
+
# resp.stage.endpoints.rtmp #=> String
|
1218
|
+
# resp.stage.endpoints.rtmps #=> String
|
1046
1219
|
#
|
1047
1220
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage AWS API Documentation
|
1048
1221
|
#
|
@@ -1129,14 +1302,15 @@ module Aws::IVSRealTime
|
|
1129
1302
|
#
|
1130
1303
|
# @option params [Hash<String,String>] :tags
|
1131
1304
|
# Tags attached to the resource. Array of maps, each of the form
|
1132
|
-
# `string:string (key:value)`. See [
|
1133
|
-
#
|
1134
|
-
#
|
1135
|
-
# beyond what is
|
1305
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
1306
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
1307
|
+
# restrictions that apply to tags and "Tag naming limits and
|
1308
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
1309
|
+
# documented there.
|
1136
1310
|
#
|
1137
1311
|
#
|
1138
1312
|
#
|
1139
|
-
# [1]: https://docs.aws.amazon.com/
|
1313
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
1140
1314
|
#
|
1141
1315
|
# @return [Types::ImportPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1142
1316
|
#
|
@@ -1271,6 +1445,61 @@ module Aws::IVSRealTime
|
|
1271
1445
|
req.send_request(options)
|
1272
1446
|
end
|
1273
1447
|
|
1448
|
+
# Lists all IngestConfigurations in your account, in the AWS region
|
1449
|
+
# where the API request is processed.
|
1450
|
+
#
|
1451
|
+
# @option params [String] :filter_by_stage_arn
|
1452
|
+
# Filters the response list to match the specified stage ARN. Only one
|
1453
|
+
# filter (by stage ARN or by state) can be used at a time.
|
1454
|
+
#
|
1455
|
+
# @option params [String] :filter_by_state
|
1456
|
+
# Filters the response list to match the specified state. Only one
|
1457
|
+
# filter (by stage ARN or by state) can be used at a time.
|
1458
|
+
#
|
1459
|
+
# @option params [String] :next_token
|
1460
|
+
# The first IngestConfiguration to retrieve. This is used for
|
1461
|
+
# pagination; see the `nextToken` response field.
|
1462
|
+
#
|
1463
|
+
# @option params [Integer] :max_results
|
1464
|
+
# Maximum number of results to return. Default: 50.
|
1465
|
+
#
|
1466
|
+
# @return [Types::ListIngestConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1467
|
+
#
|
1468
|
+
# * {Types::ListIngestConfigurationsResponse#ingest_configurations #ingest_configurations} => Array<Types::IngestConfigurationSummary>
|
1469
|
+
# * {Types::ListIngestConfigurationsResponse#next_token #next_token} => String
|
1470
|
+
#
|
1471
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1472
|
+
#
|
1473
|
+
# @example Request syntax with placeholder values
|
1474
|
+
#
|
1475
|
+
# resp = client.list_ingest_configurations({
|
1476
|
+
# filter_by_stage_arn: "StageArn",
|
1477
|
+
# filter_by_state: "ACTIVE", # accepts ACTIVE, INACTIVE
|
1478
|
+
# next_token: "PaginationToken",
|
1479
|
+
# max_results: 1,
|
1480
|
+
# })
|
1481
|
+
#
|
1482
|
+
# @example Response structure
|
1483
|
+
#
|
1484
|
+
# resp.ingest_configurations #=> Array
|
1485
|
+
# resp.ingest_configurations[0].name #=> String
|
1486
|
+
# resp.ingest_configurations[0].arn #=> String
|
1487
|
+
# resp.ingest_configurations[0].ingest_protocol #=> String, one of "RTMP", "RTMPS"
|
1488
|
+
# resp.ingest_configurations[0].stage_arn #=> String
|
1489
|
+
# resp.ingest_configurations[0].participant_id #=> String
|
1490
|
+
# resp.ingest_configurations[0].state #=> String, one of "ACTIVE", "INACTIVE"
|
1491
|
+
# resp.ingest_configurations[0].user_id #=> String
|
1492
|
+
# resp.next_token #=> String
|
1493
|
+
#
|
1494
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListIngestConfigurations AWS API Documentation
|
1495
|
+
#
|
1496
|
+
# @overload list_ingest_configurations(params = {})
|
1497
|
+
# @param [Hash] params ({})
|
1498
|
+
def list_ingest_configurations(params = {}, options = {})
|
1499
|
+
req = build_request(:list_ingest_configurations, params)
|
1500
|
+
req.send_request(options)
|
1501
|
+
end
|
1502
|
+
|
1274
1503
|
# Lists events for a specified participant that occurred during a
|
1275
1504
|
# specified stage session.
|
1276
1505
|
#
|
@@ -1315,7 +1544,7 @@ module Aws::IVSRealTime
|
|
1315
1544
|
# resp.events[0].participant_id #=> String
|
1316
1545
|
# resp.events[0].event_time #=> Time
|
1317
1546
|
# resp.events[0].remote_participant_id #=> String
|
1318
|
-
# resp.events[0].error_code #=> String, one of "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", "PUBLISHER_NOT_FOUND"
|
1547
|
+
# resp.events[0].error_code #=> String, one of "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", "PUBLISHER_NOT_FOUND", "BITRATE_EXCEEDED", "RESOLUTION_EXCEEDED", "STREAM_DURATION_EXCEEDED", "INVALID_AUDIO_CODEC", "INVALID_VIDEO_CODEC", "INVALID_PROTOCOL", "INVALID_STREAM_KEY", "REUSE_OF_STREAM_KEY"
|
1319
1548
|
# resp.next_token #=> String
|
1320
1549
|
#
|
1321
1550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEvents AWS API Documentation
|
@@ -1612,8 +1841,9 @@ module Aws::IVSRealTime
|
|
1612
1841
|
# Starts a Composition from a stage based on the configuration provided
|
1613
1842
|
# in the request.
|
1614
1843
|
#
|
1615
|
-
# A Composition is an ephemeral resource that exists after this
|
1616
|
-
# returns successfully. Composition stops and the resource is
|
1844
|
+
# A Composition is an ephemeral resource that exists after this
|
1845
|
+
# operation returns successfully. Composition stops and the resource is
|
1846
|
+
# deleted:
|
1617
1847
|
#
|
1618
1848
|
# * When StopComposition is called.
|
1619
1849
|
#
|
@@ -1646,14 +1876,15 @@ module Aws::IVSRealTime
|
|
1646
1876
|
#
|
1647
1877
|
# @option params [Hash<String,String>] :tags
|
1648
1878
|
# Tags attached to the resource. Array of maps, each of the form
|
1649
|
-
# `string:string (key:value)`. See [
|
1650
|
-
#
|
1651
|
-
#
|
1652
|
-
# beyond what is
|
1879
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
1880
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
1881
|
+
# restrictions that apply to tags and "Tag naming limits and
|
1882
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
1883
|
+
# documented there.
|
1653
1884
|
#
|
1654
1885
|
#
|
1655
1886
|
#
|
1656
|
-
# [1]: https://docs.aws.amazon.com/
|
1887
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
1657
1888
|
#
|
1658
1889
|
# @return [Types::StartCompositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1659
1890
|
#
|
@@ -1783,14 +2014,15 @@ module Aws::IVSRealTime
|
|
1783
2014
|
#
|
1784
2015
|
# @option params [required, Hash<String,String>] :tags
|
1785
2016
|
# Array of tags to be added or updated. Array of maps, each of the form
|
1786
|
-
# `string:string (key:value)`. See [
|
1787
|
-
#
|
1788
|
-
#
|
1789
|
-
#
|
2017
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
2018
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
2019
|
+
# restrictions that apply to tags and "Tag naming limits and
|
2020
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
2021
|
+
# documented there.
|
1790
2022
|
#
|
1791
2023
|
#
|
1792
2024
|
#
|
1793
|
-
# [1]: https://docs.aws.amazon.com/
|
2025
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
1794
2026
|
#
|
1795
2027
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1796
2028
|
#
|
@@ -1819,14 +2051,15 @@ module Aws::IVSRealTime
|
|
1819
2051
|
#
|
1820
2052
|
# @option params [required, Array<String>] :tag_keys
|
1821
2053
|
# Array of tags to be removed. Array of maps, each of the form
|
1822
|
-
# `string:string (key:value)`. See [
|
1823
|
-
#
|
1824
|
-
#
|
1825
|
-
#
|
2054
|
+
# `string:string (key:value)`. See [Best practices and strategies][1] in
|
2055
|
+
# *Tagging AWS Resources and Tag Editor* for details, including
|
2056
|
+
# restrictions that apply to tags and "Tag naming limits and
|
2057
|
+
# requirements"; Amazon IVS has no constraints on tags beyond what is
|
2058
|
+
# documented there.
|
1826
2059
|
#
|
1827
2060
|
#
|
1828
2061
|
#
|
1829
|
-
# [1]: https://docs.aws.amazon.com/
|
2062
|
+
# [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
|
1830
2063
|
#
|
1831
2064
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1832
2065
|
#
|
@@ -1846,6 +2079,52 @@ module Aws::IVSRealTime
|
|
1846
2079
|
req.send_request(options)
|
1847
2080
|
end
|
1848
2081
|
|
2082
|
+
# Updates a specified IngestConfiguration. Only the stage ARN attached
|
2083
|
+
# to the IngestConfiguration can be updated. An IngestConfiguration that
|
2084
|
+
# is active cannot be updated.
|
2085
|
+
#
|
2086
|
+
# @option params [required, String] :arn
|
2087
|
+
# ARN of the IngestConfiguration, for which the related stage ARN needs
|
2088
|
+
# to be updated.
|
2089
|
+
#
|
2090
|
+
# @option params [String] :stage_arn
|
2091
|
+
# Stage ARN that needs to be updated.
|
2092
|
+
#
|
2093
|
+
# @return [Types::UpdateIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2094
|
+
#
|
2095
|
+
# * {Types::UpdateIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
|
2096
|
+
#
|
2097
|
+
# @example Request syntax with placeholder values
|
2098
|
+
#
|
2099
|
+
# resp = client.update_ingest_configuration({
|
2100
|
+
# arn: "IngestConfigurationArn", # required
|
2101
|
+
# stage_arn: "IngestConfigurationStageArn",
|
2102
|
+
# })
|
2103
|
+
#
|
2104
|
+
# @example Response structure
|
2105
|
+
#
|
2106
|
+
# resp.ingest_configuration.name #=> String
|
2107
|
+
# resp.ingest_configuration.arn #=> String
|
2108
|
+
# resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
|
2109
|
+
# resp.ingest_configuration.stream_key #=> String
|
2110
|
+
# resp.ingest_configuration.stage_arn #=> String
|
2111
|
+
# resp.ingest_configuration.participant_id #=> String
|
2112
|
+
# resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
|
2113
|
+
# resp.ingest_configuration.user_id #=> String
|
2114
|
+
# resp.ingest_configuration.attributes #=> Hash
|
2115
|
+
# resp.ingest_configuration.attributes["String"] #=> String
|
2116
|
+
# resp.ingest_configuration.tags #=> Hash
|
2117
|
+
# resp.ingest_configuration.tags["TagKey"] #=> String
|
2118
|
+
#
|
2119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateIngestConfiguration AWS API Documentation
|
2120
|
+
#
|
2121
|
+
# @overload update_ingest_configuration(params = {})
|
2122
|
+
# @param [Hash] params ({})
|
2123
|
+
def update_ingest_configuration(params = {}, options = {})
|
2124
|
+
req = build_request(:update_ingest_configuration, params)
|
2125
|
+
req.send_request(options)
|
2126
|
+
end
|
2127
|
+
|
1849
2128
|
# Updates a stage’s configuration.
|
1850
2129
|
#
|
1851
2130
|
# @option params [required, String] :arn
|
@@ -1886,6 +2165,8 @@ module Aws::IVSRealTime
|
|
1886
2165
|
# resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
|
1887
2166
|
# resp.stage.endpoints.events #=> String
|
1888
2167
|
# resp.stage.endpoints.whip #=> String
|
2168
|
+
# resp.stage.endpoints.rtmp #=> String
|
2169
|
+
# resp.stage.endpoints.rtmps #=> String
|
1889
2170
|
#
|
1890
2171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage AWS API Documentation
|
1891
2172
|
#
|
@@ -1914,7 +2195,7 @@ module Aws::IVSRealTime
|
|
1914
2195
|
tracer: tracer
|
1915
2196
|
)
|
1916
2197
|
context[:gem_name] = 'aws-sdk-ivsrealtime'
|
1917
|
-
context[:gem_version] = '1.
|
2198
|
+
context[:gem_version] = '1.27.0'
|
1918
2199
|
Seahorse::Client::Request.new(handlers, context)
|
1919
2200
|
end
|
1920
2201
|
|