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