@aws-sdk/client-ivschat 3.379.1 → 3.382.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.
@@ -30,26 +30,31 @@ export type ChatTokenCapability = (typeof ChatTokenCapability)[keyof typeof Chat
30
30
  */
31
31
  export interface CreateChatTokenRequest {
32
32
  /**
33
+ * @public
33
34
  * <p>Identifier of the room that the client is trying to access. Currently this must be an
34
35
  * ARN. </p>
35
36
  */
36
37
  roomIdentifier: string | undefined;
37
38
  /**
39
+ * @public
38
40
  * <p>Application-provided ID that uniquely identifies the user associated with this token.
39
41
  * This can be any UTF-8 encoded text.</p>
40
42
  */
41
43
  userId: string | undefined;
42
44
  /**
45
+ * @public
43
46
  * <p>Set of capabilities that the user is allowed to perform in the room. Default: None (the
44
47
  * capability to view messages is implicitly included in all requests).</p>
45
48
  */
46
49
  capabilities?: (ChatTokenCapability | string)[];
47
50
  /**
51
+ * @public
48
52
  * <p>Session duration (in minutes), after which the session expires. Default: 60 (1
49
53
  * hour).</p>
50
54
  */
51
55
  sessionDurationInMinutes?: number;
52
56
  /**
57
+ * @public
53
58
  * <p>Application-provided attributes to encode into the token and attach to a chat session.
54
59
  * Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1
55
60
  * KB total.</p>
@@ -61,16 +66,19 @@ export interface CreateChatTokenRequest {
61
66
  */
62
67
  export interface CreateChatTokenResponse {
63
68
  /**
69
+ * @public
64
70
  * <p>The issued client token, encrypted.</p>
65
71
  */
66
72
  token?: string;
67
73
  /**
74
+ * @public
68
75
  * <p>Time after which the token is no longer valid and cannot be used to connect to a room.
69
76
  * This is an ISO 8601 timestamp; <i>note that this is returned as a
70
77
  * string</i>.</p>
71
78
  */
72
79
  tokenExpirationTime?: Date;
73
80
  /**
81
+ * @public
74
82
  * <p>Time after which an end user's session is no longer valid. This is an ISO 8601
75
83
  * timestamp; <i>note that this is returned as a string</i>.</p>
76
84
  */
@@ -107,10 +115,12 @@ export declare class ResourceNotFoundException extends __BaseException {
107
115
  readonly name: "ResourceNotFoundException";
108
116
  readonly $fault: "client";
109
117
  /**
118
+ * @public
110
119
  * <p/>
111
120
  */
112
121
  resourceId: string | undefined;
113
122
  /**
123
+ * @public
114
124
  * <p/>
115
125
  */
116
126
  resourceType: ResourceType | string | undefined;
@@ -125,10 +135,12 @@ export declare class ResourceNotFoundException extends __BaseException {
125
135
  */
126
136
  export interface ValidationExceptionField {
127
137
  /**
138
+ * @public
128
139
  * <p>Name of the field which failed validation.</p>
129
140
  */
130
141
  name: string | undefined;
131
142
  /**
143
+ * @public
132
144
  * <p>Explanation of the reason for the validation error.</p>
133
145
  */
134
146
  message: string | undefined;
@@ -154,10 +166,12 @@ export declare class ValidationException extends __BaseException {
154
166
  readonly name: "ValidationException";
155
167
  readonly $fault: "client";
156
168
  /**
169
+ * @public
157
170
  * <p/>
158
171
  */
159
172
  reason: ValidationExceptionReason | string | undefined;
160
173
  /**
174
+ * @public
161
175
  * <p/>
162
176
  */
163
177
  fieldList?: ValidationExceptionField[];
@@ -174,10 +188,12 @@ export declare class ConflictException extends __BaseException {
174
188
  readonly name: "ConflictException";
175
189
  readonly $fault: "client";
176
190
  /**
191
+ * @public
177
192
  * <p/>
178
193
  */
179
194
  resourceId: string | undefined;
180
195
  /**
196
+ * @public
181
197
  * <p/>
182
198
  */
183
199
  resourceType: ResourceType | string | undefined;
@@ -192,6 +208,7 @@ export declare class ConflictException extends __BaseException {
192
208
  */
193
209
  export interface CloudWatchLogsDestinationConfiguration {
194
210
  /**
211
+ * @public
195
212
  * <p>Name of the Amazon Cloudwatch Logs destination where chat activity will be logged.</p>
196
213
  */
197
214
  logGroupName: string | undefined;
@@ -202,6 +219,7 @@ export interface CloudWatchLogsDestinationConfiguration {
202
219
  */
203
220
  export interface FirehoseDestinationConfiguration {
204
221
  /**
222
+ * @public
205
223
  * <p>Name of the Amazon Kinesis Firehose delivery stream where chat activity will be
206
224
  * logged.</p>
207
225
  */
@@ -213,6 +231,7 @@ export interface FirehoseDestinationConfiguration {
213
231
  */
214
232
  export interface S3DestinationConfiguration {
215
233
  /**
234
+ * @public
216
235
  * <p>Name of the Amazon S3 bucket where chat activity will be logged.</p>
217
236
  */
218
237
  bucketName: string | undefined;
@@ -229,6 +248,7 @@ export type DestinationConfiguration = DestinationConfiguration.CloudWatchLogsMe
229
248
  */
230
249
  export declare namespace DestinationConfiguration {
231
250
  /**
251
+ * @public
232
252
  * <p>An Amazon S3 destination configuration where chat activity will be logged.</p>
233
253
  */
234
254
  interface S3Member {
@@ -238,6 +258,7 @@ export declare namespace DestinationConfiguration {
238
258
  $unknown?: never;
239
259
  }
240
260
  /**
261
+ * @public
241
262
  * <p>An Amazon CloudWatch Logs destination configuration where chat activity will be
242
263
  * logged.</p>
243
264
  */
@@ -248,6 +269,7 @@ export declare namespace DestinationConfiguration {
248
269
  $unknown?: never;
249
270
  }
250
271
  /**
272
+ * @public
251
273
  * <p>An Amazon Kinesis Data Firehose destination configuration where chat activity will be
252
274
  * logged.</p>
253
275
  */
@@ -257,6 +279,9 @@ export declare namespace DestinationConfiguration {
257
279
  firehose: FirehoseDestinationConfiguration;
258
280
  $unknown?: never;
259
281
  }
282
+ /**
283
+ * @public
284
+ */
260
285
  interface $UnknownMember {
261
286
  s3?: never;
262
287
  cloudWatchLogs?: never;
@@ -276,10 +301,12 @@ export declare namespace DestinationConfiguration {
276
301
  */
277
302
  export interface CreateLoggingConfigurationRequest {
278
303
  /**
304
+ * @public
279
305
  * <p>Logging-configuration name. The value does not need to be unique.</p>
280
306
  */
281
307
  name?: string;
282
308
  /**
309
+ * @public
283
310
  * <p>A complex type that contains a destination configuration for where chat content will be
284
311
  * logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
285
312
  * <code>firehose</code>, or <code>s3</code>) in a
@@ -287,6 +314,7 @@ export interface CreateLoggingConfigurationRequest {
287
314
  */
288
315
  destinationConfiguration: DestinationConfiguration | undefined;
289
316
  /**
317
+ * @public
290
318
  * <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
291
319
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
292
320
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -311,29 +339,35 @@ export type CreateLoggingConfigurationState = (typeof CreateLoggingConfiguration
311
339
  */
312
340
  export interface CreateLoggingConfigurationResponse {
313
341
  /**
342
+ * @public
314
343
  * <p>Logging-configuration ARN, assigned by the system.</p>
315
344
  */
316
345
  arn?: string;
317
346
  /**
347
+ * @public
318
348
  * <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
319
349
  * part of the ARN that uniquely identifies the logging configuration.</p>
320
350
  */
321
351
  id?: string;
322
352
  /**
353
+ * @public
323
354
  * <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
324
355
  * <i>note that this is returned as a string</i>.</p>
325
356
  */
326
357
  createTime?: Date;
327
358
  /**
359
+ * @public
328
360
  * <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
329
361
  * <i>note that this is returned as a string</i>.</p>
330
362
  */
331
363
  updateTime?: Date;
332
364
  /**
365
+ * @public
333
366
  * <p>Logging-configuration name, from the request (if specified).</p>
334
367
  */
335
368
  name?: string;
336
369
  /**
370
+ * @public
337
371
  * <p>A complex type that contains a destination configuration for where chat content will be
338
372
  * logged, from the request. There is only one type of destination
339
373
  * (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
@@ -341,11 +375,13 @@ export interface CreateLoggingConfigurationResponse {
341
375
  */
342
376
  destinationConfiguration?: DestinationConfiguration;
343
377
  /**
378
+ * @public
344
379
  * <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
345
380
  * configuration is ready to log chat content.</p>
346
381
  */
347
382
  state?: CreateLoggingConfigurationState | string;
348
383
  /**
384
+ * @public
349
385
  * <p>Tags attached to the resource, from the request (if specified). Array of maps, each of
350
386
  * the form <code>string:string (key:value)</code>.</p>
351
387
  */
@@ -359,14 +395,17 @@ export declare class ServiceQuotaExceededException extends __BaseException {
359
395
  readonly name: "ServiceQuotaExceededException";
360
396
  readonly $fault: "client";
361
397
  /**
398
+ * @public
362
399
  * <p/>
363
400
  */
364
401
  resourceId: string | undefined;
365
402
  /**
403
+ * @public
366
404
  * <p/>
367
405
  */
368
406
  resourceType: ResourceType | string | undefined;
369
407
  /**
408
+ * @public
370
409
  * <p/>
371
410
  */
372
411
  limit: number | undefined;
@@ -393,11 +432,13 @@ export type FallbackResult = (typeof FallbackResult)[keyof typeof FallbackResult
393
432
  */
394
433
  export interface MessageReviewHandler {
395
434
  /**
435
+ * @public
396
436
  * <p>Identifier of the message review handler. Currently this must be an ARN of a lambda
397
437
  * function.</p>
398
438
  */
399
439
  uri?: string;
400
440
  /**
441
+ * @public
401
442
  * <p>Specifies the fallback behavior (whether the message is allowed or denied) if the handler
402
443
  * does not return a valid response, encounters an error, or times out. (For the timeout period,
403
444
  * see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/service-quotas.html"> Service
@@ -412,25 +453,30 @@ export interface MessageReviewHandler {
412
453
  */
413
454
  export interface CreateRoomRequest {
414
455
  /**
456
+ * @public
415
457
  * <p>Room name. The value does not need to be unique.</p>
416
458
  */
417
459
  name?: string;
418
460
  /**
461
+ * @public
419
462
  * <p>Maximum number of messages per second that can be sent to the room (by all clients).
420
463
  * Default: 10. </p>
421
464
  */
422
465
  maximumMessageRatePerSecond?: number;
423
466
  /**
467
+ * @public
424
468
  * <p>Maximum number of characters in a single message. Messages are expected to be UTF-8
425
469
  * encoded and this limit applies specifically to rune/code-point count, not number of bytes.
426
470
  * Default: 500.</p>
427
471
  */
428
472
  maximumMessageLength?: number;
429
473
  /**
474
+ * @public
430
475
  * <p>Configuration information for optional review of messages.</p>
431
476
  */
432
477
  messageReviewHandler?: MessageReviewHandler;
433
478
  /**
479
+ * @public
434
480
  * <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
435
481
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
436
482
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -439,6 +485,7 @@ export interface CreateRoomRequest {
439
485
  */
440
486
  tags?: Record<string, string>;
441
487
  /**
488
+ * @public
442
489
  * <p>Array of logging-configuration identifiers attached to the room.</p>
443
490
  */
444
491
  loggingConfigurationIdentifiers?: string[];
@@ -448,47 +495,57 @@ export interface CreateRoomRequest {
448
495
  */
449
496
  export interface CreateRoomResponse {
450
497
  /**
498
+ * @public
451
499
  * <p>Room ARN, assigned by the system.</p>
452
500
  */
453
501
  arn?: string;
454
502
  /**
503
+ * @public
455
504
  * <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
456
505
  * that uniquely identifies the room.</p>
457
506
  */
458
507
  id?: string;
459
508
  /**
509
+ * @public
460
510
  * <p>Room name, from the request (if specified).</p>
461
511
  */
462
512
  name?: string;
463
513
  /**
514
+ * @public
464
515
  * <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
465
516
  * is returned as a string</i>.</p>
466
517
  */
467
518
  createTime?: Date;
468
519
  /**
520
+ * @public
469
521
  * <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
470
522
  * is returned as a string</i>.</p>
471
523
  */
472
524
  updateTime?: Date;
473
525
  /**
526
+ * @public
474
527
  * <p>Maximum number of messages per second that can be sent to the room (by all clients),
475
528
  * from the request (if specified).</p>
476
529
  */
477
530
  maximumMessageRatePerSecond?: number;
478
531
  /**
532
+ * @public
479
533
  * <p>Maximum number of characters in a single message, from the request (if
480
534
  * specified).</p>
481
535
  */
482
536
  maximumMessageLength?: number;
483
537
  /**
538
+ * @public
484
539
  * <p>Configuration information for optional review of messages.</p>
485
540
  */
486
541
  messageReviewHandler?: MessageReviewHandler;
487
542
  /**
543
+ * @public
488
544
  * <p>Tags attached to the resource, from the request (if specified).</p>
489
545
  */
490
546
  tags?: Record<string, string>;
491
547
  /**
548
+ * @public
492
549
  * <p>Array of logging configurations attached to the room, from the request (if
493
550
  * specified).</p>
494
551
  */
@@ -499,6 +556,7 @@ export interface CreateRoomResponse {
499
556
  */
500
557
  export interface DeleteLoggingConfigurationRequest {
501
558
  /**
559
+ * @public
502
560
  * <p>Identifier of the logging configuration to be deleted.</p>
503
561
  */
504
562
  identifier: string | undefined;
@@ -508,17 +566,20 @@ export interface DeleteLoggingConfigurationRequest {
508
566
  */
509
567
  export interface DeleteMessageRequest {
510
568
  /**
569
+ * @public
511
570
  * <p>Identifier of the room where the message should be deleted. Currently this must be an
512
571
  * ARN. </p>
513
572
  */
514
573
  roomIdentifier: string | undefined;
515
574
  /**
575
+ * @public
516
576
  * <p>ID of the message to be deleted. This is the <code>Id</code> field in the received
517
577
  * message (see <a href="https://docs.aws.amazon.com/ivs/latest/chatmsgapireference/actions-message-subscribe.html"> Message
518
578
  * (Subscribe)</a> in the Chat Messaging API).</p>
519
579
  */
520
580
  id: string | undefined;
521
581
  /**
582
+ * @public
522
583
  * <p>Reason for deleting the message.</p>
523
584
  */
524
585
  reason?: string;
@@ -528,6 +589,7 @@ export interface DeleteMessageRequest {
528
589
  */
529
590
  export interface DeleteMessageResponse {
530
591
  /**
592
+ * @public
531
593
  * <p>Operation identifier, generated by Amazon IVS Chat.</p>
532
594
  */
533
595
  id?: string;
@@ -540,14 +602,17 @@ export declare class ThrottlingException extends __BaseException {
540
602
  readonly name: "ThrottlingException";
541
603
  readonly $fault: "client";
542
604
  /**
605
+ * @public
543
606
  * <p/>
544
607
  */
545
608
  resourceId: string | undefined;
546
609
  /**
610
+ * @public
547
611
  * <p/>
548
612
  */
549
613
  resourceType: ResourceType | string | undefined;
550
614
  /**
615
+ * @public
551
616
  * <p/>
552
617
  */
553
618
  limit: number | undefined;
@@ -561,6 +626,7 @@ export declare class ThrottlingException extends __BaseException {
561
626
  */
562
627
  export interface DeleteRoomRequest {
563
628
  /**
629
+ * @public
564
630
  * <p>Identifier of the room to be deleted. Currently this must be an ARN.</p>
565
631
  */
566
632
  identifier: string | undefined;
@@ -570,15 +636,18 @@ export interface DeleteRoomRequest {
570
636
  */
571
637
  export interface DisconnectUserRequest {
572
638
  /**
639
+ * @public
573
640
  * <p>Identifier of the room from which the user's clients should be disconnected. Currently
574
641
  * this must be an ARN.</p>
575
642
  */
576
643
  roomIdentifier: string | undefined;
577
644
  /**
645
+ * @public
578
646
  * <p>ID of the user (connection) to disconnect from the room.</p>
579
647
  */
580
648
  userId: string | undefined;
581
649
  /**
650
+ * @public
582
651
  * <p>Reason for disconnecting the user.</p>
583
652
  */
584
653
  reason?: string;
@@ -593,6 +662,7 @@ export interface DisconnectUserResponse {
593
662
  */
594
663
  export interface GetLoggingConfigurationRequest {
595
664
  /**
665
+ * @public
596
666
  * <p>Identifier of the logging configuration to be retrieved.</p>
597
667
  */
598
668
  identifier: string | undefined;
@@ -619,30 +689,36 @@ export type LoggingConfigurationState = (typeof LoggingConfigurationState)[keyof
619
689
  */
620
690
  export interface GetLoggingConfigurationResponse {
621
691
  /**
692
+ * @public
622
693
  * <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
623
694
  * ARN).</p>
624
695
  */
625
696
  arn?: string;
626
697
  /**
698
+ * @public
627
699
  * <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
628
700
  * part of the ARN that uniquely identifies the logging configuration.</p>
629
701
  */
630
702
  id?: string;
631
703
  /**
704
+ * @public
632
705
  * <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
633
706
  * <i>note that this is returned as a string</i>.</p>
634
707
  */
635
708
  createTime?: Date;
636
709
  /**
710
+ * @public
637
711
  * <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
638
712
  * <i>note that this is returned as a string</i>.</p>
639
713
  */
640
714
  updateTime?: Date;
641
715
  /**
716
+ * @public
642
717
  * <p>Logging-configuration name. This value does not need to be unique.</p>
643
718
  */
644
719
  name?: string;
645
720
  /**
721
+ * @public
646
722
  * <p>A complex type that contains a destination configuration for where chat content will be
647
723
  * logged. There is only one type of destination (<code>cloudWatchLogs</code>,
648
724
  * <code>firehose</code>, or <code>s3</code>) in a
@@ -650,11 +726,13 @@ export interface GetLoggingConfigurationResponse {
650
726
  */
651
727
  destinationConfiguration?: DestinationConfiguration;
652
728
  /**
729
+ * @public
653
730
  * <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
654
731
  * configuration is ready to log chat content.</p>
655
732
  */
656
733
  state?: LoggingConfigurationState | string;
657
734
  /**
735
+ * @public
658
736
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
659
737
  * (key:value)</code>.</p>
660
738
  */
@@ -665,6 +743,7 @@ export interface GetLoggingConfigurationResponse {
665
743
  */
666
744
  export interface GetRoomRequest {
667
745
  /**
746
+ * @public
668
747
  * <p>Identifier of the room for which the configuration is to be retrieved. Currently this
669
748
  * must be an ARN.</p>
670
749
  */
@@ -675,49 +754,59 @@ export interface GetRoomRequest {
675
754
  */
676
755
  export interface GetRoomResponse {
677
756
  /**
757
+ * @public
678
758
  * <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
679
759
  */
680
760
  arn?: string;
681
761
  /**
762
+ * @public
682
763
  * <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
683
764
  * that uniquely identifies the room.</p>
684
765
  */
685
766
  id?: string;
686
767
  /**
768
+ * @public
687
769
  * <p>Room name. The value does not need to be unique.</p>
688
770
  */
689
771
  name?: string;
690
772
  /**
773
+ * @public
691
774
  * <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
692
775
  * is returned as a string</i>.</p>
693
776
  */
694
777
  createTime?: Date;
695
778
  /**
779
+ * @public
696
780
  * <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
697
781
  * is returned as a string</i>.</p>
698
782
  */
699
783
  updateTime?: Date;
700
784
  /**
785
+ * @public
701
786
  * <p>Maximum number of messages per second that can be sent to the room (by all clients).
702
787
  * Default: 10.</p>
703
788
  */
704
789
  maximumMessageRatePerSecond?: number;
705
790
  /**
791
+ * @public
706
792
  * <p>Maximum number of characters in a single message. Messages are expected to be UTF-8
707
793
  * encoded and this limit applies specifically to rune/code-point count, not number of bytes.
708
794
  * Default: 500.</p>
709
795
  */
710
796
  maximumMessageLength?: number;
711
797
  /**
798
+ * @public
712
799
  * <p>Configuration information for optional review of messages.</p>
713
800
  */
714
801
  messageReviewHandler?: MessageReviewHandler;
715
802
  /**
803
+ * @public
716
804
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
717
805
  * (key:value)</code>.</p>
718
806
  */
719
807
  tags?: Record<string, string>;
720
808
  /**
809
+ * @public
721
810
  * <p>Array of logging configurations attached to the room.</p>
722
811
  */
723
812
  loggingConfigurationIdentifiers?: string[];
@@ -727,11 +816,13 @@ export interface GetRoomResponse {
727
816
  */
728
817
  export interface ListLoggingConfigurationsRequest {
729
818
  /**
819
+ * @public
730
820
  * <p>The first logging configurations to retrieve. This is used for pagination; see the
731
821
  * <code>nextToken</code> response field.</p>
732
822
  */
733
823
  nextToken?: string;
734
824
  /**
825
+ * @public
735
826
  * <p>Maximum number of logging configurations to return. Default: 50.</p>
736
827
  */
737
828
  maxResults?: number;
@@ -742,39 +833,47 @@ export interface ListLoggingConfigurationsRequest {
742
833
  */
743
834
  export interface LoggingConfigurationSummary {
744
835
  /**
836
+ * @public
745
837
  * <p>Logging-configuration ARN.</p>
746
838
  */
747
839
  arn?: string;
748
840
  /**
841
+ * @public
749
842
  * <p>Logging-configuration ID, generated by the system. This is a relative identifier, the part
750
843
  * of the ARN that uniquely identifies the room.</p>
751
844
  */
752
845
  id?: string;
753
846
  /**
847
+ * @public
754
848
  * <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
755
849
  * <i>note that this is returned as a string</i>.</p>
756
850
  */
757
851
  createTime?: Date;
758
852
  /**
853
+ * @public
759
854
  * <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
760
855
  * <i>note that this is returned as a string</i>.</p>
761
856
  */
762
857
  updateTime?: Date;
763
858
  /**
859
+ * @public
764
860
  * <p>Logging-configuration name. The value does not need to be unique.</p>
765
861
  */
766
862
  name?: string;
767
863
  /**
864
+ * @public
768
865
  * <p>A complex type that contains a destination configuration for where chat content will be
769
866
  * logged.</p>
770
867
  */
771
868
  destinationConfiguration?: DestinationConfiguration;
772
869
  /**
870
+ * @public
773
871
  * <p>The state of the logging configuration. When this is <code>ACTIVE</code>, the
774
872
  * configuration is ready for logging chat content.</p>
775
873
  */
776
874
  state?: LoggingConfigurationState | string;
777
875
  /**
876
+ * @public
778
877
  * <p>Tags to attach to the resource. Array of maps, each of the form <code>string:string
779
878
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
780
879
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -788,12 +887,14 @@ export interface LoggingConfigurationSummary {
788
887
  */
789
888
  export interface ListLoggingConfigurationsResponse {
790
889
  /**
890
+ * @public
791
891
  * <p>List of the matching logging configurations (summary information only). There is only
792
892
  * one type of destination (<code>cloudWatchLogs</code>, <code>firehose</code>, or
793
893
  * <code>s3</code>) in a <code>destinationConfiguration</code>.</p>
794
894
  */
795
895
  loggingConfigurations: LoggingConfigurationSummary[] | undefined;
796
896
  /**
897
+ * @public
797
898
  * <p>If there are more logging configurations than <code>maxResults</code>, use
798
899
  * <code>nextToken</code> in the request to get the next set.</p>
799
900
  */
@@ -804,23 +905,28 @@ export interface ListLoggingConfigurationsResponse {
804
905
  */
805
906
  export interface ListRoomsRequest {
806
907
  /**
908
+ * @public
807
909
  * <p>Filters the list to match the specified room name.</p>
808
910
  */
809
911
  name?: string;
810
912
  /**
913
+ * @public
811
914
  * <p>The first room to retrieve. This is used for pagination; see the <code>nextToken</code>
812
915
  * response field.</p>
813
916
  */
814
917
  nextToken?: string;
815
918
  /**
919
+ * @public
816
920
  * <p>Maximum number of rooms to return. Default: 50.</p>
817
921
  */
818
922
  maxResults?: number;
819
923
  /**
924
+ * @public
820
925
  * <p>Filters the list to match the specified message review handler URI.</p>
821
926
  */
822
927
  messageReviewHandlerUri?: string;
823
928
  /**
929
+ * @public
824
930
  * <p>Logging-configuration identifier.</p>
825
931
  */
826
932
  loggingConfigurationIdentifier?: string;
@@ -831,33 +937,40 @@ export interface ListRoomsRequest {
831
937
  */
832
938
  export interface RoomSummary {
833
939
  /**
940
+ * @public
834
941
  * <p>Room ARN.</p>
835
942
  */
836
943
  arn?: string;
837
944
  /**
945
+ * @public
838
946
  * <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN that
839
947
  * uniquely identifies the room.</p>
840
948
  */
841
949
  id?: string;
842
950
  /**
951
+ * @public
843
952
  * <p>Room name. The value does not need to be unique.</p>
844
953
  */
845
954
  name?: string;
846
955
  /**
956
+ * @public
847
957
  * <p>Configuration information for optional review of messages.</p>
848
958
  */
849
959
  messageReviewHandler?: MessageReviewHandler;
850
960
  /**
961
+ * @public
851
962
  * <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this is
852
963
  * returned as a string</i>. </p>
853
964
  */
854
965
  createTime?: Date;
855
966
  /**
967
+ * @public
856
968
  * <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this is
857
969
  * returned as a string</i>. </p>
858
970
  */
859
971
  updateTime?: Date;
860
972
  /**
973
+ * @public
861
974
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
862
975
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
863
976
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -866,6 +979,7 @@ export interface RoomSummary {
866
979
  */
867
980
  tags?: Record<string, string>;
868
981
  /**
982
+ * @public
869
983
  * <p>List of logging-configuration identifiers attached to the room.</p>
870
984
  */
871
985
  loggingConfigurationIdentifiers?: string[];
@@ -875,10 +989,12 @@ export interface RoomSummary {
875
989
  */
876
990
  export interface ListRoomsResponse {
877
991
  /**
992
+ * @public
878
993
  * <p>List of the matching rooms (summary information only).</p>
879
994
  */
880
995
  rooms: RoomSummary[] | undefined;
881
996
  /**
997
+ * @public
882
998
  * <p>If there are more rooms than <code>maxResults</code>, use <code>nextToken</code> in the
883
999
  * request to get the next set.</p>
884
1000
  */
@@ -901,6 +1017,7 @@ export declare class InternalServerException extends __BaseException {
901
1017
  */
902
1018
  export interface ListTagsForResourceRequest {
903
1019
  /**
1020
+ * @public
904
1021
  * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
905
1022
  */
906
1023
  resourceArn: string | undefined;
@@ -910,6 +1027,7 @@ export interface ListTagsForResourceRequest {
910
1027
  */
911
1028
  export interface ListTagsForResourceResponse {
912
1029
  /**
1030
+ * @public
913
1031
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
914
1032
  * (key:value)</code>.</p>
915
1033
  */
@@ -920,15 +1038,18 @@ export interface ListTagsForResourceResponse {
920
1038
  */
921
1039
  export interface SendEventRequest {
922
1040
  /**
1041
+ * @public
923
1042
  * <p>Identifier of the room to which the event will be sent. Currently this must be an
924
1043
  * ARN.</p>
925
1044
  */
926
1045
  roomIdentifier: string | undefined;
927
1046
  /**
1047
+ * @public
928
1048
  * <p>Application-defined name of the event to send to clients.</p>
929
1049
  */
930
1050
  eventName: string | undefined;
931
1051
  /**
1052
+ * @public
932
1053
  * <p>Application-defined metadata to attach to the event sent to clients. The maximum length
933
1054
  * of the metadata is 1 KB total.</p>
934
1055
  */
@@ -939,6 +1060,7 @@ export interface SendEventRequest {
939
1060
  */
940
1061
  export interface SendEventResponse {
941
1062
  /**
1063
+ * @public
942
1064
  * <p>An identifier generated by Amazon IVS Chat. This identifier must be used in subsequent
943
1065
  * operations for this message, such as DeleteMessage.</p>
944
1066
  */
@@ -949,10 +1071,12 @@ export interface SendEventResponse {
949
1071
  */
950
1072
  export interface TagResourceRequest {
951
1073
  /**
1074
+ * @public
952
1075
  * <p>The ARN of the resource to be tagged. The ARN must be URL-encoded.</p>
953
1076
  */
954
1077
  resourceArn: string | undefined;
955
1078
  /**
1079
+ * @public
956
1080
  * <p>Array of tags to be added or updated. Array of maps, each of the form
957
1081
  * <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
958
1082
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -971,10 +1095,12 @@ export interface TagResourceResponse {
971
1095
  */
972
1096
  export interface UntagResourceRequest {
973
1097
  /**
1098
+ * @public
974
1099
  * <p>The ARN of the resource to be untagged. The ARN must be URL-encoded.</p>
975
1100
  */
976
1101
  resourceArn: string | undefined;
977
1102
  /**
1103
+ * @public
978
1104
  * <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
979
1105
  * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
980
1106
  * Resources</a> for details, including restrictions that apply to tags and "Tag naming
@@ -993,14 +1119,17 @@ export interface UntagResourceResponse {
993
1119
  */
994
1120
  export interface UpdateLoggingConfigurationRequest {
995
1121
  /**
1122
+ * @public
996
1123
  * <p>Identifier of the logging configuration to be updated.</p>
997
1124
  */
998
1125
  identifier: string | undefined;
999
1126
  /**
1127
+ * @public
1000
1128
  * <p>Logging-configuration name. The value does not need to be unique.</p>
1001
1129
  */
1002
1130
  name?: string;
1003
1131
  /**
1132
+ * @public
1004
1133
  * <p>A complex type that contains a destination configuration for where chat content will be
1005
1134
  * logged. There can be only one type of destination (<code>cloudWatchLogs</code>,
1006
1135
  * <code>firehose</code>, or <code>s3</code>) in a
@@ -1024,30 +1153,36 @@ export type UpdateLoggingConfigurationState = (typeof UpdateLoggingConfiguration
1024
1153
  */
1025
1154
  export interface UpdateLoggingConfigurationResponse {
1026
1155
  /**
1156
+ * @public
1027
1157
  * <p>Logging-configuration ARN, from the request (if <code>identifier</code> was an
1028
1158
  * ARN).</p>
1029
1159
  */
1030
1160
  arn?: string;
1031
1161
  /**
1162
+ * @public
1032
1163
  * <p>Logging-configuration ID, generated by the system. This is a relative identifier, the
1033
1164
  * part of the ARN that uniquely identifies the room.</p>
1034
1165
  */
1035
1166
  id?: string;
1036
1167
  /**
1168
+ * @public
1037
1169
  * <p>Time when the logging configuration was created. This is an ISO 8601 timestamp;
1038
1170
  * <i>note that this is returned as a string</i>.</p>
1039
1171
  */
1040
1172
  createTime?: Date;
1041
1173
  /**
1174
+ * @public
1042
1175
  * <p>Time of the logging configuration’s last update. This is an ISO 8601 timestamp;
1043
1176
  * <i>note that this is returned as a string</i>.</p>
1044
1177
  */
1045
1178
  updateTime?: Date;
1046
1179
  /**
1180
+ * @public
1047
1181
  * <p>Logging-configuration name, from the request (if specified).</p>
1048
1182
  */
1049
1183
  name?: string;
1050
1184
  /**
1185
+ * @public
1051
1186
  * <p>A complex type that contains a destination configuration for where chat content will be
1052
1187
  * logged, from the request. There is only one type of destination
1053
1188
  * (<code>cloudWatchLogs</code>, <code>firehose</code>, or <code>s3</code>) in a
@@ -1055,11 +1190,13 @@ export interface UpdateLoggingConfigurationResponse {
1055
1190
  */
1056
1191
  destinationConfiguration?: DestinationConfiguration;
1057
1192
  /**
1193
+ * @public
1058
1194
  * <p>The state of the logging configuration. When the state is <code>ACTIVE</code>, the
1059
1195
  * configuration is ready to log chat content.</p>
1060
1196
  */
1061
1197
  state?: UpdateLoggingConfigurationState | string;
1062
1198
  /**
1199
+ * @public
1063
1200
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1064
1201
  * (key:value)</code>. </p>
1065
1202
  */
@@ -1070,31 +1207,37 @@ export interface UpdateLoggingConfigurationResponse {
1070
1207
  */
1071
1208
  export interface UpdateRoomRequest {
1072
1209
  /**
1210
+ * @public
1073
1211
  * <p>Identifier of the room to be updated. Currently this must be an ARN.</p>
1074
1212
  */
1075
1213
  identifier: string | undefined;
1076
1214
  /**
1215
+ * @public
1077
1216
  * <p>Room name. The value does not need to be unique.</p>
1078
1217
  */
1079
1218
  name?: string;
1080
1219
  /**
1220
+ * @public
1081
1221
  * <p>Maximum number of messages per second that can be sent to the room (by all clients).
1082
1222
  * Default: 10.</p>
1083
1223
  */
1084
1224
  maximumMessageRatePerSecond?: number;
1085
1225
  /**
1226
+ * @public
1086
1227
  * <p>The maximum number of characters in a single message. Messages are expected to be UTF-8
1087
1228
  * encoded and this limit applies specifically to rune/code-point count, not number of bytes.
1088
1229
  * Default: 500.</p>
1089
1230
  */
1090
1231
  maximumMessageLength?: number;
1091
1232
  /**
1233
+ * @public
1092
1234
  * <p>Configuration information for optional review of messages. Specify an empty
1093
1235
  * <code>uri</code> string to disassociate a message review handler from the specified
1094
1236
  * room.</p>
1095
1237
  */
1096
1238
  messageReviewHandler?: MessageReviewHandler;
1097
1239
  /**
1240
+ * @public
1098
1241
  * <p>Array of logging-configuration identifiers attached to the room.</p>
1099
1242
  */
1100
1243
  loggingConfigurationIdentifiers?: string[];
@@ -1104,48 +1247,58 @@ export interface UpdateRoomRequest {
1104
1247
  */
1105
1248
  export interface UpdateRoomResponse {
1106
1249
  /**
1250
+ * @public
1107
1251
  * <p>Room ARN, from the request (if <code>identifier</code> was an ARN).</p>
1108
1252
  */
1109
1253
  arn?: string;
1110
1254
  /**
1255
+ * @public
1111
1256
  * <p>Room ID, generated by the system. This is a relative identifier, the part of the ARN
1112
1257
  * that uniquely identifies the room.</p>
1113
1258
  */
1114
1259
  id?: string;
1115
1260
  /**
1261
+ * @public
1116
1262
  * <p>Room name, from the request (if specified).</p>
1117
1263
  */
1118
1264
  name?: string;
1119
1265
  /**
1266
+ * @public
1120
1267
  * <p>Time when the room was created. This is an ISO 8601 timestamp; <i>note that this
1121
1268
  * is returned as a string</i>.</p>
1122
1269
  */
1123
1270
  createTime?: Date;
1124
1271
  /**
1272
+ * @public
1125
1273
  * <p>Time of the room’s last update. This is an ISO 8601 timestamp; <i>note that this
1126
1274
  * is returned as a string</i>.</p>
1127
1275
  */
1128
1276
  updateTime?: Date;
1129
1277
  /**
1278
+ * @public
1130
1279
  * <p>Maximum number of messages per second that can be sent to the room (by all clients),
1131
1280
  * from the request (if specified).</p>
1132
1281
  */
1133
1282
  maximumMessageRatePerSecond?: number;
1134
1283
  /**
1284
+ * @public
1135
1285
  * <p>Maximum number of characters in a single message, from the request (if
1136
1286
  * specified).</p>
1137
1287
  */
1138
1288
  maximumMessageLength?: number;
1139
1289
  /**
1290
+ * @public
1140
1291
  * <p>Configuration information for optional review of messages.</p>
1141
1292
  */
1142
1293
  messageReviewHandler?: MessageReviewHandler;
1143
1294
  /**
1295
+ * @public
1144
1296
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1145
1297
  * (key:value)</code>.</p>
1146
1298
  */
1147
1299
  tags?: Record<string, string>;
1148
1300
  /**
1301
+ * @public
1149
1302
  * <p>Array of logging configurations attached to the room, from the request (if
1150
1303
  * specified).</p>
1151
1304
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivschat",
3
3
  "description": "AWS SDK for JavaScript Ivschat Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",