aws-sdk-ivschat 1.27.0 → 1.29.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-ivschat/client.rb +162 -162
- data/lib/aws-sdk-ivschat/client_api.rb +61 -60
- data/lib/aws-sdk-ivschat/errors.rb +15 -15
- data/lib/aws-sdk-ivschat/types.rb +323 -323
- data/lib/aws-sdk-ivschat/waiters.rb +15 -0
- data/lib/aws-sdk-ivschat.rb +2 -1
- data/sig/client.rbs +61 -61
- data/sig/errors.rbs +3 -3
- data/sig/types.rbs +61 -61
- metadata +5 -4
@@ -443,51 +443,51 @@ module Aws::Ivschat
|
|
443
443
|
# Encryption keys are owned by Amazon IVS Chat and never used directly
|
444
444
|
# by your application.
|
445
445
|
#
|
446
|
-
# @option params [
|
447
|
-
#
|
448
|
-
#
|
449
|
-
#
|
446
|
+
# @option params [required, String] :room_identifier
|
447
|
+
# Identifier of the room that the client is trying to access. Currently
|
448
|
+
# this must be an ARN.
|
449
|
+
#
|
450
|
+
# @option params [required, String] :user_id
|
451
|
+
# Application-provided ID that uniquely identifies the user associated
|
452
|
+
# with this token. This can be any UTF-8 encoded text.
|
450
453
|
#
|
451
454
|
# @option params [Array<String>] :capabilities
|
452
455
|
# Set of capabilities that the user is allowed to perform in the room.
|
453
456
|
# Default: None (the capability to view messages is implicitly included
|
454
457
|
# in all requests).
|
455
458
|
#
|
456
|
-
# @option params [required, String] :room_identifier
|
457
|
-
# Identifier of the room that the client is trying to access. Currently
|
458
|
-
# this must be an ARN.
|
459
|
-
#
|
460
459
|
# @option params [Integer] :session_duration_in_minutes
|
461
460
|
# Session duration (in minutes), after which the session expires.
|
462
461
|
# Default: 60 (1 hour).
|
463
462
|
#
|
464
|
-
# @option params [
|
465
|
-
# Application-provided
|
466
|
-
#
|
463
|
+
# @option params [Hash<String,String>] :attributes
|
464
|
+
# Application-provided attributes to encode into the token and attach to
|
465
|
+
# a chat session. Map keys and values can contain UTF-8 encoded text.
|
466
|
+
# The maximum length of this field is 1 KB total.
|
467
467
|
#
|
468
468
|
# @return [Types::CreateChatTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
469
469
|
#
|
470
|
-
# * {Types::CreateChatTokenResponse#session_expiration_time #session_expiration_time} => Time
|
471
470
|
# * {Types::CreateChatTokenResponse#token #token} => String
|
472
471
|
# * {Types::CreateChatTokenResponse#token_expiration_time #token_expiration_time} => Time
|
472
|
+
# * {Types::CreateChatTokenResponse#session_expiration_time #session_expiration_time} => Time
|
473
473
|
#
|
474
474
|
# @example Request syntax with placeholder values
|
475
475
|
#
|
476
476
|
# resp = client.create_chat_token({
|
477
|
+
# room_identifier: "RoomIdentifier", # required
|
478
|
+
# user_id: "UserID", # required
|
479
|
+
# capabilities: ["SEND_MESSAGE"], # accepts SEND_MESSAGE, DISCONNECT_USER, DELETE_MESSAGE
|
480
|
+
# session_duration_in_minutes: 1,
|
477
481
|
# attributes: {
|
478
482
|
# "String" => "String",
|
479
483
|
# },
|
480
|
-
# capabilities: ["SEND_MESSAGE"], # accepts SEND_MESSAGE, DISCONNECT_USER, DELETE_MESSAGE
|
481
|
-
# room_identifier: "RoomIdentifier", # required
|
482
|
-
# session_duration_in_minutes: 1,
|
483
|
-
# user_id: "UserID", # required
|
484
484
|
# })
|
485
485
|
#
|
486
486
|
# @example Response structure
|
487
487
|
#
|
488
|
-
# resp.session_expiration_time #=> Time
|
489
488
|
# resp.token #=> String
|
490
489
|
# resp.token_expiration_time #=> Time
|
490
|
+
# resp.session_expiration_time #=> Time
|
491
491
|
#
|
492
492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateChatToken AWS API Documentation
|
493
493
|
#
|
@@ -501,15 +501,15 @@ module Aws::Ivschat
|
|
501
501
|
# Creates a logging configuration that allows clients to store and
|
502
502
|
# record sent messages.
|
503
503
|
#
|
504
|
+
# @option params [String] :name
|
505
|
+
# Logging-configuration name. The value does not need to be unique.
|
506
|
+
#
|
504
507
|
# @option params [required, Types::DestinationConfiguration] :destination_configuration
|
505
508
|
# A complex type that contains a destination configuration for where
|
506
509
|
# chat content will be logged. There can be only one type of destination
|
507
510
|
# (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
508
511
|
# `destinationConfiguration`.
|
509
512
|
#
|
510
|
-
# @option params [String] :name
|
511
|
-
# Logging-configuration name. The value does not need to be unique.
|
512
|
-
#
|
513
513
|
# @option params [Hash<String,String>] :tags
|
514
514
|
# Tags to attach to the resource. Array of maps, each of the form
|
515
515
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -524,29 +524,29 @@ module Aws::Ivschat
|
|
524
524
|
# @return [Types::CreateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
525
525
|
#
|
526
526
|
# * {Types::CreateLoggingConfigurationResponse#arn #arn} => String
|
527
|
-
# * {Types::CreateLoggingConfigurationResponse#create_time #create_time} => Time
|
528
|
-
# * {Types::CreateLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
529
527
|
# * {Types::CreateLoggingConfigurationResponse#id #id} => String
|
528
|
+
# * {Types::CreateLoggingConfigurationResponse#create_time #create_time} => Time
|
529
|
+
# * {Types::CreateLoggingConfigurationResponse#update_time #update_time} => Time
|
530
530
|
# * {Types::CreateLoggingConfigurationResponse#name #name} => String
|
531
|
+
# * {Types::CreateLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
531
532
|
# * {Types::CreateLoggingConfigurationResponse#state #state} => String
|
532
533
|
# * {Types::CreateLoggingConfigurationResponse#tags #tags} => Hash<String,String>
|
533
|
-
# * {Types::CreateLoggingConfigurationResponse#update_time #update_time} => Time
|
534
534
|
#
|
535
535
|
# @example Request syntax with placeholder values
|
536
536
|
#
|
537
537
|
# resp = client.create_logging_configuration({
|
538
|
+
# name: "LoggingConfigurationName",
|
538
539
|
# destination_configuration: { # required
|
540
|
+
# s3: {
|
541
|
+
# bucket_name: "BucketName", # required
|
542
|
+
# },
|
539
543
|
# cloud_watch_logs: {
|
540
544
|
# log_group_name: "LogGroupName", # required
|
541
545
|
# },
|
542
546
|
# firehose: {
|
543
547
|
# delivery_stream_name: "DeliveryStreamName", # required
|
544
548
|
# },
|
545
|
-
# s3: {
|
546
|
-
# bucket_name: "BucketName", # required
|
547
|
-
# },
|
548
549
|
# },
|
549
|
-
# name: "LoggingConfigurationName",
|
550
550
|
# tags: {
|
551
551
|
# "TagKey" => "TagValue",
|
552
552
|
# },
|
@@ -555,16 +555,16 @@ module Aws::Ivschat
|
|
555
555
|
# @example Response structure
|
556
556
|
#
|
557
557
|
# resp.arn #=> String
|
558
|
+
# resp.id #=> String
|
558
559
|
# resp.create_time #=> Time
|
560
|
+
# resp.update_time #=> Time
|
561
|
+
# resp.name #=> String
|
562
|
+
# resp.destination_configuration.s3.bucket_name #=> String
|
559
563
|
# resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
|
560
564
|
# resp.destination_configuration.firehose.delivery_stream_name #=> String
|
561
|
-
# resp.destination_configuration.s3.bucket_name #=> String
|
562
|
-
# resp.id #=> String
|
563
|
-
# resp.name #=> String
|
564
565
|
# resp.state #=> String, one of "ACTIVE"
|
565
566
|
# resp.tags #=> Hash
|
566
567
|
# resp.tags["TagKey"] #=> String
|
567
|
-
# resp.update_time #=> Time
|
568
568
|
#
|
569
569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfiguration AWS API Documentation
|
570
570
|
#
|
@@ -577,24 +577,21 @@ module Aws::Ivschat
|
|
577
577
|
|
578
578
|
# Creates a room that allows clients to connect and pass messages.
|
579
579
|
#
|
580
|
-
# @option params [
|
581
|
-
#
|
580
|
+
# @option params [String] :name
|
581
|
+
# Room name. The value does not need to be unique.
|
582
|
+
#
|
583
|
+
# @option params [Integer] :maximum_message_rate_per_second
|
584
|
+
# Maximum number of messages per second that can be sent to the room (by
|
585
|
+
# all clients). Default: 10.
|
582
586
|
#
|
583
587
|
# @option params [Integer] :maximum_message_length
|
584
588
|
# Maximum number of characters in a single message. Messages are
|
585
589
|
# expected to be UTF-8 encoded and this limit applies specifically to
|
586
590
|
# rune/code-point count, not number of bytes. Default: 500.
|
587
591
|
#
|
588
|
-
# @option params [Integer] :maximum_message_rate_per_second
|
589
|
-
# Maximum number of messages per second that can be sent to the room (by
|
590
|
-
# all clients). Default: 10.
|
591
|
-
#
|
592
592
|
# @option params [Types::MessageReviewHandler] :message_review_handler
|
593
593
|
# Configuration information for optional review of messages.
|
594
594
|
#
|
595
|
-
# @option params [String] :name
|
596
|
-
# Room name. The value does not need to be unique.
|
597
|
-
#
|
598
595
|
# @option params [Hash<String,String>] :tags
|
599
596
|
# Tags to attach to the resource. Array of maps, each of the form
|
600
597
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -606,50 +603,53 @@ module Aws::Ivschat
|
|
606
603
|
#
|
607
604
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
608
605
|
#
|
606
|
+
# @option params [Array<String>] :logging_configuration_identifiers
|
607
|
+
# Array of logging-configuration identifiers attached to the room.
|
608
|
+
#
|
609
609
|
# @return [Types::CreateRoomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
610
610
|
#
|
611
611
|
# * {Types::CreateRoomResponse#arn #arn} => String
|
612
|
-
# * {Types::CreateRoomResponse#create_time #create_time} => Time
|
613
612
|
# * {Types::CreateRoomResponse#id #id} => String
|
614
|
-
# * {Types::CreateRoomResponse#
|
615
|
-
# * {Types::CreateRoomResponse#
|
613
|
+
# * {Types::CreateRoomResponse#name #name} => String
|
614
|
+
# * {Types::CreateRoomResponse#create_time #create_time} => Time
|
615
|
+
# * {Types::CreateRoomResponse#update_time #update_time} => Time
|
616
616
|
# * {Types::CreateRoomResponse#maximum_message_rate_per_second #maximum_message_rate_per_second} => Integer
|
617
|
+
# * {Types::CreateRoomResponse#maximum_message_length #maximum_message_length} => Integer
|
617
618
|
# * {Types::CreateRoomResponse#message_review_handler #message_review_handler} => Types::MessageReviewHandler
|
618
|
-
# * {Types::CreateRoomResponse#name #name} => String
|
619
619
|
# * {Types::CreateRoomResponse#tags #tags} => Hash<String,String>
|
620
|
-
# * {Types::CreateRoomResponse#
|
620
|
+
# * {Types::CreateRoomResponse#logging_configuration_identifiers #logging_configuration_identifiers} => Array<String>
|
621
621
|
#
|
622
622
|
# @example Request syntax with placeholder values
|
623
623
|
#
|
624
624
|
# resp = client.create_room({
|
625
|
-
#
|
626
|
-
# maximum_message_length: 1,
|
625
|
+
# name: "RoomName",
|
627
626
|
# maximum_message_rate_per_second: 1,
|
627
|
+
# maximum_message_length: 1,
|
628
628
|
# message_review_handler: {
|
629
|
-
# fallback_result: "ALLOW", # accepts ALLOW, DENY
|
630
629
|
# uri: "LambdaArn",
|
630
|
+
# fallback_result: "ALLOW", # accepts ALLOW, DENY
|
631
631
|
# },
|
632
|
-
# name: "RoomName",
|
633
632
|
# tags: {
|
634
633
|
# "TagKey" => "TagValue",
|
635
634
|
# },
|
635
|
+
# logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
|
636
636
|
# })
|
637
637
|
#
|
638
638
|
# @example Response structure
|
639
639
|
#
|
640
640
|
# resp.arn #=> String
|
641
|
-
# resp.create_time #=> Time
|
642
641
|
# resp.id #=> String
|
643
|
-
# resp.
|
644
|
-
# resp.
|
645
|
-
# resp.
|
642
|
+
# resp.name #=> String
|
643
|
+
# resp.create_time #=> Time
|
644
|
+
# resp.update_time #=> Time
|
646
645
|
# resp.maximum_message_rate_per_second #=> Integer
|
647
|
-
# resp.
|
646
|
+
# resp.maximum_message_length #=> Integer
|
648
647
|
# resp.message_review_handler.uri #=> String
|
649
|
-
# resp.
|
648
|
+
# resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
|
650
649
|
# resp.tags #=> Hash
|
651
650
|
# resp.tags["TagKey"] #=> String
|
652
|
-
# resp.
|
651
|
+
# resp.logging_configuration_identifiers #=> Array
|
652
|
+
# resp.logging_configuration_identifiers[0] #=> String
|
653
653
|
#
|
654
654
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoom AWS API Documentation
|
655
655
|
#
|
@@ -692,6 +692,10 @@ module Aws::Ivschat
|
|
692
692
|
#
|
693
693
|
# [1]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-deletemessage-publish.html
|
694
694
|
#
|
695
|
+
# @option params [required, String] :room_identifier
|
696
|
+
# Identifier of the room where the message should be deleted. Currently
|
697
|
+
# this must be an ARN.
|
698
|
+
#
|
695
699
|
# @option params [required, String] :id
|
696
700
|
# ID of the message to be deleted. This is the `Id` field in the
|
697
701
|
# received message (see [ Message (Subscribe)][1] in the Chat Messaging
|
@@ -704,10 +708,6 @@ module Aws::Ivschat
|
|
704
708
|
# @option params [String] :reason
|
705
709
|
# Reason for deleting the message.
|
706
710
|
#
|
707
|
-
# @option params [required, String] :room_identifier
|
708
|
-
# Identifier of the room where the message should be deleted. Currently
|
709
|
-
# this must be an ARN.
|
710
|
-
#
|
711
711
|
# @return [Types::DeleteMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
712
712
|
#
|
713
713
|
# * {Types::DeleteMessageResponse#id #id} => String
|
@@ -715,9 +715,9 @@ module Aws::Ivschat
|
|
715
715
|
# @example Request syntax with placeholder values
|
716
716
|
#
|
717
717
|
# resp = client.delete_message({
|
718
|
+
# room_identifier: "RoomIdentifier", # required
|
718
719
|
# id: "MessageID", # required
|
719
720
|
# reason: "Reason",
|
720
|
-
# room_identifier: "RoomIdentifier", # required
|
721
721
|
# })
|
722
722
|
#
|
723
723
|
# @example Response structure
|
@@ -763,9 +763,6 @@ module Aws::Ivschat
|
|
763
763
|
#
|
764
764
|
# [1]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-disconnectuser-publish.html
|
765
765
|
#
|
766
|
-
# @option params [String] :reason
|
767
|
-
# Reason for disconnecting the user.
|
768
|
-
#
|
769
766
|
# @option params [required, String] :room_identifier
|
770
767
|
# Identifier of the room from which the user's clients should be
|
771
768
|
# disconnected. Currently this must be an ARN.
|
@@ -773,14 +770,17 @@ module Aws::Ivschat
|
|
773
770
|
# @option params [required, String] :user_id
|
774
771
|
# ID of the user (connection) to disconnect from the room.
|
775
772
|
#
|
773
|
+
# @option params [String] :reason
|
774
|
+
# Reason for disconnecting the user.
|
775
|
+
#
|
776
776
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
777
777
|
#
|
778
778
|
# @example Request syntax with placeholder values
|
779
779
|
#
|
780
780
|
# resp = client.disconnect_user({
|
781
|
-
# reason: "Reason",
|
782
781
|
# room_identifier: "RoomIdentifier", # required
|
783
782
|
# user_id: "UserID", # required
|
783
|
+
# reason: "Reason",
|
784
784
|
# })
|
785
785
|
#
|
786
786
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DisconnectUser AWS API Documentation
|
@@ -800,13 +800,13 @@ module Aws::Ivschat
|
|
800
800
|
# @return [Types::GetLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
801
801
|
#
|
802
802
|
# * {Types::GetLoggingConfigurationResponse#arn #arn} => String
|
803
|
-
# * {Types::GetLoggingConfigurationResponse#create_time #create_time} => Time
|
804
|
-
# * {Types::GetLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
805
803
|
# * {Types::GetLoggingConfigurationResponse#id #id} => String
|
804
|
+
# * {Types::GetLoggingConfigurationResponse#create_time #create_time} => Time
|
805
|
+
# * {Types::GetLoggingConfigurationResponse#update_time #update_time} => Time
|
806
806
|
# * {Types::GetLoggingConfigurationResponse#name #name} => String
|
807
|
+
# * {Types::GetLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
807
808
|
# * {Types::GetLoggingConfigurationResponse#state #state} => String
|
808
809
|
# * {Types::GetLoggingConfigurationResponse#tags #tags} => Hash<String,String>
|
809
|
-
# * {Types::GetLoggingConfigurationResponse#update_time #update_time} => Time
|
810
810
|
#
|
811
811
|
# @example Request syntax with placeholder values
|
812
812
|
#
|
@@ -817,16 +817,16 @@ module Aws::Ivschat
|
|
817
817
|
# @example Response structure
|
818
818
|
#
|
819
819
|
# resp.arn #=> String
|
820
|
+
# resp.id #=> String
|
820
821
|
# resp.create_time #=> Time
|
822
|
+
# resp.update_time #=> Time
|
823
|
+
# resp.name #=> String
|
824
|
+
# resp.destination_configuration.s3.bucket_name #=> String
|
821
825
|
# resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
|
822
826
|
# resp.destination_configuration.firehose.delivery_stream_name #=> String
|
823
|
-
# resp.destination_configuration.s3.bucket_name #=> String
|
824
|
-
# resp.id #=> String
|
825
|
-
# resp.name #=> String
|
826
827
|
# resp.state #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "ACTIVE"
|
827
828
|
# resp.tags #=> Hash
|
828
829
|
# resp.tags["TagKey"] #=> String
|
829
|
-
# resp.update_time #=> Time
|
830
830
|
#
|
831
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfiguration AWS API Documentation
|
832
832
|
#
|
@@ -846,15 +846,15 @@ module Aws::Ivschat
|
|
846
846
|
# @return [Types::GetRoomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
847
847
|
#
|
848
848
|
# * {Types::GetRoomResponse#arn #arn} => String
|
849
|
-
# * {Types::GetRoomResponse#create_time #create_time} => Time
|
850
849
|
# * {Types::GetRoomResponse#id #id} => String
|
851
|
-
# * {Types::GetRoomResponse#
|
852
|
-
# * {Types::GetRoomResponse#
|
850
|
+
# * {Types::GetRoomResponse#name #name} => String
|
851
|
+
# * {Types::GetRoomResponse#create_time #create_time} => Time
|
852
|
+
# * {Types::GetRoomResponse#update_time #update_time} => Time
|
853
853
|
# * {Types::GetRoomResponse#maximum_message_rate_per_second #maximum_message_rate_per_second} => Integer
|
854
|
+
# * {Types::GetRoomResponse#maximum_message_length #maximum_message_length} => Integer
|
854
855
|
# * {Types::GetRoomResponse#message_review_handler #message_review_handler} => Types::MessageReviewHandler
|
855
|
-
# * {Types::GetRoomResponse#name #name} => String
|
856
856
|
# * {Types::GetRoomResponse#tags #tags} => Hash<String,String>
|
857
|
-
# * {Types::GetRoomResponse#
|
857
|
+
# * {Types::GetRoomResponse#logging_configuration_identifiers #logging_configuration_identifiers} => Array<String>
|
858
858
|
#
|
859
859
|
# @example Request syntax with placeholder values
|
860
860
|
#
|
@@ -865,18 +865,18 @@ module Aws::Ivschat
|
|
865
865
|
# @example Response structure
|
866
866
|
#
|
867
867
|
# resp.arn #=> String
|
868
|
-
# resp.create_time #=> Time
|
869
868
|
# resp.id #=> String
|
870
|
-
# resp.
|
871
|
-
# resp.
|
872
|
-
# resp.
|
869
|
+
# resp.name #=> String
|
870
|
+
# resp.create_time #=> Time
|
871
|
+
# resp.update_time #=> Time
|
873
872
|
# resp.maximum_message_rate_per_second #=> Integer
|
874
|
-
# resp.
|
873
|
+
# resp.maximum_message_length #=> Integer
|
875
874
|
# resp.message_review_handler.uri #=> String
|
876
|
-
# resp.
|
875
|
+
# resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
|
877
876
|
# resp.tags #=> Hash
|
878
877
|
# resp.tags["TagKey"] #=> String
|
879
|
-
# resp.
|
878
|
+
# resp.logging_configuration_identifiers #=> Array
|
879
|
+
# resp.logging_configuration_identifiers[0] #=> String
|
880
880
|
#
|
881
881
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetRoom AWS API Documentation
|
882
882
|
#
|
@@ -890,13 +890,13 @@ module Aws::Ivschat
|
|
890
890
|
# Gets summary information about all your logging configurations in the
|
891
891
|
# AWS region where the API request is processed.
|
892
892
|
#
|
893
|
-
# @option params [Integer] :max_results
|
894
|
-
# Maximum number of logging configurations to return. Default: 50.
|
895
|
-
#
|
896
893
|
# @option params [String] :next_token
|
897
894
|
# The first logging configurations to retrieve. This is used for
|
898
895
|
# pagination; see the `nextToken` response field.
|
899
896
|
#
|
897
|
+
# @option params [Integer] :max_results
|
898
|
+
# Maximum number of logging configurations to return. Default: 50.
|
899
|
+
#
|
900
900
|
# @return [Types::ListLoggingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
901
|
#
|
902
902
|
# * {Types::ListLoggingConfigurationsResponse#logging_configurations #logging_configurations} => Array<Types::LoggingConfigurationSummary>
|
@@ -907,24 +907,24 @@ module Aws::Ivschat
|
|
907
907
|
# @example Request syntax with placeholder values
|
908
908
|
#
|
909
909
|
# resp = client.list_logging_configurations({
|
910
|
-
# max_results: 1,
|
911
910
|
# next_token: "PaginationToken",
|
911
|
+
# max_results: 1,
|
912
912
|
# })
|
913
913
|
#
|
914
914
|
# @example Response structure
|
915
915
|
#
|
916
916
|
# resp.logging_configurations #=> Array
|
917
917
|
# resp.logging_configurations[0].arn #=> String
|
918
|
+
# resp.logging_configurations[0].id #=> String
|
918
919
|
# resp.logging_configurations[0].create_time #=> Time
|
920
|
+
# resp.logging_configurations[0].update_time #=> Time
|
921
|
+
# resp.logging_configurations[0].name #=> String
|
922
|
+
# resp.logging_configurations[0].destination_configuration.s3.bucket_name #=> String
|
919
923
|
# resp.logging_configurations[0].destination_configuration.cloud_watch_logs.log_group_name #=> String
|
920
924
|
# resp.logging_configurations[0].destination_configuration.firehose.delivery_stream_name #=> String
|
921
|
-
# resp.logging_configurations[0].destination_configuration.s3.bucket_name #=> String
|
922
|
-
# resp.logging_configurations[0].id #=> String
|
923
|
-
# resp.logging_configurations[0].name #=> String
|
924
925
|
# resp.logging_configurations[0].state #=> String, one of "CREATING", "CREATE_FAILED", "DELETING", "DELETE_FAILED", "UPDATING", "UPDATE_FAILED", "ACTIVE"
|
925
926
|
# resp.logging_configurations[0].tags #=> Hash
|
926
927
|
# resp.logging_configurations[0].tags["TagKey"] #=> String
|
927
|
-
# resp.logging_configurations[0].update_time #=> Time
|
928
928
|
# resp.next_token #=> String
|
929
929
|
#
|
930
930
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurations AWS API Documentation
|
@@ -940,8 +940,12 @@ module Aws::Ivschat
|
|
940
940
|
# the API request is processed. Results are sorted in descending order
|
941
941
|
# of `updateTime`.
|
942
942
|
#
|
943
|
-
# @option params [String] :
|
944
|
-
#
|
943
|
+
# @option params [String] :name
|
944
|
+
# Filters the list to match the specified room name.
|
945
|
+
#
|
946
|
+
# @option params [String] :next_token
|
947
|
+
# The first room to retrieve. This is used for pagination; see the
|
948
|
+
# `nextToken` response field.
|
945
949
|
#
|
946
950
|
# @option params [Integer] :max_results
|
947
951
|
# Maximum number of rooms to return. Default: 50.
|
@@ -949,45 +953,41 @@ module Aws::Ivschat
|
|
949
953
|
# @option params [String] :message_review_handler_uri
|
950
954
|
# Filters the list to match the specified message review handler URI.
|
951
955
|
#
|
952
|
-
# @option params [String] :
|
953
|
-
#
|
954
|
-
#
|
955
|
-
# @option params [String] :next_token
|
956
|
-
# The first room to retrieve. This is used for pagination; see the
|
957
|
-
# `nextToken` response field.
|
956
|
+
# @option params [String] :logging_configuration_identifier
|
957
|
+
# Logging-configuration identifier.
|
958
958
|
#
|
959
959
|
# @return [Types::ListRoomsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
960
|
#
|
961
|
-
# * {Types::ListRoomsResponse#next_token #next_token} => String
|
962
961
|
# * {Types::ListRoomsResponse#rooms #rooms} => Array<Types::RoomSummary>
|
962
|
+
# * {Types::ListRoomsResponse#next_token #next_token} => String
|
963
963
|
#
|
964
964
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
965
965
|
#
|
966
966
|
# @example Request syntax with placeholder values
|
967
967
|
#
|
968
968
|
# resp = client.list_rooms({
|
969
|
-
# logging_configuration_identifier: "LoggingConfigurationIdentifier",
|
970
|
-
# max_results: 1,
|
971
|
-
# message_review_handler_uri: "LambdaArn",
|
972
969
|
# name: "RoomName",
|
973
970
|
# next_token: "PaginationToken",
|
971
|
+
# max_results: 1,
|
972
|
+
# message_review_handler_uri: "LambdaArn",
|
973
|
+
# logging_configuration_identifier: "LoggingConfigurationIdentifier",
|
974
974
|
# })
|
975
975
|
#
|
976
976
|
# @example Response structure
|
977
977
|
#
|
978
|
-
# resp.next_token #=> String
|
979
978
|
# resp.rooms #=> Array
|
980
979
|
# resp.rooms[0].arn #=> String
|
981
|
-
# resp.rooms[0].create_time #=> Time
|
982
980
|
# resp.rooms[0].id #=> String
|
983
|
-
# resp.rooms[0].logging_configuration_identifiers #=> Array
|
984
|
-
# resp.rooms[0].logging_configuration_identifiers[0] #=> String
|
985
|
-
# resp.rooms[0].message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
|
986
|
-
# resp.rooms[0].message_review_handler.uri #=> String
|
987
981
|
# resp.rooms[0].name #=> String
|
982
|
+
# resp.rooms[0].message_review_handler.uri #=> String
|
983
|
+
# resp.rooms[0].message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
|
984
|
+
# resp.rooms[0].create_time #=> Time
|
985
|
+
# resp.rooms[0].update_time #=> Time
|
988
986
|
# resp.rooms[0].tags #=> Hash
|
989
987
|
# resp.rooms[0].tags["TagKey"] #=> String
|
990
|
-
# resp.rooms[0].
|
988
|
+
# resp.rooms[0].logging_configuration_identifiers #=> Array
|
989
|
+
# resp.rooms[0].logging_configuration_identifiers[0] #=> String
|
990
|
+
# resp.next_token #=> String
|
991
991
|
#
|
992
992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRooms AWS API Documentation
|
993
993
|
#
|
@@ -1031,16 +1031,16 @@ module Aws::Ivschat
|
|
1031
1031
|
# logic to send events to clients of a room; e.g., to notify clients to
|
1032
1032
|
# change the way the chat UI is rendered.
|
1033
1033
|
#
|
1034
|
-
# @option params [
|
1035
|
-
#
|
1036
|
-
#
|
1034
|
+
# @option params [required, String] :room_identifier
|
1035
|
+
# Identifier of the room to which the event will be sent. Currently this
|
1036
|
+
# must be an ARN.
|
1037
1037
|
#
|
1038
1038
|
# @option params [required, String] :event_name
|
1039
1039
|
# Application-defined name of the event to send to clients.
|
1040
1040
|
#
|
1041
|
-
# @option params [
|
1042
|
-
#
|
1043
|
-
#
|
1041
|
+
# @option params [Hash<String,String>] :attributes
|
1042
|
+
# Application-defined metadata to attach to the event sent to clients.
|
1043
|
+
# The maximum length of the metadata is 1 KB total.
|
1044
1044
|
#
|
1045
1045
|
# @return [Types::SendEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1046
1046
|
#
|
@@ -1049,11 +1049,11 @@ module Aws::Ivschat
|
|
1049
1049
|
# @example Request syntax with placeholder values
|
1050
1050
|
#
|
1051
1051
|
# resp = client.send_event({
|
1052
|
+
# room_identifier: "RoomIdentifier", # required
|
1053
|
+
# event_name: "EventName", # required
|
1052
1054
|
# attributes: {
|
1053
1055
|
# "String" => "String",
|
1054
1056
|
# },
|
1055
|
-
# event_name: "EventName", # required
|
1056
|
-
# room_identifier: "RoomIdentifier", # required
|
1057
1057
|
# })
|
1058
1058
|
#
|
1059
1059
|
# @example Response structure
|
@@ -1141,60 +1141,60 @@ module Aws::Ivschat
|
|
1141
1141
|
|
1142
1142
|
# Updates a specified logging configuration.
|
1143
1143
|
#
|
1144
|
-
# @option params [Types::DestinationConfiguration] :destination_configuration
|
1145
|
-
# A complex type that contains a destination configuration for where
|
1146
|
-
# chat content will be logged. There can be only one type of destination
|
1147
|
-
# (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
1148
|
-
# `destinationConfiguration`.
|
1149
|
-
#
|
1150
1144
|
# @option params [required, String] :identifier
|
1151
1145
|
# Identifier of the logging configuration to be updated.
|
1152
1146
|
#
|
1153
1147
|
# @option params [String] :name
|
1154
1148
|
# Logging-configuration name. The value does not need to be unique.
|
1155
1149
|
#
|
1150
|
+
# @option params [Types::DestinationConfiguration] :destination_configuration
|
1151
|
+
# A complex type that contains a destination configuration for where
|
1152
|
+
# chat content will be logged. There can be only one type of destination
|
1153
|
+
# (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
1154
|
+
# `destinationConfiguration`.
|
1155
|
+
#
|
1156
1156
|
# @return [Types::UpdateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1157
1157
|
#
|
1158
1158
|
# * {Types::UpdateLoggingConfigurationResponse#arn #arn} => String
|
1159
|
-
# * {Types::UpdateLoggingConfigurationResponse#create_time #create_time} => Time
|
1160
|
-
# * {Types::UpdateLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
1161
1159
|
# * {Types::UpdateLoggingConfigurationResponse#id #id} => String
|
1160
|
+
# * {Types::UpdateLoggingConfigurationResponse#create_time #create_time} => Time
|
1161
|
+
# * {Types::UpdateLoggingConfigurationResponse#update_time #update_time} => Time
|
1162
1162
|
# * {Types::UpdateLoggingConfigurationResponse#name #name} => String
|
1163
|
+
# * {Types::UpdateLoggingConfigurationResponse#destination_configuration #destination_configuration} => Types::DestinationConfiguration
|
1163
1164
|
# * {Types::UpdateLoggingConfigurationResponse#state #state} => String
|
1164
1165
|
# * {Types::UpdateLoggingConfigurationResponse#tags #tags} => Hash<String,String>
|
1165
|
-
# * {Types::UpdateLoggingConfigurationResponse#update_time #update_time} => Time
|
1166
1166
|
#
|
1167
1167
|
# @example Request syntax with placeholder values
|
1168
1168
|
#
|
1169
1169
|
# resp = client.update_logging_configuration({
|
1170
|
+
# identifier: "LoggingConfigurationIdentifier", # required
|
1171
|
+
# name: "LoggingConfigurationName",
|
1170
1172
|
# destination_configuration: {
|
1173
|
+
# s3: {
|
1174
|
+
# bucket_name: "BucketName", # required
|
1175
|
+
# },
|
1171
1176
|
# cloud_watch_logs: {
|
1172
1177
|
# log_group_name: "LogGroupName", # required
|
1173
1178
|
# },
|
1174
1179
|
# firehose: {
|
1175
1180
|
# delivery_stream_name: "DeliveryStreamName", # required
|
1176
1181
|
# },
|
1177
|
-
# s3: {
|
1178
|
-
# bucket_name: "BucketName", # required
|
1179
|
-
# },
|
1180
1182
|
# },
|
1181
|
-
# identifier: "LoggingConfigurationIdentifier", # required
|
1182
|
-
# name: "LoggingConfigurationName",
|
1183
1183
|
# })
|
1184
1184
|
#
|
1185
1185
|
# @example Response structure
|
1186
1186
|
#
|
1187
1187
|
# resp.arn #=> String
|
1188
|
+
# resp.id #=> String
|
1188
1189
|
# resp.create_time #=> Time
|
1190
|
+
# resp.update_time #=> Time
|
1191
|
+
# resp.name #=> String
|
1192
|
+
# resp.destination_configuration.s3.bucket_name #=> String
|
1189
1193
|
# resp.destination_configuration.cloud_watch_logs.log_group_name #=> String
|
1190
1194
|
# resp.destination_configuration.firehose.delivery_stream_name #=> String
|
1191
|
-
# resp.destination_configuration.s3.bucket_name #=> String
|
1192
|
-
# resp.id #=> String
|
1193
|
-
# resp.name #=> String
|
1194
1195
|
# resp.state #=> String, one of "ACTIVE"
|
1195
1196
|
# resp.tags #=> Hash
|
1196
1197
|
# resp.tags["TagKey"] #=> String
|
1197
|
-
# resp.update_time #=> Time
|
1198
1198
|
#
|
1199
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfiguration AWS API Documentation
|
1200
1200
|
#
|
@@ -1210,68 +1210,68 @@ module Aws::Ivschat
|
|
1210
1210
|
# @option params [required, String] :identifier
|
1211
1211
|
# Identifier of the room to be updated. Currently this must be an ARN.
|
1212
1212
|
#
|
1213
|
-
# @option params [
|
1214
|
-
#
|
1213
|
+
# @option params [String] :name
|
1214
|
+
# Room name. The value does not need to be unique.
|
1215
|
+
#
|
1216
|
+
# @option params [Integer] :maximum_message_rate_per_second
|
1217
|
+
# Maximum number of messages per second that can be sent to the room (by
|
1218
|
+
# all clients). Default: 10.
|
1215
1219
|
#
|
1216
1220
|
# @option params [Integer] :maximum_message_length
|
1217
1221
|
# The maximum number of characters in a single message. Messages are
|
1218
1222
|
# expected to be UTF-8 encoded and this limit applies specifically to
|
1219
1223
|
# rune/code-point count, not number of bytes. Default: 500.
|
1220
1224
|
#
|
1221
|
-
# @option params [Integer] :maximum_message_rate_per_second
|
1222
|
-
# Maximum number of messages per second that can be sent to the room (by
|
1223
|
-
# all clients). Default: 10.
|
1224
|
-
#
|
1225
1225
|
# @option params [Types::MessageReviewHandler] :message_review_handler
|
1226
1226
|
# Configuration information for optional review of messages. Specify an
|
1227
1227
|
# empty `uri` string to disassociate a message review handler from the
|
1228
1228
|
# specified room.
|
1229
1229
|
#
|
1230
|
-
# @option params [String] :
|
1231
|
-
#
|
1230
|
+
# @option params [Array<String>] :logging_configuration_identifiers
|
1231
|
+
# Array of logging-configuration identifiers attached to the room.
|
1232
1232
|
#
|
1233
1233
|
# @return [Types::UpdateRoomResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1234
1234
|
#
|
1235
1235
|
# * {Types::UpdateRoomResponse#arn #arn} => String
|
1236
|
-
# * {Types::UpdateRoomResponse#create_time #create_time} => Time
|
1237
1236
|
# * {Types::UpdateRoomResponse#id #id} => String
|
1238
|
-
# * {Types::UpdateRoomResponse#
|
1239
|
-
# * {Types::UpdateRoomResponse#
|
1237
|
+
# * {Types::UpdateRoomResponse#name #name} => String
|
1238
|
+
# * {Types::UpdateRoomResponse#create_time #create_time} => Time
|
1239
|
+
# * {Types::UpdateRoomResponse#update_time #update_time} => Time
|
1240
1240
|
# * {Types::UpdateRoomResponse#maximum_message_rate_per_second #maximum_message_rate_per_second} => Integer
|
1241
|
+
# * {Types::UpdateRoomResponse#maximum_message_length #maximum_message_length} => Integer
|
1241
1242
|
# * {Types::UpdateRoomResponse#message_review_handler #message_review_handler} => Types::MessageReviewHandler
|
1242
|
-
# * {Types::UpdateRoomResponse#name #name} => String
|
1243
1243
|
# * {Types::UpdateRoomResponse#tags #tags} => Hash<String,String>
|
1244
|
-
# * {Types::UpdateRoomResponse#
|
1244
|
+
# * {Types::UpdateRoomResponse#logging_configuration_identifiers #logging_configuration_identifiers} => Array<String>
|
1245
1245
|
#
|
1246
1246
|
# @example Request syntax with placeholder values
|
1247
1247
|
#
|
1248
1248
|
# resp = client.update_room({
|
1249
1249
|
# identifier: "RoomIdentifier", # required
|
1250
|
-
#
|
1251
|
-
# maximum_message_length: 1,
|
1250
|
+
# name: "RoomName",
|
1252
1251
|
# maximum_message_rate_per_second: 1,
|
1252
|
+
# maximum_message_length: 1,
|
1253
1253
|
# message_review_handler: {
|
1254
|
-
# fallback_result: "ALLOW", # accepts ALLOW, DENY
|
1255
1254
|
# uri: "LambdaArn",
|
1255
|
+
# fallback_result: "ALLOW", # accepts ALLOW, DENY
|
1256
1256
|
# },
|
1257
|
-
#
|
1257
|
+
# logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
|
1258
1258
|
# })
|
1259
1259
|
#
|
1260
1260
|
# @example Response structure
|
1261
1261
|
#
|
1262
1262
|
# resp.arn #=> String
|
1263
|
-
# resp.create_time #=> Time
|
1264
1263
|
# resp.id #=> String
|
1265
|
-
# resp.
|
1266
|
-
# resp.
|
1267
|
-
# resp.
|
1264
|
+
# resp.name #=> String
|
1265
|
+
# resp.create_time #=> Time
|
1266
|
+
# resp.update_time #=> Time
|
1268
1267
|
# resp.maximum_message_rate_per_second #=> Integer
|
1269
|
-
# resp.
|
1268
|
+
# resp.maximum_message_length #=> Integer
|
1270
1269
|
# resp.message_review_handler.uri #=> String
|
1271
|
-
# resp.
|
1270
|
+
# resp.message_review_handler.fallback_result #=> String, one of "ALLOW", "DENY"
|
1272
1271
|
# resp.tags #=> Hash
|
1273
1272
|
# resp.tags["TagKey"] #=> String
|
1274
|
-
# resp.
|
1273
|
+
# resp.logging_configuration_identifiers #=> Array
|
1274
|
+
# resp.logging_configuration_identifiers[0] #=> String
|
1275
1275
|
#
|
1276
1276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateRoom AWS API Documentation
|
1277
1277
|
#
|
@@ -1295,7 +1295,7 @@ module Aws::Ivschat
|
|
1295
1295
|
params: params,
|
1296
1296
|
config: config)
|
1297
1297
|
context[:gem_name] = 'aws-sdk-ivschat'
|
1298
|
-
context[:gem_version] = '1.
|
1298
|
+
context[:gem_version] = '1.29.0'
|
1299
1299
|
Seahorse::Client::Request.new(handlers, context)
|
1300
1300
|
end
|
1301
1301
|
|