aws-sdk-ivsrealtime 1.19.0 → 1.21.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -89,6 +89,11 @@ module Aws::IVSRealTime
89
89
 
90
90
  # @overload initialize(options)
91
91
  # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
92
97
  # @option options [required, Aws::CredentialProvider] :credentials
93
98
  # Your AWS credentials. This can be an instance of any one of the
94
99
  # following classes:
@@ -209,7 +214,6 @@ module Aws::IVSRealTime
209
214
  # 'https://example.com'
210
215
  # 'http://example.com:123'
211
216
  #
212
- #
213
217
  # @option options [Integer] :endpoint_cache_max_entries (1000)
214
218
  # Used for the maximum size limit of the LRU cache storing endpoints data
215
219
  # for endpoint discovery enabled operations. Defaults to 1000.
@@ -298,7 +302,6 @@ module Aws::IVSRealTime
298
302
  # throttling. This is a provisional mode that may change behavior
299
303
  # in the future.
300
304
  #
301
- #
302
305
  # @option options [String] :sdk_ua_app_id
303
306
  # A unique and opaque application ID that is appended to the
304
307
  # User-Agent header as app/sdk_ua_app_id. It should have a
@@ -418,6 +421,10 @@ module Aws::IVSRealTime
418
421
  # @option params [String] :name
419
422
  # Optional name to identify the resource.
420
423
  #
424
+ # @option params [Types::Video] :video
425
+ # Video configuration. Default: video resolution 1280x720, bitrate 2500
426
+ # kbps, 30 fps.
427
+ #
421
428
  # @option params [Hash<String,String>] :tags
422
429
  # Tags attached to the resource. Array of maps, each of the form
423
430
  # `string:string (key:value)`. See [Tagging AWS Resources][1] for
@@ -429,10 +436,6 @@ module Aws::IVSRealTime
429
436
  #
430
437
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
431
438
  #
432
- # @option params [Types::Video] :video
433
- # Video configuration. Default: video resolution 1280x720, bitrate 2500
434
- # kbps, 30 fps.
435
- #
436
439
  # @return [Types::CreateEncoderConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
437
440
  #
438
441
  # * {Types::CreateEncoderConfigurationResponse#encoder_configuration #encoder_configuration} => Types::EncoderConfiguration
@@ -441,14 +444,14 @@ module Aws::IVSRealTime
441
444
  #
442
445
  # resp = client.create_encoder_configuration({
443
446
  # name: "EncoderConfigurationName",
444
- # tags: {
445
- # "TagKey" => "TagValue",
446
- # },
447
447
  # video: {
448
- # bitrate: 1,
449
- # framerate: 1.0,
450
- # height: 1,
451
448
  # width: 1,
449
+ # height: 1,
450
+ # framerate: 1.0,
451
+ # bitrate: 1,
452
+ # },
453
+ # tags: {
454
+ # "TagKey" => "TagValue",
452
455
  # },
453
456
  # })
454
457
  #
@@ -456,12 +459,12 @@ module Aws::IVSRealTime
456
459
  #
457
460
  # resp.encoder_configuration.arn #=> String
458
461
  # resp.encoder_configuration.name #=> String
462
+ # resp.encoder_configuration.video.width #=> Integer
463
+ # resp.encoder_configuration.video.height #=> Integer
464
+ # resp.encoder_configuration.video.framerate #=> Float
465
+ # resp.encoder_configuration.video.bitrate #=> Integer
459
466
  # resp.encoder_configuration.tags #=> Hash
460
467
  # resp.encoder_configuration.tags["TagKey"] #=> String
461
- # resp.encoder_configuration.video.bitrate #=> Integer
462
- # resp.encoder_configuration.video.framerate #=> Float
463
- # resp.encoder_configuration.video.height #=> Integer
464
- # resp.encoder_configuration.video.width #=> Integer
465
468
  #
466
469
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateEncoderConfiguration AWS API Documentation
467
470
  #
@@ -479,30 +482,30 @@ module Aws::IVSRealTime
479
482
  # Encryption keys are owned by Amazon IVS and never used directly by
480
483
  # your application.
481
484
  #
482
- # @option params [Hash<String,String>] :attributes
483
- # Application-provided attributes to encode into the token and attach to
484
- # a stage. Map keys and values can contain UTF-8 encoded text. The
485
- # maximum length of this field is 1 KB total. *This field is exposed to
486
- # all stage participants and should not be used for personally
487
- # identifying, confidential, or sensitive information.*
488
- #
489
- # @option params [Array<String>] :capabilities
490
- # Set of capabilities that the user is allowed to perform in the stage.
491
- # Default: `PUBLISH, SUBSCRIBE`.
485
+ # @option params [required, String] :stage_arn
486
+ # ARN of the stage to which this token is scoped.
492
487
  #
493
488
  # @option params [Integer] :duration
494
489
  # Duration (in minutes), after which the token expires. Default: 720 (12
495
490
  # hours).
496
491
  #
497
- # @option params [required, String] :stage_arn
498
- # ARN of the stage to which this token is scoped.
499
- #
500
492
  # @option params [String] :user_id
501
493
  # Name that can be specified to help identify the token. This can be any
502
494
  # UTF-8 encoded text. *This field is exposed to all stage participants
503
495
  # and should not be used for personally identifying, confidential, or
504
496
  # sensitive information.*
505
497
  #
498
+ # @option params [Hash<String,String>] :attributes
499
+ # Application-provided attributes to encode into the token and attach to
500
+ # a stage. Map keys and values can contain UTF-8 encoded text. The
501
+ # maximum length of this field is 1 KB total. *This field is exposed to
502
+ # all stage participants and should not be used for personally
503
+ # identifying, confidential, or sensitive information.*
504
+ #
505
+ # @option params [Array<String>] :capabilities
506
+ # Set of capabilities that the user is allowed to perform in the stage.
507
+ # Default: `PUBLISH, SUBSCRIBE`.
508
+ #
506
509
  # @return [Types::CreateParticipantTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
507
510
  #
508
511
  # * {Types::CreateParticipantTokenResponse#participant_token #participant_token} => Types::ParticipantToken
@@ -510,26 +513,26 @@ module Aws::IVSRealTime
510
513
  # @example Request syntax with placeholder values
511
514
  #
512
515
  # resp = client.create_participant_token({
516
+ # stage_arn: "StageArn", # required
517
+ # duration: 1,
518
+ # user_id: "ParticipantTokenUserId",
513
519
  # attributes: {
514
520
  # "String" => "String",
515
521
  # },
516
522
  # capabilities: ["PUBLISH"], # accepts PUBLISH, SUBSCRIBE
