aws-sdk-ivsrealtime 1.26.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7837229d1ef371694ee811281327204a4dc9497a27a1bfbdad56bf19db1e265d
4
- data.tar.gz: d8fe560600bea180a1f015971225c8191f836d107cd3141ed422a4b05e2a2807
3
+ metadata.gz: aa8eb5367c9bbf6db45444e42851f51cfbf9fd4ba1cbbd64af8da9bd69096d92
4
+ data.tar.gz: 6c3f18ca6b373f0601f36a1f9a62b62425ad68e05cc0ec537eadeee3b21fb166
5
5
  SHA512:
6
- metadata.gz: 98c9e2d3afeef8ae6825bc1967d35c5a79b45090c9aa593dbd11bbc514ba717f008127f5b5d2916ed103f53a394e81c6685705d6f960c45a0b9d247646398162
7
- data.tar.gz: d16b08bd84eafacc30edeb1cb6c867465eca30d8ae3147170ec980381fd147878597006ea34f3c7f2035e4d8a19c729256b56c246cf1abcf8d2d3af53642804d
6
+ metadata.gz: 8eddaa989d2d45b3d0d5442089346dbf5c323b445306f32ff99e8f274beb0a23698b7116efe8ace3d17d261508e437051d6c6c6cfd9364282539901594ed8b52
7
+ data.tar.gz: 345e477010be900d0815ab0e4c3e98022f869d280b78fa179cf21458b190d2f267805c4217e4e35717da181517b6ab99370df5176cb9fa5fdbe58cbeefdb1240
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2024-09-10)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.27.0 (2024-09-09)
10
+ ------------------
11
+
12
+ * Feature - IVS Real-Time now offers customers the ability to broadcast to Stages using RTMP(S).
13
+
4
14
  1.26.0 (2024-09-03)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.26.0
1
+ 1.28.0
@@ -425,6 +425,12 @@ module Aws::IVSRealTime
425
425
  # @option options [String] :ssl_ca_store
426
426
  # Sets the X509::Store to verify peer certificate.
427
427
  #
428
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
429
+ # Sets a client certificate when creating http connections.
430
+ #
431
+ # @option options [OpenSSL::PKey] :ssl_key
432
+ # Sets a client key when creating http connections.
433
+ #
428
434
  # @option options [Float] :ssl_timeout
429
435
  # Sets the SSL timeout in seconds
430
436
  #
@@ -448,14 +454,15 @@ module Aws::IVSRealTime
448
454
  #
449
455
  # @option params [Hash<String,String>] :tags
450
456
  # Tags attached to the resource. Array of maps, each of the form
451
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
452
- # details, including restrictions that apply to tags and "Tag naming
453
- # limits and requirements"; Amazon IVS has no constraints on tags
454
- # beyond what is documented there.
457
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
458
+ # *Tagging AWS Resources and Tag Editor* for details, including
459
+ # restrictions that apply to tags and "Tag naming limits and
460
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
461
+ # documented there.
455
462
  #
456
463
  #
457
464
  #
458
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
465
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
459
466
  #
460
467
  # @return [Types::CreateEncoderConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
461
468
  #
@@ -496,6 +503,95 @@ module Aws::IVSRealTime
496
503
  req.send_request(options)
497
504
  end
498
505
 
