@aws-sdk/client-chime-sdk-meetings 3.378.0 → 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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -7,6 +7,7 @@
7
7
  */
8
8
  export * from "./ChimeSDKMeetingsClient";
9
9
  export * from "./ChimeSDKMeetings";
10
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
10
11
  export * from "./commands";
11
12
  export * from "./pagination";
12
13
  export * from "./models";
@@ -40,14 +40,17 @@ export type MediaCapabilities = (typeof MediaCapabilities)[keyof typeof MediaCap
40
40
  */
41
41
  export interface AttendeeCapabilities {
42
42
  /**
43
+ * @public
43
44
  * <p>The audio capability assigned to an attendee.</p>
44
45
  */
45
46
  Audio: MediaCapabilities | string | undefined;
46
47
  /**
48
+ * @public
47
49
  * <p>The video capability assigned to an attendee.</p>
48
50
  */
49
51
  Video: MediaCapabilities | string | undefined;
50
52
  /**
53
+ * @public
51
54
  * <p>The content capability assigned to an attendee.</p>
52
55
  */
53
56
  Content: MediaCapabilities | string | undefined;
@@ -69,6 +72,7 @@ export interface AttendeeCapabilities {
69
72
  */
70
73
  export interface Attendee {
71
74
  /**
75
+ * @public
72
76
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
73
77
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
74
78
  * </p>
@@ -77,14 +81,17 @@ export interface Attendee {
77
81
  */
78
82
  ExternalUserId?: string;
79
83
  /**
84
+ * @public
80
85
  * <p>The Amazon Chime SDK attendee ID.</p>
81
86
  */
82
87
  AttendeeId?: string;
83
88
  /**
89
+ * @public
84
90
  * <p>The join token used by the Amazon Chime SDK attendee.</p>
85
91
  */
86
92
  JoinToken?: string;
87
93
  /**
94
+ * @public
88
95
  * <p>The capabilities assigned to an attendee: audio, video, or content.</p>
89
96
  * <note>
90
97
  * <p>You use the capabilities with a set of values that control what the capabilities can do, such as <code>SendReceive</code> data. For more information about those values, see
@@ -115,6 +122,7 @@ export interface Attendee {
115
122
  */
116
123
  export interface AttendeeIdItem {
117
124
  /**
125
+ * @public
118
126
  * <p>A list of one or more attendee IDs.</p>
119
127
  */
120
128
  AttendeeId: string | undefined;
@@ -137,6 +145,7 @@ export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof Me
137
145
  */
138
146
  export interface AudioFeatures {
139
147
  /**
148
+ * @public
140
149
  * <p>Makes echo reduction available to clients who connect to the meeting.</p>
141
150
  */
142
151
  EchoReduction?: MeetingFeatureStatus | string;
@@ -151,6 +160,7 @@ export declare class BadRequestException extends __BaseException {
151
160
  Code?: string;
152
161
  Message?: string;
153
162
  /**
163
+ * @public
154
164
  * <p>The request id associated with the call responsible for the exception.</p>
155
165
  */
156
166
  RequestId?: string;
@@ -165,6 +175,7 @@ export declare class BadRequestException extends __BaseException {
165
175
  */
166
176
  export interface CreateAttendeeRequestItem {
167
177
  /**
178
+ * @public
168
179
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
169
180
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
170
181
  * </p>
@@ -173,6 +184,7 @@ export interface CreateAttendeeRequestItem {
173
184
  */
174
185
  ExternalUserId: string | undefined;
175
186
  /**
187
+ * @public
176
188
  * <p>A list of one or more capabilities.</p>
177
189
  */
178
190
  Capabilities?: AttendeeCapabilities;
@@ -182,10 +194,12 @@ export interface CreateAttendeeRequestItem {
182
194
  */
183
195
  export interface BatchCreateAttendeeRequest {
184
196
  /**
197
+ * @public
185
198
  * <p>The Amazon Chime SDK ID of the meeting to which you're adding attendees.</p>
186
199
  */
187
200
  MeetingId: string | undefined;
188
201
  /**
202
+ * @public
189
203
  * <p>The attendee information, including attendees' IDs and join tokens.</p>
190
204
  */
191
205
  Attendees: CreateAttendeeRequestItem[] | undefined;
@@ -196,6 +210,7 @@ export interface BatchCreateAttendeeRequest {
196
210
  */
197
211
  export interface CreateAttendeeError {
198
212
  /**
213
+ * @public
199
214
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
200
215
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
201
216
  * </p>
@@ -204,10 +219,12 @@ export interface CreateAttendeeError {
204
219
  */
205
220
  ExternalUserId?: string;
206
221
  /**
222
+ * @public
207
223
  * <p>The error code.</p>
208
224
  */
209
225
  ErrorCode?: string;
210
226
  /**
227
+ * @public
211
228
  * <p>The error message.</p>
212
229
  */
213
230
  ErrorMessage?: string;
@@ -217,10 +234,12 @@ export interface CreateAttendeeError {
217
234
  */
218
235
  export interface BatchCreateAttendeeResponse {
219
236
  /**
237
+ * @public
220
238
  * <p>The attendee information, including attendees' IDs and join tokens.</p>
221
239
  */
222
240
  Attendees?: Attendee[];
223
241
  /**
242
+ * @public
224
243
  * <p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>
225
244
  */
226
245
  Errors?: CreateAttendeeError[];
@@ -235,6 +254,7 @@ export declare class ForbiddenException extends __BaseException {
235
254
  Code?: string;
236
255
  Message?: string;
237
256
  /**
257
+ * @public
238
258
  * <p>The request id associated with the call responsible for the exception.</p>
239
259
  */
240
260
  RequestId?: string;
@@ -253,6 +273,7 @@ export declare class LimitExceededException extends __BaseException {
253
273
  Code?: string;
254
274
  Message?: string;
255
275
  /**
276
+ * @public
256
277
  * <p>The request id associated with the call responsible for the exception.</p>
257
278
  */
258
279
  RequestId?: string;
@@ -271,6 +292,7 @@ export declare class NotFoundException extends __BaseException {
271
292
  Code?: string;
272
293
  Message?: string;
273
294
  /**
295
+ * @public
274
296
  * <p>The request ID associated with the call responsible for the exception.</p>
275
297
  */
276
298
  RequestId?: string;
@@ -289,6 +311,7 @@ export declare class ServiceFailureException extends __BaseException {
289
311
  Code?: string;
290
312
  Message?: string;
291
313
  /**
314
+ * @public
292
315
  * <p>The ID of the failed request.</p>
293
316
  */
294
317
  RequestId?: string;
@@ -307,10 +330,12 @@ export declare class ServiceUnavailableException extends __BaseException {
307
330
  Code?: string;
308
331
  Message?: string;
309
332
  /**
333
+ * @public
310
334
  * <p>The request id associated with the call responsible for the exception.</p>
311
335
  */
312
336
  RequestId?: string;
313
337
  /**
338
+ * @public
314
339
  * <p>The number of seconds the caller should wait before retrying.</p>
315
340
  */
316
341
  RetryAfterSeconds?: string;
@@ -329,6 +354,7 @@ export declare class ThrottlingException extends __BaseException {
329
354
  Code?: string;
330
355
  Message?: string;
331
356
  /**
357
+ * @public
332
358
  * <p>The ID of the request that exceeded the throttling limit.</p>
333
359
  */
334
360
  RequestId?: string;
@@ -347,6 +373,7 @@ export declare class UnauthorizedException extends __BaseException {
347
373
  Code?: string;
348
374
  Message?: string;
349
375
  /**
376
+ * @public
350
377
  * <p>The request id associated with the call responsible for the exception.</p>
351
378
  */
352
379
  RequestId?: string;
@@ -365,6 +392,7 @@ export declare class UnprocessableEntityException extends __BaseException {
365
392
  Code?: string;
366
393
  Message?: string;
367
394
  /**
395
+ * @public
368
396
  * <p>The request id associated with the call responsible for the exception.</p>
369
397
  */
370
398
  RequestId?: string;
@@ -378,14 +406,17 @@ export declare class UnprocessableEntityException extends __BaseException {
378
406
  */
379
407
  export interface BatchUpdateAttendeeCapabilitiesExceptRequest {
380
408
  /**
409
+ * @public
381
410
  * <p>The ID of the meeting associated with the update request.</p>
382
411
  */
383
412
  MeetingId: string | undefined;
384
413
  /**
414
+ * @public
385
415
  * <p>The <code>AttendeeIDs</code> that you want to exclude from one or more capabilities.</p>
386
416
  */
387
417
  ExcludedAttendeeIds: AttendeeIdItem[] | undefined;
388
418
  /**
419
+ * @public
389
420
  * <p>The capabilities (<code>audio</code>, <code>video</code>, or <code>content</code>) that you want to update.</p>
390
421
  */
391
422
  Capabilities: AttendeeCapabilities | undefined;
@@ -400,6 +431,7 @@ export declare class ConflictException extends __BaseException {
400
431
  Code?: string;
401
432
  Message?: string;
402
433
  /**
434
+ * @public
403
435
  * <p>The ID of the request involved in the conflict.</p>
404
436
  */
405
437
  RequestId?: string;
@@ -413,10 +445,12 @@ export declare class ConflictException extends __BaseException {
413
445
  */
414
446
  export interface CreateAttendeeRequest {
415
447
  /**
448
+ * @public
416
449
  * <p>The unique ID of the meeting.</p>
417
450
  */
418
451
  MeetingId: string | undefined;
419
452
  /**
453
+ * @public
420
454
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
421
455
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
422
456
  * </p>
@@ -425,6 +459,7 @@ export interface CreateAttendeeRequest {
425
459
  */
426
460
  ExternalUserId: string | undefined;
427
461
  /**
462
+ * @public
428
463
  * <p>The capabilities (<code>audio</code>, <code>video</code>, or <code>content</code>) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on
429
464
  * all media channels by default.</p>
430
465
  * <note>
@@ -455,6 +490,7 @@ export interface CreateAttendeeRequest {
455
490
  */
456
491
  export interface CreateAttendeeResponse {
457
492
  /**
493
+ * @public
458
494
  * <p>The attendee information, including attendee ID and join token.</p>
459
495
  */
460
496
  Attendee?: Attendee;
@@ -465,6 +501,7 @@ export interface CreateAttendeeResponse {
465
501
  */
466
502
  export interface MeetingFeaturesConfiguration {
467
503
  /**
504
+ * @public
468
505
  * <p>The configuration settings for the audio features available to a meeting.</p>
469
506
  */
470
507
  Audio?: AudioFeatures;
@@ -475,14 +512,17 @@ export interface MeetingFeaturesConfiguration {
475
512
  */
476
513
  export interface NotificationsConfiguration {
477
514
  /**
515
+ * @public
478
516
  * <p>The ARN of the AWS Lambda function in the notifications configuration.</p>
479
517
  */
480
518
  LambdaFunctionArn?: string;
481
519
  /**
520
+ * @public
482
521
  * <p>The ARN of the SNS topic.</p>
483
522
  */
484
523
  SnsTopicArn?: string;
485
524
  /**
525
+ * @public
486
526
  * <p>The ARN of the SQS queue.</p>
487
527
  */
488
528
  SqsQueueArn?: string;
@@ -493,10 +533,12 @@ export interface NotificationsConfiguration {
493
533
  */
494
534
  export interface Tag {
495
535
  /**
536
+ * @public
496
537
  * <p>The tag's key.</p>
497
538
  */
498
539
  Key: string | undefined;
499
540
  /**
541
+ * @public
500
542
  * <p>The tag's value.</p>
501
543
  */
502
544
  Value: string | undefined;
@@ -506,10 +548,12 @@ export interface Tag {
506
548
  */
507
549
  export interface CreateMeetingRequest {
508
550
  /**
551
+ * @public
509
552
  * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
510
553
  */
511
554
  ClientRequestToken?: string;
512
555
  /**
556
+ * @public
513
557
  * <p>The Region in which to create the meeting.</p>
514
558
  * <p>
515
559
  * Available values:
@@ -536,10 +580,12 @@ export interface CreateMeetingRequest {
536
580
  */
537
581
  MediaRegion: string | undefined;
538
582
  /**
583
+ * @public
539
584
  * <p>Reserved.</p>
540
585
  */
541
586
  MeetingHostId?: string;
542
587
  /**
588
+ * @public
543
589
  * <p>The external meeting ID.</p>
544
590
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
545
591
  * </p>
@@ -548,22 +594,27 @@ export interface CreateMeetingRequest {
548
594
  */
549
595
  ExternalMeetingId: string | undefined;
550
596
  /**
597
+ * @public
551
598
  * <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
552
599
  */
553
600
  NotificationsConfiguration?: NotificationsConfiguration;
554
601
  /**
602
+ * @public
555
603
  * <p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>
556
604
  */
557
605
  MeetingFeatures?: MeetingFeaturesConfiguration;
558
606
  /**
607
+ * @public
559
608
  * <p>When specified, replicates the media from the primary meeting to the new meeting.</p>
560
609
  */
561
610
  PrimaryMeetingId?: string;
562
611
  /**
612
+ * @public
563
613
  * <p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>
564
614
  */
565
615
  TenantIds?: string[];
566
616
  /**
617
+ * @public
567
618
  * <p>Applies one or more tags to an Amazon Chime SDK meeting. Note the following:</p>
568
619
  * <ul>
569
620
  * <li>
@@ -611,34 +662,42 @@ export interface CreateMeetingRequest {
611
662
  */
612
663
  export interface MediaPlacement {
613
664
  /**
665
+ * @public
614
666
  * <p>The audio host URL.</p>
615
667
  */
616
668
  AudioHostUrl?: string;
617
669
  /**
670
+ * @public
618
671
  * <p>The audio fallback URL.</p>
619
672
  */
620
673
  AudioFallbackUrl?: string;
621
674
  /**
675
+ * @public
622
676
  * <p>The signaling URL.</p>
623
677
  */
624
678
  SignalingUrl?: string;
625
679
  /**
680
+ * @public
626
681
  * <p>The turn control URL.</p>
627
682
  */
628
683
  TurnControlUrl?: string;
629
684
  /**
685
+ * @public
630
686
  * <p>The screen data URL.</p>
631
687
  */
632
688
  ScreenDataUrl?: string;
633
689
  /**
690
+ * @public
634
691
  * <p>The screen viewing URL.</p>
635
692
  */
636
693
  ScreenViewingUrl?: string;
637
694
  /**
695
+ * @public
638
696
  * <p>The screen sharing URL.</p>
639
697
  */
640
698
  ScreenSharingUrl?: string;
641
699
  /**
700
+ * @public
642
701
  * <p>The event ingestion URL.</p>
643
702
  */
644
703
  EventIngestionUrl?: string;
@@ -649,14 +708,17 @@ export interface MediaPlacement {
649
708
  */
650
709
  export interface Meeting {
651
710
  /**
711
+ * @public
652
712
  * <p>The Amazon Chime SDK meeting ID.</p>
653
713
  */
654
714
  MeetingId?: string;
655
715
  /**
716
+ * @public
656
717
  * <p>Reserved.</p>
657
718
  */
658
719
  MeetingHostId?: string;
659
720
  /**
721
+ * @public
660
722
  * <p>The external meeting ID.</p>
661
723
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
662
724
  * </p>
@@ -665,6 +727,7 @@ export interface Meeting {
665
727
  */
666
728
  ExternalMeetingId?: string;
667
729
  /**
730
+ * @public
668
731
  * <p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>,
669
732
  * <code>ap-northeast-2</code>, <code>ap-south-1</code>, <code>ap-southeast-1</code>, <code>ap-southeast-2</code>, <code>ca-central-1</code>,
670
733
  * <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>,
@@ -675,22 +738,27 @@ export interface Meeting {
675
738
  */
676
739
  MediaRegion?: string;
677
740
  /**
741
+ * @public
678
742
  * <p>The media placement for the meeting.</p>
679
743
  */
680
744
  MediaPlacement?: MediaPlacement;
681
745
  /**
746
+ * @public
682
747
  * <p>The features available to a meeting, such as echo reduction.</p>
683
748
  */
684
749
  MeetingFeatures?: MeetingFeaturesConfiguration;
685
750
  /**
751
+ * @public
686
752
  * <p>When specified, replicates the media from the primary meeting to this meeting.</p>
687
753
  */
688
754
  PrimaryMeetingId?: string;
689
755
  /**
756
+ * @public
690
757
  * <p>Array of strings.</p>
691
758
  */
692
759
  TenantIds?: string[];
693
760
  /**
761
+ * @public
694
762
  * <p>The ARN of the meeting.</p>
695
763
  */
696
764
  MeetingArn?: string;
@@ -700,6 +768,7 @@ export interface Meeting {
700
768
  */
701
769
  export interface CreateMeetingResponse {
702
770
  /**
771
+ * @public
703
772
  * <p>The meeting information, including the meeting ID and
704
773
  * <code>MediaPlacement</code>.</p>
705
774
  */
@@ -710,10 +779,12 @@ export interface CreateMeetingResponse {
710
779
  */
711
780
  export interface CreateMeetingWithAttendeesRequest {
712
781
  /**
782
+ * @public
713
783
  * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
714
784
  */
715
785
  ClientRequestToken?: string;
716
786
  /**
787
+ * @public
717
788
  * <p>The Region in which to create the meeting.</p>
718
789
  * <p>
719
790
  * Available values:
@@ -740,10 +811,12 @@ export interface CreateMeetingWithAttendeesRequest {
740
811
  */
741
812
  MediaRegion: string | undefined;
742
813
  /**
814
+ * @public
743
815
  * <p>Reserved.</p>
744
816
  */
745
817
  MeetingHostId?: string;
746
818
  /**
819
+ * @public
747
820
  * <p>The external meeting ID.</p>
748
821
  * <p>Pattern: <code>[-_&@+=,()\{\}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*</code>
749
822
  * </p>
@@ -752,26 +825,32 @@ export interface CreateMeetingWithAttendeesRequest {
752
825
  */
753
826
  ExternalMeetingId: string | undefined;
754
827
  /**
828
+ * @public
755
829
  * <p>Lists the audio and video features enabled for a meeting, such as echo reduction.</p>
756
830
  */
757
831
  MeetingFeatures?: MeetingFeaturesConfiguration;
758
832
  /**
833
+ * @public
759
834
  * <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
760
835
  */
761
836
  NotificationsConfiguration?: NotificationsConfiguration;
762
837
  /**
838
+ * @public
763
839
  * <p>The attendee information, including attendees' IDs and join tokens.</p>
764
840
  */
765
841
  Attendees: CreateAttendeeRequestItem[] | undefined;
766
842
  /**
843
+ * @public
767
844
  * <p>When specified, replicates the media from the primary meeting to the new meeting.</p>
768
845
  */
769
846
  PrimaryMeetingId?: string;
770
847
  /**
848
+ * @public
771
849
  * <p>A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.</p>
772
850
  */
773
851
  TenantIds?: string[];
774
852
  /**
853
+ * @public
775
854
  * <p>The tags in the request.</p>
776
855
  */
777
856
  Tags?: Tag[];
@@ -781,15 +860,18 @@ export interface CreateMeetingWithAttendeesRequest {
781
860
  */
782
861
  export interface CreateMeetingWithAttendeesResponse {
783
862
  /**
863
+ * @public
784
864
  * <p>The meeting information, including the meeting ID and
785
865
  * <code>MediaPlacement</code>.</p>
786
866
  */
787
867
  Meeting?: Meeting;
788
868
  /**
869
+ * @public
789
870
  * <p>The attendee information, including attendees' IDs and join tokens.</p>
790
871
  */
791
872
  Attendees?: Attendee[];
792
873
  /**
874
+ * @public
793
875
  * <p>If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.</p>
794
876
  */
795
877
  Errors?: CreateAttendeeError[];
@@ -799,10 +881,12 @@ export interface CreateMeetingWithAttendeesResponse {
799
881
  */
800
882
  export interface DeleteAttendeeRequest {
801
883
  /**
884
+ * @public
802
885
  * <p>The Amazon Chime SDK meeting ID.</p>
803
886
  */
804
887
  MeetingId: string | undefined;
805
888
  /**
889
+ * @public
806
890
  * <p>The Amazon Chime SDK attendee ID.</p>
807
891
  */
808
892
  AttendeeId: string | undefined;
@@ -812,6 +896,7 @@ export interface DeleteAttendeeRequest {
812
896
  */
813
897
  export interface DeleteMeetingRequest {
814
898
  /**
899
+ * @public
815
900
  * <p>The Amazon Chime SDK meeting ID.</p>
816
901
  */
817
902
  MeetingId: string | undefined;
@@ -821,10 +906,12 @@ export interface DeleteMeetingRequest {
821
906
  */
822
907
  export interface GetAttendeeRequest {
823
908
  /**
909
+ * @public
824
910
  * <p>The Amazon Chime SDK meeting ID.</p>
825
911
  */
826
912
  MeetingId: string | undefined;
827
913
  /**
914
+ * @public
828
915
  * <p>The Amazon Chime SDK attendee ID.</p>
829
916
  */
830
917
  AttendeeId: string | undefined;
@@ -834,6 +921,7 @@ export interface GetAttendeeRequest {
834
921
  */
835
922
  export interface GetAttendeeResponse {
836
923
  /**
924
+ * @public
837
925
  * <p>The Amazon Chime SDK attendee information.</p>
838
926
  */
839
927
  Attendee?: Attendee;
@@ -843,6 +931,7 @@ export interface GetAttendeeResponse {
843
931
  */
844
932
  export interface GetMeetingRequest {
845
933
  /**
934
+ * @public
846
935
  * <p>The Amazon Chime SDK meeting ID.</p>
847
936
  */
848
937
  MeetingId: string | undefined;
@@ -852,6 +941,7 @@ export interface GetMeetingRequest {
852
941
  */
853
942
  export interface GetMeetingResponse {
854
943
  /**
944
+ * @public
855
945
  * <p>The Amazon Chime SDK meeting information.</p>
856
946
  */
857
947
  Meeting?: Meeting;
@@ -861,14 +951,17 @@ export interface GetMeetingResponse {
861
951
  */
862
952
  export interface ListAttendeesRequest {
863
953
  /**
954
+ * @public
864
955
  * <p>The Amazon Chime SDK meeting ID.</p>
865
956
  */
866
957
  MeetingId: string | undefined;
867
958
  /**
959
+ * @public
868
960
  * <p>The token to use to retrieve the next page of results.</p>
869
961
  */
870
962
  NextToken?: string;
871
963
  /**
964
+ * @public
872
965
  * <p>The maximum number of results to return in a single call.</p>
873
966
  */
874
967
  MaxResults?: number;
@@ -878,10 +971,12 @@ export interface ListAttendeesRequest {
878
971
  */
879
972
  export interface ListAttendeesResponse {
880
973
  /**
974
+ * @public
881
975
  * <p>The Amazon Chime SDK attendee information.</p>
882
976
  */
883
977
  Attendees?: Attendee[];
884
978
  /**
979
+ * @public
885
980
  * <p>The token to use to retrieve the next page of results.</p>
886
981
  */
887
982
  NextToken?: string;
@@ -891,6 +986,7 @@ export interface ListAttendeesResponse {
891
986
  */
892
987
  export interface ListTagsForResourceRequest {
893
988
  /**
989
+ * @public
894
990
  * <p>The ARN of the resource.</p>
895
991
  */
896
992
  ResourceARN: string | undefined;
@@ -900,6 +996,7 @@ export interface ListTagsForResourceRequest {
900
996
  */
901
997
  export interface ListTagsForResourceResponse {
902
998
  /**
999
+ * @public
903
1000
  * <p>The tags requested for the specified resource.</p>
904
1001
  */
905
1002
  Tags?: Tag[];
@@ -914,10 +1011,12 @@ export declare class ResourceNotFoundException extends __BaseException {
914
1011
  Code?: string;
915
1012
  Message?: string;
916
1013
  /**
1014
+ * @public
917
1015
  * <p>The ID of the resource that couldn't be found.</p>
918
1016
  */
919
1017
  RequestId?: string;
920
1018
  /**
1019
+ * @public
921
1020
  * <p>The name of the resource that couldn't be found.</p>
922
1021
  */
923
1022
  ResourceName?: string;
@@ -999,26 +1098,32 @@ export type TranscribeMedicalType = (typeof TranscribeMedicalType)[keyof typeof
999
1098
  */
1000
1099
  export interface EngineTranscribeMedicalSettings {
1001
1100
  /**
1101
+ * @public
1002
1102
  * <p>The language code specified for the Amazon Transcribe Medical engine.</p>
1003
1103
  */
1004
1104
  LanguageCode: TranscribeMedicalLanguageCode | string | undefined;
1005
1105
  /**
1106
+ * @public
1006
1107
  * <p>The specialty specified for the Amazon Transcribe Medical engine.</p>
1007
1108
  */
1008
1109
  Specialty: TranscribeMedicalSpecialty | string | undefined;
1009
1110
  /**
1111
+ * @public
1010
1112
  * <p>The type of transcription.</p>
1011
1113
  */
1012
1114
  Type: TranscribeMedicalType | string | undefined;
1013
1115
  /**
1116
+ * @public
1014
1117
  * <p>The name of the vocabulary passed to Amazon Transcribe Medical.</p>
1015
1118
  */
1016
1119
  VocabularyName?: string;
1017
1120
  /**
1121
+ * @public
1018
1122
  * <p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region. </p>
1019
1123
  */
1020
1124
  Region?: TranscribeMedicalRegion | string;
1021
1125
  /**
1126
+ * @public
1022
1127
  * <p>Set this field to <code>PHI</code> to identify personal health information in the transcription output.</p>
1023
1128
  */
1024
1129
  ContentIdentificationType?: TranscribeMedicalContentIdentificationType | string;
@@ -1128,11 +1233,13 @@ export type TranscribeVocabularyFilterMethod = (typeof TranscribeVocabularyFilte
1128
1233
  */
1129
1234
  export interface EngineTranscribeSettings {
1130
1235
  /**
1236
+ * @public
1131
1237
  * <p>Specify the language code that represents the language spoken.</p>
1132
1238
  * <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
1133
1239
  */
1134
1240
  LanguageCode?: TranscribeLanguageCode | string;
1135
1241
  /**
1242
+ * @public
1136
1243
  * <p>Specify how you want your vocabulary filter applied to your transcript.</p>
1137
1244
  * <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
1138
1245
  * <p>To delete words, choose <code>remove</code>.</p>
@@ -1140,12 +1247,14 @@ export interface EngineTranscribeSettings {
1140
1247
  */
1141
1248
  VocabularyFilterMethod?: TranscribeVocabularyFilterMethod | string;
1142
1249
  /**
1250
+ * @public
1143
1251
  * <p>Specify the name of the custom vocabulary filter that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive. </p>
1144
1252
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
1145
1253
  * <p>If you include <code>IdentifyLanguage</code> and want to use one or more vocabulary filters with your transcription, use the <code>VocabularyFilterNames</code> parameter instead.</p>
1146
1254
  */
1147
1255
  VocabularyFilterName?: string;
1148
1256
  /**
1257
+ * @public
1149
1258
  * <p>Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
1150
1259
  * <p>If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
1151
1260
  * <p>If you include <code>IdentifyLanguage</code> and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code>
@@ -1153,6 +1262,7 @@ export interface EngineTranscribeSettings {
1153
1262
  */
1154
1263
  VocabularyName?: string;
1155
1264
  /**
1265
+ * @public
1156
1266
  * <p>The AWS Region in which to use Amazon Transcribe.</p>
1157
1267
  * <p>If you don't specify a Region, then the <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html">MediaRegion</a> of the meeting is used.
1158
1268
  * However, if Amazon Transcribe is not available in the <code>MediaRegion</code>, then a <code>TranscriptFailed</code> event is sent.</p>
@@ -1162,15 +1272,18 @@ export interface EngineTranscribeSettings {
1162
1272
  */
1163
1273
  Region?: TranscribeRegion | string;
1164
1274
  /**
1275
+ * @public
1165
1276
  * <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</p>
1166
1277
  */
1167
1278
  EnablePartialResultsStabilization?: boolean;
1168
1279
  /**
1280
+ * @public
1169
1281
  * <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
1170
1282
  * <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
1171
1283
  */
1172
1284
  PartialResultsStability?: TranscribePartialResultsStability | string;
1173
1285
  /**
1286
+ * @public
1174
1287
  * <p>Labels all personally identifiable information (PII) identified in your transcript. If you don't include <code>PiiEntityTypes</code>, all PII is identified.</p>
1175
1288
  * <note>
1176
1289
  * <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>.</p>
@@ -1178,6 +1291,7 @@ export interface EngineTranscribeSettings {
1178
1291
  */
1179
1292
  ContentIdentificationType?: TranscribeContentIdentificationType | string;
1180
1293
  /**
1294
+ * @public
1181
1295
  * <p>Content redaction is performed at the segment level. If you don't include <code>PiiEntityTypes</code>, all PII is redacted.</p>
1182
1296
  * <note>
1183
1297
  * <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code>.</p>
@@ -1185,6 +1299,7 @@ export interface EngineTranscribeSettings {
1185
1299
  */
1186
1300
  ContentRedactionType?: TranscribeContentRedactionType | string;
1187
1301
  /**
1302
+ * @public
1188
1303
  * <p>Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
1189
1304
  * <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>, <code>CREDIT_DEBIT_EXPIRY</code>
1190
1305
  * <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>,<code>NAME</code>, <code>PHONE</code>, <code>PIN</code>,
@@ -1194,6 +1309,7 @@ export interface EngineTranscribeSettings {
1194
1309
  */
1195
1310
  PiiEntityTypes?: string;
1196
1311
  /**
1312
+ * @public
1197
1313
  * <p>Specify the name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.</p>
1198
1314
  * <p>The language of the specified language model must match the language code. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with
1199
1315
  * a language mismatch.</p>
@@ -1201,6 +1317,7 @@ export interface EngineTranscribeSettings {
1201
1317
  */
1202
1318
  LanguageModelName?: string;
1203
1319
  /**
1320
+ * @public
1204
1321
  * <p>Enables automatic language identification for your transcription.</p>
1205
1322
  * <p>If you include <code>IdentifyLanguage</code>, you can optionally use <code>LanguageOptions</code> to include a list of language codes that you think may be present in your audio stream.
1206
1323
  * Including language options can improve transcription accuracy.</p>
@@ -1210,6 +1327,7 @@ export interface EngineTranscribeSettings {
1210
1327
  */
1211
1328
  IdentifyLanguage?: boolean;
1212
1329
  /**
1330
+ * @public
1213
1331
  * <p>Specify two or more language codes that represent the languages you think may be present in your media; including more than five is not recommended. If you're unsure what languages
1214
1332
  * are present, do not include this parameter.</p>
1215
1333
  * <p>Including language options can improve the accuracy of language identification.</p>
@@ -1220,17 +1338,20 @@ export interface EngineTranscribeSettings {
1220
1338
  */
1221
1339
  LanguageOptions?: string;
1222
1340
  /**
1341
+ * @public
1223
1342
  * <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
1224
1343
  * <p>You can only use this parameter if you include <code>IdentifyLanguage</code> and <code>LanguageOptions</code>.</p>
1225
1344
  */
1226
1345
  PreferredLanguage?: TranscribeLanguageCode | string;
1227
1346
  /**
1347
+ * @public
1228
1348
  * <p>Specify the names of the custom vocabularies that you want to use when processing your transcription. Note that vocabulary names are case sensitive.</p>
1229
1349
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
1230
1350
  * <p>If you don't include <code>IdentifyLanguage</code> and want to use a custom vocabulary with your transcription, use the <code>VocabularyName</code> parameter instead.</p>
1231
1351
  */
1232
1352
  VocabularyNames?: string;
1233
1353
  /**
1354
+ * @public
1234
1355
  * <p>Specify the names of the custom vocabulary filters that you want to use when processing your transcription. Note that vocabulary filter names are case sensitive.</p>
1235
1356
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
1236
1357
  * <p> If you're <i>not</i> including <code>IdentifyLanguage</code> and want to use a custom vocabulary filter with your transcription, use the <code>VocabularyFilterName</code>
@@ -1244,10 +1365,12 @@ export interface EngineTranscribeSettings {
1244
1365
  */
1245
1366
  export interface TranscriptionConfiguration {
1246
1367
  /**
1368
+ * @public
1247
1369
  * <p>The transcription configuration settings passed to Amazon Transcribe.</p>
1248
1370
  */
1249
1371
  EngineTranscribeSettings?: EngineTranscribeSettings;
1250
1372
  /**
1373
+ * @public
1251
1374
  * <p>The transcription configuration settings passed to Amazon Transcribe Medical.</p>
1252
1375
  */
1253
1376
  EngineTranscribeMedicalSettings?: EngineTranscribeMedicalSettings;
@@ -1257,10 +1380,12 @@ export interface TranscriptionConfiguration {
1257
1380
  */
1258
1381
  export interface StartMeetingTranscriptionRequest {
1259
1382
  /**
1383
+ * @public
1260
1384
  * <p>The unique ID of the meeting being transcribed.</p>
1261
1385
  */
1262
1386
  MeetingId: string | undefined;
1263
1387
  /**
1388
+ * @public
1264
1389
  * <p>The configuration for the current transcription operation. Must contain <code>EngineTranscribeSettings</code> or
1265
1390
  * <code>EngineTranscribeMedicalSettings</code>.</p>
1266
1391
  */
@@ -1271,6 +1396,7 @@ export interface StartMeetingTranscriptionRequest {
1271
1396
  */
1272
1397
  export interface StopMeetingTranscriptionRequest {
1273
1398
  /**
1399
+ * @public
1274
1400
  * <p>The unique ID of the meeting for which you stop transcription.</p>
1275
1401
  */
1276
1402
  MeetingId: string | undefined;
@@ -1280,10 +1406,12 @@ export interface StopMeetingTranscriptionRequest {
1280
1406
  */
1281
1407
  export interface TagResourceRequest {
1282
1408
  /**
1409
+ * @public
1283
1410
  * <p>The ARN of the resource.</p>
1284
1411
  */
1285
1412
  ResourceARN: string | undefined;
1286
1413
  /**
1414
+ * @public
1287
1415
  * <p>Lists the requested tags.</p>
1288
1416
  */
1289
1417
  Tags: Tag[] | undefined;
@@ -1303,10 +1431,12 @@ export declare class TooManyTagsException extends __BaseException {
1303
1431
  Code?: string;
1304
1432
  Message?: string;
1305
1433
  /**
1434
+ * @public
1306
1435
  * <p>The ID of the request that contains too many tags.</p>
1307
1436
  */
1308
1437
  RequestId?: string;
1309
1438
  /**
1439
+ * @public
1310
1440
  * <p>The name of the resource that received too many tags.</p>
1311
1441
  */
1312
1442
  ResourceName?: string;
@@ -1320,10 +1450,12 @@ export declare class TooManyTagsException extends __BaseException {
1320
1450
  */
1321
1451
  export interface UntagResourceRequest {
1322
1452
  /**
1453
+ * @public
1323
1454
  * <p>The ARN of the resource that you're removing tags from.</p>
1324
1455
  */
1325
1456
  ResourceARN: string | undefined;
1326
1457
  /**
1458
+ * @public
1327
1459
  * <p>The tag keys being removed from the resources.</p>
1328
1460
  */
1329
1461
  TagKeys: string[] | undefined;
@@ -1338,14 +1470,17 @@ export interface UntagResourceResponse {
1338
1470
  */
1339
1471
  export interface UpdateAttendeeCapabilitiesRequest {
1340
1472
  /**
1473
+ * @public
1341
1474
  * <p>The ID of the meeting associated with the update request.</p>
1342
1475
  */
1343
1476
  MeetingId: string | undefined;
1344
1477
  /**
1478
+ * @public
1345
1479
  * <p>The ID of the attendee associated with the update request.</p>
1346
1480
  */
1347
1481
  AttendeeId: string | undefined;
1348
1482
  /**
1483
+ * @public
1349
1484
  * <p>The capabilities that you want to update.</p>
1350
1485
  */
1351
1486
  Capabilities: AttendeeCapabilities | undefined;
@@ -1355,6 +1490,7 @@ export interface UpdateAttendeeCapabilitiesRequest {
1355
1490
  */
1356
1491
  export interface UpdateAttendeeCapabilitiesResponse {
1357
1492
  /**
1493
+ * @public
1358
1494
  * <p>The updated attendee data.</p>
1359
1495
  */
1360
1496
  Attendee?: Attendee;
@@ -1,5 +1,6 @@
1
1
  export * from "./ChimeSDKMeetingsClient";
2
2
  export * from "./ChimeSDKMeetings";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-chime-sdk-meetings",
3
3
  "description": "AWS SDK for JavaScript Chime Sdk Meetings Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
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
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "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",