517
- # duration: 1,
518
- # stage_arn: "StageArn", # required
519
- # user_id: "ParticipantTokenUserId",
520
523
  # })
521
524
  #
522
525
  # @example Response structure
523
526
  #
527
+ # resp.participant_token.participant_id #=> String
528
+ # resp.participant_token.token #=> String
529
+ # resp.participant_token.user_id #=> String
524
530
  # resp.participant_token.attributes #=> Hash
525
531
  # resp.participant_token.attributes["String"] #=> String
532
+ # resp.participant_token.duration #=> Integer
526
533
  # resp.participant_token.capabilities #=> Array
527
534
  # resp.participant_token.capabilities[0] #=> String, one of "PUBLISH", "SUBSCRIBE"
528
- # resp.participant_token.duration #=> Integer
529
535
  # resp.participant_token.expiration_time #=> Time
530
- # resp.participant_token.participant_id #=> String
531
- # resp.participant_token.token #=> String
532
- # resp.participant_token.user_id #=> String
533
536
  #
534
537
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateParticipantToken AWS API Documentation
535
538
  #
@@ -560,10 +563,13 @@ module Aws::IVSRealTime
560
563
  #
561
564
  # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
562
565
  #
566
+ # @option params [Types::AutoParticipantRecordingConfiguration] :auto_participant_recording_configuration
567
+ # Auto participant recording configuration object attached to the stage.
568
+ #
563
569
  # @return [Types::CreateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
564
570
  #
565
- # * {Types::CreateStageResponse#participant_tokens #participant_tokens} => Array&lt;Types::ParticipantToken&gt;
566
571
  # * {Types::CreateStageResponse#stage #stage} => Types::Stage
572
+ # * {Types::CreateStageResponse#participant_tokens #participant_tokens} => Array&lt;Types::ParticipantToken&gt;
567
573
  #
568
574
  # @example Request syntax with placeholder values
569
575
  #
@@ -571,36 +577,43 @@ module Aws::IVSRealTime
571
577
  # name: "StageName",
572
578
  # participant_token_configurations: [
573
579
  # {
580
+ # duration: 1,
581
+ # user_id: "ParticipantTokenUserId",
574
582
  # attributes: {
575
583
  # "String" => "String",
576
584
  # },
577
585
  # capabilities: ["PUBLISH"], # accepts PUBLISH, SUBSCRIBE
578
- # duration: 1,
579
- # user_id: "ParticipantTokenUserId",
580
586
  # },
581
587
  # ],
582
588
  # tags: {
583
589
  # "TagKey" => "TagValue",
584
590
  # },
591
+ # auto_participant_recording_configuration: {
592
+ # storage_configuration_arn: "AutoParticipantRecordingStorageConfigurationArn", # required
593
+ # media_types: ["AUDIO_VIDEO"], # accepts AUDIO_VIDEO, AUDIO_ONLY
594
+ # },
585
595
  # })
586
596
  #
587
597
  # @example Response structure
588
598
  #
599
+ # resp.stage.arn #=> String
600
+ # resp.stage.name #=> String
601
+ # resp.stage.active_session_id #=> String
602
+ # resp.stage.tags #=> Hash
603
+ # resp.stage.tags["TagKey"] #=> String
604
+ # resp.stage.auto_participant_recording_configuration.storage_configuration_arn #=> String
605
+ # resp.stage.auto_participant_recording_configuration.media_types #=> Array
606
+ # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
589
607
  # resp.participant_tokens #=> Array
608
+ # resp.participant_tokens[0].participant_id #=> String
609
+ # resp.participant_tokens[0].token #=> String
610
+ # resp.participant_tokens[0].user_id #=> String
590
611
  # resp.participant_tokens[0].attributes #=> Hash
591
612
  # resp.participant_tokens[0].attributes["String"] #=> String
613
+ # resp.participant_tokens[0].duration #=> Integer
592
614
  # resp.participant_tokens[0].capabilities #=> Array
593
615
  # resp.participant_tokens[0].capabilities[0] #=> String, one of "PUBLISH", "SUBSCRIBE"
594
- # resp.participant_tokens[0].duration #=> Integer
595
616
  # resp.participant_tokens[0].expiration_time #=> Time
596
- # resp.participant_tokens[0].participant_id #=> String
597
- # resp.participant_tokens[0].token #=> String
598
- # resp.participant_tokens[0].user_id #=> String
599
- # resp.stage.active_session_id #=> String
600
- # resp.stage.arn #=> String
601
- # resp.stage.name #=> String
602
- # resp.stage.tags #=> Hash
603
- # resp.stage.tags["TagKey"] #=> String
604
617
  #
605
618
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/CreateStage AWS API Documentation
606
619
  #
@@ -744,6 +757,9 @@ module Aws::IVSRealTime
744
757
  # Disconnects a specified participant and revokes the participant
745
758
  # permanently from a specified stage.
746
759
  #
760
+ # @option params [required, String] :stage_arn
761
+ # ARN of the stage to which the participant is attached.
762
+ #
747
763
  # @option params [required, String] :participant_id
748
764
  # Identifier of the participant to be disconnected. This is assigned by
749
765
  # IVS and returned by CreateParticipantToken.
@@ -751,17 +767,14 @@ module Aws::IVSRealTime
751
767
  # @option params [String] :reason
752
768
  # Description of why this participant is being disconnected.
753
769
  #
754
- # @option params [required, String] :stage_arn
755
- # ARN of the stage to which the participant is attached.
756
- #
757
770
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
758
771
  #
759
772
  # @example Request syntax with placeholder values
760
773
  #
761
774
  # resp = client.disconnect_participant({
775
+ # stage_arn: "StageArn", # required
762
776
  # participant_id: "ParticipantTokenId", # required
763
777
  # reason: "DisconnectParticipantReason",
764
- # stage_arn: "StageArn", # required
765
778
  # })
766
779
  #
767
780
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DisconnectParticipant AWS API Documentation
@@ -791,40 +804,40 @@ module Aws::IVSRealTime
791
804
  # @example Response structure
792
805
  #
793
806
  # resp.composition.arn #=> String