506
+ # Creates a new IngestConfiguration resource, used to specify the ingest
507
+ # protocol for a stage.
508
+ #
509
+ # @option params [String] :name
510
+ # Optional name that can be specified for the IngestConfiguration being
511
+ # created.
512
+ #
513
+ # @option params [String] :stage_arn
514
+ # ARN of the stage with which the IngestConfiguration is associated.
515
+ #
516
+ # @option params [String] :user_id
517
+ # Customer-assigned name to help identify the participant using the
518
+ # IngestConfiguration; this can be used to link a participant to a user
519
+ # in the customer’s own systems. This can be any UTF-8 encoded text.
520
+ # *This field is exposed to all stage participants and should not be
521
+ # used for personally identifying, confidential, or sensitive
522
+ # information.*
523
+ #
524
+ # @option params [Hash<String,String>] :attributes
525
+ # Application-provided attributes to store in the IngestConfiguration
526
+ # and attach to a stage. Map keys and values can contain UTF-8 encoded
527
+ # text. The maximum length of this field is 1 KB total. *This field is
528
+ # exposed to all stage participants and should not be used for
529
+ # personally identifying, confidential, or sensitive information.*
530
+ #
531
+ # @option params [required, String] :ingest_protocol
532
+ # Type of ingest protocol that the user employs to broadcast. If this is
533
+ # set to `RTMP`, `insecureIngest` must be set to `true`.
534
+ #
535
+ # @option params [Boolean] :insecure_ingest
536
+ # Whether the stage allows insecure RTMP ingest. This must be set to
537
+ # `true`, if `ingestProtocol` is set to `RTMP`. Default: `false`.
538
+ #
539
+ # @option params [Hash<String,String>] :tags
540
+ # Tags attached to the resource. Array of maps, each of the form
541
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
542
+ # *Tagging AWS Resources and Tag Editor* for details, including
543
+ # restrictions that apply to tags and "Tag naming limits and
544
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
545
+ # documented there.
546
+ #
547
+ #
548
+ #
549
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
550
+ #
551
+ # @return [Types::CreateIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
552
+ #
553
+ # * {Types::CreateIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
554
+ #
555
+ # @example Request syntax with placeholder values
556
+ #
557
+ # resp = client.create_ingest_configuration({
558
+ # name: "IngestConfigurationName",
559
+ # stage_arn: "IngestConfigurationStageArn",
560
+ # user_id: "UserId",
561
+ # attributes: {
562
+ # "String" => "String",
563
+ # },
564
+ # ingest_protocol: "RTMP", # required, accepts RTMP, RTMPS
565
+ # insecure_ingest: false,
566
+ # tags: {
567
+ # "TagKey" => "TagValue",
568
+ # },
569
+ # })
570
+ #
571
+ # @example Response structure
572
+ #
573
+ # resp.ingest_configuration.name #=> String
574
+ # resp.ingest_configuration.arn #=> String
575
+ # resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
576
+ # resp.ingest_configuration.stream_key #=> String
577
+ # resp.ingest_configuration.stage_arn #=> String
578
+ # resp.ingest_configuration.participant_id #=> String
579
+ # resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
580
+ # resp.ingest_configuration.user_id #=> String
581
+ # resp.ingest_configuration.attributes #=> Hash
582
+ # resp.ingest_configuration.attributes["String"] #=> String
583
+ # resp.ingest_configuration.tags #=> Hash
584
+ # resp.ingest_configuration.tags["TagKey"] #=> String
585
+ #
586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateIngestConfiguration AWS API Documentation
587
+ #
588
+ # @overload create_ingest_configuration(params = {})
589
+ # @param [Hash] params ({})
590
+ def create_ingest_configuration(params = {}, options = {})
591
+ req = build_request(:create_ingest_configuration, params)
592
+ req.send_request(options)
593
+ end
594
+
499
595
  # Creates an additional token for a specified stage. This can be done
500
596
  # after stage creation or when tokens expire. Tokens always are scoped
501
597
  # to the stage for which they are created.
@@ -575,14 +671,15 @@ module Aws::IVSRealTime
575
671
  #
576
672
  # @option params [Hash<String,String>] :tags
577
673
  # Tags attached to the resource. Array of maps, each of the form
578
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
579
- # details, including restrictions that apply to tags and "Tag naming
580
- # limits and requirements"; Amazon IVS has no constraints on tags
581
- # beyond what is documented there.
674
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
675
+ # *Tagging AWS Resources and Tag Editor* for details, including
676
+ # restrictions that apply to tags and "Tag naming limits and
677
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
678
+ # documented there.
582
679
  #
583
680
  #
584
681
  #
585
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
682
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
586
683
  #
587
684
  # @option params [Types::AutoParticipantRecordingConfiguration] :auto_participant_recording_configuration
588
685
  # Configuration object for individual participant recording, to attach
@@ -628,6 +725,8 @@ module Aws::IVSRealTime
628
725
  # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
629
726
  # resp.stage.endpoints.events #=> String
630
727
  # resp.stage.endpoints.whip #=> String
728
+ # resp.stage.endpoints.rtmp #=> String
729
+ # resp.stage.endpoints.rtmps #=> String
631
730
  # resp.participant_tokens #=> Array
632
731
  # resp.participant_tokens[0].participant_id #=> String
633
732
  # resp.participant_tokens[0].token #=> String
@@ -662,14 +761,15 @@ module Aws::IVSRealTime
662
761
  #
663
762
  # @option params [Hash<String,String>] :tags
664
763
  # Tags attached to the resource. Array of maps, each of the form
