aws-sdk-ivschat 1.27.0 → 1.29.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 +162 -162
- data/lib/aws-sdk-ivschat/client_api.rb +61 -60
- data/lib/aws-sdk-ivschat/errors.rb +15 -15
- data/lib/aws-sdk-ivschat/types.rb +323 -323
- data/lib/aws-sdk-ivschat/waiters.rb +15 -0
- data/lib/aws-sdk-ivschat.rb +2 -1
- data/sig/client.rbs +61 -61
- data/sig/errors.rbs +3 -3
- data/sig/types.rbs +61 -61
- metadata +5 -4
@@ -55,11 +55,15 @@ module Aws::Ivschat
|
|
55
55
|
include Aws::Structure
|
56
56
|
end
|
57
57
|
|
58
|
-
# @!attribute [rw]
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
58
|
+
# @!attribute [rw] room_identifier
|
59
|
+
# Identifier of the room that the client is trying to access.
|
60
|
+
# Currently this must be an ARN.
|
61
|
+
# @return [String]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] user_id
|
64
|
+
# Application-provided ID that uniquely identifies the user associated
|
65
|
+
# with this token. This can be any UTF-8 encoded text.
|
66
|
+
# @return [String]
|
63
67
|
#
|
64
68
|
# @!attribute [rw] capabilities
|
65
69
|
# Set of capabilities that the user is allowed to perform in the room.
|
@@ -67,38 +71,29 @@ module Aws::Ivschat
|
|
67
71
|
# included in all requests).
|
68
72
|
# @return [Array<String>]
|
69
73
|
#
|
70
|
-
# @!attribute [rw] room_identifier
|
71
|
-
# Identifier of the room that the client is trying to access.
|
72
|
-
# Currently this must be an ARN.
|
73
|
-
# @return [String]
|
74
|
-
#
|
75
74
|
# @!attribute [rw] session_duration_in_minutes
|
76
75
|
# Session duration (in minutes), after which the session expires.
|
77
76
|
# Default: 60 (1 hour).
|
78
77
|
# @return [Integer]
|
79
78
|
#
|
80
|
-
# @!attribute [rw]
|
81
|
-
# Application-provided
|
82
|
-
#
|
83
|
-
#
|
79
|
+
# @!attribute [rw] attributes
|
80
|
+
# Application-provided attributes to encode into the token and attach
|
81
|
+
# to a chat session. Map keys and values can contain UTF-8 encoded
|
82
|
+
# text. The maximum length of this field is 1 KB total.
|
83
|
+
# @return [Hash<String,String>]
|
84
84
|
#
|
85
85
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateChatTokenRequest AWS API Documentation
|
86
86
|
#
|
87
87
|
class CreateChatTokenRequest < Struct.new(
|
88
|
-
:attributes,
|
89
|
-
:capabilities,
|
90
88
|
:room_identifier,
|
89
|
+
:user_id,
|
90
|
+
:capabilities,
|
91
91
|
:session_duration_in_minutes,
|
92
|
-
:
|
93
|
-
SENSITIVE = [:
|
92
|
+
:attributes)
|
93
|
+
SENSITIVE = [:user_id, :attributes]
|
94
94
|
include Aws::Structure
|
95
95
|
end
|
96
96
|
|
97
|
-
# @!attribute [rw] session_expiration_time
|
98
|
-
# Time after which an end user's session is no longer valid. This is
|
99
|
-
# an ISO 8601 timestamp; *note that this is returned as a string*.
|
100
|
-
# @return [Time]
|
101
|
-
#
|
102
97
|
# @!attribute [rw] token
|
103
98
|
# The issued client token, encrypted.
|
104
99
|
# @return [String]
|
@@ -109,16 +104,25 @@ module Aws::Ivschat
|
|
109
104
|
# returned as a string*.
|
110
105
|
# @return [Time]
|
111
106
|
#
|
107
|
+
# @!attribute [rw] session_expiration_time
|
108
|
+
# Time after which an end user's session is no longer valid. This is
|
109
|
+
# an ISO 8601 timestamp; *note that this is returned as a string*.
|
110
|
+
# @return [Time]
|
111
|
+
#
|
112
112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateChatTokenResponse AWS API Documentation
|
113
113
|
#
|
114
114
|
class CreateChatTokenResponse < Struct.new(
|
115
|
-
:session_expiration_time,
|
116
115
|
:token,
|
117
|
-
:token_expiration_time
|
116
|
+
:token_expiration_time,
|
117
|
+
:session_expiration_time)
|
118
118
|
SENSITIVE = [:token]
|
119
119
|
include Aws::Structure
|
120
120
|
end
|
121
121
|
|
122
|
+
# @!attribute [rw] name
|
123
|
+
# Logging-configuration name. The value does not need to be unique.
|
124
|
+
# @return [String]
|
125
|
+
#
|
122
126
|
# @!attribute [rw] destination_configuration
|
123
127
|
# A complex type that contains a destination configuration for where
|
124
128
|
# chat content will be logged. There can be only one type of
|
@@ -126,10 +130,6 @@ module Aws::Ivschat
|
|
126
130
|
# `destinationConfiguration`.
|
127
131
|
# @return [Types::DestinationConfiguration]
|
128
132
|
#
|
129
|
-
# @!attribute [rw] name
|
130
|
-
# Logging-configuration name. The value does not need to be unique.
|
131
|
-
# @return [String]
|
132
|
-
#
|
133
133
|
# @!attribute [rw] tags
|
134
134
|
# Tags to attach to the resource. Array of maps, each of the form
|
135
135
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -145,8 +145,8 @@ module Aws::Ivschat
|
|
145
145
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationRequest AWS API Documentation
|
146
146
|
#
|
147
147
|
class CreateLoggingConfigurationRequest < Struct.new(
|
148
|
-
:destination_configuration,
|
149
148
|
:name,
|
149
|
+
:destination_configuration,
|
150
150
|
:tags)
|
151
151
|
SENSITIVE = []
|
152
152
|
include Aws::Structure
|
@@ -156,11 +156,26 @@ module Aws::Ivschat
|
|
156
156
|
# Logging-configuration ARN, assigned by the system.
|
157
157
|
# @return [String]
|
158
158
|
#
|
159
|
+
# @!attribute [rw] id
|
160
|
+
# Logging-configuration ID, generated by the system. This is a
|
161
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
162
|
+
# the logging configuration.
|
163
|
+
# @return [String]
|
164
|
+
#
|
159
165
|
# @!attribute [rw] create_time
|
160
166
|
# Time when the logging configuration was created. This is an ISO 8601
|
161
167
|
# timestamp; *note that this is returned as a string*.
|
162
168
|
# @return [Time]
|
163
169
|
#
|
170
|
+
# @!attribute [rw] update_time
|
171
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
172
|
+
# timestamp; *note that this is returned as a string*.
|
173
|
+
# @return [Time]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] name
|
176
|
+
# Logging-configuration name, from the request (if specified).
|
177
|
+
# @return [String]
|
178
|
+
#
|
164
179
|
# @!attribute [rw] destination_configuration
|
165
180
|
# A complex type that contains a destination configuration for where
|
166
181
|
# chat content will be logged, from the request. There is only one
|
@@ -168,16 +183,6 @@ module Aws::Ivschat
|
|
168
183
|
# `destinationConfiguration`.
|
169
184
|
# @return [Types::DestinationConfiguration]
|
170
185
|
#
|
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
186
|
# @!attribute [rw] state
|
182
187
|
# The state of the logging configuration. When the state is `ACTIVE`,
|
183
188
|
# the configuration is ready to log chat content.
|
@@ -188,29 +193,29 @@ module Aws::Ivschat
|
|
188
193
|
# Array of maps, each of the form `string:string (key:value)`.
|
189
194
|
# @return [Hash<String,String>]
|
190
195
|
#
|
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
196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateLoggingConfigurationResponse AWS API Documentation
|
197
197
|
#
|
198
198
|
class CreateLoggingConfigurationResponse < Struct.new(
|
199
199
|
:arn,
|
200
|
-
:create_time,
|
201
|
-
:destination_configuration,
|
202
200
|
:id,
|
201
|
+
:create_time,
|
202
|
+
:update_time,
|
203
203
|
:name,
|
204
|
+
:destination_configuration,
|
204
205
|
:state,
|
205
|
-
:tags
|
206
|
-
:update_time)
|
206
|
+
:tags)
|
207
207
|
SENSITIVE = []
|
208
208
|
include Aws::Structure
|
209
209
|
end
|
210
210
|
|
211
|
-
# @!attribute [rw]
|
212
|
-
#
|
213
|
-
# @return [
|
211
|
+
# @!attribute [rw] name
|
212
|
+
# Room name. The value does not need to be unique.
|
213
|
+
# @return [String]
|
214
|
+
#
|
215
|
+
# @!attribute [rw] maximum_message_rate_per_second
|
216
|
+
# Maximum number of messages per second that can be sent to the room
|
217
|
+
# (by all clients). Default: 10.
|
218
|
+
# @return [Integer]
|
214
219
|
#
|
215
220
|
# @!attribute [rw] maximum_message_length
|
216
221
|
# Maximum number of characters in a single message. Messages are
|
@@ -218,19 +223,10 @@ module Aws::Ivschat
|
|
218
223
|
# rune/code-point count, not number of bytes. Default: 500.
|
219
224
|
# @return [Integer]
|
220
225
|
#
|
221
|
-
# @!attribute [rw] maximum_message_rate_per_second
|
222
|
-
# Maximum number of messages per second that can be sent to the room
|
223
|
-
# (by all clients). Default: 10.
|
224
|
-
# @return [Integer]
|
225
|
-
#
|
226
226
|
# @!attribute [rw] message_review_handler
|
227
227
|
# Configuration information for optional review of messages.
|
228
228
|
# @return [Types::MessageReviewHandler]
|
229
229
|
#
|
230
|
-
# @!attribute [rw] name
|
231
|
-
# Room name. The value does not need to be unique.
|
232
|
-
# @return [String]
|
233
|
-
#
|
234
230
|
# @!attribute [rw] tags
|
235
231
|
# Tags to attach to the resource. Array of maps, each of the form
|
236
232
|
# `string:string (key:value)`. See [Tagging AWS Resources][1] for
|
@@ -243,15 +239,19 @@ module Aws::Ivschat
|
|
243
239
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
244
240
|
# @return [Hash<String,String>]
|
245
241
|
#
|
242
|
+
# @!attribute [rw] logging_configuration_identifiers
|
243
|
+
# Array of logging-configuration identifiers attached to the room.
|
244
|
+
# @return [Array<String>]
|
245
|
+
#
|
246
246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomRequest AWS API Documentation
|
247
247
|
#
|
248
248
|
class CreateRoomRequest < Struct.new(
|
249
|
-
:
|
250
|
-
:maximum_message_length,
|
249
|
+
:name,
|
251
250
|
:maximum_message_rate_per_second,
|
251
|
+
:maximum_message_length,
|
252
252
|
:message_review_handler,
|
253
|
-
:
|
254
|
-
:
|
253
|
+
:tags,
|
254
|
+
:logging_configuration_identifiers)
|
255
255
|
SENSITIVE = []
|
256
256
|
include Aws::Structure
|
257
257
|
end
|
@@ -260,61 +260,61 @@ module Aws::Ivschat
|
|
260
260
|
# Room ARN, assigned by the system.
|
261
261
|
# @return [String]
|
262
262
|
#
|
263
|
-
# @!attribute [rw] create_time
|
264
|
-
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
265
|
-
# that this is returned as a string*.
|
266
|
-
# @return [Time]
|
267
|
-
#
|
268
263
|
# @!attribute [rw] id
|
269
264
|
# Room ID, generated by the system. This is a relative identifier, the
|
270
265
|
# part of the ARN that uniquely identifies the room.
|
271
266
|
# @return [String]
|
272
267
|
#
|
273
|
-
# @!attribute [rw]
|
274
|
-
#
|
275
|
-
#
|
276
|
-
# @return [Array<String>]
|
268
|
+
# @!attribute [rw] name
|
269
|
+
# Room name, from the request (if specified).
|
270
|
+
# @return [String]
|
277
271
|
#
|
278
|
-
# @!attribute [rw]
|
279
|
-
#
|
280
|
-
#
|
281
|
-
# @return [
|
272
|
+
# @!attribute [rw] create_time
|
273
|
+
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
274
|
+
# that this is returned as a string*.
|
275
|
+
# @return [Time]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] update_time
|
278
|
+
# Time of the room’s last update. This is an ISO 8601 timestamp; *note
|
279
|
+
# that this is returned as a string*.
|
280
|
+
# @return [Time]
|
282
281
|
#
|
283
282
|
# @!attribute [rw] maximum_message_rate_per_second
|
284
283
|
# Maximum number of messages per second that can be sent to the room
|
285
284
|
# (by all clients), from the request (if specified).
|
286
285
|
# @return [Integer]
|
287
286
|
#
|
287
|
+
# @!attribute [rw] maximum_message_length
|
288
|
+
# Maximum number of characters in a single message, from the request
|
289
|
+
# (if specified).
|
290
|
+
# @return [Integer]
|
291
|
+
#
|
288
292
|
# @!attribute [rw] message_review_handler
|
289
293
|
# Configuration information for optional review of messages.
|
290
294
|
# @return [Types::MessageReviewHandler]
|
291
295
|
#
|
292
|
-
# @!attribute [rw] name
|
293
|
-
# Room name, from the request (if specified).
|
294
|
-
# @return [String]
|
295
|
-
#
|
296
296
|
# @!attribute [rw] tags
|
297
297
|
# Tags attached to the resource, from the request (if specified).
|
298
298
|
# @return [Hash<String,String>]
|
299
299
|
#
|
300
|
-
# @!attribute [rw]
|
301
|
-
#
|
302
|
-
#
|
303
|
-
# @return [
|
300
|
+
# @!attribute [rw] logging_configuration_identifiers
|
301
|
+
# Array of logging configurations attached to the room, from the
|
302
|
+
# request (if specified).
|
303
|
+
# @return [Array<String>]
|
304
304
|
#
|
305
305
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomResponse AWS API Documentation
|
306
306
|
#
|
307
307
|
class CreateRoomResponse < Struct.new(
|
308
308
|
:arn,
|
309
|
-
:create_time,
|
310
309
|
:id,
|
311
|
-
:
|
312
|
-
:
|
310
|
+
:name,
|
311
|
+
:create_time,
|
312
|
+
:update_time,
|
313
313
|
:maximum_message_rate_per_second,
|
314
|
+
:maximum_message_length,
|
314
315
|
:message_review_handler,
|
315
|
-
:name,
|
316
316
|
:tags,
|
317
|
-
:
|
317
|
+
:logging_configuration_identifiers)
|
318
318
|
SENSITIVE = []
|
319
319
|
include Aws::Structure
|
320
320
|
end
|
@@ -331,6 +331,11 @@ module Aws::Ivschat
|
|
331
331
|
include Aws::Structure
|
332
332
|
end
|
333
333
|
|
334
|
+
# @!attribute [rw] room_identifier
|
335
|
+
# Identifier of the room where the message should be deleted.
|
336
|
+
# Currently this must be an ARN.
|
337
|
+
# @return [String]
|
338
|
+
#
|
334
339
|
# @!attribute [rw] id
|
335
340
|
# ID of the message to be deleted. This is the `Id` field in the
|
336
341
|
# received message (see [ Message (Subscribe)][1] in the Chat
|
@@ -345,17 +350,12 @@ module Aws::Ivschat
|
|
345
350
|
# Reason for deleting the message.
|
346
351
|
# @return [String]
|
347
352
|
#
|
348
|
-
# @!attribute [rw] room_identifier
|
349
|
-
# Identifier of the room where the message should be deleted.
|
350
|
-
# Currently this must be an ARN.
|
351
|
-
# @return [String]
|
352
|
-
#
|
353
353
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteMessageRequest AWS API Documentation
|
354
354
|
#
|
355
355
|
class DeleteMessageRequest < Struct.new(
|
356
|
+
:room_identifier,
|
356
357
|
:id,
|
357
|
-
:reason
|
358
|
-
:room_identifier)
|
358
|
+
:reason)
|
359
359
|
SENSITIVE = []
|
360
360
|
include Aws::Structure
|
361
361
|
end
|
@@ -393,6 +393,11 @@ module Aws::Ivschat
|
|
393
393
|
#
|
394
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
395
|
#
|
396
|
+
# @!attribute [rw] s3
|
397
|
+
# An Amazon S3 destination configuration where chat activity will be
|
398
|
+
# logged.
|
399
|
+
# @return [Types::S3DestinationConfiguration]
|
400
|
+
#
|
396
401
|
# @!attribute [rw] cloud_watch_logs
|
397
402
|
# An Amazon CloudWatch Logs destination configuration where chat
|
398
403
|
# activity will be logged.
|
@@ -403,32 +408,23 @@ module Aws::Ivschat
|
|
403
408
|
# activity will be logged.
|
404
409
|
# @return [Types::FirehoseDestinationConfiguration]
|
405
410
|
#
|
406
|
-
# @!attribute [rw] s3
|
407
|
-
# An Amazon S3 destination configuration where chat activity will be
|
408
|
-
# logged.
|
409
|
-
# @return [Types::S3DestinationConfiguration]
|
410
|
-
#
|
411
411
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DestinationConfiguration AWS API Documentation
|
412
412
|
#
|
413
413
|
class DestinationConfiguration < Struct.new(
|
414
|
+
:s3,
|
414
415
|
:cloud_watch_logs,
|
415
416
|
:firehose,
|
416
|
-
:s3,
|
417
417
|
:unknown)
|
418
418
|
SENSITIVE = []
|
419
419
|
include Aws::Structure
|
420
420
|
include Aws::Structure::Union
|
421
421
|
|
422
|
+
class S3 < DestinationConfiguration; end
|
422
423
|
class CloudWatchLogs < DestinationConfiguration; end
|
423
424
|
class Firehose < DestinationConfiguration; end
|
424
|
-
class S3 < DestinationConfiguration; end
|
425
425
|
class Unknown < DestinationConfiguration; end
|
426
426
|
end
|
427
427
|
|
428
|
-
# @!attribute [rw] reason
|
429
|
-
# Reason for disconnecting the user.
|
430
|
-
# @return [String]
|
431
|
-
#
|
432
428
|
# @!attribute [rw] room_identifier
|
433
429
|
# Identifier of the room from which the user's clients should be
|
434
430
|
# disconnected. Currently this must be an ARN.
|
@@ -438,12 +434,16 @@ module Aws::Ivschat
|
|
438
434
|
# ID of the user (connection) to disconnect from the room.
|
439
435
|
# @return [String]
|
440
436
|
#
|
437
|
+
# @!attribute [rw] reason
|
438
|
+
# Reason for disconnecting the user.
|
439
|
+
# @return [String]
|
440
|
+
#
|
441
441
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DisconnectUserRequest AWS API Documentation
|
442
442
|
#
|
443
443
|
class DisconnectUserRequest < Struct.new(
|
444
|
-
:reason,
|
445
444
|
:room_identifier,
|
446
|
-
:user_id
|
445
|
+
:user_id,
|
446
|
+
:reason)
|
447
447
|
SENSITIVE = [:user_id]
|
448
448
|
include Aws::Structure
|
449
449
|
end
|
@@ -484,11 +484,26 @@ module Aws::Ivschat
|
|
484
484
|
# ARN).
|
485
485
|
# @return [String]
|
486
486
|
#
|
487
|
+
# @!attribute [rw] id
|
488
|
+
# Logging-configuration ID, generated by the system. This is a
|
489
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
490
|
+
# the logging configuration.
|
491
|
+
# @return [String]
|
492
|
+
#
|
487
493
|
# @!attribute [rw] create_time
|
488
494
|
# Time when the logging configuration was created. This is an ISO 8601
|
489
495
|
# timestamp; *note that this is returned as a string*.
|
490
496
|
# @return [Time]
|
491
497
|
#
|
498
|
+
# @!attribute [rw] update_time
|
499
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
500
|
+
# timestamp; *note that this is returned as a string*.
|
501
|
+
# @return [Time]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] name
|
504
|
+
# Logging-configuration name. This value does not need to be unique.
|
505
|
+
# @return [String]
|
506
|
+
#
|
492
507
|
# @!attribute [rw] destination_configuration
|
493
508
|
# A complex type that contains a destination configuration for where
|
494
509
|
# chat content will be logged. There is only one type of destination
|
@@ -496,16 +511,6 @@ module Aws::Ivschat
|
|
496
511
|
# `destinationConfiguration`.
|
497
512
|
# @return [Types::DestinationConfiguration]
|
498
513
|
#
|
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
514
|
# @!attribute [rw] state
|
510
515
|
# The state of the logging configuration. When the state is `ACTIVE`,
|
511
516
|
# the configuration is ready to log chat content.
|
@@ -516,22 +521,17 @@ module Aws::Ivschat
|
|
516
521
|
# `string:string (key:value)`.
|
517
522
|
# @return [Hash<String,String>]
|
518
523
|
#
|
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
524
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetLoggingConfigurationResponse AWS API Documentation
|
525
525
|
#
|
526
526
|
class GetLoggingConfigurationResponse < Struct.new(
|
527
527
|
:arn,
|
528
|
-
:create_time,
|
529
|
-
:destination_configuration,
|
530
528
|
:id,
|
529
|
+
:create_time,
|
530
|
+
:update_time,
|
531
531
|
:name,
|
532
|
+
:destination_configuration,
|
532
533
|
:state,
|
533
|
-
:tags
|
534
|
-
:update_time)
|
534
|
+
:tags)
|
535
535
|
SENSITIVE = []
|
536
536
|
include Aws::Structure
|
537
537
|
end
|
@@ -553,19 +553,29 @@ module Aws::Ivschat
|
|
553
553
|
# Room ARN, from the request (if `identifier` was an ARN).
|
554
554
|
# @return [String]
|
555
555
|
#
|
556
|
+
# @!attribute [rw] id
|
557
|
+
# Room ID, generated by the system. This is a relative identifier, the
|
558
|
+
# part of the ARN that uniquely identifies the room.
|
559
|
+
# @return [String]
|
560
|
+
#
|
561
|
+
# @!attribute [rw] name
|
562
|
+
# Room name. The value does not need to be unique.
|
563
|
+
# @return [String]
|
564
|
+
#
|
556
565
|
# @!attribute [rw] create_time
|
557
566
|
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
558
567
|
# that this is returned as a string*.
|
559
568
|
# @return [Time]
|
560
569
|
#
|
561
|
-
# @!attribute [rw]
|
562
|
-
#
|
563
|
-
#
|
564
|
-
# @return [
|
570
|
+
# @!attribute [rw] update_time
|
571
|
+
# Time of the room’s last update. This is an ISO 8601 timestamp; *note
|
572
|
+
# that this is returned as a string*.
|
573
|
+
# @return [Time]
|
565
574
|
#
|
566
|
-
# @!attribute [rw]
|
567
|
-
#
|
568
|
-
#
|
575
|
+
# @!attribute [rw] maximum_message_rate_per_second
|
576
|
+
# Maximum number of messages per second that can be sent to the room
|
577
|
+
# (by all clients). Default: 10.
|
578
|
+
# @return [Integer]
|
569
579
|
#
|
570
580
|
# @!attribute [rw] maximum_message_length
|
571
581
|
# Maximum number of characters in a single message. Messages are
|
@@ -573,42 +583,32 @@ module Aws::Ivschat
|
|
573
583
|
# rune/code-point count, not number of bytes. Default: 500.
|
574
584
|
# @return [Integer]
|
575
585
|
#
|
576
|
-
# @!attribute [rw] maximum_message_rate_per_second
|
577
|
-
# Maximum number of messages per second that can be sent to the room
|
578
|
-
# (by all clients). Default: 10.
|
579
|
-
# @return [Integer]
|
580
|
-
#
|
581
586
|
# @!attribute [rw] message_review_handler
|
582
587
|
# Configuration information for optional review of messages.
|
583
588
|
# @return [Types::MessageReviewHandler]
|
584
589
|
#
|
585
|
-
# @!attribute [rw] name
|
586
|
-
# Room name. The value does not need to be unique.
|
587
|
-
# @return [String]
|
588
|
-
#
|
589
590
|
# @!attribute [rw] tags
|
590
591
|
# Tags attached to the resource. Array of maps, each of the form
|
591
592
|
# `string:string (key:value)`.
|
592
593
|
# @return [Hash<String,String>]
|
593
594
|
#
|
594
|
-
# @!attribute [rw]
|
595
|
-
#
|
596
|
-
#
|
597
|
-
# @return [Time]
|
595
|
+
# @!attribute [rw] logging_configuration_identifiers
|
596
|
+
# Array of logging configurations attached to the room.
|
597
|
+
# @return [Array<String>]
|
598
598
|
#
|
599
599
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetRoomResponse AWS API Documentation
|
600
600
|
#
|
601
601
|
class GetRoomResponse < Struct.new(
|
602
602
|
:arn,
|
603
|
-
:create_time,
|
604
603
|
:id,
|
605
|
-
:
|
606
|
-
:
|
604
|
+
:name,
|
605
|
+
:create_time,
|
606
|
+
:update_time,
|
607
607
|
:maximum_message_rate_per_second,
|
608
|
+
:maximum_message_length,
|
608
609
|
:message_review_handler,
|
609
|
-
:name,
|
610
610
|
:tags,
|
611
|
-
:
|
611
|
+
:logging_configuration_identifiers)
|
612
612
|
SENSITIVE = []
|
613
613
|
include Aws::Structure
|
614
614
|
end
|
@@ -624,20 +624,20 @@ module Aws::Ivschat
|
|
624
624
|
include Aws::Structure
|
625
625
|
end
|
626
626
|
|
627
|
-
# @!attribute [rw] max_results
|
628
|
-
# Maximum number of logging configurations to return. Default: 50.
|
629
|
-
# @return [Integer]
|
630
|
-
#
|
631
627
|
# @!attribute [rw] next_token
|
632
628
|
# The first logging configurations to retrieve. This is used for
|
633
629
|
# pagination; see the `nextToken` response field.
|
634
630
|
# @return [String]
|
635
631
|
#
|
632
|
+
# @!attribute [rw] max_results
|
633
|
+
# Maximum number of logging configurations to return. Default: 50.
|
634
|
+
# @return [Integer]
|
635
|
+
#
|
636
636
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListLoggingConfigurationsRequest AWS API Documentation
|
637
637
|
#
|
638
638
|
class ListLoggingConfigurationsRequest < Struct.new(
|
639
|
-
:
|
640
|
-
:
|
639
|
+
:next_token,
|
640
|
+
:max_results)
|
641
641
|
SENSITIVE = []
|
642
642
|
include Aws::Structure
|
643
643
|
end
|
@@ -662,8 +662,13 @@ module Aws::Ivschat
|
|
662
662
|
include Aws::Structure
|
663
663
|
end
|
664
664
|
|
665
|
-
# @!attribute [rw]
|
666
|
-
#
|
665
|
+
# @!attribute [rw] name
|
666
|
+
# Filters the list to match the specified room name.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @!attribute [rw] next_token
|
670
|
+
# The first room to retrieve. This is used for pagination; see the
|
671
|
+
# `nextToken` response field.
|
667
672
|
# @return [String]
|
668
673
|
#
|
669
674
|
# @!attribute [rw] max_results
|
@@ -674,41 +679,36 @@ module Aws::Ivschat
|
|
674
679
|
# Filters the list to match the specified message review handler URI.
|
675
680
|
# @return [String]
|
676
681
|
#
|
677
|
-
# @!attribute [rw]
|
678
|
-
#
|
679
|
-
# @return [String]
|
680
|
-
#
|
681
|
-
# @!attribute [rw] next_token
|
682
|
-
# The first room to retrieve. This is used for pagination; see the
|
683
|
-
# `nextToken` response field.
|
682
|
+
# @!attribute [rw] logging_configuration_identifier
|
683
|
+
# Logging-configuration identifier.
|
684
684
|
# @return [String]
|
685
685
|
#
|
686
686
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsRequest AWS API Documentation
|
687
687
|
#
|
688
688
|
class ListRoomsRequest < Struct.new(
|
689
|
-
:
|
689
|
+
:name,
|
690
|
+
:next_token,
|
690
691
|
:max_results,
|
691
692
|
:message_review_handler_uri,
|
692
|
-
:
|
693
|
-
:next_token)
|
693
|
+
:logging_configuration_identifier)
|
694
694
|
SENSITIVE = []
|
695
695
|
include Aws::Structure
|
696
696
|
end
|
697
697
|
|
698
|
+
# @!attribute [rw] rooms
|
699
|
+
# List of the matching rooms (summary information only).
|
700
|
+
# @return [Array<Types::RoomSummary>]
|
701
|
+
#
|
698
702
|
# @!attribute [rw] next_token
|
699
703
|
# If there are more rooms than `maxResults`, use `nextToken` in the
|
700
704
|
# request to get the next set.
|
701
705
|
# @return [String]
|
702
706
|
#
|
703
|
-
# @!attribute [rw] rooms
|
704
|
-
# List of the matching rooms (summary information only).
|
705
|
-
# @return [Array<Types::RoomSummary>]
|
706
|
-
#
|
707
707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsResponse AWS API Documentation
|
708
708
|
#
|
709
709
|
class ListRoomsResponse < Struct.new(
|
710
|
-
:
|
711
|
-
:
|
710
|
+
:rooms,
|
711
|
+
:next_token)
|
712
712
|
SENSITIVE = []
|
713
713
|
include Aws::Structure
|
714
714
|
end
|
@@ -745,26 +745,31 @@ module Aws::Ivschat
|
|
745
745
|
# Logging-configuration ARN.
|
746
746
|
# @return [String]
|
747
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
748
|
# @!attribute [rw] id
|
759
749
|
# Logging-configuration ID, generated by the system. This is a
|
760
750
|
# relative identifier, the part of the ARN that uniquely identifies
|
761
751
|
# the room.
|
762
752
|
# @return [String]
|
763
753
|
#
|
754
|
+
# @!attribute [rw] create_time
|
755
|
+
# Time when the logging configuration was created. This is an ISO 8601
|
756
|
+
# timestamp; *note that this is returned as a string*.
|
757
|
+
# @return [Time]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] update_time
|
760
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
761
|
+
# timestamp; *note that this is returned as a string*.
|
762
|
+
# @return [Time]
|
763
|
+
#
|
764
764
|
# @!attribute [rw] name
|
765
765
|
# Logging-configuration name. The value does not need to be unique.
|
766
766
|
# @return [String]
|
767
767
|
#
|
768
|
+
# @!attribute [rw] destination_configuration
|
769
|
+
# A complex type that contains a destination configuration for where
|
770
|
+
# chat content will be logged.
|
771
|
+
# @return [Types::DestinationConfiguration]
|
772
|
+
#
|
768
773
|
# @!attribute [rw] state
|
769
774
|
# The state of the logging configuration. When this is `ACTIVE`, the
|
770
775
|
# configuration is ready for logging chat content.
|
@@ -782,28 +787,28 @@ module Aws::Ivschat
|
|
782
787
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
783
788
|
# @return [Hash<String,String>]
|
784
789
|
#
|
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]
|
789
|
-
#
|
790
790
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/LoggingConfigurationSummary AWS API Documentation
|
791
791
|
#
|
792
792
|
class LoggingConfigurationSummary < Struct.new(
|
793
793
|
:arn,
|
794
|
-
:create_time,
|
795
|
-
:destination_configuration,
|
796
794
|
:id,
|
795
|
+
:create_time,
|
796
|
+
:update_time,
|
797
797
|
:name,
|
798
|
+
:destination_configuration,
|
798
799
|
:state,
|
799
|
-
:tags
|
800
|
-
:update_time)
|
800
|
+
:tags)
|
801
801
|
SENSITIVE = []
|
802
802
|
include Aws::Structure
|
803
803
|
end
|
804
804
|
|
805
805
|
# Configuration information for optional message review.
|
806
806
|
#
|
807
|
+
# @!attribute [rw] uri
|
808
|
+
# Identifier of the message review handler. Currently this must be an
|
809
|
+
# ARN of a lambda function.
|
810
|
+
# @return [String]
|
811
|
+
#
|
807
812
|
# @!attribute [rw] fallback_result
|
808
813
|
# Specifies the fallback behavior (whether the message is allowed or
|
809
814
|
# denied) if the handler does not return a valid response, encounters
|
@@ -817,16 +822,11 @@ module Aws::Ivschat
|
|
817
822
|
# [1]: https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html
|
818
823
|
# @return [String]
|
819
824
|
#
|
820
|
-
# @!attribute [rw] uri
|
821
|
-
# Identifier of the message review handler. Currently this must be an
|
822
|
-
# ARN of a lambda function.
|
823
|
-
# @return [String]
|
824
|
-
#
|
825
825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/MessageReviewHandler AWS API Documentation
|
826
826
|
#
|
827
827
|
class MessageReviewHandler < Struct.new(
|
828
|
-
:
|
829
|
-
:
|
828
|
+
:uri,
|
829
|
+
:fallback_result)
|
830
830
|
SENSITIVE = []
|
831
831
|
include Aws::Structure
|
832
832
|
end
|
@@ -867,27 +867,28 @@ module Aws::Ivschat
|
|
867
867
|
# Room ARN.
|
868
868
|
# @return [String]
|
869
869
|
#
|
870
|
-
# @!attribute [rw] create_time
|
871
|
-
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
872
|
-
# that this is returned as a string*.
|
873
|
-
# @return [Time]
|
874
|
-
#
|
875
870
|
# @!attribute [rw] id
|
876
871
|
# Room ID, generated by the system. This is a relative identifier, the
|
877
872
|
# part of the ARN that uniquely identifies the room.
|
878
873
|
# @return [String]
|
879
874
|
#
|
880
|
-
# @!attribute [rw]
|
881
|
-
#
|
882
|
-
# @return [
|
875
|
+
# @!attribute [rw] name
|
876
|
+
# Room name. The value does not need to be unique.
|
877
|
+
# @return [String]
|
883
878
|
#
|
884
879
|
# @!attribute [rw] message_review_handler
|
885
880
|
# Configuration information for optional review of messages.
|
886
881
|
# @return [Types::MessageReviewHandler]
|
887
882
|
#
|
888
|
-
# @!attribute [rw]
|
889
|
-
#
|
890
|
-
#
|
883
|
+
# @!attribute [rw] create_time
|
884
|
+
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
885
|
+
# that this is returned as a string*.
|
886
|
+
# @return [Time]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] update_time
|
889
|
+
# Time of the room’s last update. This is an ISO 8601 timestamp; *note
|
890
|
+
# that this is returned as a string*.
|
891
|
+
# @return [Time]
|
891
892
|
#
|
892
893
|
# @!attribute [rw] tags
|
893
894
|
# Tags attached to the resource. Array of maps, each of the form
|
@@ -901,22 +902,21 @@ module Aws::Ivschat
|
|
901
902
|
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
902
903
|
# @return [Hash<String,String>]
|
903
904
|
#
|
904
|
-
# @!attribute [rw]
|
905
|
-
#
|
906
|
-
#
|
907
|
-
# @return [Time]
|
905
|
+
# @!attribute [rw] logging_configuration_identifiers
|
906
|
+
# List of logging-configuration identifiers attached to the room.
|
907
|
+
# @return [Array<String>]
|
908
908
|
#
|
909
909
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/RoomSummary AWS API Documentation
|
910
910
|
#
|
911
911
|
class RoomSummary < Struct.new(
|
912
912
|
:arn,
|
913
|
-
:create_time,
|
914
913
|
:id,
|
915
|
-
:logging_configuration_identifiers,
|
916
|
-
:message_review_handler,
|
917
914
|
:name,
|
915
|
+
:message_review_handler,
|
916
|
+
:create_time,
|
917
|
+
:update_time,
|
918
918
|
:tags,
|
919
|
-
:
|
919
|
+
:logging_configuration_identifiers)
|
920
920
|
SENSITIVE = []
|
921
921
|
include Aws::Structure
|
922
922
|
end
|
@@ -935,26 +935,26 @@ module Aws::Ivschat
|
|
935
935
|
include Aws::Structure
|
936
936
|
end
|
937
937
|
|
938
|
-
# @!attribute [rw]
|
939
|
-
#
|
940
|
-
#
|
941
|
-
# @return [
|
938
|
+
# @!attribute [rw] room_identifier
|
939
|
+
# Identifier of the room to which the event will be sent. Currently
|
940
|
+
# this must be an ARN.
|
941
|
+
# @return [String]
|
942
942
|
#
|
943
943
|
# @!attribute [rw] event_name
|
944
944
|
# Application-defined name of the event to send to clients.
|
945
945
|
# @return [String]
|
946
946
|
#
|
947
|
-
# @!attribute [rw]
|
948
|
-
#
|
949
|
-
#
|
950
|
-
# @return [String]
|
947
|
+
# @!attribute [rw] attributes
|
948
|
+
# Application-defined metadata to attach to the event sent to clients.
|
949
|
+
# The maximum length of the metadata is 1 KB total.
|
950
|
+
# @return [Hash<String,String>]
|
951
951
|
#
|
952
952
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/SendEventRequest AWS API Documentation
|
953
953
|
#
|
954
954
|
class SendEventRequest < Struct.new(
|
955
|
-
:
|
955
|
+
:room_identifier,
|
956
956
|
:event_name,
|
957
|
-
:
|
957
|
+
:attributes)
|
958
958
|
SENSITIVE = []
|
959
959
|
include Aws::Structure
|
960
960
|
end
|
@@ -973,9 +973,6 @@ module Aws::Ivschat
|
|
973
973
|
include Aws::Structure
|
974
974
|
end
|
975
975
|
|
976
|
-
# @!attribute [rw] limit
|
977
|
-
# @return [Integer]
|
978
|
-
#
|
979
976
|
# @!attribute [rw] message
|
980
977
|
# @return [String]
|
981
978
|
#
|
@@ -985,13 +982,16 @@ module Aws::Ivschat
|
|
985
982
|
# @!attribute [rw] resource_type
|
986
983
|
# @return [String]
|
987
984
|
#
|
985
|
+
# @!attribute [rw] limit
|
986
|
+
# @return [Integer]
|
987
|
+
#
|
988
988
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ServiceQuotaExceededException AWS API Documentation
|
989
989
|
#
|
990
990
|
class ServiceQuotaExceededException < Struct.new(
|
991
|
-
:limit,
|
992
991
|
:message,
|
993
992
|
:resource_id,
|
994
|
-
:resource_type
|
993
|
+
:resource_type,
|
994
|
+
:limit)
|
995
995
|
SENSITIVE = []
|
996
996
|
include Aws::Structure
|
997
997
|
end
|
@@ -1025,9 +1025,6 @@ module Aws::Ivschat
|
|
1025
1025
|
#
|
1026
1026
|
class TagResourceResponse < Aws::EmptyStructure; end
|
1027
1027
|
|
1028
|
-
# @!attribute [rw] limit
|
1029
|
-
# @return [Integer]
|
1030
|
-
#
|
1031
1028
|
# @!attribute [rw] message
|
1032
1029
|
# @return [String]
|
1033
1030
|
#
|
@@ -1037,13 +1034,16 @@ module Aws::Ivschat
|
|
1037
1034
|
# @!attribute [rw] resource_type
|
1038
1035
|
# @return [String]
|
1039
1036
|
#
|
1037
|
+
# @!attribute [rw] limit
|
1038
|
+
# @return [Integer]
|
1039
|
+
#
|
1040
1040
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ThrottlingException AWS API Documentation
|
1041
1041
|
#
|
1042
1042
|
class ThrottlingException < Struct.new(
|
1043
|
-
:limit,
|
1044
1043
|
:message,
|
1045
1044
|
:resource_id,
|
1046
|
-
:resource_type
|
1045
|
+
:resource_type,
|
1046
|
+
:limit)
|
1047
1047
|
SENSITIVE = []
|
1048
1048
|
include Aws::Structure
|
1049
1049
|
end
|
@@ -1077,13 +1077,6 @@ module Aws::Ivschat
|
|
1077
1077
|
#
|
1078
1078
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
1079
1079
|
|
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
1080
|
# @!attribute [rw] identifier
|
1088
1081
|
# Identifier of the logging configuration to be updated.
|
1089
1082
|
# @return [String]
|
@@ -1092,12 +1085,19 @@ module Aws::Ivschat
|
|
1092
1085
|
# Logging-configuration name. The value does not need to be unique.
|
1093
1086
|
# @return [String]
|
1094
1087
|
#
|
1088
|
+
# @!attribute [rw] destination_configuration
|
1089
|
+
# A complex type that contains a destination configuration for where
|
1090
|
+
# chat content will be logged. There can be only one type of
|
1091
|
+
# destination (`cloudWatchLogs`, `firehose`, or `s3`) in a
|
1092
|
+
# `destinationConfiguration`.
|
1093
|
+
# @return [Types::DestinationConfiguration]
|
1094
|
+
#
|
1095
1095
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationRequest AWS API Documentation
|
1096
1096
|
#
|
1097
1097
|
class UpdateLoggingConfigurationRequest < Struct.new(
|
1098
|
-
:destination_configuration,
|
1099
1098
|
:identifier,
|
1100
|
-
:name
|
1099
|
+
:name,
|
1100
|
+
:destination_configuration)
|
1101
1101
|
SENSITIVE = []
|
1102
1102
|
include Aws::Structure
|
1103
1103
|
end
|
@@ -1107,11 +1107,26 @@ module Aws::Ivschat
|
|
1107
1107
|
# ARN).
|
1108
1108
|
# @return [String]
|
1109
1109
|
#
|
1110
|
+
# @!attribute [rw] id
|
1111
|
+
# Logging-configuration ID, generated by the system. This is a
|
1112
|
+
# relative identifier, the part of the ARN that uniquely identifies
|
1113
|
+
# the room.
|
1114
|
+
# @return [String]
|
1115
|
+
#
|
1110
1116
|
# @!attribute [rw] create_time
|
1111
1117
|
# Time when the logging configuration was created. This is an ISO 8601
|
1112
1118
|
# timestamp; *note that this is returned as a string*.
|
1113
1119
|
# @return [Time]
|
1114
1120
|
#
|
1121
|
+
# @!attribute [rw] update_time
|
1122
|
+
# Time of the logging configuration’s last update. This is an ISO 8601
|
1123
|
+
# timestamp; *note that this is returned as a string*.
|
1124
|
+
# @return [Time]
|
1125
|
+
#
|
1126
|
+
# @!attribute [rw] name
|
1127
|
+
# Logging-configuration name, from the request (if specified).
|
1128
|
+
# @return [String]
|
1129
|
+
#
|
1115
1130
|
# @!attribute [rw] destination_configuration
|
1116
1131
|
# A complex type that contains a destination configuration for where
|
1117
1132
|
# chat content will be logged, from the request. There is only one
|
@@ -1119,16 +1134,6 @@ module Aws::Ivschat
|
|
1119
1134
|
# `destinationConfiguration`.
|
1120
1135
|
# @return [Types::DestinationConfiguration]
|
1121
1136
|
#
|
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
1137
|
# @!attribute [rw] state
|
1133
1138
|
# The state of the logging configuration. When the state is `ACTIVE`,
|
1134
1139
|
# the configuration is ready to log chat content.
|
@@ -1139,22 +1144,17 @@ module Aws::Ivschat
|
|
1139
1144
|
# `string:string (key:value)`.
|
1140
1145
|
# @return [Hash<String,String>]
|
1141
1146
|
#
|
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
1147
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateLoggingConfigurationResponse AWS API Documentation
|
1148
1148
|
#
|
1149
1149
|
class UpdateLoggingConfigurationResponse < Struct.new(
|
1150
1150
|
:arn,
|
1151
|
-
:create_time,
|
1152
|
-
:destination_configuration,
|
1153
1151
|
:id,
|
1152
|
+
:create_time,
|
1153
|
+
:update_time,
|
1154
1154
|
:name,
|
1155
|
+
:destination_configuration,
|
1155
1156
|
:state,
|
1156
|
-
:tags
|
1157
|
-
:update_time)
|
1157
|
+
:tags)
|
1158
1158
|
SENSITIVE = []
|
1159
1159
|
include Aws::Structure
|
1160
1160
|
end
|
@@ -1163,9 +1163,14 @@ module Aws::Ivschat
|
|
1163
1163
|
# Identifier of the room to be updated. Currently this must be an ARN.
|
1164
1164
|
# @return [String]
|
1165
1165
|
#
|
1166
|
-
# @!attribute [rw]
|
1167
|
-
#
|
1168
|
-
# @return [
|
1166
|
+
# @!attribute [rw] name
|
1167
|
+
# Room name. The value does not need to be unique.
|
1168
|
+
# @return [String]
|
1169
|
+
#
|
1170
|
+
# @!attribute [rw] maximum_message_rate_per_second
|
1171
|
+
# Maximum number of messages per second that can be sent to the room
|
1172
|
+
# (by all clients). Default: 10.
|
1173
|
+
# @return [Integer]
|
1169
1174
|
#
|
1170
1175
|
# @!attribute [rw] maximum_message_length
|
1171
1176
|
# The maximum number of characters in a single message. Messages are
|
@@ -1173,30 +1178,25 @@ module Aws::Ivschat
|
|
1173
1178
|
# rune/code-point count, not number of bytes. Default: 500.
|
1174
1179
|
# @return [Integer]
|
1175
1180
|
#
|
1176
|
-
# @!attribute [rw] maximum_message_rate_per_second
|
1177
|
-
# Maximum number of messages per second that can be sent to the room
|
1178
|
-
# (by all clients). Default: 10.
|
1179
|
-
# @return [Integer]
|
1180
|
-
#
|
1181
1181
|
# @!attribute [rw] message_review_handler
|
1182
1182
|
# Configuration information for optional review of messages. Specify
|
1183
1183
|
# an empty `uri` string to disassociate a message review handler from
|
1184
1184
|
# the specified room.
|
1185
1185
|
# @return [Types::MessageReviewHandler]
|
1186
1186
|
#
|
1187
|
-
# @!attribute [rw]
|
1188
|
-
#
|
1189
|
-
# @return [String]
|
1187
|
+
# @!attribute [rw] logging_configuration_identifiers
|
1188
|
+
# Array of logging-configuration identifiers attached to the room.
|
1189
|
+
# @return [Array<String>]
|
1190
1190
|
#
|
1191
1191
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateRoomRequest AWS API Documentation
|
1192
1192
|
#
|
1193
1193
|
class UpdateRoomRequest < Struct.new(
|
1194
1194
|
:identifier,
|
1195
|
-
:
|
1196
|
-
:maximum_message_length,
|
1195
|
+
:name,
|
1197
1196
|
:maximum_message_rate_per_second,
|
1197
|
+
:maximum_message_length,
|
1198
1198
|
:message_review_handler,
|
1199
|
-
:
|
1199
|
+
:logging_configuration_identifiers)
|
1200
1200
|
SENSITIVE = []
|
1201
1201
|
include Aws::Structure
|
1202
1202
|
end
|
@@ -1205,100 +1205,100 @@ module Aws::Ivschat
|
|
1205
1205
|
# Room ARN, from the request (if `identifier` was an ARN).
|
1206
1206
|
# @return [String]
|
1207
1207
|
#
|
1208
|
-
# @!attribute [rw] create_time
|
1209
|
-
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
1210
|
-
# that this is returned as a string*.
|
1211
|
-
# @return [Time]
|
1212
|
-
#
|
1213
1208
|
# @!attribute [rw] id
|
1214
1209
|
# Room ID, generated by the system. This is a relative identifier, the
|
1215
1210
|
# part of the ARN that uniquely identifies the room.
|
1216
1211
|
# @return [String]
|
1217
1212
|
#
|
1218
|
-
# @!attribute [rw]
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
# @return [Array<String>]
|
1213
|
+
# @!attribute [rw] name
|
1214
|
+
# Room name, from the request (if specified).
|
1215
|
+
# @return [String]
|
1222
1216
|
#
|
1223
|
-
# @!attribute [rw]
|
1224
|
-
#
|
1225
|
-
#
|
1226
|
-
# @return [
|
1217
|
+
# @!attribute [rw] create_time
|
1218
|
+
# Time when the room was created. This is an ISO 8601 timestamp; *note
|
1219
|
+
# that this is returned as a string*.
|
1220
|
+
# @return [Time]
|
1221
|
+
#
|
1222
|
+
# @!attribute [rw] update_time
|
1223
|
+
# Time of the room’s last update. This is an ISO 8601 timestamp; *note
|
1224
|
+
# that this is returned as a string*.
|
1225
|
+
# @return [Time]
|
1227
1226
|
#
|
1228
1227
|
# @!attribute [rw] maximum_message_rate_per_second
|
1229
1228
|
# Maximum number of messages per second that can be sent to the room
|
1230
1229
|
# (by all clients), from the request (if specified).
|
1231
1230
|
# @return [Integer]
|
1232
1231
|
#
|
1232
|
+
# @!attribute [rw] maximum_message_length
|
1233
|
+
# Maximum number of characters in a single message, from the request
|
1234
|
+
# (if specified).
|
1235
|
+
# @return [Integer]
|
1236
|
+
#
|
1233
1237
|
# @!attribute [rw] message_review_handler
|
1234
1238
|
# Configuration information for optional review of messages.
|
1235
1239
|
# @return [Types::MessageReviewHandler]
|
1236
1240
|
#
|
1237
|
-
# @!attribute [rw] name
|
1238
|
-
# Room name, from the request (if specified).
|
1239
|
-
# @return [String]
|
1240
|
-
#
|
1241
1241
|
# @!attribute [rw] tags
|
1242
1242
|
# Tags attached to the resource. Array of maps, each of the form
|
1243
1243
|
# `string:string (key:value)`.
|
1244
1244
|
# @return [Hash<String,String>]
|
1245
1245
|
#
|
1246
|
-
# @!attribute [rw]
|
1247
|
-
#
|
1248
|
-
#
|
1249
|
-
# @return [
|
1246
|
+
# @!attribute [rw] logging_configuration_identifiers
|
1247
|
+
# Array of logging configurations attached to the room, from the
|
1248
|
+
# request (if specified).
|
1249
|
+
# @return [Array<String>]
|
1250
1250
|
#
|
1251
1251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateRoomResponse AWS API Documentation
|
1252
1252
|
#
|
1253
1253
|
class UpdateRoomResponse < Struct.new(
|
1254
1254
|
:arn,
|
1255
|
-
:create_time,
|
1256
1255
|
:id,
|
1257
|
-
:
|
1258
|
-
:
|
1256
|
+
:name,
|
1257
|
+
:create_time,
|
1258
|
+
:update_time,
|
1259
1259
|
:maximum_message_rate_per_second,
|
1260
|
+
:maximum_message_length,
|
1260
1261
|
:message_review_handler,
|
1261
|
-
:name,
|
1262
1262
|
:tags,
|
1263
|
-
:
|
1263
|
+
:logging_configuration_identifiers)
|
1264
1264
|
SENSITIVE = []
|
1265
1265
|
include Aws::Structure
|
1266
1266
|
end
|
1267
1267
|
|
1268
|
-
# @!attribute [rw] field_list
|
1269
|
-
# @return [Array<Types::ValidationExceptionField>]
|
1270
|
-
#
|
1271
1268
|
# @!attribute [rw] message
|
1272
1269
|
# @return [String]
|
1273
1270
|
#
|
1274
1271
|
# @!attribute [rw] reason
|
1275
1272
|
# @return [String]
|
1276
1273
|
#
|
1274
|
+
# @!attribute [rw] field_list
|
1275
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1276
|
+
#
|
1277
1277
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ValidationException AWS API Documentation
|
1278
1278
|
#
|
1279
1279
|
class ValidationException < Struct.new(
|
1280
|
-
:field_list,
|
1281
1280
|
:message,
|
1282
|
-
:reason
|
1281
|
+
:reason,
|
1282
|
+
:field_list)
|
1283
1283
|
SENSITIVE = []
|
1284
1284
|
include Aws::Structure
|
1285
1285
|
end
|
1286
1286
|
|
1287
1287
|
# This object is used in the ValidationException error.
|
1288
1288
|
#
|
1289
|
-
# @!attribute [rw] message
|
1290
|
-
# Explanation of the reason for the validation error.
|
1291
|
-
# @return [String]
|
1292
|
-
#
|
1293
1289
|
# @!attribute [rw] name
|
1294
1290
|
# Name of the field which failed validation.
|
1295
1291
|
# @return [String]
|
1296
1292
|
#
|
1293
|
+
# @!attribute [rw] message
|
1294
|
+
# Explanation of the reason for the validation error.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
1297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ValidationExceptionField AWS API Documentation
|
1298
1298
|
#
|
1299
1299
|
class ValidationExceptionField < Struct.new(
|
1300
|
-
:
|
1301
|
-
:
|
1300
|
+
:name,
|
1301
|
+
:message)
|
1302
1302
|
SENSITIVE = []
|
1303
1303
|
include Aws::Structure
|
1304
1304
|
end
|