794
- # resp.composition.destinations #=> Array
795
- # resp.composition.destinations[0].configuration.channel.channel_arn #=> String
796
- # resp.composition.destinations[0].configuration.channel.encoder_configuration_arn #=> String
797
- # resp.composition.destinations[0].configuration.name #=> String
798
- # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns #=> Array
799
- # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns[0] #=> String
800
- # resp.composition.destinations[0].configuration.s3.recording_configuration.format #=> String, one of "HLS"
801
- # resp.composition.destinations[0].configuration.s3.storage_configuration_arn #=> String
802
- # resp.composition.destinations[0].detail.s3.recording_prefix #=> String
803
- # resp.composition.destinations[0].end_time #=> Time
804
- # resp.composition.destinations[0].id #=> String
805
- # resp.composition.destinations[0].start_time #=> Time
806
- # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
807
- # resp.composition.end_time #=> Time
807
+ # resp.composition.stage_arn #=> String
808
+ # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
808
809
  # resp.composition.layout.grid.featured_participant_attribute #=> String
809
- # resp.composition.layout.grid.grid_gap #=> Integer
810
810
  # resp.composition.layout.grid.omit_stopped_video #=> Boolean
811
811
  # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
812
812
  # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
813
+ # resp.composition.layout.grid.grid_gap #=> Integer
813
814
  # resp.composition.layout.pip.featured_participant_attribute #=> String
814
- # resp.composition.layout.pip.grid_gap #=> Integer
815
815
  # resp.composition.layout.pip.omit_stopped_video #=> Boolean
816
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
817
+ # resp.composition.layout.pip.grid_gap #=> Integer
818
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
816
819
  # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
817
- # resp.composition.layout.pip.pip_height #=> Integer
818
820
  # resp.composition.layout.pip.pip_offset #=> Integer
819
- # resp.composition.layout.pip.pip_participant_attribute #=> String
820
821
  # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
821
822
  # resp.composition.layout.pip.pip_width #=> Integer
822
- # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
823
- # resp.composition.stage_arn #=> String
824
- # resp.composition.start_time #=> Time
825
- # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
823
+ # resp.composition.layout.pip.pip_height #=> Integer
824
+ # resp.composition.destinations #=> Array
825
+ # resp.composition.destinations[0].id #=> String
826
+ # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
827
+ # resp.composition.destinations[0].start_time #=> Time
828
+ # resp.composition.destinations[0].end_time #=> Time
829
+ # resp.composition.destinations[0].configuration.name #=> String
830
+ # resp.composition.destinations[0].configuration.channel.channel_arn #=> String
831
+ # resp.composition.destinations[0].configuration.channel.encoder_configuration_arn #=> String
832
+ # resp.composition.destinations[0].configuration.s3.storage_configuration_arn #=> String
833
+ # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns #=> Array
834
+ # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns[0] #=> String
835
+ # resp.composition.destinations[0].configuration.s3.recording_configuration.format #=> String, one of "HLS"
836
+ # resp.composition.destinations[0].detail.s3.recording_prefix #=> String
826
837
  # resp.composition.tags #=> Hash
827
838
  # resp.composition.tags["TagKey"] #=> String
839
+ # resp.composition.start_time #=> Time
840
+ # resp.composition.end_time #=> Time
828
841
  #
829
842
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetComposition AWS API Documentation
830
843
  #
@@ -854,12 +867,12 @@ module Aws::IVSRealTime
854
867
  #
855
868
  # resp.encoder_configuration.arn #=> String
856
869
  # resp.encoder_configuration.name #=> String
870
+ # resp.encoder_configuration.video.width #=> Integer
871
+ # resp.encoder_configuration.video.height #=> Integer
872
+ # resp.encoder_configuration.video.framerate #=> Float
873
+ # resp.encoder_configuration.video.bitrate #=> Integer
857
874
  # resp.encoder_configuration.tags #=> Hash
858
875
  # resp.encoder_configuration.tags["TagKey"] #=> String
859
- # resp.encoder_configuration.video.bitrate #=> Integer
860
- # resp.encoder_configuration.video.framerate #=> Float
861
- # resp.encoder_configuration.video.height #=> Integer
862
- # resp.encoder_configuration.video.width #=> Integer
863
876
  #
864
877
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetEncoderConfiguration AWS API Documentation
865
878
  #
@@ -872,15 +885,15 @@ module Aws::IVSRealTime
872
885
 
873
886
  # Gets information about the specified participant token.
874
887
  #
875
- # @option params [required, String] :participant_id
876
- # Unique identifier for the participant. This is assigned by IVS and
877
- # returned by CreateParticipantToken.
888
+ # @option params [required, String] :stage_arn
889
+ # Stage ARN.
878
890
  #
879
891
  # @option params [required, String] :session_id
880
892
  # ID of a session within the stage.
881
893
  #
882
- # @option params [required, String] :stage_arn
883
- # Stage ARN.
894
+ # @option params [required, String] :participant_id
895
+ # Unique identifier for the participant. This is assigned by IVS and
896
+ # returned by CreateParticipantToken.
884
897
  #
885
898
  # @return [Types::GetParticipantResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
886
899
  #
@@ -889,26 +902,29 @@ module Aws::IVSRealTime
889
902
  # @example Request syntax with placeholder values
890
903
  #
891
904
  # resp = client.get_participant({
892
- # participant_id: "ParticipantId", # required
893
- # session_id: "StageSessionId", # required
894
905
  # stage_arn: "StageArn", # required
906
+ # session_id: "StageSessionId", # required
907
+ # participant_id: "ParticipantId", # required
895
908
  # })
896
909
  #
897
910
  # @example Response structure
898
911
  #
912
+ # resp.participant.participant_id #=> String
913
+ # resp.participant.user_id #=> String
914
+ # resp.participant.state #=> String, one of "CONNECTED", "DISCONNECTED"
915
+ # resp.participant.first_join_time #=> Time
899
916
  # resp.participant.attributes #=> Hash
900
917
  # resp.participant.attributes["String"] #=> String
901
- # resp.participant.browser_name #=> String
902
- # resp.participant.browser_version #=> String
903
- # resp.participant.first_join_time #=> Time
918
+ # resp.participant.published #=> Boolean
904
919
  # resp.participant.isp_name #=> String
905
920
  # resp.participant.os_name #=> String
906
921
  # resp.participant.os_version #=> String
907
- # resp.participant.participant_id #=> String
908
- # resp.participant.published #=> Boolean
922
+ # resp.participant.browser_name #=> String
923
+ # resp.participant.browser_version #=> String
909
924
  # resp.participant.sdk_version #=> String
910
- # resp.participant.state #=> String, one of "CONNECTED", "DISCONNECTED"
911
- # resp.participant.user_id #=> String
925
+ # resp.participant.recording_s3_bucket_name #=> String
926
+ # resp.participant.recording_s3_prefix #=> String
927
+ # resp.participant.recording_state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "STOPPED", "FAILED", "DISABLED"
912
928
  #
913
929
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetParticipant AWS API Documentation
914
930
  #
