aws-sdk-ivsrealtime 1.19.0 → 1.20.0

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