665
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
666
- # details, including restrictions that apply to tags and "Tag naming
667
- # limits and requirements"; Amazon IVS has no constraints on tags
668
- # beyond what is documented there.
764
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
765
+ # *Tagging AWS Resources and Tag Editor* for details, including
766
+ # restrictions that apply to tags and "Tag naming limits and
767
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
768
+ # documented there.
669
769
  #
670
770
  #
671
771
  #
672
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
772
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
673
773
  #
674
774
  # @return [Types::CreateStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
675
775
  #
@@ -727,6 +827,38 @@ module Aws::IVSRealTime
727
827
  req.send_request(options)
728
828
  end
729
829
 
830
+ # Deletes a specified IngestConfiguration, so it can no longer be used
831
+ # to broadcast. An IngestConfiguration cannot be deleted if the
832
+ # publisher is actively streaming to a stage, unless `force` is set to
833
+ # `true`.
834
+ #
835
+ # @option params [required, String] :arn
836
+ # ARN of the IngestConfiguration.
837
+ #
838
+ # @option params [Boolean] :force
839
+ # Optional field to force deletion of the IngestConfiguration. If this
840
+ # is set to `true` when a participant is actively publishing, the
841
+ # participant is disconnected from the stage, followed by deletion of
842
+ # the IngestConfiguration. Default: `false`.
843
+ #
844
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
845
+ #
846
+ # @example Request syntax with placeholder values
847
+ #
848
+ # resp = client.delete_ingest_configuration({
849
+ # arn: "IngestConfigurationArn", # required
850
+ # force: false,
851
+ # })
852
+ #
853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeleteIngestConfiguration AWS API Documentation
854
+ #
855
+ # @overload delete_ingest_configuration(params = {})
856
+ # @param [Hash] params ({})
857
+ def delete_ingest_configuration(params = {}, options = {})
858
+ req = build_request(:delete_ingest_configuration, params)
859
+ req.send_request(options)
860
+ end
861
+
730
862
  # Deletes the specified public key used to sign stage participant
731
863
  # tokens. This invalidates future participant tokens generated using the
732
864
  # key pair’s private key.
@@ -752,7 +884,9 @@ module Aws::IVSRealTime
752
884
  end
753
885
 
754
886
  # Shuts down and deletes the specified stage (disconnecting all
755
- # participants).
887
+ # participants). This operation also removes the `stageArn` from the
888
+ # associated IngestConfiguration, if there are participants using the
889
+ # IngestConfiguration to publish to the stage.
756
890
  #
757
891
  # @option params [required, String] :arn
758
892
  # ARN of the stage to be deleted.
@@ -802,15 +936,18 @@ module Aws::IVSRealTime
802
936
  req.send_request(options)
803
937
  end
804
938
 
805
- # Disconnects a specified participant and revokes the participant
806
- # permanently from a specified stage.
939
+ # Disconnects a specified participant from a specified stage. If the
940
+ # participant is publishing using an IngestConfiguration,
941
+ # DisconnectParticipant also updates the `stageArn` in the
942
+ # IngestConfiguration to be an empty string.
807
943
  #
808
944
  # @option params [required, String] :stage_arn
809
945
  # ARN of the stage to which the participant is attached.
810
946
  #
811
947
  # @option params [required, String] :participant_id
812
- # Identifier of the participant to be disconnected. This is assigned by
813
- # IVS and returned by CreateParticipantToken.
948
+ # Identifier of the participant to be disconnected. IVS assigns this; it
949
+ # is returned by CreateParticipantToken (for streams using WebRTC
950
+ # ingest) or CreateIngestConfiguration (for streams using RTMP ingest).
814
951
  #
815
952
  # @option params [String] :reason
816
953
  # Description of why this participant is being disconnected.
@@ -931,6 +1068,45 @@ module Aws::IVSRealTime
931
1068
  req.send_request(options)
932
1069
  end
933
1070
 