@@ -936,11 +952,14 @@ module Aws::IVSRealTime
936
952
  #
937
953
  # @example Response structure
938
954
  #
939
- # resp.stage.active_session_id #=> String
940
955
  # resp.stage.arn #=> String
941
956
  # resp.stage.name #=> String
957
+ # resp.stage.active_session_id #=> String
942
958
  # resp.stage.tags #=> Hash
943
959
  # resp.stage.tags["TagKey"] #=> String
960
+ # resp.stage.auto_participant_recording_configuration.storage_configuration_arn #=> String
961
+ # resp.stage.auto_participant_recording_configuration.media_types #=> Array
962
+ # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
944
963
  #
945
964
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStage AWS API Documentation
946
965
  #
@@ -953,12 +972,12 @@ module Aws::IVSRealTime
953
972
 
954
973
  # Gets information for the specified stage session.
955
974
  #
956
- # @option params [required, String] :session_id
957
- # ID of a session within the stage.
958
- #
959
975
  # @option params [required, String] :stage_arn
960
976
  # ARN of the stage for which the information is to be retrieved.
961
977
  #
978
+ # @option params [required, String] :session_id
979
+ # ID of a session within the stage.
980
+ #
962
981
  # @return [Types::GetStageSessionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
963
982
  #
964
983
  # * {Types::GetStageSessionResponse#stage_session #stage_session} => Types::StageSession
@@ -966,15 +985,15 @@ module Aws::IVSRealTime
966
985
  # @example Request syntax with placeholder values
967
986
  #
968
987
  # resp = client.get_stage_session({
969
- # session_id: "StageSessionId", # required
970
988
  # stage_arn: "StageArn", # required
989
+ # session_id: "StageSessionId", # required
971
990
  # })
972
991
  #
973
992
  # @example Response structure
974
993
  #
975
- # resp.stage_session.end_time #=> Time
976
994
  # resp.stage_session.session_id #=> String
977
995
  # resp.stage_session.start_time #=> Time
996
+ # resp.stage_session.end_time #=> Time
978
997
  #
979
998
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetStageSession AWS API Documentation
980
999
  #
@@ -1020,20 +1039,20 @@ module Aws::IVSRealTime
1020
1039
  # Gets summary information about all Compositions in your account, in
1021
1040
  # the AWS region where the API request is processed.
1022
1041
  #
1023
- # @option params [String] :filter_by_encoder_configuration_arn
1024
- # Filters the Composition list to match the specified
1025
- # EncoderConfiguration attached to at least one of its output.
1026
- #
1027
1042
  # @option params [String] :filter_by_stage_arn
1028
1043
  # Filters the Composition list to match the specified Stage ARN.
1029
1044
  #
1030
- # @option params [Integer] :max_results
1031
- # Maximum number of results to return. Default: 100.
1045
+ # @option params [String] :filter_by_encoder_configuration_arn
1046
+ # Filters the Composition list to match the specified
1047
+ # EncoderConfiguration attached to at least one of its output.
1032
1048
  #
1033
1049
  # @option params [String] :next_token
1034
1050
  # The first Composition to retrieve. This is used for pagination; see
1035
1051
  # the `nextToken` response field.
1036
1052
  #
1053
+ # @option params [Integer] :max_results
1054
+ # Maximum number of results to return. Default: 100.
1055
+ #
1037
1056
  # @return [Types::ListCompositionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1038
1057
  #
1039
1058
  # * {Types::ListCompositionsResponse#compositions #compositions} => Array&lt;Types::CompositionSummary&gt;
@@ -1044,27 +1063,27 @@ module Aws::IVSRealTime
1044
1063
  # @example Request syntax with placeholder values
1045
1064
  #
1046
1065
  # resp = client.list_compositions({
1047
- # filter_by_encoder_configuration_arn: "EncoderConfigurationArn",
1048
1066
  # filter_by_stage_arn: "StageArn",
1049
- # max_results: 1,
1067
+ # filter_by_encoder_configuration_arn: "EncoderConfigurationArn",
1050
1068
  # next_token: "PaginationToken",
1069
+ # max_results: 1,
1051
1070
  # })
1052
1071
  #
1053
1072
  # @example Response structure
1054
1073
  #
1055
1074
  # resp.compositions #=> Array
1056
1075
  # resp.compositions[0].arn #=> String
1076
+ # resp.compositions[0].stage_arn #=> String
1057
1077
  # resp.compositions[0].destinations #=> Array
1058
- # resp.compositions[0].destinations[0].end_time #=> Time
1059
1078
  # resp.compositions[0].destinations[0].id #=> String
1060
- # resp.compositions[0].destinations[0].start_time #=> Time
1061
1079
  # resp.compositions[0].destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
1062
- # resp.compositions[0].end_time #=> Time
1063
- # resp.compositions[0].stage_arn #=> String
1064
- # resp.compositions[0].start_time #=> Time
1080
+ # resp.compositions[0].destinations[0].start_time #=> Time
1081
+ # resp.compositions[0].destinations[0].end_time #=> Time
1065
1082
  # resp.compositions[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
1066
1083
  # resp.compositions[0].tags #=> Hash
1067
1084
  # resp.compositions[0].tags["TagKey"] #=> String
1085
+ # resp.compositions[0].start_time #=> Time
1086
+ # resp.compositions[0].end_time #=> Time
1068
1087
  # resp.next_token #=> String
1069
1088
  #
1070
1089
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListCompositions AWS API Documentation
@@ -1079,13 +1098,13 @@ module Aws::IVSRealTime
1079
1098
  # Gets summary information about all EncoderConfigurations in your
1080
1099
  # account, in the AWS region where the API request is processed.
1081
1100
  #
1082
- # @option params [Integer] :max_results
1083
- # Maximum number of results to return. Default: 100.
1084
- #
1085
1101
  # @option params [String] :next_token
1086
1102
  # The first encoder configuration to retrieve. This is used for
1087
1103
  # pagination; see the `nextToken` response field.
1088
1104
  #
1105
+ # @option params [Integer] :max_results
1106
+ # Maximum number of results to return. Default: 100.
1107
+ #
1089
1108
  # @return [Types::ListEncoderConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1090
1109
  #
1091
1110
  # * {Types::ListEncoderConfigurationsResponse#encoder_configurations #encoder_configurations} => Array&lt;Types::EncoderConfigurationSummary&gt;
@@ -1096,8 +1115,8 @@ module Aws::IVSRealTime
1096
1115
  # @example Request syntax with placeholder values
1097
1116
  #
1098
1117
  # resp = client.list_encoder_configurations({
