aws-sdk-ivschat 1.5.0 → 1.6.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.
@@ -21,6 +21,28 @@ module Aws::Ivschat
21
21
  include Aws::Structure
22
22
  end
23
23
 
24
+ # Specifies a CloudWatch Logs location where chat logs will be stored.
25
+ #
26
+ # @note When making an API call, you may pass CloudWatchLogsDestinationConfiguration
27
+ # data as a hash:
28
+ #
29
+ # {
30
+ # log_group_name: "LogGroupName", # required
31
+ # }
32
+ #
33
+ # @!attribute [rw] log_group_name
34
+ # Name of the Amazon Cloudwatch Logs destination where chat activity
35
+ # will be logged.
36
+ # @return [String]
37
+ #
38
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CloudWatchLogsDestinationConfiguration AWS API Documentation
39
+ #
40
+ class CloudWatchLogsDestinationConfiguration < Struct.new(
41
+ :log_group_name)
42
+ SENSITIVE = []
43
+ include Aws::Structure
44
+ end
45
+
24
46
  # @!attribute [rw] message
25
47
  # @return [String]
26
48
  #
@@ -117,10 +139,121 @@ module Aws::Ivschat
117
139
  include Aws::Structure
118
140
  end
119
141
 
142
+ # @note When making an API call, you may pass CreateLoggingConfigurationRequest
143
+ # data as a hash:
144
+ #
145
+ # {
146
+ # destination_configuration: { # required
147
+ # cloud_watch_logs: {
148
+ # log_group_name: "LogGroupName", # required
149
+ # },
150
+ # firehose: {
151
+ # delivery_stream_name: "DeliveryStreamName", # required
152
+ # },
153
+ # s3: {
154
+ # bucket_name: "BucketName", # required
155
+ # },
156
+ # },
157
+ # name: "LoggingConfigurationName",
158
+ # tags: {
159
+ # "TagKey" => "TagValue",
160
+ # },
161
+ # }
162
+ #
163
+ # @!attribute [rw] destination_configuration
164
+ # A complex type that contains a destination configuration for where
165
+ # chat content will be logged. There can be only one type of
166
+ # destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
167
+ # `destinationConfiguration`.
168
+ # @return [Types::DestinationConfiguration]
169
+ #
170
+ # @!attribute [rw] name
171
+ # Logging-configuration name. The value does not need to be unique.
172
+ # @return [String]
173
+ #
174
+ # @!attribute [rw] tags
175
+ # Tags to attach to the resource. Array of maps, each of the form
176
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
177
+ # details, including restrictions that apply to tags and "Tag naming
178
+ # limits and requirements"; Amazon IVS Chat has no constraints on
179
+ # tags beyond what is documented there.
180
+ #
181
+ #
182
+ #
183
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
184
+ # @return [Hash<String,String>]
185
+ #
186
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationRequest AWS API Documentation
187
+ #
188
+ class CreateLoggingConfigurationRequest < Struct.new(
189
+ :destination_configuration,
190
+ :name,
191
+ :tags)
192
+ SENSITIVE = []
193
+ include Aws::Structure
194
+ end
195
+
196
+ # @!attribute [rw] arn
197
+ # Logging-configuration ARN, assigned by the system.
198
+ # @return [String]
199
+ #
200
+ # @!attribute [rw] create_time
201
+ # Time when the logging configuration was created. This is an ISO 8601
202
+ # timestamp; *note that this is returned as a string*.
203
+ # @return [Time]
204
+ #
205
+ # @!attribute [rw] destination_configuration
206
+ # A complex type that contains a destination configuration for where
207
+ # chat content will be logged, from the request. There is only one
208
+ # type of destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
209
+ # `destinationConfiguration`.
210
+ # @return [Types::DestinationConfiguration]
211
+ #
212
+ # @!attribute [rw] id
213
+ # Logging-configuration ID, generated by the system. This is a
214
+ # relative identifier, the part of the ARN that uniquely identifies
215
+ # the logging configuration.
216
+ # @return [String]
217
+ #
218
+ # @!attribute [rw] name
219
+ # Logging-configuration name, from the request (if specified).
220
+ # @return [String]
221
+ #
222
+ # @!attribute [rw] state
223
+ # The state of the logging configuration. When the state is `ACTIVE`,
224
+ # the configuration is ready to log chat content.
225
+ # @return [String]
226
+ #
227
+ # @!attribute [rw] tags
228
+ # Tags attached to the resource, from the request (if specified).
229
+ # Array of maps, each of the form `string:string (key:value)`.
230
+ # @return [Hash<String,String>]
231
+ #
232
+ # @!attribute [rw] update_time
233
+ # Time of the logging configuration’s last update. This is an ISO 8601
234
+ # timestamp; *note that this is returned as a string*.
235
+ # @return [Time]
236
+ #
237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationResponse AWS API Documentation
238
+ #
239
+ class CreateLoggingConfigurationResponse < Struct.new(
240
+ :arn,
241
+ :create_time,
242
+ :destination_configuration,
243
+ :id,
244
+ :name,
245
+ :state,
246
+ :tags,
247
+ :update_time)
248
+ SENSITIVE = []
249
+ include Aws::Structure
250
+ end
251
+
120
252
  # @note When making an API call, you may pass CreateRoomRequest