1071
+ # Gets information about the specified IngestConfiguration.
1072
+ #
1073
+ # @option params [required, String] :arn
1074
+ # ARN of the ingest for which the information is to be retrieved.
1075
+ #
1076
+ # @return [Types::GetIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1077
+ #
1078
+ # * {Types::GetIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
1079
+ #
1080
+ # @example Request syntax with placeholder values
1081
+ #
1082
+ # resp = client.get_ingest_configuration({
1083
+ # arn: "IngestConfigurationArn", # required
1084
+ # })
1085
+ #
1086
+ # @example Response structure
1087
+ #
1088
+ # resp.ingest_configuration.name #=> String
1089
+ # resp.ingest_configuration.arn #=> String
1090
+ # resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
1091
+ # resp.ingest_configuration.stream_key #=> String
1092
+ # resp.ingest_configuration.stage_arn #=> String
1093
+ # resp.ingest_configuration.participant_id #=> String
1094
+ # resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
1095
+ # resp.ingest_configuration.user_id #=> String
1096
+ # resp.ingest_configuration.attributes #=> Hash
1097
+ # resp.ingest_configuration.attributes["String"] #=> String
1098
+ # resp.ingest_configuration.tags #=> Hash
1099
+ # resp.ingest_configuration.tags["TagKey"] #=> String
1100
+ #
1101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetIngestConfiguration AWS API Documentation
1102
+ #
1103
+ # @overload get_ingest_configuration(params = {})
1104
+ # @param [Hash] params ({})
1105
+ def get_ingest_configuration(params = {}, options = {})
1106
+ req = build_request(:get_ingest_configuration, params)
1107
+ req.send_request(options)
1108
+ end
1109
+
934
1110
  # Gets information about the specified participant token.
935
1111
  #
936
1112
  # @option params [required, String] :stage_arn
@@ -973,6 +1149,7 @@ module Aws::IVSRealTime
973
1149
  # resp.participant.recording_s3_bucket_name #=> String
974
1150
  # resp.participant.recording_s3_prefix #=> String
975
1151
  # resp.participant.recording_state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "STOPPED", "FAILED", "DISABLED"
1152
+ # resp.participant.protocol #=> String, one of "UNKNOWN", "WHIP", "RTMP", "RTMPS"
976
1153
  #
977
1154
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipant AWS API Documentation
978
1155
  #
@@ -1043,6 +1220,8 @@ module Aws::IVSRealTime
1043
1220
  # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
1044
1221
  # resp.stage.endpoints.events #=> String
1045
1222
  # resp.stage.endpoints.whip #=> String
1223
+ # resp.stage.endpoints.rtmp #=> String
1224
+ # resp.stage.endpoints.rtmps #=> String
1046
1225
  #
1047
1226
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage AWS API Documentation
1048
1227
  #
@@ -1129,14 +1308,15 @@ module Aws::IVSRealTime
1129
1308
  #
1130
1309
  # @option params [Hash<String,String>] :tags
1131
1310
  # Tags attached to the resource. Array of maps, each of the form
1132
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1133
- # details, including restrictions that apply to tags and "Tag naming
1134
- # limits and requirements"; Amazon IVS has no constraints on tags
1135
- # beyond what is documented there.
1311
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
1312
+ # *Tagging AWS Resources and Tag Editor* for details, including
1313
+ # restrictions that apply to tags and "Tag naming limits and
1314
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
1315
+ # documented there.
1136
1316
  #
1137
1317
  #
1138
1318
  #
1139
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1319
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1140
1320
  #
1141
1321
  # @return [Types::ImportPublicKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1142
1322
  #
@@ -1271,6 +1451,61 @@ module Aws::IVSRealTime
1271
1451
  req.send_request(options)
1272
1452
  end
1273
1453
 