1099
- # max_results: 1,
1100
1118
  # next_token: "PaginationToken",
1119
+ # max_results: 1,
1101
1120
  # })
1102
1121
  #
1103
1122
  # @example Response structure
@@ -1121,22 +1140,22 @@ module Aws::IVSRealTime
1121
1140
  # Lists events for a specified participant that occurred during a
1122
1141
  # specified stage session.
1123
1142
  #
1124
- # @option params [Integer] :max_results
1125
- # Maximum number of results to return. Default: 50.
1143
+ # @option params [required, String] :stage_arn
1144
+ # Stage ARN.
1126
1145
  #
1127
- # @option params [String] :next_token
1128
- # The first participant event to retrieve. This is used for pagination;
1129
- # see the `nextToken` response field.
1146
+ # @option params [required, String] :session_id
1147
+ # ID of a session within the stage.
1130
1148
  #
1131
1149
  # @option params [required, String] :participant_id
1132
1150
  # Unique identifier for this participant. This is assigned by IVS and
1133
1151
  # returned by CreateParticipantToken.
1134
1152
  #
1135
- # @option params [required, String] :session_id
1136
- # ID of a session within the stage.
1153
+ # @option params [String] :next_token
1154
+ # The first participant event to retrieve. This is used for pagination;
1155
+ # see the `nextToken` response field.
1137
1156
  #
1138
- # @option params [required, String] :stage_arn
1139
- # Stage ARN.
1157
+ # @option params [Integer] :max_results
1158
+ # Maximum number of results to return. Default: 50.
1140
1159
  #
1141
1160
  # @return [Types::ListParticipantEventsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1142
1161
  #
@@ -1148,21 +1167,21 @@ module Aws::IVSRealTime
1148
1167
  # @example Request syntax with placeholder values
1149
1168
  #
1150
1169
  # resp = client.list_participant_events({
1151
- # max_results: 1,
1152
- # next_token: "PaginationToken",
1153
- # participant_id: "ParticipantId", # required
1154
- # session_id: "StageSessionId", # required
1155
1170
  # stage_arn: "StageArn", # required
1171
+ # session_id: "StageSessionId", # required
1172
+ # participant_id: "ParticipantId", # required
1173
+ # next_token: "PaginationToken",
1174
+ # max_results: 1,
1156
1175
  # })
1157
1176
  #
1158
1177
  # @example Response structure
1159
1178
  #
1160
1179
  # resp.events #=> Array
1161
- # resp.events[0].error_code #=> String, one of "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", "PUBLISHER_NOT_FOUND"
1162
- # resp.events[0].event_time #=> Time
1163
1180
  # resp.events[0].name #=> String, one of "JOINED", "LEFT", "PUBLISH_STARTED", "PUBLISH_STOPPED", "SUBSCRIBE_STARTED", "SUBSCRIBE_STOPPED", "PUBLISH_ERROR", "SUBSCRIBE_ERROR", "JOIN_ERROR"
1164
1181
  # resp.events[0].participant_id #=> String
1182
+ # resp.events[0].event_time #=> Time
1165
1183
  # resp.events[0].remote_participant_id #=> String
1184
+ # resp.events[0].error_code #=> String, one of "INSUFFICIENT_CAPABILITIES", "QUOTA_EXCEEDED", "PUBLISHER_NOT_FOUND"
1166
1185
  # resp.next_token #=> String
1167
1186
  #
1168
1187
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipantEvents AWS API Documentation
@@ -1176,64 +1195,74 @@ module Aws::IVSRealTime
1176
1195
 
1177
1196
  # Lists all participants in a specified stage session.
1178
1197
  #
1198
+ # @option params [required, String] :stage_arn
1199
+ # Stage ARN.
1200
+ #
1201
+ # @option params [required, String] :session_id
1202
+ # ID of the session within the stage.
1203
+ #
1204
+ # @option params [String] :filter_by_user_id
1205
+ # Filters the response list to match the specified user ID. Only one of
1206
+ # `filterByUserId`, `filterByPublished`, `filterByState`, or
1207
+ # `filterByRecordingState` can be provided per request. A `userId` is a
1208
+ # customer-assigned name to help identify the token; this can be used to
1209
+ # link a participant to a user in the customer’s own systems.
1210
+ #
1179
1211
  # @option params [Boolean] :filter_by_published
1180
1212
  # Filters the response list to only show participants who published
1181
1213
  # during the stage session. Only one of `filterByUserId`,
1182
- # `filterByPublished`, or `filterByState` can be provided per request.
1214
+ # `filterByPublished`, `filterByState`, or `filterByRecordingState` can
1215
+ # be provided per request.
1183
1216
  #
1184
1217
  # @option params [String] :filter_by_state
1185
1218
  # Filters the response list to only show participants in the specified
1186
- # state. Only one of `filterByUserId`, `filterByPublished`, or
1187
- # `filterByState` can be provided per request.
1188
- #
1189
- # @option params [String] :filter_by_user_id
1190
- # Filters the response list to match the specified user ID. Only one of
1191
- # `filterByUserId`, `filterByPublished`, or `filterByState` can be
1192
- # provided per request. A `userId` is a customer-assigned name to help
1193
- # identify the token; this can be used to link a participant to a user
1194
- # in the customer’s own systems.
1195
- #
1196
- # @option params [Integer] :max_results
1197
- # Maximum number of results to return. Default: 50.
1219
+ # state. Only one of `filterByUserId`, `filterByPublished`,
1220
+ # `filterByState`, or `filterByRecordingState` can be provided per
1221
+ # request.
1198
1222
  #
1199
1223
  # @option params [String] :next_token
1200
1224
  # The first participant to retrieve. This is used for pagination; see
1201
1225
  # the `nextToken` response field.
1202
1226
  #
1203
- # @option params [required, String] :session_id
1204
- # ID of the session within the stage.
1227
+ # @option params [Integer] :max_results
1228
+ # Maximum number of results to return. Default: 50.
1205
1229
  #
1206
- # @option params [required, String] :stage_arn
1207
- # Stage ARN.
1230
+ # @option params [String] :filter_by_recording_state
1231
+ # Filters the response list to only show participants with the specified
1232
+ # recording state. Only one of `filterByUserId`, `filterByPublished`,
1233
+ # `filterByState`, or `filterByRecordingState` can be provided per
1234
+ # request.
1208
1235
  #
1209
1236
  # @return [Types::ListParticipantsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1210
1237
  #
1211
- # * {Types::ListParticipantsResponse#next_token #next_token} => String
1212
1238
  # * {Types::ListParticipantsResponse#participants #participants} => Array&lt;Types::ParticipantSummary&gt;
