aws-sdk-ivschat 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,922 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Ivschat
11
+ module Types
12
+
13
+ # @!attribute [rw] message
14
+ # @return [String]
15
+ #
16
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/AccessDeniedException AWS API Documentation
17
+ #
18
+ class AccessDeniedException < Struct.new(
19
+ :message)
20
+ SENSITIVE = []
21
+ include Aws::Structure
22
+ end
23
+
24
+ # @!attribute [rw] message
25
+ # @return [String]
26
+ #
27
+ # @!attribute [rw] resource_id
28
+ # @return [String]
29
+ #
30
+ # @!attribute [rw] resource_type
31
+ # @return [String]
32
+ #
33
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ConflictException AWS API Documentation
34
+ #
35
+ class ConflictException < Struct.new(
36
+ :message,
37
+ :resource_id,
38
+ :resource_type)
39
+ SENSITIVE = []
40
+ include Aws::Structure
41
+ end
42
+
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
+ # @!attribute [rw] attributes
57
+ # Application-provided attributes to encode into the token and attach
58
+ # to a chat session. Map keys and values can contain UTF-8 encoded
59
+ # text. The maximum length of this field is 1 KB total.
60
+ # @return [Hash<String,String>]
61
+ #
62
+ # @!attribute [rw] capabilities
63
+ # Set of capabilities that the user is allowed to perform in the room.
64
+ # Default: None (the capability to view messages is implicitly
65
+ # included in all requests).
66
+ # @return [Array<String>]
67
+ #
68
+ # @!attribute [rw] room_identifier
69
+ # Identifier of the room that the client is trying to access.
70
+ # Currently this must be an ARN.
71
+ # @return [String]
72
+ #
73
+ # @!attribute [rw] session_duration_in_minutes
74
+ # Session duration (in minutes), after which the session expires.
75
+ # Default: 60 (1 hour).
76
+ # @return [Integer]
77
+ #
78
+ # @!attribute [rw] user_id
79
+ # Application-provided ID that uniquely identifies the user associated
80
+ # with this token. This can be any UTF-8 encoded text.
81
+ # @return [String]
82
+ #
83
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateChatTokenRequest AWS API Documentation
84
+ #
85
+ class CreateChatTokenRequest < Struct.new(
86
+ :attributes,
87
+ :capabilities,
88
+ :room_identifier,
89
+ :session_duration_in_minutes,
90
+ :user_id)
91
+ SENSITIVE = []
92
+ include Aws::Structure
93
+ end
94
+
95
+ # @!attribute [rw] session_expiration_time
96
+ # Time after which an end user's session is no longer valid. This is
97
+ # an ISO 8601 timestamp; *note that this is returned as a string*.
98
+ # @return [Time]
99
+ #
100
+ # @!attribute [rw] token
101
+ # The issued client token, encrypted.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] token_expiration_time
105
+ # Time after which the token is no longer valid and cannot be used to
106
+ # connect to a room. This is an ISO 8601 timestamp; *note that this is
107
+ # returned as a string*.
108
+ # @return [Time]
109
+ #
110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateChatTokenResponse AWS API Documentation
111
+ #
112
+ class CreateChatTokenResponse < Struct.new(
113
+ :session_expiration_time,
114
+ :token,
115
+ :token_expiration_time)
116
+ SENSITIVE = []
117
+ include Aws::Structure
118
+ end
119
+
120
+ # @note When making an API call, you may pass CreateRoomRequest
121
+ # data as a hash:
122
+ #
123
+ # {
124
+ # maximum_message_length: 1,
125
+ # maximum_message_rate_per_second: 1,
126
+ # message_review_handler: {
127
+ # fallback_result: "ALLOW", # accepts ALLOW, DENY
128
+ # uri: "LambdaArn",
129
+ # },
130
+ # name: "RoomName",
131
+ # tags: {
132
+ # "TagKey" => "TagValue",
133
+ # },
134
+ # }
135
+ #
136
+ # @!attribute [rw] maximum_message_length
137
+ # Maximum number of characters in a single message. Messages are
138
+ # expected to be UTF-8 encoded and this limit applies specifically to
139
+ # rune/code-point count, not number of bytes. Default: 500.
140
+ # @return [Integer]
141
+ #
142
+ # @!attribute [rw] maximum_message_rate_per_second
143
+ # Maximum number of messages per second that a client can send to the
144
+ # room. Default: 10.
145
+ # @return [Integer]
146
+ #
147
+ # @!attribute [rw] message_review_handler
148
+ # Configuration information for optional review of messages.
149
+ # @return [Types::MessageReviewHandler]
150
+ #
151
+ # @!attribute [rw] name
152
+ # Room name. The value does not need to be unique.
153
+ # @return [String]
154
+ #
155
+ # @!attribute [rw] tags
156
+ # Tags to attach to the resource. Array of maps, each of the form
157
+ # `string:string (key:value)`.
158
+ # @return [Hash<String,String>]
159
+ #
160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomRequest AWS API Documentation
161
+ #
162
+ class CreateRoomRequest < Struct.new(
163
+ :maximum_message_length,
164
+ :maximum_message_rate_per_second,
165
+ :message_review_handler,
166
+ :name,
167
+ :tags)
168
+ SENSITIVE = []
169
+ include Aws::Structure
170
+ end
171
+
172
+ # @!attribute [rw] arn
173
+ # Room ARN, assigned by the system.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] create_time
177
+ # Time when the room was created. This is an ISO 8601 timestamp; *note
178
+ # that this is returned as a string*.
179
+ # @return [Time]
180
+ #
181
+ # @!attribute [rw] id
182
+ # Room ID, generated by the system. This is a relative identifier, the
183
+ # part of the ARN that uniquely identifies the room.
184
+ # @return [String]
185
+ #
186
+ # @!attribute [rw] maximum_message_length
187
+ # Maximum number of characters in a single message, from the request.
188
+ # @return [Integer]
189
+ #
190
+ # @!attribute [rw] maximum_message_rate_per_second
191
+ # Maximum number of messages per second that a client can send to the
192
+ # room, from the request.
193
+ # @return [Integer]
194
+ #
195
+ # @!attribute [rw] message_review_handler
196
+ # Configuration information for optional review of messages.
197
+ # @return [Types::MessageReviewHandler]
198
+ #
199
+ # @!attribute [rw] name
200
+ # Room name, from the request (if specified).
201
+ # @return [String]
202
+ #
203
+ # @!attribute [rw] tags
204
+ # Tags attached to the resource, from the request.
205
+ # @return [Hash<String,String>]
206
+ #
207
+ # @!attribute [rw] update_time
208
+ # Time of the room’s last update. This is an ISO 8601 timestamp; *note
209
+ # that this is returned as a string*.
210
+ # @return [Time]
211
+ #
212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/CreateRoomResponse AWS API Documentation
213
+ #
214
+ class CreateRoomResponse < Struct.new(
215
+ :arn,
216
+ :create_time,
217
+ :id,
218
+ :maximum_message_length,
219
+ :maximum_message_rate_per_second,
220
+ :message_review_handler,
221
+ :name,
222
+ :tags,
223
+ :update_time)
224
+ SENSITIVE = []
225
+ include Aws::Structure
226
+ end
227
+
228
+ # @note When making an API call, you may pass DeleteMessageRequest
229
+ # data as a hash:
230
+ #
231
+ # {
232
+ # id: "MessageID", # required
233
+ # reason: "Reason",
234
+ # room_identifier: "RoomIdentifier", # required
235
+ # }
236
+ #
237
+ # @!attribute [rw] id
238
+ # ID of the message to be deleted. This is the `Id` field in the
239
+ # received message (see [ Message (Subscribe)][1] in the Chat
240
+ # Messaging API).
241
+ #
242
+ #
243
+ #
244
+ # [1]: https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] reason
248
+ # Reason for deleting the message.
249
+ # @return [String]
250
+ #
251
+ # @!attribute [rw] room_identifier
252
+ # Identifier of the room where the message should be deleted.
253
+ # Currently this must be an ARN.
254
+ # @return [String]
255
+ #
256
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteMessageRequest AWS API Documentation
257
+ #
258
+ class DeleteMessageRequest < Struct.new(
259
+ :id,
260
+ :reason,
261
+ :room_identifier)
262
+ SENSITIVE = []
263
+ include Aws::Structure
264
+ end
265
+
266
+ # @!attribute [rw] id
267
+ # Operation identifier, generated by Amazon IVS Chat.
268
+ # @return [String]
269
+ #
270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteMessageResponse AWS API Documentation
271
+ #
272
+ class DeleteMessageResponse < Struct.new(
273
+ :id)
274
+ SENSITIVE = []
275
+ include Aws::Structure
276
+ end
277
+
278
+ # @note When making an API call, you may pass DeleteRoomRequest
279
+ # data as a hash:
280
+ #
281
+ # {
282
+ # identifier: "RoomIdentifier", # required
283
+ # }
284
+ #
285
+ # @!attribute [rw] identifier
286
+ # Identifier of the room to be deleted. Currently this must be an ARN.
287
+ # @return [String]
288
+ #
289
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DeleteRoomRequest AWS API Documentation
290
+ #
291
+ class DeleteRoomRequest < Struct.new(
292
+ :identifier)
293
+ SENSITIVE = []
294
+ include Aws::Structure
295
+ end
296
+
297
+ # @note When making an API call, you may pass DisconnectUserRequest
298
+ # data as a hash:
299
+ #
300
+ # {
301
+ # reason: "Reason",
302
+ # room_identifier: "RoomIdentifier", # required
303
+ # user_id: "UserID", # required
304
+ # }
305
+ #
306
+ # @!attribute [rw] reason
307
+ # Reason for disconnecting the user.
308
+ # @return [String]
309
+ #
310
+ # @!attribute [rw] room_identifier
311
+ # Identifier of the room from which the user's clients should be
312
+ # disconnected. Currently this must be an ARN.
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] user_id
316
+ # ID of the user (connection) to disconnect from the room.
317
+ # @return [String]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DisconnectUserRequest AWS API Documentation
320
+ #
321
+ class DisconnectUserRequest < Struct.new(
322
+ :reason,
323
+ :room_identifier,
324
+ :user_id)
325
+ SENSITIVE = []
326
+ include Aws::Structure
327
+ end
328
+
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/DisconnectUserResponse AWS API Documentation
330
+ #
331
+ class DisconnectUserResponse < Aws::EmptyStructure; end
332
+
333
+ # @note When making an API call, you may pass GetRoomRequest
334
+ # data as a hash:
335
+ #
336
+ # {
337
+ # identifier: "RoomIdentifier", # required
338
+ # }
339
+ #
340
+ # @!attribute [rw] identifier
341
+ # Identifier of the room for which the configuration is to be
342
+ # retrieved. Currently this must be an ARN.
343
+ # @return [String]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetRoomRequest AWS API Documentation
346
+ #
347
+ class GetRoomRequest < Struct.new(
348
+ :identifier)
349
+ SENSITIVE = []
350
+ include Aws::Structure
351
+ end
352
+
353
+ # @!attribute [rw] arn
354
+ # Room ARN, from the request (if `identifier` was an ARN).
355
+ # @return [String]
356
+ #
357
+ # @!attribute [rw] create_time
358
+ # Time when the room was created. This is an ISO 8601 timestamp; *note
359
+ # that this is returned as a string*.
360
+ # @return [Time]
361
+ #
362
+ # @!attribute [rw] id
363
+ # Room ID, generated by the system. This is a relative identifier, the
364
+ # part of the ARN that uniquely identifies the room.
365
+ # @return [String]
366
+ #
367
+ # @!attribute [rw] maximum_message_length
368
+ # Maximum number of characters in a single message. Messages are
369
+ # expected to be UTF-8 encoded and this limit applies specifically to
370
+ # rune/code-point count, not number of bytes. Default: 500.
371
+ # @return [Integer]
372
+ #
373
+ # @!attribute [rw] maximum_message_rate_per_second
374
+ # Maximum number of messages per second that a client can send to the
375
+ # room. Default: 10.
376
+ # @return [Integer]
377
+ #
378
+ # @!attribute [rw] message_review_handler
379
+ # Configuration information for optional review of messages.
380
+ # @return [Types::MessageReviewHandler]
381
+ #
382
+ # @!attribute [rw] name
383
+ # Room name. The value does not need to be unique.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] tags
387
+ # Tags attached to the resource. Array of maps, each of the form
388
+ # `string:string (key:value)`.
389
+ # @return [Hash<String,String>]
390
+ #
391
+ # @!attribute [rw] update_time
392
+ # Time of the room’s last update. This is an ISO 8601 timestamp; *note
393
+ # that this is returned as a string*.
394
+ # @return [Time]
395
+ #
396
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/GetRoomResponse AWS API Documentation
397
+ #
398
+ class GetRoomResponse < Struct.new(
399
+ :arn,
400
+ :create_time,
401
+ :id,
402
+ :maximum_message_length,
403
+ :maximum_message_rate_per_second,
404
+ :message_review_handler,
405
+ :name,
406
+ :tags,
407
+ :update_time)
408
+ SENSITIVE = []
409
+ include Aws::Structure
410
+ end
411
+
412
+ # @!attribute [rw] message
413
+ # @return [String]
414
+ #
415
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/InternalServerException AWS API Documentation
416
+ #
417
+ class InternalServerException < Struct.new(
418
+ :message)
419
+ SENSITIVE = []
420
+ include Aws::Structure
421
+ end
422
+
423
+ # @note When making an API call, you may pass ListRoomsRequest
424
+ # data as a hash:
425
+ #
426
+ # {
427
+ # max_results: 1,
428
+ # message_review_handler_uri: "LambdaArn",
429
+ # name: "RoomName",
430
+ # next_token: "PaginationToken",
431
+ # }
432
+ #
433
+ # @!attribute [rw] max_results
434
+ # Maximum number of rooms to return. Default: 50.
435
+ # @return [Integer]
436
+ #
437
+ # @!attribute [rw] message_review_handler_uri
438
+ # Filters the list to match the specified message review handler URI.
439
+ # @return [String]
440
+ #
441
+ # @!attribute [rw] name
442
+ # Filters the list to match the specified room name.
443
+ # @return [String]
444
+ #
445
+ # @!attribute [rw] next_token
446
+ # The first room to retrieve. This is used for pagination; see the
447
+ # `nextToken` response field.
448
+ # @return [String]
449
+ #
450
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsRequest AWS API Documentation
451
+ #
452
+ class ListRoomsRequest < Struct.new(
453
+ :max_results,
454
+ :message_review_handler_uri,
455
+ :name,
456
+ :next_token)
457
+ SENSITIVE = []
458
+ include Aws::Structure
459
+ end
460
+
461
+ # @!attribute [rw] next_token
462
+ # If there are more rooms than `maxResults`, use `nextToken` in the
463
+ # request to get the next set.
464
+ # @return [String]
465
+ #
466
+ # @!attribute [rw] rooms
467
+ # List of the matching rooms (summary information only).
468
+ # @return [Array<Types::RoomSummary>]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListRoomsResponse AWS API Documentation
471
+ #
472
+ class ListRoomsResponse < Struct.new(
473
+ :next_token,
474
+ :rooms)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
479
+ # @note When making an API call, you may pass ListTagsForResourceRequest
480
+ # data as a hash:
481
+ #
482
+ # {
483
+ # resource_arn: "ResourceArn", # required
484
+ # }
485
+ #
486
+ # @!attribute [rw] resource_arn
487
+ # The ARN of the resource to be retrieved. The ARN must be
488
+ # URL-encoded.
489
+ # @return [String]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResourceRequest AWS API Documentation
492
+ #
493
+ class ListTagsForResourceRequest < Struct.new(
494
+ :resource_arn)
495
+ SENSITIVE = []
496
+ include Aws::Structure
497
+ end
498
+
499
+ # @!attribute [rw] tags
500
+ # Tags to attach to the resource. Array of maps, each of the form
501
+ # `string:string (key:value)`.
502
+ # @return [Hash<String,String>]
503
+ #
504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ListTagsForResourceResponse AWS API Documentation
505
+ #
506
+ class ListTagsForResourceResponse < Struct.new(
507
+ :tags)
508
+ SENSITIVE = []
509
+ include Aws::Structure
510
+ end
511
+
512
+ # Configuration information for optional message review.
513
+ #
514
+ # @note When making an API call, you may pass MessageReviewHandler
515
+ # data as a hash:
516
+ #
517
+ # {
518
+ # fallback_result: "ALLOW", # accepts ALLOW, DENY
519
+ # uri: "LambdaArn",
520
+ # }
521
+ #
522
+ # @!attribute [rw] fallback_result
523
+ # Specifies the fallback behavior (whether the message is allowed or
524
+ # denied) if the handler does not return a valid response, encounters
525
+ # an error or times out. If allowed, the message is delivered with
526
+ # returned content to all users connected to the room. If denied, the
527
+ # message is not delivered to any user. Default: `ALLOW`.
528
+ # @return [String]
529
+ #
530
+ # @!attribute [rw] uri
531
+ # Identifier of the message review handler. Currently this must be an
532
+ # ARN of a lambda function.
533
+ # @return [String]
534
+ #
535
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/MessageReviewHandler AWS API Documentation
536
+ #
537
+ class MessageReviewHandler < Struct.new(
538
+ :fallback_result,
539
+ :uri)
540
+ SENSITIVE = []
541
+ include Aws::Structure
542
+ end
543
+
544
+ # @!attribute [rw] message
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/PendingVerification AWS API Documentation
548
+ #
549
+ class PendingVerification < Struct.new(
550
+ :message)
551
+ SENSITIVE = []
552
+ include Aws::Structure
553
+ end
554
+
555
+ # @!attribute [rw] message
556
+ # @return [String]
557
+ #
558
+ # @!attribute [rw] resource_id
559
+ # @return [String]
560
+ #
561
+ # @!attribute [rw] resource_type
562
+ # @return [String]
563
+ #
564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ResourceNotFoundException AWS API Documentation
565
+ #
566
+ class ResourceNotFoundException < Struct.new(
567
+ :message,
568
+ :resource_id,
569
+ :resource_type)
570
+ SENSITIVE = []
571
+ include Aws::Structure
572
+ end
573
+
574
+ # Summary information about a room.
575
+ #
576
+ # @!attribute [rw] arn
577
+ # Room ARN.
578
+ # @return [String]
579
+ #
580
+ # @!attribute [rw] create_time
581
+ # Time when the room was created. This is an ISO 8601 timestamp; *note
582
+ # that this is returned as a string*.
583
+ # @return [Time]
584
+ #
585
+ # @!attribute [rw] id
586
+ # Room ID, generated by the system. This is a relative identifier, the
587
+ # part of the ARN that uniquely identifies the room.
588
+ # @return [String]
589
+ #
590
+ # @!attribute [rw] message_review_handler
591
+ # Configuration information for optional review of messages.
592
+ # @return [Types::MessageReviewHandler]
593
+ #
594
+ # @!attribute [rw] name
595
+ # Room name. The value does not need to be unique.
596
+ # @return [String]
597
+ #
598
+ # @!attribute [rw] tags
599
+ # Tags attached to the resource.
600
+ # @return [Hash<String,String>]
601
+ #
602
+ # @!attribute [rw] update_time
603
+ # Time of the room’s last update. This is an ISO 8601 timestamp; *note
604
+ # that this is returned as a string*.
605
+ # @return [Time]
606
+ #
607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/RoomSummary AWS API Documentation
608
+ #
609
+ class RoomSummary < Struct.new(
610
+ :arn,
611
+ :create_time,
612
+ :id,
613
+ :message_review_handler,
614
+ :name,
615
+ :tags,
616
+ :update_time)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @note When making an API call, you may pass SendEventRequest
622
+ # data as a hash:
623
+ #
624
+ # {
625
+ # attributes: {
626
+ # "String" => "String",
627
+ # },
628
+ # event_name: "EventName", # required
629
+ # room_identifier: "RoomIdentifier", # required
630
+ # }
631
+ #
632
+ # @!attribute [rw] attributes
633
+ # Application-defined metadata to attach to the event sent to clients.
634
+ # The maximum length of the metadata is 1 KB total.
635
+ # @return [Hash<String,String>]
636
+ #
637
+ # @!attribute [rw] event_name
638
+ # Application-defined name of the event to send to clients.
639
+ # @return [String]
640
+ #
641
+ # @!attribute [rw] room_identifier
642
+ # Identifier of the room to which the event will be sent. Currently
643
+ # this must be an ARN.
644
+ # @return [String]
645
+ #
646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/SendEventRequest AWS API Documentation
647
+ #
648
+ class SendEventRequest < Struct.new(
649
+ :attributes,
650
+ :event_name,
651
+ :room_identifier)
652
+ SENSITIVE = []
653
+ include Aws::Structure
654
+ end
655
+
656
+ # @!attribute [rw] id
657
+ # An identifier generated by Amazon IVS Chat. This identifier must be
658
+ # used in subsequent operations for this message, such as
659
+ # DeleteMessage.
660
+ # @return [String]
661
+ #
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/SendEventResponse AWS API Documentation
663
+ #
664
+ class SendEventResponse < Struct.new(
665
+ :id)
666
+ SENSITIVE = []
667
+ include Aws::Structure
668
+ end
669
+
670
+ # @!attribute [rw] limit
671
+ # @return [Integer]
672
+ #
673
+ # @!attribute [rw] message
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] resource_id
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] resource_type
680
+ # @return [String]
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ServiceQuotaExceededException AWS API Documentation
683
+ #
684
+ class ServiceQuotaExceededException < Struct.new(
685
+ :limit,
686
+ :message,
687
+ :resource_id,
688
+ :resource_type)
689
+ SENSITIVE = []
690
+ include Aws::Structure
691
+ end
692
+
693
+ # @note When making an API call, you may pass TagResourceRequest
694
+ # data as a hash:
695
+ #
696
+ # {
697
+ # resource_arn: "ResourceArn", # required
698
+ # tags: { # required
699
+ # "TagKey" => "TagValue",
700
+ # },
701
+ # }
702
+ #
703
+ # @!attribute [rw] resource_arn
704
+ # The ARN of the resource to be tagged. The ARN must be URL-encoded.
705
+ # @return [String]
706
+ #
707
+ # @!attribute [rw] tags
708
+ # Array of tags to be added or updated.
709
+ # @return [Hash<String,String>]
710
+ #
711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/TagResourceRequest AWS API Documentation
712
+ #
713
+ class TagResourceRequest < Struct.new(
714
+ :resource_arn,
715
+ :tags)
716
+ SENSITIVE = []
717
+ include Aws::Structure
718
+ end
719
+
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/TagResourceResponse AWS API Documentation
721
+ #
722
+ class TagResourceResponse < Aws::EmptyStructure; end
723
+
724
+ # @!attribute [rw] limit
725
+ # @return [Integer]
726
+ #
727
+ # @!attribute [rw] message
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] resource_id
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] resource_type
734
+ # @return [String]
735
+ #
736
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ThrottlingException AWS API Documentation
737
+ #
738
+ class ThrottlingException < Struct.new(
739
+ :limit,
740
+ :message,
741
+ :resource_id,
742
+ :resource_type)
743
+ SENSITIVE = []
744
+ include Aws::Structure
745
+ end
746
+
747
+ # @note When making an API call, you may pass UntagResourceRequest
748
+ # data as a hash:
749
+ #
750
+ # {
751
+ # resource_arn: "ResourceArn", # required
752
+ # tag_keys: ["TagKey"], # required
753
+ # }
754
+ #
755
+ # @!attribute [rw] resource_arn
756
+ # The ARN of the resource to be untagged. The ARN must be URL-encoded.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] tag_keys
760
+ # Array of tags to be removed.
761
+ # @return [Array<String>]
762
+ #
763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UntagResourceRequest AWS API Documentation
764
+ #
765
+ class UntagResourceRequest < Struct.new(
766
+ :resource_arn,
767
+ :tag_keys)
768
+ SENSITIVE = []
769
+ include Aws::Structure
770
+ end
771
+
772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UntagResourceResponse AWS API Documentation
773
+ #
774
+ class UntagResourceResponse < Aws::EmptyStructure; end
775
+
776
+ # @note When making an API call, you may pass UpdateRoomRequest
777
+ # data as a hash:
778
+ #
779
+ # {
780
+ # identifier: "RoomIdentifier", # required
781
+ # maximum_message_length: 1,
782
+ # maximum_message_rate_per_second: 1,
783
+ # message_review_handler: {
784
+ # fallback_result: "ALLOW", # accepts ALLOW, DENY
785
+ # uri: "LambdaArn",
786
+ # },
787
+ # name: "RoomName",
788
+ # }
789
+ #
790
+ # @!attribute [rw] identifier
791
+ # Identifier of the room to be updated. Currently this must be an ARN.
792
+ # @return [String]
793
+ #
794
+ # @!attribute [rw] maximum_message_length
795
+ # The maximum number of characters in a single message. Messages are
796
+ # expected to be UTF-8 encoded and this limit applies specifically to
797
+ # rune/code-point count, not number of bytes. Default: 500.
798
+ # @return [Integer]
799
+ #
800
+ # @!attribute [rw] maximum_message_rate_per_second
801
+ # The maximum number of messages per second that a client can send to
802
+ # the room. Default: 10.
803
+ # @return [Integer]
804
+ #
805
+ # @!attribute [rw] message_review_handler
806
+ # Configuration information for optional review of messages. Specify
807
+ # an empty `uri` string to disassociate a message review handler from
808
+ # the specified room.
809
+ # @return [Types::MessageReviewHandler]
810
+ #
811
+ # @!attribute [rw] name
812
+ # Room name. The value does not need to be unique.
813
+ # @return [String]
814
+ #
815
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateRoomRequest AWS API Documentation
816
+ #
817
+ class UpdateRoomRequest < Struct.new(
818
+ :identifier,
819
+ :maximum_message_length,
820
+ :maximum_message_rate_per_second,
821
+ :message_review_handler,
822
+ :name)
823
+ SENSITIVE = []
824
+ include Aws::Structure
825
+ end
826
+
827
+ # @!attribute [rw] arn
828
+ # Room ARN, from the request (if `identifier` was an ARN).
829
+ # @return [String]
830
+ #
831
+ # @!attribute [rw] create_time
832
+ # Time when the room was created. This is an ISO 8601 timestamp; *note
833
+ # that this is returned as a string*.
834
+ # @return [Time]
835
+ #
836
+ # @!attribute [rw] id
837
+ # Room ID, generated by the system. This is a relative identifier, the
838
+ # part of the ARN that uniquely identifies the room.
839
+ # @return [String]
840
+ #
841
+ # @!attribute [rw] maximum_message_length
842
+ # Maximum number of characters in a single message, from the request.
843
+ # @return [Integer]
844
+ #
845
+ # @!attribute [rw] maximum_message_rate_per_second
846
+ # Maximum number of messages per second that a client can send to the
847
+ # room, from the request.
848
+ # @return [Integer]
849
+ #
850
+ # @!attribute [rw] message_review_handler
851
+ # Configuration information for optional review of messages.
852
+ # @return [Types::MessageReviewHandler]
853
+ #
854
+ # @!attribute [rw] name
855
+ # Room name, from the request.
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] tags
859
+ # Tags attached to the resource.
860
+ # @return [Hash<String,String>]
861
+ #
862
+ # @!attribute [rw] update_time
863
+ # Time of the room’s last update. This is an ISO 8601 timestamp; *note
864
+ # that this is returned as a string*.
865
+ # @return [Time]
866
+ #
867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/UpdateRoomResponse AWS API Documentation
868
+ #
869
+ class UpdateRoomResponse < Struct.new(
870
+ :arn,
871
+ :create_time,
872
+ :id,
873
+ :maximum_message_length,
874
+ :maximum_message_rate_per_second,
875
+ :message_review_handler,
876
+ :name,
877
+ :tags,
878
+ :update_time)
879
+ SENSITIVE = []
880
+ include Aws::Structure
881
+ end
882
+
883
+ # @!attribute [rw] field_list
884
+ # @return [Array<Types::ValidationExceptionField>]
885
+ #
886
+ # @!attribute [rw] message
887
+ # @return [String]
888
+ #
889
+ # @!attribute [rw] reason
890
+ # @return [String]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ValidationException AWS API Documentation
893
+ #
894
+ class ValidationException < Struct.new(
895
+ :field_list,
896
+ :message,
897
+ :reason)
898
+ SENSITIVE = []
899
+ include Aws::Structure
900
+ end
901
+
902
+ # This object is used in the ValidationException error.
903
+ #
904
+ # @!attribute [rw] message
905
+ # Explanation of the reason for the validation error.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] name
909
+ # Name of the field which failed validation.
910
+ # @return [String]
911
+ #
912
+ # @see http://docs.aws.amazon.com/goto/WebAPI/ivschat-2020-07-14/ValidationExceptionField AWS API Documentation
913
+ #
914
+ class ValidationExceptionField < Struct.new(
915
+ :message,
916
+ :name)
917
+ SENSITIVE = []
918
+ include Aws::Structure
919
+ end
920
+
921
+ end
922
+ end