1454
+ # Lists all IngestConfigurations in your account, in the AWS region
1455
+ # where the API request is processed.
1456
+ #
1457
+ # @option params [String] :filter_by_stage_arn
1458
+ # Filters the response list to match the specified stage ARN. Only one
1459
+ # filter (by stage ARN or by state) can be used at a time.
1460
+ #
1461
+ # @option params [String] :filter_by_state
1462
+ # Filters the response list to match the specified state. Only one
1463
+ # filter (by stage ARN or by state) can be used at a time.
1464
+ #
1465
+ # @option params [String] :next_token
1466
+ # The first IngestConfiguration to retrieve. This is used for
1467
+ # pagination; see the `nextToken` response field.
1468
+ #
1469
+ # @option params [Integer] :max_results
1470
+ # Maximum number of results to return. Default: 50.
1471
+ #
1472
+ # @return [Types::ListIngestConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1473
+ #
1474
+ # * {Types::ListIngestConfigurationsResponse#ingest_configurations #ingest_configurations} => Array&lt;Types::IngestConfigurationSummary&gt;
1475
+ # * {Types::ListIngestConfigurationsResponse#next_token #next_token} => String
1476
+ #
1477
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1478
+ #
1479
+ # @example Request syntax with placeholder values
1480
+ #
1481
+ # resp = client.list_ingest_configurations({
1482
+ # filter_by_stage_arn: "StageArn",
1483
+ # filter_by_state: "ACTIVE", # accepts ACTIVE, INACTIVE
1484
+ # next_token: "PaginationToken",
1485
+ # max_results: 1,
1486
+ # })
1487
+ #
1488
+ # @example Response structure
1489
+ #
1490
+ # resp.ingest_configurations #=> Array
1491
+ # resp.ingest_configurations[0].name #=> String
1492
+ # resp.ingest_configurations[0].arn #=> String
1493
+ # resp.ingest_configurations[0].ingest_protocol #=> String, one of "RTMP", "RTMPS"
1494
+ # resp.ingest_configurations[0].stage_arn #=> String
1495
+ # resp.ingest_configurations[0].participant_id #=> String
1496
+ # resp.ingest_configurations[0].state #=> String, one of "ACTIVE", "INACTIVE"
1497
+ # resp.ingest_configurations[0].user_id #=> String
1498
+ # resp.next_token #=> String
1499
+ #
1500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListIngestConfigurations AWS API Documentation
1501
+ #
1502
+ # @overload list_ingest_configurations(params = {})
1503
+ # @param [Hash] params ({})
1504
+ def list_ingest_configurations(params = {}, options = {})
1505
+ req = build_request(:list_ingest_configurations, params)
1506
+ req.send_request(options)
1507
+ end
1508
+
1274
1509
  # Lists events for a specified participant that occurred during a
1275
1510
  # specified stage session.
1276
1511
  #
@@ -1315,7 +1550,7 @@ module Aws::IVSRealTime
1315
1550
  # resp.events[0].participant_id #=> String
1316
1551
  # resp.events[0].event_time #=> Time
1317
1552
  # resp.events[0].remote_participant_id #=> String
1318
- # resp.events[0].error_code #=> String, one of "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", "PUBLISHER_NOT_FOUND"
1553
+ # 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
1554
  # resp.next_token #=> String
1320
1555
  #
1321
1556
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEvents AWS API Documentation
@@ -1612,8 +1847,9 @@ module Aws::IVSRealTime
1612
1847
  # Starts a Composition from a stage based on the configuration provided
1613
1848
  # in the request.
1614
1849
  #
1615
- # A Composition is an ephemeral resource that exists after this endpoint
1616
- # returns successfully. Composition stops and the resource is deleted:
1850
+ # A Composition is an ephemeral resource that exists after this
1851
+ # operation returns successfully. Composition stops and the resource is
1852
+ # deleted:
1617
1853
  #
1618
1854
  # * When StopComposition is called.
1619
1855
  #
@@ -1646,14 +1882,15 @@ module Aws::IVSRealTime
1646
1882
  #
1647
1883
  # @option params [Hash<String,String>] :tags
1648
1884
  # Tags attached to the resource. Array of maps, each of the form
1649
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1650
- # details, including restrictions that apply to tags and "Tag naming
1651
- # limits and requirements"; Amazon IVS has no constraints on tags
1652
- # beyond what is documented there.
1885
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
1886
+ # *Tagging AWS Resources and Tag Editor* for details, including
1887
+ # restrictions that apply to tags and "Tag naming limits and
1888
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
1889
+ # documented there.
1653
1890
  #
1654
1891
  #
1655
1892
  #
1656
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
1893
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1657
1894
  #
1658
1895
  # @return [Types::StartCompositionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1659
1896
  #
@@ -1783,14 +2020,15 @@ module Aws::IVSRealTime
1783
2020
  #
1784
2021
  # @option params [required, Hash<String,String>] :tags
1785
2022
  # Array of tags to be added or updated. Array of maps, each of the form
1786
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1787
- # details, including restrictions that apply to tags and "Tag naming
1788
- # limits and requirements"; Amazon IVS has no constraints beyond what
1789
- # is documented there.
2023
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
2024
+ # *Tagging AWS Resources and Tag Editor* for details, including
2025
+ # restrictions that apply to tags and "Tag naming limits and
2026
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2027
+ # documented there.
1790
2028
  #
1791
2029
  #
1792
2030
  #
1793
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2031
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1794
2032
  #
1795
2033
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1796
2034
  #
@@ -1819,14 +2057,15 @@ module Aws::IVSRealTime
1819
2057
  #