1239
+ # * {Types::ListParticipantsResponse#next_token #next_token} => String
1213
1240
  #
1214
1241
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1215
1242
  #
1216
1243
  # @example Request syntax with placeholder values
1217
1244
  #
1218
1245
  # resp = client.list_participants({
1246
+ # stage_arn: "StageArn", # required
1247
+ # session_id: "StageSessionId", # required
1248
+ # filter_by_user_id: "UserId",
1219
1249
  # filter_by_published: false,
1220
1250
  # filter_by_state: "CONNECTED", # accepts CONNECTED, DISCONNECTED
1221
- # filter_by_user_id: "UserId",
1222
- # max_results: 1,
1223
1251
  # next_token: "PaginationToken",
1224
- # session_id: "StageSessionId", # required
1225
- # stage_arn: "StageArn", # required
1252
+ # max_results: 1,
1253
+ # filter_by_recording_state: "STARTING", # accepts STARTING, ACTIVE, STOPPING, STOPPED, FAILED
1226
1254
  # })
1227
1255
  #
1228
1256
  # @example Response structure
1229
1257
  #
1230
- # resp.next_token #=> String
1231
1258
  # resp.participants #=> Array
1232
- # resp.participants[0].first_join_time #=> Time
1233
1259
  # resp.participants[0].participant_id #=> String
1234
- # resp.participants[0].published #=> Boolean
1235
- # resp.participants[0].state #=> String, one of "CONNECTED", "DISCONNECTED"
1236
1260
  # resp.participants[0].user_id #=> String
1261
+ # resp.participants[0].state #=> String, one of "CONNECTED", "DISCONNECTED"
1262
+ # resp.participants[0].first_join_time #=> Time
1263
+ # resp.participants[0].published #=> Boolean
1264
+ # resp.participants[0].recording_state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "STOPPED", "FAILED", "DISABLED"
1265
+ # resp.next_token #=> String
1237
1266
  #
1238
1267
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListParticipants AWS API Documentation
1239
1268
  #
@@ -1246,38 +1275,38 @@ module Aws::IVSRealTime
1246
1275
 
1247
1276
  # Gets all sessions for a specified stage.
1248
1277
  #
1249
- # @option params [Integer] :max_results
1250
- # Maximum number of results to return. Default: 50.
1278
+ # @option params [required, String] :stage_arn
1279
+ # Stage ARN.
1251
1280
  #
1252
1281
  # @option params [String] :next_token
1253
1282
  # The first stage session to retrieve. This is used for pagination; see
1254
1283
  # the `nextToken` response field.
1255
1284
  #
1256
- # @option params [required, String] :stage_arn
1257
- # Stage ARN.
1285
+ # @option params [Integer] :max_results
1286
+ # Maximum number of results to return. Default: 50.
1258
1287
  #
1259
1288
  # @return [Types::ListStageSessionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1260
1289
  #
1261
- # * {Types::ListStageSessionsResponse#next_token #next_token} => String
1262
1290
  # * {Types::ListStageSessionsResponse#stage_sessions #stage_sessions} => Array&lt;Types::StageSessionSummary&gt;
1291
+ # * {Types::ListStageSessionsResponse#next_token #next_token} => String
1263
1292
  #
1264
1293
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1265
1294
  #
1266
1295
  # @example Request syntax with placeholder values
1267
1296
  #
1268
1297
  # resp = client.list_stage_sessions({
1269
- # max_results: 1,
1270
- # next_token: "PaginationToken",
1271
1298
  # stage_arn: "StageArn", # required
1299
+ # next_token: "PaginationToken",
1300
+ # max_results: 1,
1272
1301
  # })
1273
1302
  #
1274
1303
  # @example Response structure
1275
1304
  #
1276
- # resp.next_token #=> String
1277
1305
  # resp.stage_sessions #=> Array
1278
- # resp.stage_sessions[0].end_time #=> Time
1279
1306
  # resp.stage_sessions[0].session_id #=> String
1280
1307
  # resp.stage_sessions[0].start_time #=> Time
1308
+ # resp.stage_sessions[0].end_time #=> Time
1309
+ # resp.next_token #=> String
1281
1310
  #
1282
1311
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStageSessions AWS API Documentation
1283
1312
  #
@@ -1291,36 +1320,36 @@ module Aws::IVSRealTime
1291
1320
  # Gets summary information about all stages in your account, in the AWS
1292
1321
  # region where the API request is processed.
1293
1322
  #
1294
- # @option params [Integer] :max_results
1295
- # Maximum number of results to return. Default: 50.
1296
- #
1297
1323
  # @option params [String] :next_token
1298
1324
  # The first stage to retrieve. This is used for pagination; see the
1299
1325
  # `nextToken` response field.
1300
1326
  #
1327
+ # @option params [Integer] :max_results
1328
+ # Maximum number of results to return. Default: 50.
1329
+ #
1301
1330
  # @return [Types::ListStagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1302
1331
  #
1303
- # * {Types::ListStagesResponse#next_token #next_token} => String
1304
1332
  # * {Types::ListStagesResponse#stages #stages} => Array&lt;Types::StageSummary&gt;
1333
+ # * {Types::ListStagesResponse#next_token #next_token} => String
1305
1334
  #
1306
1335
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1307
1336
  #
1308
1337
  # @example Request syntax with placeholder values
1309
1338
  #
1310
1339
  # resp = client.list_stages({
1311
- # max_results: 1,
1312
1340
  # next_token: "PaginationToken",
1341
+ # max_results: 1,
1313
1342
  # })
1314
1343
  #
1315
1344
  # @example Response structure
1316
1345
  #
1317
- # resp.next_token #=> String
1318
1346
  # resp.stages #=> Array
1319
- # resp.stages[0].active_session_id #=> String
1320
1347
  # resp.stages[0].arn #=> String
1321
1348
  # resp.stages[0].name #=> String
1349
+ # resp.stages[0].active_session_id #=> String
1322
1350
  # resp.stages[0].tags #=> Hash
1323
1351
  # resp.stages[0].tags["TagKey"] #=> String
1352
+ # resp.next_token #=> String
1324
1353
  #
1325
1354
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStages AWS API Documentation
1326
1355
  #
@@ -1334,37 +1363,37 @@ module Aws::IVSRealTime
1334
1363
  # Gets summary information about all storage configurations in your
1335
1364
  # account, in the AWS region where the API request is processed.
1336
1365
  #
1337
- # @option params [Integer] :max_results
1338
- # Maximum number of storage configurations to return. Default: your
1339
- # service quota or 100, whichever is smaller.
1340
- #
1341
1366
  # @option params [String] :next_token