121
253
  # data as a hash:
122
254
  #
123
255
  # {
256
+ # logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
124
257
  # maximum_message_length: 1,
125
258
  # maximum_message_rate_per_second: 1,
126
259
  # message_review_handler: {
@@ -133,6 +266,10 @@ module Aws::Ivschat
133
266
  # },
134
267
  # }
135
268
  #
269
+ # @!attribute [rw] logging_configuration_identifiers
270
+ # Array of logging-configuration identifiers attached to the room.
271
+ # @return [Array<String>]
272
+ #
136
273
  # @!attribute [rw] maximum_message_length
137
274
  # Maximum number of characters in a single message. Messages are
138
275
  # expected to be UTF-8 encoded and this limit applies specifically to
@@ -167,6 +304,7 @@ module Aws::Ivschat
167
304
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomRequest AWS API Documentation
168
305
  #
169
306
  class CreateRoomRequest < Struct.new(
307
+ :logging_configuration_identifiers,
170
308
  :maximum_message_length,
171
309
  :maximum_message_rate_per_second,
172
310
  :message_review_handler,
@@ -190,13 +328,19 @@ module Aws::Ivschat
190
328
  # part of the ARN that uniquely identifies the room.
191
329
  # @return [String]
192
330
  #
331
+ # @!attribute [rw] logging_configuration_identifiers
332
+ # Array of logging configurations attached to the room, from the
333
+ # request (if specified).
334
+ # @return [Array<String>]
335
+ #
193
336
  # @!attribute [rw] maximum_message_length
194
- # Maximum number of characters in a single message, from the request.
337
+ # Maximum number of characters in a single message, from the request
338
+ # (if specified).
195
339
  # @return [Integer]
196
340
  #
197
341
  # @!attribute [rw] maximum_message_rate_per_second
198
342
  # Maximum number of messages per second that can be sent to the room
199
- # (by all clients), from the request.
343
+ # (by all clients), from the request (if specified).
200
344
  # @return [Integer]
201
345
  #
202
346
  # @!attribute [rw] message_review_handler
@@ -208,7 +352,7 @@ module Aws::Ivschat
208
352
  # @return [String]
209
353
  #
210
354
  # @!attribute [rw] tags
211
- # Tags attached to the resource, from the request.
355
+ # Tags attached to the resource, from the request (if specified).
212
356
  # @return [Hash<String,String>]
213
357
  #
214
358
  # @!attribute [rw] update_time
@@ -222,6 +366,7 @@ module Aws::Ivschat
222
366
  :arn,
223
367
  :create_time,
224
368
  :id,
369
+ :logging_configuration_identifiers,
225
370
  :maximum_message_length,
226
371
  :maximum_message_rate_per_second,
227
372
  :message_review_handler,
@@ -232,6 +377,25 @@ module Aws::Ivschat
232
377
  include Aws::Structure
233
378
  end
234
379
 
380
+ # @note When making an API call, you may pass DeleteLoggingConfigurationRequest
381
+ # data as a hash:
382
+ #
383
+ # {
384
+ # identifier: "LoggingConfigurationIdentifier", # required
385
+ # }
386
+ #
387
+ # @!attribute [rw] identifier
388
+ # Identifier of the logging configuration to be deleted.
389
+ # @return [String]
390
+ #
391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteLoggingConfigurationRequest AWS API Documentation
392
+ #
393
+ class DeleteLoggingConfigurationRequest < Struct.new(
394
+ :identifier)
395
+ SENSITIVE = []
396
+ include Aws::Structure
397
+ end
398
+
235
399
  # @note When making an API call, you may pass DeleteMessageRequest
236
400
  # data as a hash:
237
401
  #
@@ -301,6 +465,46 @@ module Aws::Ivschat
301
465
  include Aws::Structure
302
466
  end
303
467
 
468
+ # A complex type that describes a location where chat logs will be
469
+ # stored. Each member represents the configuration of one log
470
+ # destination. For logging, you define only one type of destination (for
471
+ # CloudWatch Logs, Kinesis Firehose, or S3).
472
+ #
473
+ # @note DestinationConfiguration is a union - when making an API calls you must set exactly one of the members.
474
+ #
475
+ # @note DestinationConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DestinationConfiguration corresponding to the set member.
476
+ #
477
+ # @!attribute [rw] cloud_watch_logs
478
+ # Name of the Amazon CloudWatch Logs destination where chat activity
479
+ # will be logged.
480
+ # @return [Types::CloudWatchLogsDestinationConfiguration]
481
+ #
482
+ # @!attribute [rw] firehose
483
+ # Name of the Amazon Kinesis Data Firehose destination where chat
484
+ # activity will be logged
485
+ # @return [Types::FirehoseDestinationConfiguration]
486
+ #
487
+ # @!attribute [rw] s3
488
+ # Name of the Amazon S3 bucket where chat activity will be logged.
489
+ # @return [Types::S3DestinationConfiguration]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DestinationConfiguration AWS API Documentation
492
+ #
493
+ class DestinationConfiguration < Struct.new(
494
+ :cloud_watch_logs,
495
+ :firehose,
496
+ :s3,
497
+ :unknown)
498
+ SENSITIVE = []
499
+ include Aws::Structure
500
+ include Aws::Structure::Union
501
+
502
+ class CloudWatchLogs < DestinationConfiguration; end
503
+ class Firehose < DestinationConfiguration; end
504
+ class S3 < DestinationConfiguration; end
505
+ class Unknown < DestinationConfiguration; end
506
+ end
507
+
304
508
  # @note When making an API call, you may pass DisconnectUserRequest
305
509
  # data as a hash:
306
510
  #
@@ -337,6 +541,104 @@ module Aws::Ivschat
337
541
  #
338
542
  class DisconnectUserResponse < Aws::EmptyStructure; end
339
543
 
544
+ # Specifies a Kinesis Firehose location where chat logs will be stored.
545
+ #
546
+ # @note When making an API call, you may pass FirehoseDestinationConfiguration
547
+ # data as a hash:
548
+ #
549
+ # {
550
+ # delivery_stream_name: "DeliveryStreamName", # required
551
+ # }
552
+ #
553
+ # @!attribute [rw] delivery_stream_name
554
+ # Name of the Amazon Kinesis Firehose delivery stream where chat
555
+ # activity will be logged.
556
+ # @return [String]
557
+ #
558
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/FirehoseDestinationConfiguration AWS API Documentation
559
+ #
560
+ class FirehoseDestinationConfiguration < Struct.new(
561
+ :delivery_stream_name)
562
+ SENSITIVE = []
563
+ include Aws::Structure
564
+ end
565
+
566
+ # @note When making an API call, you may pass GetLoggingConfigurationRequest
567
+ # data as a hash:
568
+ #
569
+ # {
570
+ # identifier: "LoggingConfigurationIdentifier", # required
571
+ # }
572
+ #
573
+ # @!attribute [rw] identifier
574
+ # Identifier of the logging configuration to be retrieved.
575
+ # @return [String]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfigurationRequest AWS API Documentation
578
+ #
579
+ class GetLoggingConfigurationRequest < Struct.new(
580
+ :identifier)
581
+ SENSITIVE = []
582
+ include Aws::Structure
583
+ end
584
+
585
+ # @!attribute [rw] arn
586
+ # Logging-configuration ARN, from the request (if `identifier` was an
587
+ # ARN).
588
+ # @return [String]
589
+ #
590
+ # @!attribute [rw] create_time
591
+ # Time when the logging configuration was created. This is an ISO 8601
592
+ # timestamp; *note that this is returned as a string*.
593
+ # @return [Time]
594
+ #
595
+ # @!attribute [rw] destination_configuration
596
+ # A complex type that contains a destination configuration for where
597
+ # chat content will be logged. There is only one type of destination
598
+ # (`cloudWatchLogs`, `firehose`, or `s3`) in a
599
+ # `destinationConfiguration`.
600
+ # @return [Types::DestinationConfiguration]
601
+ #
602
+ # @!attribute [rw] id
603
+ # Logging-configuration ID, generated by the system. This is a
604
+ # relative identifier, the part of the ARN that uniquely identifies
605
+ # the logging configuration.
606
+ # @return [String]
607
+ #
608
+ # @!attribute [rw] name
609
+ # Logging-configuration name. This value does not need to be unique.
610
+ # @return [String]
611
+ #
612
+ # @!attribute [rw] state
613
+ # The state of the logging configuration. When the state is `ACTIVE`,
614
+ # the configuration is ready to log chat content.
615
+ # @return [String]
616
+ #
617
+ # @!attribute [rw] tags
618
+ # Tags attached to the resource. Array of maps, each of the form
619
+ # `string:string (key:value)`.
620
+ # @return [Hash<String,String>]
621
+ #
622
+ # @!attribute [rw] update_time
623
+ # Time of the logging configuration’s last update. This is an ISO 8601
624
+ # timestamp; *note that this is returned as a string*.
625
+ # @return [Time]
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfigurationResponse AWS API Documentation
628
+ #
629
+ class GetLoggingConfigurationResponse < Struct.new(
630
+ :arn,
631
+ :create_time,
632
+ :destination_configuration,
633
+ :id,
634
+ :name,
635
+ :state,
636
+ :tags,
637
+ :update_time)
638
+ SENSITIVE = []
639
+ include Aws::Structure
640
+ end
641
+
340
642
  # @note When making an API call, you may pass GetRoomRequest
341
643
  # data as a hash:
342
644
  #
@@ -371,6 +673,10 @@ module Aws::Ivschat
371
673
  # part of the ARN that uniquely identifies the room.
372
674
  # @return [String]
373
675
  #
676
+ # @!attribute [rw] logging_configuration_identifiers
677
+ # Array of logging configurations attached to the room.
678
+ # @return [Array<String>]
679
+ #
374
680
  # @!attribute [rw] maximum_message_length
375
681
  # Maximum number of characters in a single message. Messages are
376
682
  # expected to be UTF-8 encoded and this limit applies specifically to
@@ -406,6 +712,7 @@ module Aws::Ivschat
406
712
  :arn,
407
713
  :create_time,
408
714
  :id,
715
+ :logging_configuration_identifiers,
409
716
  :maximum_message_length,
410
717
  :maximum_message_rate_per_second,
411
718
  :message_review_handler,
@@ -427,16 +734,67 @@ module Aws::Ivschat
427
734
  include Aws::Structure
428
735
  end
429
736
 
737
+ # @note When making an API call, you may pass ListLoggingConfigurationsRequest
738
+ # data as a hash:
739
+ #
740
+ # {
741
+ # max_results: 1,
742
+ # next_token: "PaginationToken",
743
+ # }
744
+ #
745
+ # @!attribute [rw] max_results
746
+ # Maximum number of logging configurations to return. Default: 50.
747
+ # @return [Integer]
748
+ #
749
+ # @!attribute [rw] next_token
750
+ # The first logging configurations to retrieve. This is used for
751
+ # pagination; see the `nextToken` response field.
752
+ # @return [String]
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurationsRequest AWS API Documentation
755
+ #
756
+ class ListLoggingConfigurationsRequest < Struct.new(
757
+ :max_results,
758
+ :next_token)
759
+ SENSITIVE = []
760
+ include Aws::Structure
761
+ end
762
+
763
+ # @!attribute [rw] logging_configurations
764
+ # List of the matching logging configurations (summary information
765
+ # only). There is only one type of destination (`cloudWatchLogs`,
766
+ # `firehose`, or `s3`) in a `destinationConfiguration`.
767
+ # @return [Array<Types::LoggingConfigurationSummary>]
768
+ #
769
+ # @!attribute [rw] next_token
770
+ # If there are more logging configurations than `maxResults`, use
771
+ # `nextToken` in the request to get the next set.
772
+ # @return [String]
773
+ #
774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurationsResponse AWS API Documentation
775
+ #
776
+ class ListLoggingConfigurationsResponse < Struct.new(
777
+ :logging_configurations,
778
+ :next_token)
779
+ SENSITIVE = []
780
+ include Aws::Structure
781
+ end
782
+
430
783
  # @note When making an API call, you may pass ListRoomsRequest
431
784
  # data as a hash:
432
785
  #
433
786
  # {
787
+ # logging_configuration_identifier: "LoggingConfigurationIdentifier",
434
788
  # max_results: 1,
435
789
  # message_review_handler_uri: "LambdaArn",
436
790
  # name: "RoomName",
437
791
  # next_token: "PaginationToken",
438
792
  # }
439
793
  #
794
+ # @!attribute [rw] logging_configuration_identifier
795
+ # Logging-configuration identifier.
796
+ # @return [String]
797
+ #
440
798
  # @!attribute [rw] max_results
441
799
  # Maximum number of rooms to return. Default: 50.
442
800
  # @return [Integer]
@@ -457,6 +815,7 @@ module Aws::Ivschat
457
815
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsRequest AWS API Documentation
458
816
  #
459
817
  class ListRoomsRequest < Struct.new(
818
+ :logging_configuration_identifier,
460
819
  :max_results,
461
820
  :message_review_handler_uri,
462
821
  :name,
@@ -504,7 +863,8 @@ module Aws::Ivschat
504
863
  end
505
864
 
506
865
  # @!attribute [rw] tags
507
- # Tags attached to the resource, from the request.
866
+ # Tags attached to the resource. Array of maps, each of the form
867
+ # `string:string (key:value)`.
508
868
  # @return [Hash<String,String>]
509
869
  #
510
870
  # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResourceResponse AWS API Documentation
@@ -515,6 +875,69 @@ module Aws::Ivschat
515
875
  include Aws::Structure
516
876
  end
517
877
 
878
+ # Summary information about a logging configuration.
879
+ #
880
+ # @!attribute [rw] arn
881
+ # Logging-configuration ARN.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] create_time
885
+ # Time when the logging configuration was created. This is an ISO 8601
886
+ # timestamp; *note that this is returned as a string*.
887
+ # @return [Time]
888
+ #
889
+ # @!attribute [rw] destination_configuration
890
+ # A complex type that contains a destination configuration for where
891
+ # chat content will be logged.
892
+ # @return [Types::DestinationConfiguration]
893
+ #
894
+ # @!attribute [rw] id
895
+ # Logging-configuration ID, generated by the system. This is a
896
+ # relative identifier, the part of the ARN that uniquely identifies
897
+ # the room.
898
+ # @return [String]
899
+ #
900
+ # @!attribute [rw] name
901
+ # Logging-configuration name. The value does not need to be unique.
902
+ # @return [String]
903
+ #
904
+ # @!attribute [rw] state
905
+ # The state of the logging configuration. When this is `ACTIVE`, the
906
+ # configuration is ready for logging chat content.
907
+ # @return [String]
908
+ #
909
+ # @!attribute [rw] tags
910
+ # Tags to attach to the resource. Array of maps, each of the form
911
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
912
+ # details, including restrictions that apply to tags and "Tag naming
913
+ # limits and requirements"; Amazon IVS Chat has no constraints on
914
+ # tags beyond what is documented there.
915
+ #
916
+ #
917
+ #
918
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
919
+ # @return [Hash<String,String>]
920
+ #
921
+ # @!attribute [rw] update_time
922
+ # Time of the logging configuration’s last update. This is an ISO 8601
923
+ # timestamp; *note that this is returned as a string*.
924
+ # @return [Time]
925
+ #
926
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/LoggingConfigurationSummary AWS API Documentation
927
+ #
928
+ class LoggingConfigurationSummary < Struct.new(
929
+ :arn,
930
+ :create_time,
931
+ :destination_configuration,
932
+ :id,
933
+ :name,
934
+ :state,
935
+ :tags,
936
+ :update_time)
937
+ SENSITIVE = []
938
+ include Aws::Structure
939
+ end
940
+
518
941
  # Configuration information for optional message review.
519
942
  #
520
943
  # @note When making an API call, you may pass MessageReviewHandler
@@ -598,6 +1021,10 @@ module Aws::Ivschat
598
1021
  # part of the ARN that uniquely identifies the room.
599
1022
  # @return [String]
600
1023
  #
1024
+ # @!attribute [rw] logging_configuration_identifiers
1025
+ # List of logging-configuration identifiers attached to the room.
1026
+ # @return [Array<String>]
1027
+ #
601
1028
  # @!attribute [rw] message_review_handler
602
1029
  # Configuration information for optional review of messages.
603
1030
  # @return [Types::MessageReviewHandler]
@@ -607,7 +1034,8 @@ module Aws::Ivschat
607
1034
  # @return [String]
608
1035
  #
609
1036
  # @!attribute [rw] tags
610
- # Tags attached to the resource. See [Tagging AWS Resources][1] for
1037
+ # Tags attached to the resource. Array of maps, each of the form
1038
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
611
1039
  # details, including restrictions that apply to tags and "Tag naming
612
1040
  # limits and requirements"; Amazon IVS Chat has no constraints beyond
613
1041
  # what is documented there.
@@ -628,6 +1056,7 @@ module Aws::Ivschat
628
1056
  :arn,
629
1057
  :create_time,
630
1058
  :id,
1059
+ :logging_configuration_identifiers,
631
1060
  :message_review_handler,
632
1061
  :name,
633
1062
  :tags,
@@ -636,6 +1065,27 @@ module Aws::Ivschat
636
1065
  include Aws::Structure
637
1066
  end
638
1067
 
1068
+ # Specifies an S3 location where chat logs will be stored.
1069
+ #
1070
+ # @note When making an API call, you may pass S3DestinationConfiguration
1071
+ # data as a hash:
1072
+ #
1073
+ # {
1074
+ # bucket_name: "BucketName", # required
1075
+ # }
1076
+ #
1077
+ # @!attribute [rw] bucket_name
1078
+ # Name of the Amazon S3 bucket where chat activity will be logged.
1079
+ # @return [String]
1080
+ #
1081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/S3DestinationConfiguration AWS API Documentation
1082
+ #
1083
+ class S3DestinationConfiguration < Struct.new(
1084
+ :bucket_name)
1085
+ SENSITIVE = []
1086
+ include Aws::Structure
1087
+ end
1088
+
639
1089
  # @note When making an API call, you may pass SendEventRequest
640
1090
  # data as a hash:
641
1091
  #
@@ -723,10 +1173,11 @@ module Aws::Ivschat
723
1173
  # @return [String]
724
1174
  #
725
1175
  # @!attribute [rw] tags
726
- # Array of tags to be added or updated. See [Tagging AWS Resources][1]
727
- # for details, including restrictions that apply to tags and "Tag
728
- # naming limits and requirements"; Amazon IVS Chat has no constraints
729
- # beyond what is documented there.
1176
+ # Array of tags to be added or updated. Array of maps, each of the
1177
+ # form `string:string (key:value)`. See [Tagging AWS Resources][1] for
1178
+ # details, including restrictions that apply to tags and "Tag naming
1179
+ # limits and requirements"; Amazon IVS Chat has no constraints beyond
1180
+ # what is documented there.
730
1181
  #
731
1182
  #
732
1183
  #
@@ -782,7 +1233,8 @@ module Aws::Ivschat
782
1233
  # @return [String]
783
1234
  #
784
1235
  # @!attribute [rw] tag_keys
785
- # Array of tags to be removed. See [Tagging AWS Resources][1] for
1236
+ # Array of tags to be removed. Array of maps, each of the form
1237
+ # `string:string (key:value)`. See [Tagging AWS Resources][1] for
786
1238
  # details, including restrictions that apply to tags and "Tag naming
787
1239
  # limits and requirements"; Amazon IVS Chat has no constraints beyond
788
1240
  # what is documented there.
@@ -805,11 +1257,113 @@ module Aws::Ivschat
805
1257
  #
806
1258
  class UntagResourceResponse < Aws::EmptyStructure; end
807
1259
 
1260
+ # @note When making an API call, you may pass UpdateLoggingConfigurationRequest
1261
+ # data as a hash:
1262
+ #
1263
+ # {
1264
+ # destination_configuration: {
1265
+ # cloud_watch_logs: {
1266
+ # log_group_name: "LogGroupName", # required
1267
+ # },
1268
+ # firehose: {
1269
+ # delivery_stream_name: "DeliveryStreamName", # required
1270
+ # },
1271
+ # s3: {
1272
+ # bucket_name: "BucketName", # required
1273
+ # },
1274
+ # },
1275
+ # identifier: "LoggingConfigurationIdentifier", # required
1276
+ # name: "LoggingConfigurationName",
1277
+ # }
1278
+ #
1279
+ # @!attribute [rw] destination_configuration
1280
+ # A complex type that contains a destination configuration for where
1281
+ # chat content will be logged. There can be only one type of
1282
+ # destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
1283
+ # `destinationConfiguration`.
1284
+ # @return [Types::DestinationConfiguration]
1285
+ #
1286
+ # @!attribute [rw] identifier
1287
+ # Identifier of the logging configuration to be updated.
1288
+ # @return [String]
1289
+ #
1290
+ # @!attribute [rw] name
1291
+ # Logging-configuration name. The value does not need to be unique.
1292
+ # @return [String]
1293
+ #
1294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationRequest AWS API Documentation
1295
+ #
1296
+ class UpdateLoggingConfigurationRequest < Struct.new(
1297
+ :destination_configuration,
1298
+ :identifier,
1299
+ :name)
1300
+ SENSITIVE = []
1301
+ include Aws::Structure
1302
+ end
1303
+
1304
+ # @!attribute [rw] arn
1305
+ # Logging-configuration ARN, from the request (if `identifier` was an
1306
+ # ARN).
1307
+ # @return [String]
1308
+ #
1309
+ # @!attribute [rw] create_time
1310
+ # Time when the logging configuration was created. This is an ISO 8601
1311
+ # timestamp; *note that this is returned as a string*.
1312
+ # @return [Time]
1313
+ #
1314
+ # @!attribute [rw] destination_configuration
1315
+ # A complex type that contains a destination configuration for where
1316
+ # chat content will be logged, from the request. There is only one
1317
+ # type of destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
1318
+ # `destinationConfiguration`.
1319
+ # @return [Types::DestinationConfiguration]
1320
+ #
1321
+ # @!attribute [rw] id
1322
+ # Logging-configuration ID, generated by the system. This is a
1323
+ # relative identifier, the part of the ARN that uniquely identifies
1324
+ # the room.
1325
+ # @return [String]
1326
+ #
1327
+ # @!attribute [rw] name
1328
+ # Logging-configuration name, from the request (if specified).
1329
+ # @return [String]
1330
+ #
1331
+ # @!attribute [rw] state
1332
+ # The state of the logging configuration. When the state is `ACTIVE`,
1333
+ # the configuration is ready to log chat content.
1334
+ # @return [String]
1335
+ #
1336
+ # @!attribute [rw] tags
1337
+ # Tags attached to the resource. Array of maps, each of the form
1338
+ # `string:string (key:value)`.
1339
+ # @return [Hash<String,String>]
1340
+ #
1341
+ # @!attribute [rw] update_time
1342
+ # Time of the logging configuration’s last update. This is an ISO 8601
1343
+ # timestamp; *note that this is returned as a string*.
1344
+ # @return [Time]
1345
+ #
1346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationResponse AWS API Documentation
1347
+ #
1348
+ class UpdateLoggingConfigurationResponse < Struct.new(
1349
+ :arn,
1350
+ :create_time,
1351
+ :destination_configuration,
1352
+ :id,
1353
+ :name,
1354
+ :state,
1355
+ :tags,
1356
+ :update_time)
1357
+ SENSITIVE = []
1358
+ include Aws::Structure
1359
+ end
1360
+
808
1361
  # @note When making an API call, you may pass UpdateRoomRequest
809
1362
  # data as a hash:
810
1363
  #
811
1364
  # {
812
1365
  # identifier: "RoomIdentifier", # required
1366
+ # logging_configuration_identifiers: ["LoggingConfigurationIdentifier"],
813
1367
  # maximum_message_length: 1,
814
1368
  # maximum_message_rate_per_second: 1,
815
1369
  # message_review_handler: {
@@ -823,6 +1377,10 @@ module Aws::Ivschat
823
1377
  # Identifier of the room to be updated. Currently this must be an ARN.
824
1378
  # @return [String]
825
1379
  #
1380
+ # @!attribute [rw] logging_configuration_identifiers
1381
+ # Array of logging-configuration identifiers attached to the room.
1382
+ # @return [Array<String>]
1383
+ #
826
1384
  # @!attribute [rw] maximum_message_length
827
1385
  # The maximum number of characters in a single message. Messages are
828
1386
  # expected to be UTF-8 encoded and this limit applies specifically to
@@ -848,6 +1406,7 @@ module Aws::Ivschat
848
1406
  #
849
1407
  class UpdateRoomRequest < Struct.new(
850
1408
  :identifier,
1409
+ :logging_configuration_identifiers,
851
1410
  :maximum_message_length,
852
1411
  :maximum_message_rate_per_second,
853
1412
  :message_review_handler,
@@ -870,13 +1429,19 @@ module Aws::Ivschat
870
1429
  # part of the ARN that uniquely identifies the room.
871
1430
  # @return [String]
872
1431
  #
1432
+ # @!attribute [rw] logging_configuration_identifiers
1433
+ # Array of logging configurations attached to the room, from the
1434
+ # request (if specified).
1435
+ # @return [Array<String>]
1436
+ #
873
1437
  # @!attribute [rw] maximum_message_length
874
- # Maximum number of characters in a single message, from the request.
1438
+ # Maximum number of characters in a single message, from the request
1439
+ # (if specified).
875
1440
  # @return [Integer]
876
1441
  #
877
1442
  # @!attribute [rw] maximum_message_rate_per_second
878
1443
  # Maximum number of messages per second that can be sent to the room
879
- # (by all clients), from the request.
1444
+ # (by all clients), from the request (if specified).
880
1445
  # @return [Integer]
881
1446
  #
882
1447
  # @!attribute [rw] message_review_handler
@@ -884,11 +1449,12 @@ module Aws::Ivschat
884
1449
  # @return [Types::MessageReviewHandler]
885
1450
  #
886
1451
  # @!attribute [rw] name
887
- # Room name, from the request.
1452
+ # Room name, from the request (if specified).
888
1453
  # @return [String]
889
1454
  #
890
1455
  # @!attribute [rw] tags
891
- # Tags attached to the resource.
1456
+ # Tags attached to the resource. Array of maps, each of the form
1457
+ # `string:string (key:value)`.
892
1458
  # @return [Hash<String,String>]
893
1459
  #
894
1460
  # @!attribute [rw] update_time
@@ -902,6 +1468,7 @@ module Aws::Ivschat
902
1468
  :arn,
903
1469
  :create_time,
904
1470
  :id,
1471
+ :logging_configuration_identifiers,
905
1472
  :maximum_message_length,
906
1473
  :maximum_message_rate_per_second,
907
1474
  :message_review_handler,