1820
2058
  # @option params [required, Array<String>] :tag_keys
1821
2059
  # Array of tags to be removed. Array of maps, each of the form
1822
- # `string:string (key:value)`. See [Tagging AWS Resources][1] for
1823
- # details, including restrictions that apply to tags and "Tag naming
1824
- # limits and requirements"; Amazon IVS has no constraints beyond what
1825
- # is documented there.
2060
+ # `string:string (key:value)`. See [Best practices and strategies][1] in
2061
+ # *Tagging AWS Resources and Tag Editor* for details, including
2062
+ # restrictions that apply to tags and "Tag naming limits and
2063
+ # requirements"; Amazon IVS has no constraints on tags beyond what is
2064
+ # documented there.
1826
2065
  #
1827
2066
  #
1828
2067
  #
1829
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
2068
+ # [1]: https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html
1830
2069
  #
1831
2070
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1832
2071
  #
@@ -1846,6 +2085,52 @@ module Aws::IVSRealTime
1846
2085
  req.send_request(options)
1847
2086
  end
1848
2087
 
2088
+ # Updates a specified IngestConfiguration. Only the stage ARN attached
2089
+ # to the IngestConfiguration can be updated. An IngestConfiguration that
2090
+ # is active cannot be updated.
2091
+ #
2092
+ # @option params [required, String] :arn
2093
+ # ARN of the IngestConfiguration, for which the related stage ARN needs
2094
+ # to be updated.
2095
+ #
2096
+ # @option params [String] :stage_arn
2097
+ # Stage ARN that needs to be updated.
2098
+ #
2099
+ # @return [Types::UpdateIngestConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2100
+ #
2101
+ # * {Types::UpdateIngestConfigurationResponse#ingest_configuration #ingest_configuration} => Types::IngestConfiguration
2102
+ #
2103
+ # @example Request syntax with placeholder values
2104
+ #
2105
+ # resp = client.update_ingest_configuration({
2106
+ # arn: "IngestConfigurationArn", # required
2107
+ # stage_arn: "IngestConfigurationStageArn",
2108
+ # })
2109
+ #
2110
+ # @example Response structure
2111
+ #
2112
+ # resp.ingest_configuration.name #=> String
2113
+ # resp.ingest_configuration.arn #=> String
2114
+ # resp.ingest_configuration.ingest_protocol #=> String, one of "RTMP", "RTMPS"
2115
+ # resp.ingest_configuration.stream_key #=> String
2116
+ # resp.ingest_configuration.stage_arn #=> String
2117
+ # resp.ingest_configuration.participant_id #=> String
2118
+ # resp.ingest_configuration.state #=> String, one of "ACTIVE", "INACTIVE"
2119
+ # resp.ingest_configuration.user_id #=> String
2120
+ # resp.ingest_configuration.attributes #=> Hash
2121
+ # resp.ingest_configuration.attributes["String"] #=> String
2122
+ # resp.ingest_configuration.tags #=> Hash
2123
+ # resp.ingest_configuration.tags["TagKey"] #=> String
2124
+ #
2125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateIngestConfiguration AWS API Documentation
2126
+ #
2127
+ # @overload update_ingest_configuration(params = {})
2128
+ # @param [Hash] params ({})
2129
+ def update_ingest_configuration(params = {}, options = {})
2130
+ req = build_request(:update_ingest_configuration, params)
2131
+ req.send_request(options)
2132
+ end
2133
+
1849
2134
  # Updates a stage’s configuration.
1850
2135
  #
1851
2136
  # @option params [required, String] :arn
@@ -1886,6 +2171,8 @@ module Aws::IVSRealTime
1886
2171
  # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
1887
2172
  # resp.stage.endpoints.events #=> String
1888
2173
  # resp.stage.endpoints.whip #=> String
2174
+ # resp.stage.endpoints.rtmp #=> String
2175
+ # resp.stage.endpoints.rtmps #=> String
1889
2176
  #
1890
2177
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage AWS API Documentation
1891
2178
  #
@@ -1914,7 +2201,7 @@ module Aws::IVSRealTime
1914
2201
  tracer: tracer
1915
2202
  )
1916
2203
  context[:gem_name] = 'aws-sdk-ivsrealtime'
1917
- context[:gem_version] = '1.26.0'
2204
+ context[:gem_version] = '1.28.0'
1918
2205
  Seahorse::Client::Request.new(handlers, context)
1919
2206
  end
1920
2207