1342
1367
  # The first storage configuration to retrieve. This is used for
1343
1368
  # pagination; see the `nextToken` response field.
1344
1369
  #
1370
+ # @option params [Integer] :max_results
1371
+ # Maximum number of storage configurations to return. Default: your
1372
+ # service quota or 100, whichever is smaller.
1373
+ #
1345
1374
  # @return [Types::ListStorageConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1346
1375
  #
1347
- # * {Types::ListStorageConfigurationsResponse#next_token #next_token} => String
1348
1376
  # * {Types::ListStorageConfigurationsResponse#storage_configurations #storage_configurations} => Array&lt;Types::StorageConfigurationSummary&gt;
1377
+ # * {Types::ListStorageConfigurationsResponse#next_token #next_token} => String
1349
1378
  #
1350
1379
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1351
1380
  #
1352
1381
  # @example Request syntax with placeholder values
1353
1382
  #
1354
1383
  # resp = client.list_storage_configurations({
1355
- # max_results: 1,
1356
1384
  # next_token: "PaginationToken",
1385
+ # max_results: 1,
1357
1386
  # })
1358
1387
  #
1359
1388
  # @example Response structure
1360
1389
  #
1361
- # resp.next_token #=> String
1362
1390
  # resp.storage_configurations #=> Array
1363
1391
  # resp.storage_configurations[0].arn #=> String
1364
1392
  # resp.storage_configurations[0].name #=> String
1365
1393
  # resp.storage_configurations[0].s3.bucket_name #=> String
1366
1394
  # resp.storage_configurations[0].tags #=> Hash
1367
1395
  # resp.storage_configurations[0].tags["TagKey"] #=> String
1396
+ # resp.next_token #=> String
1368
1397
  #
1369
1398
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListStorageConfigurations AWS API Documentation
1370
1399
  #
@@ -1424,8 +1453,8 @@ module Aws::IVSRealTime
1424
1453
  # * When broadcasting is disconnected and all attempts to reconnect are
1425
1454
  # exhausted.
1426
1455
  #
1427
- # @option params [required, Array<Types::DestinationConfiguration>] :destinations
1428
- # Array of destination configuration.
1456
+ # @option params [required, String] :stage_arn
1457
+ # ARN of the stage to be used for compositing.
1429
1458
  #
1430
1459
  # @option params [String] :idempotency_token
1431
1460
  # Idempotency token.
@@ -1436,8 +1465,8 @@ module Aws::IVSRealTime
1436
1465
  # @option params [Types::LayoutConfiguration] :layout
1437
1466
  # Layout object to configure composition parameters.
1438
1467
  #
1439
- # @option params [required, String] :stage_arn
1440
- # ARN of the stage to be used for compositing.
1468
+ # @option params [required, Array<Types::DestinationConfiguration>] :destinations
1469
+ # Array of destination configuration.
1441
1470
  #
1442
1471
  # @option params [Hash<String,String>] :tags
1443
1472
  # Tags attached to the resource. Array of maps, each of the form
@@ -1457,45 +1486,45 @@ module Aws::IVSRealTime
1457
1486
  # @example Request syntax with placeholder values
1458
1487
  #
1459
1488
  # resp = client.start_composition({
1460
- # destinations: [ # required
1461
- # {
1462
- # channel: {
1463
- # channel_arn: "ChannelArn", # required
1464
- # encoder_configuration_arn: "EncoderConfigurationArn",
1465
- # },
1466
- # name: "DestinationConfigurationName",
1467
- # s3: {
1468
- # encoder_configuration_arns: ["EncoderConfigurationArn"], # required
1469
- # recording_configuration: {
1470
- # format: "HLS", # accepts HLS
1471
- # },
1472
- # storage_configuration_arn: "StorageConfigurationArn", # required
1473
- # },
1474
- # },
1475
- # ],
1489
+ # stage_arn: "StageArn", # required
1476
1490
  # idempotency_token: "CompositionClientToken",
1477
1491
  # layout: {
1478
1492
  # grid: {
1479
1493
  # featured_participant_attribute: "AttributeKey",
1480
- # grid_gap: 1,
1481
1494
  # omit_stopped_video: false,
1482
1495
  # video_aspect_ratio: "AUTO", # accepts AUTO, VIDEO, SQUARE, PORTRAIT
1483
1496
  # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1497
+ # grid_gap: 1,
1484
1498
  # },
1485
1499
  # pip: {
1486
1500
  # featured_participant_attribute: "AttributeKey",
1487
- # grid_gap: 1,
1488
1501
  # omit_stopped_video: false,
1502
+ # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1503
+ # grid_gap: 1,
1504
+ # pip_participant_attribute: "AttributeKey",
1489
1505
  # pip_behavior: "STATIC", # accepts STATIC, DYNAMIC
1490
- # pip_height: 1,
1491
1506
  # pip_offset: 1,
1492
- # pip_participant_attribute: "AttributeKey",
1493
1507
  # pip_position: "TOP_LEFT", # accepts TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, BOTTOM_RIGHT
1494
1508
  # pip_width: 1,
1495
- # video_fill_mode: "FILL", # accepts FILL, COVER, CONTAIN
1509
+ # pip_height: 1,
1496
1510
  # },
1497
1511
  # },
1498
- # stage_arn: "StageArn", # required
1512
+ # destinations: [ # required
1513
+ # {
1514
+ # name: "DestinationConfigurationName",
1515
+ # channel: {
1516
+ # channel_arn: "ChannelArn", # required
1517
+ # encoder_configuration_arn: "EncoderConfigurationArn",
1518
+ # },
1519
+ # s3: {
1520
+ # storage_configuration_arn: "StorageConfigurationArn", # required
1521
+ # encoder_configuration_arns: ["EncoderConfigurationArn"], # required
1522
+ # recording_configuration: {
1523
+ # format: "HLS", # accepts HLS
1524
+ # },
1525
+ # },
1526
+ # },
1527
+ # ],
1499
1528
  # tags: {
1500
1529
  # "TagKey" => "TagValue",
1501
1530
  # },
@@ -1504,40 +1533,40 @@ module Aws::IVSRealTime
1504
1533
  # @example Response structure
1505
1534
  #
1506
1535
  # resp.composition.arn #=> String
