aws-sdk-ivschat 1.5.0 → 1.7.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 +304 -10
- data/lib/aws-sdk-ivschat/client_api.rb +190 -0
- data/lib/aws-sdk-ivschat/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-ivschat/endpoint_provider.rb +75 -75
- data/lib/aws-sdk-ivschat/endpoints.rb +70 -0
- data/lib/aws-sdk-ivschat/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-ivschat/types.rb +481 -128
- data/lib/aws-sdk-ivschat.rb +1 -1
- metadata +2 -2
@@ -21,6 +21,21 @@ 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
|
+
# @!attribute [rw] log_group_name
|
27
|
+
# Name of the Amazon Cloudwatch Logs destination where chat activity
|
28
|
+
# will be logged.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CloudWatchLogsDestinationConfiguration AWS API Documentation
|
32
|
+
#
|
33
|
+
class CloudWatchLogsDestinationConfiguration < Struct.new(
|
34
|
+
:log_group_name)
|
35
|
+
SENSITIVE = []
|
36
|
+
include Aws::Structure
|
37
|
+
end
|
38
|
+
|
24
39
|
# @!attribute [rw] message
|
25
40
|
# @return [String]
|
26
41
|
#
|
@@ -40,19 +55,6 @@ module Aws::Ivschat
|
|
40
55
|
include Aws::Structure
|
41
56
|
end
|
42
57
|
|
43
|
-
# @note When making an API call, you may pass CreateChatTokenRequest
|
44
|
-
# data as a hash:
|
45
|
-
#
|
46
|
-
# {
|
47
|
-
# attributes: {
|
48
|
-
# "String" => "String",
|
49
|
-
# },
|
50
|
-
# capabilities: ["SEND_MESSAGE"], # accepts SEND_MESSAGE, DISCONNECT_USER, DELETE_MESSAGE
|
51
|
-
# room_identifier: "RoomIdentifier", # required
|
52
|
-
# session_duration_in_minutes: 1,
|
53
|
-
# user_id: "UserID", # required
|
54
|
-
# }
|
55
|
-
#
|
56
58
|
# @!attribute [rw] attributes
|
57
59
|
# Application-provided attributes to encode into the token and attach
|
58
60
|
# to a chat session. Map keys and values can contain UTF-8 encoded
|
@@ -117,21 +119,98 @@ module Aws::Ivschat
|
|
117
119
|
include Aws::Structure
|
118
120
|
end
|
119
121
|
|
120
|
-
#
|
121
|
-
#
|
122
|
+
# @!attribute [rw] destination_configuration
|
123
|
+
# A complex type that contains a destination configuration for where
|
124
|
+
# chat content will be logged. There can be only one type of
|
125
|
+
# destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
126
|
+
# `destinationConfiguration`.
|
127
|
+
# @return [Types::DestinationConfiguration]
|
128
|
+
#
|
129
|
+
# @!attribute [rw] name
|
130
|
+
# Logging-configuration name. The value does not need to be unique.
|
131
|
+
# @return [String]
|
132
|
+
#
|
133
|
+
# @!attribute [rw] tags
|
134
|
+
# Tags to attach to the resource. Array of maps, each of the form
|
135
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
136
|
+
# details, including restrictions that apply to tags and "Tag naming
|
137
|
+
# limits and requirements"; Amazon IVS Chat has no constraints on
|
138
|
+
# tags beyond what is documented there.
|
122
139
|
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
140
|
+
#
|
141
|
+
#
|
142
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
143
|
+
# @return [Hash<String,String>]
|
144
|
+
#
|
145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationRequest AWS API Documentation
|
146
|
+
#
|
147
|
+
class CreateLoggingConfigurationRequest < Struct.new(
|
148
|
+
:destination_configuration,
|
149
|
+
:name,
|
150
|
+
:tags)
|
151
|
+
SENSITIVE = []
|
152
|
+
include Aws::Structure
|
153
|
+
end
|
154
|
+
|
155
|
+
# @!attribute [rw] arn
|
156
|
+
# Logging-configuration ARN, assigned by the system.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] create_time
|
160
|
+
# Time when the logging configuration was created. This is an ISO 8601
|
161
|
+
# timestamp; *note that this is returned as a string*.
|
162
|
+
# @return [Time]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] destination_configuration
|
165
|
+
# A complex type that contains a destination configuration for where
|
166
|
+
# chat content will be logged, from the request. There is only one
|
167
|
+
# type of destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
168
|
+
# `destinationConfiguration`.
|
169
|
+
# @return [Types::DestinationConfiguration]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] id
|
172
|
+
# Logging-configuration ID, generated by the system. This is a
|
173
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
174
|
+
# the logging configuration.
|
175
|
+
# @return [String]
|
176
|
+
#
|
177
|
+
# @!attribute [rw] name
|
178
|
+
# Logging-configuration name, from the request (if specified).
|
179
|
+
# @return [String]
|
180
|
+
#
|
181
|
+
# @!attribute [rw] state
|
182
|
+
# The state of the logging configuration. When the state is `ACTIVE`,
|
183
|
+
# the configuration is ready to log chat content.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @!attribute [rw] tags
|
187
|
+
# Tags attached to the resource, from the request (if specified).
|
188
|
+
# Array of maps, each of the form `string:string (key:value)`.
|
189
|
+
# @return [Hash<String,String>]
|
190
|
+
#
|
191
|
+
# @!attribute [rw] update_time
|
192
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
193
|
+
# timestamp; *note that this is returned as a string*.
|
194
|
+
# @return [Time]
|
195
|
+
#
|
196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationResponse AWS API Documentation
|
197
|
+
#
|
198
|
+
class CreateLoggingConfigurationResponse < Struct.new(
|
199
|
+
:arn,
|
200
|
+
:create_time,
|
201
|
+
:destination_configuration,
|
202
|
+
:id,
|
203
|
+
:name,
|
204
|
+
:state,
|
205
|
+
:tags,
|
206
|
+
:update_time)
|
207
|
+
SENSITIVE = []
|
208
|
+
include Aws::Structure
|
209
|
+
end
|
210
|
+
|
211
|
+
# @!attribute [rw] logging_configuration_identifiers
|
212
|
+
# Array of logging-configuration identifiers attached to the room.
|
213
|
+
# @return [Array<String>]
|
135
214
|
#
|
136
215
|
# @!attribute [rw] maximum_message_length
|
137
216
|
# Maximum number of characters in a single message. Messages are
|
@@ -167,6 +246,7 @@ module Aws::Ivschat
|
|
167
246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomRequest AWS API Documentation
|
168
247
|
#
|
169
248
|
class CreateRoomRequest < Struct.new(
|
249
|
+
:logging_configuration_identifiers,
|
170
250
|
:maximum_message_length,
|
171
251
|
:maximum_message_rate_per_second,
|
172
252
|
:message_review_handler,
|
@@ -190,13 +270,19 @@ module Aws::Ivschat
|
|
190
270
|
# part of the ARN that uniquely identifies the room.
|
191
271
|
# @return [String]
|
192
272
|
#
|
273
|
+
# @!attribute [rw] logging_configuration_identifiers
|
274
|
+
# Array of logging configurations attached to the room, from the
|
275
|
+
# request (if specified).
|
276
|
+
# @return [Array<String>]
|
277
|
+
#
|
193
278
|
# @!attribute [rw] maximum_message_length
|
194
|
-
# Maximum number of characters in a single message, from the request
|
279
|
+
# Maximum number of characters in a single message, from the request
|
280
|
+
# (if specified).
|
195
281
|
# @return [Integer]
|
196
282
|
#
|
197
283
|
# @!attribute [rw] maximum_message_rate_per_second
|
198
284
|
# Maximum number of messages per second that can be sent to the room
|
199
|
-
# (by all clients), from the request.
|
285
|
+
# (by all clients), from the request (if specified).
|
200
286
|
# @return [Integer]
|
201
287
|
#
|
202
288
|
# @!attribute [rw] message_review_handler
|
@@ -208,7 +294,7 @@ module Aws::Ivschat
|
|
208
294
|
# @return [String]
|
209
295
|
#
|
210
296
|
# @!attribute [rw] tags
|
211
|
-
# Tags attached to the resource, from the request.
|
297
|
+
# Tags attached to the resource, from the request (if specified).
|
212
298
|
# @return [Hash<String,String>]
|
213
299
|
#
|
214
300
|
# @!attribute [rw] update_time
|
@@ -222,6 +308,7 @@ module Aws::Ivschat
|
|
222
308
|
:arn,
|
223
309
|
:create_time,
|
224
310
|
:id,
|
311
|
+
:logging_configuration_identifiers,
|
225
312
|
:maximum_message_length,
|
226
313
|
:maximum_message_rate_per_second,
|
227
314
|
:message_review_handler,
|
@@ -232,15 +319,18 @@ module Aws::Ivschat
|
|
232
319
|
include Aws::Structure
|
233
320
|
end
|
234
321
|
|
235
|
-
#
|
236
|
-
#
|
322
|
+
# @!attribute [rw] identifier
|
323
|
+
# Identifier of the logging configuration to be deleted.
|
324
|
+
# @return [String]
|
237
325
|
#
|
238
|
-
#
|
239
|
-
# id: "MessageID", # required
|
240
|
-
# reason: "Reason",
|
241
|
-
# room_identifier: "RoomIdentifier", # required
|
242
|
-
# }
|
326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteLoggingConfigurationRequest AWS API Documentation
|
243
327
|
#
|
328
|
+
class DeleteLoggingConfigurationRequest < Struct.new(
|
329
|
+
:identifier)
|
330
|
+
SENSITIVE = []
|
331
|
+
include Aws::Structure
|
332
|
+
end
|
333
|
+
|
244
334
|
# @!attribute [rw] id
|
245
335
|
# ID of the message to be deleted. This is the `Id` field in the
|
246
336
|
# received message (see [ Message (Subscribe)][1] in the Chat
|
@@ -282,13 +372,6 @@ module Aws::Ivschat
|
|
282
372
|
include Aws::Structure
|
283
373
|
end
|
284
374
|
|
285
|
-
# @note When making an API call, you may pass DeleteRoomRequest
|
286
|
-
# data as a hash:
|
287
|
-
#
|
288
|
-
# {
|
289
|
-
# identifier: "RoomIdentifier", # required
|
290
|
-
# }
|
291
|
-
#
|
292
375
|
# @!attribute [rw] identifier
|
293
376
|
# Identifier of the room to be deleted. Currently this must be an ARN.
|
294
377
|
# @return [String]
|
@@ -301,15 +384,47 @@ module Aws::Ivschat
|
|
301
384
|
include Aws::Structure
|
302
385
|
end
|
303
386
|
|
304
|
-
#
|
305
|
-
#
|
387
|
+
# A complex type that describes a location where chat logs will be
|
388
|
+
# stored. Each member represents the configuration of one log
|
389
|
+
# destination. For logging, you define only one type of destination (for
|
390
|
+
# CloudWatch Logs, Kinesis Firehose, or S3).
|
391
|
+
#
|
392
|
+
# @note DestinationConfiguration is a union - when making an API calls you must set exactly one of the members.
|
393
|
+
#
|
394
|
+
# @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.
|
395
|
+
#
|
396
|
+
# @!attribute [rw] cloud_watch_logs
|
397
|
+
# An Amazon CloudWatch Logs destination configuration where chat
|
398
|
+
# activity will be logged.
|
399
|
+
# @return [Types::CloudWatchLogsDestinationConfiguration]
|
400
|
+
#
|
401
|
+
# @!attribute [rw] firehose
|
402
|
+
# An Amazon Kinesis Data Firehose destination configuration where chat
|
403
|
+
# activity will be logged.
|
404
|
+
# @return [Types::FirehoseDestinationConfiguration]
|
306
405
|
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
310
|
-
#
|
311
|
-
# }
|
406
|
+
# @!attribute [rw] s3
|
407
|
+
# An Amazon S3 destination configuration where chat activity will be
|
408
|
+
# logged.
|
409
|
+
# @return [Types::S3DestinationConfiguration]
|
312
410
|
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DestinationConfiguration AWS API Documentation
|
412
|
+
#
|
413
|
+
class DestinationConfiguration < Struct.new(
|
414
|
+
:cloud_watch_logs,
|
415
|
+
:firehose,
|
416
|
+
:s3,
|
417
|
+
:unknown)
|
418
|
+
SENSITIVE = []
|
419
|
+
include Aws::Structure
|
420
|
+
include Aws::Structure::Union
|
421
|
+
|
422
|
+
class CloudWatchLogs < DestinationConfiguration; end
|
423
|
+
class Firehose < DestinationConfiguration; end
|
424
|
+
class S3 < DestinationConfiguration; end
|
425
|
+
class Unknown < DestinationConfiguration; end
|
426
|
+
end
|
427
|
+
|
313
428
|
# @!attribute [rw] reason
|
314
429
|
# Reason for disconnecting the user.
|
315
430
|
# @return [String]
|
@@ -337,13 +452,90 @@ module Aws::Ivschat
|
|
337
452
|
#
|
338
453
|
class DisconnectUserResponse < Aws::EmptyStructure; end
|
339
454
|
|
340
|
-
#
|
341
|
-
#
|
455
|
+
# Specifies a Kinesis Firehose location where chat logs will be stored.
|
456
|
+
#
|
457
|
+
# @!attribute [rw] delivery_stream_name
|
458
|
+
# Name of the Amazon Kinesis Firehose delivery stream where chat
|
459
|
+
# activity will be logged.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/FirehoseDestinationConfiguration AWS API Documentation
|
463
|
+
#
|
464
|
+
class FirehoseDestinationConfiguration < Struct.new(
|
465
|
+
:delivery_stream_name)
|
466
|
+
SENSITIVE = []
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# @!attribute [rw] identifier
|
471
|
+
# Identifier of the logging configuration to be retrieved.
|
472
|
+
# @return [String]
|
473
|
+
#
|
474
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfigurationRequest AWS API Documentation
|
475
|
+
#
|
476
|
+
class GetLoggingConfigurationRequest < Struct.new(
|
477
|
+
:identifier)
|
478
|
+
SENSITIVE = []
|
479
|
+
include Aws::Structure
|
480
|
+
end
|
481
|
+
|
482
|
+
# @!attribute [rw] arn
|
483
|
+
# Logging-configuration ARN, from the request (if `identifier` was an
|
484
|
+
# ARN).
|
485
|
+
# @return [String]
|
342
486
|
#
|
343
|
-
#
|
344
|
-
#
|
345
|
-
#
|
487
|
+
# @!attribute [rw] create_time
|
488
|
+
# Time when the logging configuration was created. This is an ISO 8601
|
489
|
+
# timestamp; *note that this is returned as a string*.
|
490
|
+
# @return [Time]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] destination_configuration
|
493
|
+
# A complex type that contains a destination configuration for where
|
494
|
+
# chat content will be logged. There is only one type of destination
|
495
|
+
# (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
496
|
+
# `destinationConfiguration`.
|
497
|
+
# @return [Types::DestinationConfiguration]
|
498
|
+
#
|
499
|
+
# @!attribute [rw] id
|
500
|
+
# Logging-configuration ID, generated by the system. This is a
|
501
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
502
|
+
# the logging configuration.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] name
|
506
|
+
# Logging-configuration name. This value does not need to be unique.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @!attribute [rw] state
|
510
|
+
# The state of the logging configuration. When the state is `ACTIVE`,
|
511
|
+
# the configuration is ready to log chat content.
|
512
|
+
# @return [String]
|
513
|
+
#
|
514
|
+
# @!attribute [rw] tags
|
515
|
+
# Tags attached to the resource. Array of maps, each of the form
|
516
|
+
# `string:string (key:value)`.
|
517
|
+
# @return [Hash<String,String>]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] update_time
|
520
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
521
|
+
# timestamp; *note that this is returned as a string*.
|
522
|
+
# @return [Time]
|
523
|
+
#
|
524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfigurationResponse AWS API Documentation
|
346
525
|
#
|
526
|
+
class GetLoggingConfigurationResponse < Struct.new(
|
527
|
+
:arn,
|
528
|
+
:create_time,
|
529
|
+
:destination_configuration,
|
530
|
+
:id,
|
531
|
+
:name,
|
532
|
+
:state,
|
533
|
+
:tags,
|
534
|
+
:update_time)
|
535
|
+
SENSITIVE = []
|
536
|
+
include Aws::Structure
|
537
|
+
end
|
538
|
+
|
347
539
|
# @!attribute [rw] identifier
|
348
540
|
# Identifier of the room for which the configuration is to be
|
349
541
|
# retrieved. Currently this must be an ARN.
|
@@ -371,6 +563,10 @@ module Aws::Ivschat
|
|
371
563
|
# part of the ARN that uniquely identifies the room.
|
372
564
|
# @return [String]
|
373
565
|
#
|
566
|
+
# @!attribute [rw] logging_configuration_identifiers
|
567
|
+
# Array of logging configurations attached to the room.
|
568
|
+
# @return [Array<String>]
|
569
|
+
#
|
374
570
|
# @!attribute [rw] maximum_message_length
|
375
571
|
# Maximum number of characters in a single message. Messages are
|
376
572
|
# expected to be UTF-8 encoded and this limit applies specifically to
|
@@ -406,6 +602,7 @@ module Aws::Ivschat
|
|
406
602
|
:arn,
|
407
603
|
:create_time,
|
408
604
|
:id,
|
605
|
+
:logging_configuration_identifiers,
|
409
606
|
:maximum_message_length,
|
410
607
|
:maximum_message_rate_per_second,
|
411
608
|
:message_review_handler,
|
@@ -427,15 +624,47 @@ module Aws::Ivschat
|
|
427
624
|
include Aws::Structure
|
428
625
|
end
|
429
626
|
|
430
|
-
#
|
431
|
-
#
|
627
|
+
# @!attribute [rw] max_results
|
628
|
+
# Maximum number of logging configurations to return. Default: 50.
|
629
|
+
# @return [Integer]
|
432
630
|
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
631
|
+
# @!attribute [rw] next_token
|
632
|
+
# The first logging configurations to retrieve. This is used for
|
633
|
+
# pagination; see the `nextToken` response field.
|
634
|
+
# @return [String]
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurationsRequest AWS API Documentation
|
637
|
+
#
|
638
|
+
class ListLoggingConfigurationsRequest < Struct.new(
|
639
|
+
:max_results,
|
640
|
+
:next_token)
|
641
|
+
SENSITIVE = []
|
642
|
+
include Aws::Structure
|
643
|
+
end
|
644
|
+
|
645
|
+
# @!attribute [rw] logging_configurations
|
646
|
+
# List of the matching logging configurations (summary information
|
647
|
+
# only). There is only one type of destination (`cloudWatchLogs`,
|
648
|
+
# `firehose`, or `s3`) in a `destinationConfiguration`.
|
649
|
+
# @return [Array<Types::LoggingConfigurationSummary>]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] next_token
|
652
|
+
# If there are more logging configurations than `maxResults`, use
|
653
|
+
# `nextToken` in the request to get the next set.
|
654
|
+
# @return [String]
|
655
|
+
#
|
656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurationsResponse AWS API Documentation
|
657
|
+
#
|
658
|
+
class ListLoggingConfigurationsResponse < Struct.new(
|
659
|
+
:logging_configurations,
|
660
|
+
:next_token)
|
661
|
+
SENSITIVE = []
|
662
|
+
include Aws::Structure
|
663
|
+
end
|
664
|
+
|
665
|
+
# @!attribute [rw] logging_configuration_identifier
|
666
|
+
# Logging-configuration identifier.
|
667
|
+
# @return [String]
|
439
668
|
#
|
440
669
|
# @!attribute [rw] max_results
|
441
670
|
# Maximum number of rooms to return. Default: 50.
|
@@ -457,6 +686,7 @@ module Aws::Ivschat
|
|
457
686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsRequest AWS API Documentation
|
458
687
|
#
|
459
688
|
class ListRoomsRequest < Struct.new(
|
689
|
+
:logging_configuration_identifier,
|
460
690
|
:max_results,
|
461
691
|
:message_review_handler_uri,
|
462
692
|
:name,
|
@@ -483,13 +713,6 @@ module Aws::Ivschat
|
|
483
713
|
include Aws::Structure
|
484
714
|
end
|
485
715
|
|
486
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
487
|
-
# data as a hash:
|
488
|
-
#
|
489
|
-
# {
|
490
|
-
# resource_arn: "ResourceArn", # required
|
491
|
-
# }
|
492
|
-
#
|
493
716
|
# @!attribute [rw] resource_arn
|
494
717
|
# The ARN of the resource to be retrieved. The ARN must be
|
495
718
|
# URL-encoded.
|
@@ -504,7 +727,8 @@ module Aws::Ivschat
|
|
504
727
|
end
|
505
728
|
|
506
729
|
# @!attribute [rw] tags
|
507
|
-
# Tags attached to the resource,
|
730
|
+
# Tags attached to the resource. Array of maps, each of the form
|
731
|
+
# `string:string (key:value)`.
|
508
732
|
# @return [Hash<String,String>]
|
509
733
|
#
|
510
734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResourceResponse AWS API Documentation
|
@@ -515,15 +739,70 @@ module Aws::Ivschat
|
|
515
739
|
include Aws::Structure
|
516
740
|
end
|
517
741
|
|
518
|
-
#
|
742
|
+
# Summary information about a logging configuration.
|
743
|
+
#
|
744
|
+
# @!attribute [rw] arn
|
745
|
+
# Logging-configuration ARN.
|
746
|
+
# @return [String]
|
747
|
+
#
|
748
|
+
# @!attribute [rw] create_time
|
749
|
+
# Time when the logging configuration was created. This is an ISO 8601
|
750
|
+
# timestamp; *note that this is returned as a string*.
|
751
|
+
# @return [Time]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] destination_configuration
|
754
|
+
# A complex type that contains a destination configuration for where
|
755
|
+
# chat content will be logged.
|
756
|
+
# @return [Types::DestinationConfiguration]
|
757
|
+
#
|
758
|
+
# @!attribute [rw] id
|
759
|
+
# Logging-configuration ID, generated by the system. This is a
|
760
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
761
|
+
# the room.
|
762
|
+
# @return [String]
|
763
|
+
#
|
764
|
+
# @!attribute [rw] name
|
765
|
+
# Logging-configuration name. The value does not need to be unique.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] state
|
769
|
+
# The state of the logging configuration. When this is `ACTIVE`, the
|
770
|
+
# configuration is ready for logging chat content.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
# @!attribute [rw] tags
|
774
|
+
# Tags to attach to the resource. Array of maps, each of the form
|
775
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
776
|
+
# details, including restrictions that apply to tags and "Tag naming
|
777
|
+
# limits and requirements"; Amazon IVS Chat has no constraints on
|
778
|
+
# tags beyond what is documented there.
|
779
|
+
#
|
780
|
+
#
|
781
|
+
#
|
782
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
783
|
+
# @return [Hash<String,String>]
|
519
784
|
#
|
520
|
-
#
|
521
|
-
#
|
785
|
+
# @!attribute [rw] update_time
|
786
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
787
|
+
# timestamp; *note that this is returned as a string*.
|
788
|
+
# @return [Time]
|
522
789
|
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
|
526
|
-
|
790
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/LoggingConfigurationSummary AWS API Documentation
|
791
|
+
#
|
792
|
+
class LoggingConfigurationSummary < Struct.new(
|
793
|
+
:arn,
|
794
|
+
:create_time,
|
795
|
+
:destination_configuration,
|
796
|
+
:id,
|
797
|
+
:name,
|
798
|
+
:state,
|
799
|
+
:tags,
|
800
|
+
:update_time)
|
801
|
+
SENSITIVE = []
|
802
|
+
include Aws::Structure
|
803
|
+
end
|
804
|
+
|
805
|
+
# Configuration information for optional message review.
|
527
806
|
#
|
528
807
|
# @!attribute [rw] fallback_result
|
529
808
|
# Specifies the fallback behavior (whether the message is allowed or
|
@@ -598,6 +877,10 @@ module Aws::Ivschat
|
|
598
877
|
# part of the ARN that uniquely identifies the room.
|
599
878
|
# @return [String]
|
600
879
|
#
|
880
|
+
# @!attribute [rw] logging_configuration_identifiers
|
881
|
+
# List of logging-configuration identifiers attached to the room.
|
882
|
+
# @return [Array<String>]
|
883
|
+
#
|
601
884
|
# @!attribute [rw] message_review_handler
|
602
885
|
# Configuration information for optional review of messages.
|
603
886
|
# @return [Types::MessageReviewHandler]
|
@@ -607,7 +890,8 @@ module Aws::Ivschat
|
|
607
890
|
# @return [String]
|
608
891
|
#
|
609
892
|
# @!attribute [rw] tags
|
610
|
-
# Tags attached to the resource.
|
893
|
+
# Tags attached to the resource. Array of maps, each of the form
|
894
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
611
895
|
# details, including restrictions that apply to tags and "Tag naming
|
612
896
|
# limits and requirements"; Amazon IVS Chat has no constraints beyond
|
613
897
|
# what is documented there.
|
@@ -628,6 +912,7 @@ module Aws::Ivschat
|
|
628
912
|
:arn,
|
629
913
|
:create_time,
|
630
914
|
:id,
|
915
|
+
:logging_configuration_identifiers,
|
631
916
|
:message_review_handler,
|
632
917
|
:name,
|
633
918
|
:tags,
|
@@ -636,17 +921,20 @@ module Aws::Ivschat
|
|
636
921
|
include Aws::Structure
|
637
922
|
end
|
638
923
|
|
639
|
-
#
|
640
|
-
#
|
924
|
+
# Specifies an S3 location where chat logs will be stored.
|
925
|
+
#
|
926
|
+
# @!attribute [rw] bucket_name
|
927
|
+
# Name of the Amazon S3 bucket where chat activity will be logged.
|
928
|
+
# @return [String]
|
641
929
|
#
|
642
|
-
#
|
643
|
-
# attributes: {
|
644
|
-
# "String" => "String",
|
645
|
-
# },
|
646
|
-
# event_name: "EventName", # required
|
647
|
-
# room_identifier: "RoomIdentifier", # required
|
648
|
-
# }
|
930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/S3DestinationConfiguration AWS API Documentation
|
649
931
|
#
|
932
|
+
class S3DestinationConfiguration < Struct.new(
|
933
|
+
:bucket_name)
|
934
|
+
SENSITIVE = []
|
935
|
+
include Aws::Structure
|
936
|
+
end
|
937
|
+
|
650
938
|
# @!attribute [rw] attributes
|
651
939
|
# Application-defined metadata to attach to the event sent to clients.
|
652
940
|
# The maximum length of the metadata is 1 KB total.
|
@@ -708,25 +996,16 @@ module Aws::Ivschat
|
|
708
996
|
include Aws::Structure
|
709
997
|
end
|
710
998
|
|
711
|
-
# @note When making an API call, you may pass TagResourceRequest
|
712
|
-
# data as a hash:
|
713
|
-
#
|
714
|
-
# {
|
715
|
-
# resource_arn: "ResourceArn", # required
|
716
|
-
# tags: { # required
|
717
|
-
# "TagKey" => "TagValue",
|
718
|
-
# },
|
719
|
-
# }
|
720
|
-
#
|
721
999
|
# @!attribute [rw] resource_arn
|
722
1000
|
# The ARN of the resource to be tagged. The ARN must be URL-encoded.
|
723
1001
|
# @return [String]
|
724
1002
|
#
|
725
1003
|
# @!attribute [rw] tags
|
726
|
-
# Array of tags to be added or updated.
|
727
|
-
#
|
728
|
-
#
|
729
|
-
#
|
1004
|
+
# Array of tags to be added or updated. Array of maps, each of the
|
1005
|
+
# form `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
1006
|
+
# details, including restrictions that apply to tags and "Tag naming
|
1007
|
+
# limits and requirements"; Amazon IVS Chat has no constraints beyond
|
1008
|
+
# what is documented there.
|
730
1009
|
#
|
731
1010
|
#
|
732
1011
|
#
|
@@ -769,20 +1048,13 @@ module Aws::Ivschat
|
|
769
1048
|
include Aws::Structure
|
770
1049
|
end
|
771
1050
|
|
772
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
773
|
-
# data as a hash:
|
774
|
-
#
|
775
|
-
# {
|
776
|
-
# resource_arn: "ResourceArn", # required
|
777
|
-
# tag_keys: ["TagKey"], # required
|
778
|
-
# }
|
779
|
-
#
|
780
1051
|
# @!attribute [rw] resource_arn
|
781
1052
|
# The ARN of the resource to be untagged. The ARN must be URL-encoded.
|
782
1053
|
# @return [String]
|
783
1054
|
#
|
784
1055
|
# @!attribute [rw] tag_keys
|
785
|
-
# Array of tags to be removed.
|
1056
|
+
# Array of tags to be removed. Array of maps, each of the form
|
1057
|
+
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
786
1058
|
# details, including restrictions that apply to tags and "Tag naming
|
787
1059
|
# limits and requirements"; Amazon IVS Chat has no constraints beyond
|
788
1060
|
# what is documented there.
|
@@ -805,24 +1077,96 @@ module Aws::Ivschat
|
|
805
1077
|
#
|
806
1078
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
807
1079
|
|
808
|
-
#
|
809
|
-
#
|
1080
|
+
# @!attribute [rw] destination_configuration
|
1081
|
+
# A complex type that contains a destination configuration for where
|
1082
|
+
# chat content will be logged. There can be only one type of
|
1083
|
+
# destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
1084
|
+
# `destinationConfiguration`.
|
1085
|
+
# @return [Types::DestinationConfiguration]
|
1086
|
+
#
|
1087
|
+
# @!attribute [rw] identifier
|
1088
|
+
# Identifier of the logging configuration to be updated.
|
1089
|
+
# @return [String]
|
1090
|
+
#
|
1091
|
+
# @!attribute [rw] name
|
1092
|
+
# Logging-configuration name. The value does not need to be unique.
|
1093
|
+
# @return [String]
|
1094
|
+
#
|
1095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationRequest AWS API Documentation
|
1096
|
+
#
|
1097
|
+
class UpdateLoggingConfigurationRequest < Struct.new(
|
1098
|
+
:destination_configuration,
|
1099
|
+
:identifier,
|
1100
|
+
:name)
|
1101
|
+
SENSITIVE = []
|
1102
|
+
include Aws::Structure
|
1103
|
+
end
|
1104
|
+
|
1105
|
+
# @!attribute [rw] arn
|
1106
|
+
# Logging-configuration ARN, from the request (if `identifier` was an
|
1107
|
+
# ARN).
|
1108
|
+
# @return [String]
|
1109
|
+
#
|
1110
|
+
# @!attribute [rw] create_time
|
1111
|
+
# Time when the logging configuration was created. This is an ISO 8601
|
1112
|
+
# timestamp; *note that this is returned as a string*.
|
1113
|
+
# @return [Time]
|
810
1114
|
#
|
811
|
-
#
|
812
|
-
#
|
813
|
-
#
|
814
|
-
#
|
815
|
-
#
|
816
|
-
#
|
817
|
-
# uri: "LambdaArn",
|
818
|
-
# },
|
819
|
-
# name: "RoomName",
|
820
|
-
# }
|
1115
|
+
# @!attribute [rw] destination_configuration
|
1116
|
+
# A complex type that contains a destination configuration for where
|
1117
|
+
# chat content will be logged, from the request. There is only one
|
1118
|
+
# type of destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
1119
|
+
# `destinationConfiguration`.
|
1120
|
+
# @return [Types::DestinationConfiguration]
|
821
1121
|
#
|
1122
|
+
# @!attribute [rw] id
|
1123
|
+
# Logging-configuration ID, generated by the system. This is a
|
1124
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
1125
|
+
# the room.
|
1126
|
+
# @return [String]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] name
|
1129
|
+
# Logging-configuration name, from the request (if specified).
|
1130
|
+
# @return [String]
|
1131
|
+
#
|
1132
|
+
# @!attribute [rw] state
|
1133
|
+
# The state of the logging configuration. When the state is `ACTIVE`,
|
1134
|
+
# the configuration is ready to log chat content.
|
1135
|
+
# @return [String]
|
1136
|
+
#
|
1137
|
+
# @!attribute [rw] tags
|
1138
|
+
# Tags attached to the resource. Array of maps, each of the form
|
1139
|
+
# `string:string (key:value)`.
|
1140
|
+
# @return [Hash<String,String>]
|
1141
|
+
#
|
1142
|
+
# @!attribute [rw] update_time
|
1143
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
1144
|
+
# timestamp; *note that this is returned as a string*.
|
1145
|
+
# @return [Time]
|
1146
|
+
#
|
1147
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationResponse AWS API Documentation
|
1148
|
+
#
|
1149
|
+
class UpdateLoggingConfigurationResponse < Struct.new(
|
1150
|
+
:arn,
|
1151
|
+
:create_time,
|
1152
|
+
:destination_configuration,
|
1153
|
+
:id,
|
1154
|
+
:name,
|
1155
|
+
:state,
|
1156
|
+
:tags,
|
1157
|
+
:update_time)
|
1158
|
+
SENSITIVE = []
|
1159
|
+
include Aws::Structure
|
1160
|
+
end
|
1161
|
+
|
822
1162
|
# @!attribute [rw] identifier
|
823
1163
|
# Identifier of the room to be updated. Currently this must be an ARN.
|
824
1164
|
# @return [String]
|
825
1165
|
#
|
1166
|
+
# @!attribute [rw] logging_configuration_identifiers
|
1167
|
+
# Array of logging-configuration identifiers attached to the room.
|
1168
|
+
# @return [Array<String>]
|
1169
|
+
#
|
826
1170
|
# @!attribute [rw] maximum_message_length
|
827
1171
|
# The maximum number of characters in a single message. Messages are
|
828
1172
|
# expected to be UTF-8 encoded and this limit applies specifically to
|
@@ -848,6 +1192,7 @@ module Aws::Ivschat
|
|
848
1192
|
#
|
849
1193
|
class UpdateRoomRequest < Struct.new(
|
850
1194
|
:identifier,
|
1195
|
+
:logging_configuration_identifiers,
|
851
1196
|
:maximum_message_length,
|
852
1197
|
:maximum_message_rate_per_second,
|
853
1198
|
:message_review_handler,
|
@@ -870,13 +1215,19 @@ module Aws::Ivschat
|
|
870
1215
|
# part of the ARN that uniquely identifies the room.
|
871
1216
|
# @return [String]
|
872
1217
|
#
|
1218
|
+
# @!attribute [rw] logging_configuration_identifiers
|
1219
|
+
# Array of logging configurations attached to the room, from the
|
1220
|
+
# request (if specified).
|
1221
|
+
# @return [Array<String>]
|
1222
|
+
#
|
873
1223
|
# @!attribute [rw] maximum_message_length
|
874
|
-
# Maximum number of characters in a single message, from the request
|
1224
|
+
# Maximum number of characters in a single message, from the request
|
1225
|
+
# (if specified).
|
875
1226
|
# @return [Integer]
|
876
1227
|
#
|
877
1228
|
# @!attribute [rw] maximum_message_rate_per_second
|
878
1229
|
# Maximum number of messages per second that can be sent to the room
|
879
|
-
# (by all clients), from the request.
|
1230
|
+
# (by all clients), from the request (if specified).
|
880
1231
|
# @return [Integer]
|
881
1232
|
#
|
882
1233
|
# @!attribute [rw] message_review_handler
|
@@ -884,11 +1235,12 @@ module Aws::Ivschat
|
|
884
1235
|
# @return [Types::MessageReviewHandler]
|
885
1236
|
#
|
886
1237
|
# @!attribute [rw] name
|
887
|
-
# Room name, from the request.
|
1238
|
+
# Room name, from the request (if specified).
|
888
1239
|
# @return [String]
|
889
1240
|
#
|
890
1241
|
# @!attribute [rw] tags
|
891
|
-
# Tags attached to the resource.
|
1242
|
+
# Tags attached to the resource. Array of maps, each of the form
|
1243
|
+
# `string:string (key:value)`.
|
892
1244
|
# @return [Hash<String,String>]
|
893
1245
|
#
|
894
1246
|
# @!attribute [rw] update_time
|
@@ -902,6 +1254,7 @@ module Aws::Ivschat
|
|
902
1254
|
:arn,
|
903
1255
|
:create_time,
|
904
1256
|
:id,
|
1257
|
+
:logging_configuration_identifiers,
|
905
1258
|
:maximum_message_length,
|
906
1259
|
:maximum_message_rate_per_second,
|
907
1260
|
:message_review_handler,
|