1507
- # resp.composition.destinations #=> Array
1508
- # resp.composition.destinations[0].configuration.channel.channel_arn #=> String
1509
- # resp.composition.destinations[0].configuration.channel.encoder_configuration_arn #=> String
1510
- # resp.composition.destinations[0].configuration.name #=> String
1511
- # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns #=> Array
1512
- # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns[0] #=> String
1513
- # resp.composition.destinations[0].configuration.s3.recording_configuration.format #=> String, one of "HLS"
1514
- # resp.composition.destinations[0].configuration.s3.storage_configuration_arn #=> String
1515
- # resp.composition.destinations[0].detail.s3.recording_prefix #=> String
1516
- # resp.composition.destinations[0].end_time #=> Time
1517
- # resp.composition.destinations[0].id #=> String
1518
- # resp.composition.destinations[0].start_time #=> Time
1519
- # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
1520
- # resp.composition.end_time #=> Time
1536
+ # resp.composition.stage_arn #=> String
1537
+ # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
1521
1538
  # resp.composition.layout.grid.featured_participant_attribute #=> String
1522
- # resp.composition.layout.grid.grid_gap #=> Integer
1523
1539
  # resp.composition.layout.grid.omit_stopped_video #=> Boolean
1524
1540
  # resp.composition.layout.grid.video_aspect_ratio #=> String, one of "AUTO", "VIDEO", "SQUARE", "PORTRAIT"
1525
1541
  # resp.composition.layout.grid.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1542
+ # resp.composition.layout.grid.grid_gap #=> Integer
1526
1543
  # resp.composition.layout.pip.featured_participant_attribute #=> String
1527
- # resp.composition.layout.pip.grid_gap #=> Integer
1528
1544
  # resp.composition.layout.pip.omit_stopped_video #=> Boolean
1545
+ # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1546
+ # resp.composition.layout.pip.grid_gap #=> Integer
1547
+ # resp.composition.layout.pip.pip_participant_attribute #=> String
1529
1548
  # resp.composition.layout.pip.pip_behavior #=> String, one of "STATIC", "DYNAMIC"
1530
- # resp.composition.layout.pip.pip_height #=> Integer
1531
1549
  # resp.composition.layout.pip.pip_offset #=> Integer
1532
- # resp.composition.layout.pip.pip_participant_attribute #=> String
1533
1550
  # resp.composition.layout.pip.pip_position #=> String, one of "TOP_LEFT", "TOP_RIGHT", "BOTTOM_LEFT", "BOTTOM_RIGHT"
1534
1551
  # resp.composition.layout.pip.pip_width #=> Integer
1535
- # resp.composition.layout.pip.video_fill_mode #=> String, one of "FILL", "COVER", "CONTAIN"
1536
- # resp.composition.stage_arn #=> String
1537
- # resp.composition.start_time #=> Time
1538
- # resp.composition.state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "FAILED", "STOPPED"
1552
+ # resp.composition.layout.pip.pip_height #=> Integer
1553
+ # resp.composition.destinations #=> Array
1554
+ # resp.composition.destinations[0].id #=> String
1555
+ # resp.composition.destinations[0].state #=> String, one of "STARTING", "ACTIVE", "STOPPING", "RECONNECTING", "FAILED", "STOPPED"
1556
+ # resp.composition.destinations[0].start_time #=> Time
1557
+ # resp.composition.destinations[0].end_time #=> Time
1558
+ # resp.composition.destinations[0].configuration.name #=> String
1559
+ # resp.composition.destinations[0].configuration.channel.channel_arn #=> String
1560
+ # resp.composition.destinations[0].configuration.channel.encoder_configuration_arn #=> String
1561
+ # resp.composition.destinations[0].configuration.s3.storage_configuration_arn #=> String
1562
+ # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns #=> Array
1563
+ # resp.composition.destinations[0].configuration.s3.encoder_configuration_arns[0] #=> String
1564
+ # resp.composition.destinations[0].configuration.s3.recording_configuration.format #=> String, one of "HLS"
1565
+ # resp.composition.destinations[0].detail.s3.recording_prefix #=> String
1539
1566
  # resp.composition.tags #=> Hash
1540
1567
  # resp.composition.tags["TagKey"] #=> String
1568
+ # resp.composition.start_time #=> Time
1569
+ # resp.composition.end_time #=> Time
1541
1570
  #
1542
1571
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/StartComposition AWS API Documentation
1543
1572
  #
@@ -1649,6 +1678,11 @@ module Aws::IVSRealTime
1649
1678
  # @option params [String] :name
1650
1679
  # Name of the stage to be updated.
1651
1680
  #
1681
+ # @option params [Types::AutoParticipantRecordingConfiguration] :auto_participant_recording_configuration
1682
+ # Auto-participant-recording configuration object to attach to the
1683
+ # stage. Auto-participant-recording configuration cannot be updated
1684
+ # while recording is active.
1685
+ #
1652
1686
  # @return [Types::UpdateStageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1653
1687
  #
1654
1688
  # * {Types::UpdateStageResponse#stage #stage} => Types::Stage
@@ -1658,15 +1692,22 @@ module Aws::IVSRealTime
1658
1692
  # resp = client.update_stage({
1659
1693
  # arn: "StageArn", # required
1660
1694
  # name: "StageName",
1695
+ # auto_participant_recording_configuration: {
1696
+ # storage_configuration_arn: "AutoParticipantRecordingStorageConfigurationArn", # required
1697
+ # media_types: ["AUDIO_VIDEO"], # accepts AUDIO_VIDEO, AUDIO_ONLY
1698
+ # },
1661
1699
  # })
1662
1700
  #
1663
1701
  # @example Response structure
1664
1702
  #
1665
- # resp.stage.active_session_id #=> String
1666
1703
  # resp.stage.arn #=> String
1667
1704
  # resp.stage.name #=> String
1705
+ # resp.stage.active_session_id #=> String
1668
1706
  # resp.stage.tags #=> Hash
1669
1707
  # resp.stage.tags["TagKey"] #=> String
1708
+ # resp.stage.auto_participant_recording_configuration.storage_configuration_arn #=> String
1709
+ # resp.stage.auto_participant_recording_configuration.media_types #=> Array
1710
+ # resp.stage.auto_participant_recording_configuration.media_types[0] #=> String, one of "AUDIO_VIDEO", "AUDIO_ONLY"
1670
1711
  #
1671
1712
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/UpdateStage AWS API Documentation
1672
1713
  #
@@ -1690,7 +1731,7 @@ module Aws::IVSRealTime
1690
1731
  params: params,
1691
1732
  config: config)
1692
1733
  context[:gem_name] = 'aws-sdk-ivsrealtime'
1693
- context[:gem_version] = '1.19.0'
1734
+ context[:gem_version] = '1.21.0'
1694
1735
  Seahorse::Client::Request.new(handlers, context)
1695
1736
  end
1696
1737