@aws-sdk/client-chime 3.379.1 → 3.385.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.
Files changed (3) hide show
  1. package/dist-types/models/models_0.d.ts +632 -0
  2. package/dist-types/models/models_1.d.ts +430 -0
  3. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -85,6 +85,7 @@ export type License = (typeof License)[keyof typeof License];
85
85
  */
86
86
  export interface SigninDelegateGroup {
87
87
  /**
88
+ * @public
88
89
  * <p>The group name.</p>
89
90
  */
90
91
  GroupName?: string;
@@ -95,40 +96,49 @@ export interface SigninDelegateGroup {
95
96
  */
96
97
  export interface Account {
97
98
  /**
99
+ * @public
98
100
  * <p>The AWS account ID.</p>
99
101
  */
100
102
  AwsAccountId: string | undefined;
101
103
  /**
104
+ * @public
102
105
  * <p>The Amazon Chime account ID.</p>
103
106
  */
104
107
  AccountId: string | undefined;
105
108
  /**
109
+ * @public
106
110
  * <p>The Amazon Chime account name.</p>
107
111
  */
108
112
  Name: string | undefined;
109
113
  /**
114
+ * @public
110
115
  * <p>The Amazon Chime account type. For more information about different account types, see
111
116
  * <a href="https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html">Managing Your Amazon Chime Accounts</a> in the <i>Amazon Chime Administration
112
117
  * Guide</i>.</p>
113
118
  */
114
119
  AccountType?: AccountType | string;
115
120
  /**
121
+ * @public
116
122
  * <p>The Amazon Chime account creation timestamp, in ISO 8601 format.</p>
117
123
  */
118
124
  CreatedTimestamp?: Date;
119
125
  /**
126
+ * @public
120
127
  * <p>The default license for the Amazon Chime account.</p>
121
128
  */
122
129
  DefaultLicense?: License | string;
123
130
  /**
131
+ * @public
124
132
  * <p>Supported licenses for the Amazon Chime account.</p>
125
133
  */
126
134
  SupportedLicenses?: (License | string)[];
127
135
  /**
136
+ * @public
128
137
  * <p>The status of the account.</p>
129
138
  */
130
139
  AccountStatus?: AccountStatus | string;
131
140
  /**
141
+ * @public
132
142
  * <p>The sign-in delegate groups associated with the account.</p>
133
143
  */
134
144
  SigninDelegateGroups?: SigninDelegateGroup[];
@@ -141,10 +151,12 @@ export interface Account {
141
151
  */
142
152
  export interface AccountSettings {
143
153
  /**
154
+ * @public
144
155
  * <p>Setting that stops or starts remote control of shared screens during meetings.</p>
145
156
  */
146
157
  DisableRemoteControl?: boolean;
147
158
  /**
159
+ * @public
148
160
  * <p>Setting that allows meeting participants to choose the <b>Call me at a phone number</b> option. For more information, see
149
161
  * <a href="https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html">Join a Meeting without the Amazon Chime App</a>.</p>
150
162
  */
@@ -156,42 +168,52 @@ export interface AccountSettings {
156
168
  */
157
169
  export interface Address {
158
170
  /**
171
+ * @public
159
172
  * <p>The address street, such as <code>8th Avenue</code>.</p>
160
173
  */
161
174
  streetName?: string;
162
175
  /**
176
+ * @public
163
177
  * <p>The address suffix, such as the <code>N</code> in <code>8th Avenue N</code>.</p>
164
178
  */
165
179
  streetSuffix?: string;
166
180
  /**
181
+ * @public
167
182
  * <p>An address suffix location, such as the <code>S. Unit A</code> in <code>Central Park S. Unit A</code>.</p>
168
183
  */
169
184
  postDirectional?: string;
170
185
  /**
186
+ * @public
171
187
  * <p>An address prefix location, such as the <code>N</code> in <code>N. Third St.</code>.</p>
172
188
  */
173
189
  preDirectional?: string;
174
190
  /**
191
+ * @public
175
192
  * <p>The numeric portion of an address.</p>
176
193
  */
177
194
  streetNumber?: string;
178
195
  /**
196
+ * @public
179
197
  * <p>The city of an address.</p>
180
198
  */
181
199
  city?: string;
182
200
  /**
201
+ * @public
183
202
  * <p>The state of an address.</p>
184
203
  */
185
204
  state?: string;
186
205
  /**
206
+ * @public
187
207
  * <p>The postal code of an address.</p>
188
208
  */
189
209
  postalCode?: string;
190
210
  /**
211
+ * @public
191
212
  * <p>The Zip + 4 or postal code + 4 of an address.</p>
192
213
  */
193
214
  postalCodePlus4?: string;
194
215
  /**
216
+ * @public
195
217
  * <p>The country of an address. </p>
196
218
  */
197
219
  country?: string;
@@ -202,10 +224,12 @@ export interface Address {
202
224
  */
203
225
  export interface AlexaForBusinessMetadata {
204
226
  /**
227
+ * @public
205
228
  * <p>Starts or stops Alexa for Business.</p>
206
229
  */
207
230
  IsAlexaForBusinessEnabled?: boolean;
208
231
  /**
232
+ * @public
209
233
  * <p>The ARN of the room resource.</p>
210
234
  */
211
235
  AlexaForBusinessRoomArn?: string;
@@ -216,22 +240,27 @@ export interface AlexaForBusinessMetadata {
216
240
  */
217
241
  export interface AppInstance {
218
242
  /**
243
+ * @public
219
244
  * <p>The ARN of the messaging instance.</p>
220
245
  */
221
246
  AppInstanceArn?: string;
222
247
  /**
248
+ * @public
223
249
  * <p>The name of an <code>AppInstance</code>.</p>
224
250
  */
225
251
  Name?: string;
226
252
  /**
253
+ * @public
227
254
  * <p>The metadata of an <code>AppInstance</code>.</p>
228
255
  */
229
256
  Metadata?: string;
230
257
  /**
258
+ * @public
231
259
  * <p>The time at which an <code>AppInstance</code> was created. In epoch milliseconds.</p>
232
260
  */
233
261
  CreatedTimestamp?: Date;
234
262
  /**
263
+ * @public
235
264
  * <p>The time an <code>AppInstance</code> was last updated. In epoch milliseconds.</p>
236
265
  */
237
266
  LastUpdatedTimestamp?: Date;
@@ -242,10 +271,12 @@ export interface AppInstance {
242
271
  */
243
272
  export interface Identity {
244
273
  /**
274
+ * @public
245
275
  * <p>The ARN in an Identity.</p>
246
276
  */
247
277
  Arn?: string;
248
278
  /**
279
+ * @public
249
280
  * <p>The name in an Identity.</p>
250
281
  */
251
282
  Name?: string;
@@ -256,14 +287,17 @@ export interface Identity {
256
287
  */
257
288
  export interface AppInstanceAdmin {
258
289
  /**
290
+ * @public
259
291
  * <p>The <code>AppInstanceAdmin</code> data.</p>
260
292
  */
261
293
  Admin?: Identity;
262
294
  /**
295
+ * @public
263
296
  * <p>The ARN of the <code>AppInstance</code> for which the user is an administrator.</p>
264
297
  */
265
298
  AppInstanceArn?: string;
266
299
  /**
300
+ * @public
267
301
  * <p>The time at which an administrator was created.</p>
268
302
  */
269
303
  CreatedTimestamp?: Date;
@@ -274,6 +308,7 @@ export interface AppInstanceAdmin {
274
308
  */
275
309
  export interface AppInstanceAdminSummary {
276
310
  /**
311
+ * @public
277
312
  * <p>The details of the <code>AppInstanceAdmin</code>.</p>
278
313
  */
279
314
  Admin?: Identity;
@@ -296,14 +331,17 @@ export type AppInstanceDataType = (typeof AppInstanceDataType)[keyof typeof AppI
296
331
  */
297
332
  export interface AppInstanceSummary {
298
333
  /**
334
+ * @public
299
335
  * <p>The <code>AppInstance</code> ARN.</p>
300
336
  */
301
337
  AppInstanceArn?: string;
302
338
  /**
339
+ * @public
303
340
  * <p>The name of the <code>AppInstance</code>.</p>
304
341
  */
305
342
  Name?: string;
306
343
  /**
344
+ * @public
307
345
  * <p>The metadata of the <code>AppInstance</code>.</p>
308
346
  */
309
347
  Metadata?: string;
@@ -314,6 +352,7 @@ export interface AppInstanceSummary {
314
352
  */
315
353
  export interface ChannelRetentionSettings {
316
354
  /**
355
+ * @public
317
356
  * <p>The time in days to retain the messages in a channel.</p>
318
357
  */
319
358
  RetentionDays?: number;
@@ -324,6 +363,7 @@ export interface ChannelRetentionSettings {
324
363
  */
325
364
  export interface AppInstanceRetentionSettings {
326
365
  /**
366
+ * @public
327
367
  * <p>The length of time in days to retain the messages in a channel.</p>
328
368
  */
329
369
  ChannelRetentionSettings?: ChannelRetentionSettings;
@@ -334,10 +374,12 @@ export interface AppInstanceRetentionSettings {
334
374
  */
335
375
  export interface AppInstanceStreamingConfiguration {
336
376
  /**
377
+ * @public
337
378
  * <p>The type of data to be streamed.</p>
338
379
  */
339
380
  AppInstanceDataType: AppInstanceDataType | string | undefined;
340
381
  /**
382
+ * @public
341
383
  * <p>The resource ARN.</p>
342
384
  */
343
385
  ResourceArn: string | undefined;
@@ -348,22 +390,27 @@ export interface AppInstanceStreamingConfiguration {
348
390
  */
349
391
  export interface AppInstanceUser {
350
392
  /**
393
+ * @public
351
394
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
352
395
  */
353
396
  AppInstanceUserArn?: string;
354
397
  /**
398
+ * @public
355
399
  * <p>The name of the <code>AppInstanceUser</code>.</p>
356
400
  */
357
401
  Name?: string;
358
402
  /**
403
+ * @public
359
404
  * <p>The time at which the <code>AppInstanceUser</code> was created.</p>
360
405
  */
361
406
  CreatedTimestamp?: Date;
362
407
  /**
408
+ * @public
363
409
  * <p>The metadata of the <code>AppInstanceUser</code>.</p>
364
410
  */
365
411
  Metadata?: string;
366
412
  /**
413
+ * @public
367
414
  * <p>The time at which the <code>AppInstanceUser</code> was last updated.</p>
368
415
  */
369
416
  LastUpdatedTimestamp?: Date;
@@ -374,14 +421,17 @@ export interface AppInstanceUser {
374
421
  */
375
422
  export interface AppInstanceUserSummary {
376
423
  /**
424
+ * @public
377
425
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
378
426
  */
379
427
  AppInstanceUserArn?: string;
380
428
  /**
429
+ * @public
381
430
  * <p>The name of an <code>AppInstanceUser</code>.</p>
382
431
  */
383
432
  Name?: string;
384
433
  /**
434
+ * @public
385
435
  * <p>The metadata of the <code>AppInstanceUser</code>.</p>
386
436
  */
387
437
  Metadata?: string;
@@ -404,10 +454,12 @@ export type ChannelMembershipType = (typeof ChannelMembershipType)[keyof typeof
404
454
  */
405
455
  export interface AppInstanceUserMembershipSummary {
406
456
  /**
457
+ * @public
407
458
  * <p>The type of <code>ChannelMembership</code>.</p>
408
459
  */
409
460
  Type?: ChannelMembershipType | string;
410
461
  /**
462
+ * @public
411
463
  * <p>The time at which a message was last read.</p>
412
464
  */
413
465
  ReadMarkerTimestamp?: Date;
@@ -430,6 +482,7 @@ export type AudioMuxType = (typeof AudioMuxType)[keyof typeof AudioMuxType];
430
482
  */
431
483
  export interface AudioArtifactsConfiguration {
432
484
  /**
485
+ * @public
433
486
  * <p>The MUX type of the audio artifact configuration object.</p>
434
487
  */
435
488
  MuxType: AudioMuxType | string | undefined;
@@ -463,10 +516,12 @@ export type ArtifactsState = (typeof ArtifactsState)[keyof typeof ArtifactsState
463
516
  */
464
517
  export interface ContentArtifactsConfiguration {
465
518
  /**
519
+ * @public
466
520
  * <p>Indicates whether the content artifact is enabled or disabled.</p>
467
521
  */
468
522
  State: ArtifactsState | string | undefined;
469
523
  /**
524
+ * @public
470
525
  * <p>The MUX type of the artifact configuration.</p>
471
526
  */
472
527
  MuxType?: ContentMuxType | string;
@@ -488,10 +543,12 @@ export type VideoMuxType = (typeof VideoMuxType)[keyof typeof VideoMuxType];
488
543
  */
489
544
  export interface VideoArtifactsConfiguration {
490
545
  /**
546
+ * @public
491
547
  * <p>Indicates whether the video artifact is enabled or disabled.</p>
492
548
  */
493
549
  State: ArtifactsState | string | undefined;
494
550
  /**
551
+ * @public
495
552
  * <p>The MUX type of the video artifact configuration object.</p>
496
553
  */
497
554
  MuxType?: VideoMuxType | string;
@@ -502,14 +559,17 @@ export interface VideoArtifactsConfiguration {
502
559
  */
503
560
  export interface ArtifactsConfiguration {
504
561
  /**
562
+ * @public
505
563
  * <p>The configuration for the audio artifacts.</p>
506
564
  */
507
565
  Audio: AudioArtifactsConfiguration | undefined;
508
566
  /**
567
+ * @public
509
568
  * <p>The configuration for the video artifacts.</p>
510
569
  */
511
570
  Video: VideoArtifactsConfiguration | undefined;
512
571
  /**
572
+ * @public
513
573
  * <p>The configuration for the content artifacts.</p>
514
574
  */
515
575
  Content: ContentArtifactsConfiguration | undefined;
@@ -519,14 +579,17 @@ export interface ArtifactsConfiguration {
519
579
  */
520
580
  export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
521
581
  /**
582
+ * @public
522
583
  * <p>The Amazon Chime Voice Connector ID.</p>
523
584
  */
524
585
  VoiceConnectorId: string | undefined;
525
586
  /**
587
+ * @public
526
588
  * <p>List of phone numbers, in E.164 format.</p>
527
589
  */
528
590
  E164PhoneNumbers: string[] | undefined;
529
591
  /**
592
+ * @public
530
593
  * <p>If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.</p>
531
594
  */
532
595
  ForceAssociate?: boolean;
@@ -538,14 +601,17 @@ export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
538
601
  */
539
602
  export interface PhoneNumberError {
540
603
  /**
604
+ * @public
541
605
  * <p>The phone number ID for which the action failed.</p>
542
606
  */
543
607
  PhoneNumberId?: string;
544
608
  /**
609
+ * @public
545
610
  * <p>The error code.</p>
546
611
  */
547
612
  ErrorCode?: ErrorCode | string;
548
613
  /**
614
+ * @public
549
615
  * <p>The error message.</p>
550
616
  */
551
617
  ErrorMessage?: string;
@@ -555,6 +621,7 @@ export interface PhoneNumberError {
555
621
  */
556
622
  export interface AssociatePhoneNumbersWithVoiceConnectorResponse {
557
623
  /**
624
+ * @public
558
625
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and
559
626
  * error messages.</p>
560
627
  */
@@ -663,14 +730,17 @@ export declare class UnauthorizedClientException extends __BaseException {
663
730
  */
664
731
  export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
665
732
  /**
733
+ * @public
666
734
  * <p>The Amazon Chime Voice Connector group ID.</p>
667
735
  */
668
736
  VoiceConnectorGroupId: string | undefined;
669
737
  /**
738
+ * @public
670
739
  * <p>List of phone numbers, in E.164 format.</p>
671
740
  */
672
741
  E164PhoneNumbers: string[] | undefined;
673
742
  /**
743
+ * @public
674
744
  * <p>If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.</p>
675
745
  */
676
746
  ForceAssociate?: boolean;
@@ -680,6 +750,7 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
680
750
  */
681
751
  export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
682
752
  /**
753
+ * @public
683
754
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
684
755
  */
685
756
  PhoneNumberErrors?: PhoneNumberError[];
@@ -689,14 +760,17 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
689
760
  */
690
761
  export interface AssociatePhoneNumberWithUserRequest {
691
762
  /**
763
+ * @public
692
764
  * <p>The Amazon Chime account ID.</p>
693
765
  */
694
766
  AccountId: string | undefined;
695
767
  /**
768
+ * @public
696
769
  * <p>The user ID.</p>
697
770
  */
698
771
  UserId: string | undefined;
699
772
  /**
773
+ * @public
700
774
  * <p>The phone number, in E.164 format.</p>
701
775
  */
702
776
  E164PhoneNumber: string | undefined;
@@ -711,10 +785,12 @@ export interface AssociatePhoneNumberWithUserResponse {
711
785
  */
712
786
  export interface AssociateSigninDelegateGroupsWithAccountRequest {
713
787
  /**
788
+ * @public
714
789
  * <p>The Amazon Chime account ID.</p>
715
790
  */
716
791
  AccountId: string | undefined;
717
792
  /**
793
+ * @public
718
794
  * <p>The sign-in delegate groups.</p>
719
795
  */
720
796
  SigninDelegateGroups: SigninDelegateGroup[] | undefined;
@@ -745,14 +821,17 @@ export interface AssociateSigninDelegateGroupsWithAccountResponse {
745
821
  */
746
822
  export interface Attendee {
747
823
  /**
824
+ * @public
748
825
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
749
826
  */
750
827
  ExternalUserId?: string;
751
828
  /**
829
+ * @public
752
830
  * <p>The Amazon Chime SDK attendee ID.</p>
753
831
  */
754
832
  AttendeeId?: string;
755
833
  /**
834
+ * @public
756
835
  * <p>The join token used by the Amazon Chime SDK attendee.</p>
757
836
  */
758
837
  JoinToken?: string;
@@ -763,10 +842,12 @@ export interface Attendee {
763
842
  */
764
843
  export interface Tag {
765
844
  /**
845
+ * @public
766
846
  * <p>The key of the tag.</p>
767
847
  */
768
848
  Key: string | undefined;
769
849
  /**
850
+ * @public
770
851
  * <p>The value of the tag.</p>
771
852
  */
772
853
  Value: string | undefined;
@@ -778,18 +859,22 @@ export interface Tag {
778
859
  */
779
860
  export interface BatchChannelMemberships {
780
861
  /**
862
+ * @public
781
863
  * <p>The identifier of the member who invited another member.</p>
782
864
  */
783
865
  InvitedBy?: Identity;
784
866
  /**
867
+ * @public
785
868
  * <p>The membership types set for the channel users.</p>
786
869
  */
787
870
  Type?: ChannelMembershipType | string;
788
871
  /**
872
+ * @public
789
873
  * <p>The users successfully added to the request.</p>
790
874
  */
791
875
  Members?: Identity[];
792
876
  /**
877
+ * @public
793
878
  * <p>The ARN of the channel to which you're adding users.</p>
794
879
  */
795
880
  ChannelArn?: string;
@@ -800,10 +885,12 @@ export interface BatchChannelMemberships {
800
885
  */
801
886
  export interface CreateAttendeeRequestItem {
802
887
  /**
888
+ * @public
803
889
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
804
890
  */
805
891
  ExternalUserId: string | undefined;
806
892
  /**
893
+ * @public
807
894
  * <p>The tag key-value pairs.</p>
808
895
  */
809
896
  Tags?: Tag[];
@@ -813,10 +900,12 @@ export interface CreateAttendeeRequestItem {
813
900
  */
814
901
  export interface BatchCreateAttendeeRequest {
815
902
  /**
903
+ * @public
816
904
  * <p>The Amazon Chime SDK meeting ID.</p>
817
905
  */
818
906
  MeetingId: string | undefined;
819
907
  /**
908
+ * @public
820
909
  * <p>The request containing the attendees to create.</p>
821
910
  */
822
911
  Attendees: CreateAttendeeRequestItem[] | undefined;
@@ -827,14 +916,17 @@ export interface BatchCreateAttendeeRequest {
827
916
  */
828
917
  export interface CreateAttendeeError {
829
918
  /**
919
+ * @public
830
920
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
831
921
  */
832
922
  ExternalUserId?: string;
833
923
  /**
924
+ * @public
834
925
  * <p>The error code.</p>
835
926
  */
836
927
  ErrorCode?: string;
837
928
  /**
929
+ * @public
838
930
  * <p>The error message.</p>
839
931
  */
840
932
  ErrorMessage?: string;
@@ -844,10 +936,12 @@ export interface CreateAttendeeError {
844
936
  */
845
937
  export interface BatchCreateAttendeeResponse {
846
938
  /**
939
+ * @public
847
940
  * <p>The attendee information, including attendees IDs and join tokens.</p>
848
941
  */
849
942
  Attendees?: Attendee[];
850
943
  /**
944
+ * @public
851
945
  * <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>
852
946
  */
853
947
  Errors?: CreateAttendeeError[];
@@ -871,10 +965,12 @@ export declare class ResourceLimitExceededException extends __BaseException {
871
965
  */
872
966
  export interface BatchCreateChannelMembershipRequest {
873
967
  /**
968
+ * @public
874
969
  * <p>The ARN of the channel to which you're adding users.</p>
875
970
  */
876
971
  ChannelArn: string | undefined;
877
972
  /**
973
+ * @public
878
974
  * <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
879
975
  * members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
880
976
  * are only returned if the type filter in <code>ListChannelMemberships</code> equals
@@ -883,10 +979,12 @@ export interface BatchCreateChannelMembershipRequest {
883
979
  */
884
980
  Type?: ChannelMembershipType | string;
885
981
  /**
982
+ * @public
886
983
  * <p>The ARNs of the members you want to add to the channel.</p>
887
984
  */
888
985
  MemberArns: string[] | undefined;
889
986
  /**
987
+ * @public
890
988
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
891
989
  */
892
990
  ChimeBearer?: string;
@@ -897,14 +995,17 @@ export interface BatchCreateChannelMembershipRequest {
897
995
  */
898
996
  export interface BatchCreateChannelMembershipError {
899
997
  /**
998
+ * @public
900
999
  * <p>The ARN of the member that the service couldn't add.</p>
901
1000
  */
902
1001
  MemberArn?: string;
903
1002
  /**
1003
+ * @public
904
1004
  * <p>The error code.</p>
905
1005
  */
906
1006
  ErrorCode?: ErrorCode | string;
907
1007
  /**
1008
+ * @public
908
1009
  * <p>The error message.</p>
909
1010
  */
910
1011
  ErrorMessage?: string;
@@ -914,10 +1015,12 @@ export interface BatchCreateChannelMembershipError {
914
1015
  */
915
1016
  export interface BatchCreateChannelMembershipResponse {
916
1017
  /**
1018
+ * @public
917
1019
  * <p>The list of channel memberships in the response.</p>
918
1020
  */
919
1021
  BatchChannelMemberships?: BatchChannelMemberships;
920
1022
  /**
1023
+ * @public
921
1024
  * <p>If the action fails for one or more of the memberships in the request, a list of the
922
1025
  * memberships is returned, along with error codes and error messages.</p>
923
1026
  */
@@ -941,10 +1044,12 @@ export type RoomMembershipRole = (typeof RoomMembershipRole)[keyof typeof RoomMe
941
1044
  */
942
1045
  export interface MembershipItem {
943
1046
  /**
1047
+ * @public
944
1048
  * <p>The member ID.</p>
945
1049
  */
946
1050
  MemberId?: string;
947
1051
  /**
1052
+ * @public
948
1053
  * <p>The member role.</p>
949
1054
  */
950
1055
  Role?: RoomMembershipRole | string;
@@ -954,14 +1059,17 @@ export interface MembershipItem {
954
1059
  */
955
1060
  export interface BatchCreateRoomMembershipRequest {
956
1061
  /**
1062
+ * @public
957
1063
  * <p>The Amazon Chime account ID.</p>
958
1064
  */
959
1065
  AccountId: string | undefined;
960
1066
  /**
1067
+ * @public
961
1068
  * <p>The room ID.</p>
962
1069
  */
963
1070
  RoomId: string | undefined;
964
1071
  /**
1072
+ * @public
965
1073
  * <p>The list of membership items.</p>
966
1074
  */
967
1075
  MembershipItemList: MembershipItem[] | undefined;
@@ -972,14 +1080,17 @@ export interface BatchCreateRoomMembershipRequest {
972
1080
  */
973
1081
  export interface MemberError {
974
1082
  /**
1083
+ * @public
975
1084
  * <p>The member ID.</p>
976
1085
  */
977
1086
  MemberId?: string;
978
1087
  /**
1088
+ * @public
979
1089
  * <p>The error code.</p>
980
1090
  */
981
1091
  ErrorCode?: ErrorCode | string;
982
1092
  /**
1093
+ * @public
983
1094
  * <p>The error message.</p>
984
1095
  */
985
1096
  ErrorMessage?: string;
@@ -989,6 +1100,7 @@ export interface MemberError {
989
1100
  */
990
1101
  export interface BatchCreateRoomMembershipResponse {
991
1102
  /**
1103
+ * @public
992
1104
  * <p>If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.</p>
993
1105
  */
994
1106
  Errors?: MemberError[];
@@ -998,6 +1110,7 @@ export interface BatchCreateRoomMembershipResponse {
998
1110
  */
999
1111
  export interface BatchDeletePhoneNumberRequest {
1000
1112
  /**
1113
+ * @public
1001
1114
  * <p>List of phone number IDs.</p>
1002
1115
  */
1003
1116
  PhoneNumberIds: string[] | undefined;
@@ -1007,6 +1120,7 @@ export interface BatchDeletePhoneNumberRequest {
1007
1120
  */
1008
1121
  export interface BatchDeletePhoneNumberResponse {
1009
1122
  /**
1123
+ * @public
1010
1124
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
1011
1125
  */
1012
1126
  PhoneNumberErrors?: PhoneNumberError[];
@@ -1016,10 +1130,12 @@ export interface BatchDeletePhoneNumberResponse {
1016
1130
  */
1017
1131
  export interface BatchSuspendUserRequest {
1018
1132
  /**
1133
+ * @public
1019
1134
  * <p>The Amazon Chime account ID.</p>
1020
1135
  */
1021
1136
  AccountId: string | undefined;
1022
1137
  /**
1138
+ * @public
1023
1139
  * <p>The request containing the user IDs to suspend.</p>
1024
1140
  */
1025
1141
  UserIdList: string[] | undefined;
@@ -1031,14 +1147,17 @@ export interface BatchSuspendUserRequest {
1031
1147
  */
1032
1148
  export interface UserError {
1033
1149
  /**
1150
+ * @public
1034
1151
  * <p>The user ID for which the action failed.</p>
1035
1152
  */
1036
1153
  UserId?: string;
1037
1154
  /**
1155
+ * @public
1038
1156
  * <p>The error code.</p>
1039
1157
  */
1040
1158
  ErrorCode?: ErrorCode | string;
1041
1159
  /**
1160
+ * @public
1042
1161
  * <p>The error message.</p>
1043
1162
  */
1044
1163
  ErrorMessage?: string;
@@ -1048,6 +1167,7 @@ export interface UserError {
1048
1167
  */
1049
1168
  export interface BatchSuspendUserResponse {
1050
1169
  /**
1170
+ * @public
1051
1171
  * <p>If the <a>BatchSuspendUser</a> action fails for one or more of the user IDs in the
1052
1172
  * request, a list of the user IDs is returned, along with error codes and error messages.</p>
1053
1173
  */
@@ -1058,10 +1178,12 @@ export interface BatchSuspendUserResponse {
1058
1178
  */
1059
1179
  export interface BatchUnsuspendUserRequest {
1060
1180
  /**
1181
+ * @public
1061
1182
  * <p>The Amazon Chime account ID.</p>
1062
1183
  */
1063
1184
  AccountId: string | undefined;
1064
1185
  /**
1186
+ * @public
1065
1187
  * <p>The request containing the user IDs to unsuspend.</p>
1066
1188
  */
1067
1189
  UserIdList: string[] | undefined;
@@ -1071,6 +1193,7 @@ export interface BatchUnsuspendUserRequest {
1071
1193
  */
1072
1194
  export interface BatchUnsuspendUserResponse {
1073
1195
  /**
1196
+ * @public
1074
1197
  * <p>If the <a>BatchUnsuspendUser</a> action fails for one or more of the user IDs in the
1075
1198
  * request, a list of the user IDs is returned, along with error codes and error messages.</p>
1076
1199
  */
@@ -1096,14 +1219,17 @@ export type PhoneNumberProductType = (typeof PhoneNumberProductType)[keyof typeo
1096
1219
  */
1097
1220
  export interface UpdatePhoneNumberRequestItem {
1098
1221
  /**
1222
+ * @public
1099
1223
  * <p>The phone number ID to update.</p>
1100
1224
  */
1101
1225
  PhoneNumberId: string | undefined;
1102
1226
  /**
1227
+ * @public
1103
1228
  * <p>The product type to update.</p>
1104
1229
  */
1105
1230
  ProductType?: PhoneNumberProductType | string;
1106
1231
  /**
1232
+ * @public
1107
1233
  * <p>The outbound calling name to update.</p>
1108
1234
  */
1109
1235
  CallingName?: string;
@@ -1113,6 +1239,7 @@ export interface UpdatePhoneNumberRequestItem {
1113
1239
  */
1114
1240
  export interface BatchUpdatePhoneNumberRequest {
1115
1241
  /**
1242
+ * @public
1116
1243
  * <p>The request containing the phone number IDs and product types or calling names to update.</p>
1117
1244
  */
1118
1245
  UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItem[] | undefined;
@@ -1122,6 +1249,7 @@ export interface BatchUpdatePhoneNumberRequest {
1122
1249
  */
1123
1250
  export interface BatchUpdatePhoneNumberResponse {
1124
1251
  /**
1252
+ * @public
1125
1253
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
1126
1254
  */
1127
1255
  PhoneNumberErrors?: PhoneNumberError[];
@@ -1145,18 +1273,22 @@ export type UserType = (typeof UserType)[keyof typeof UserType];
1145
1273
  */
1146
1274
  export interface UpdateUserRequestItem {
1147
1275
  /**
1276
+ * @public
1148
1277
  * <p>The user ID.</p>
1149
1278
  */
1150
1279
  UserId: string | undefined;
1151
1280
  /**
1281
+ * @public
1152
1282
  * <p>The user license type.</p>
1153
1283
  */
1154
1284
  LicenseType?: License | string;
1155
1285
  /**
1286
+ * @public
1156
1287
  * <p>The user type.</p>
1157
1288
  */
1158
1289
  UserType?: UserType | string;
1159
1290
  /**
1291
+ * @public
1160
1292
  * <p>The Alexa for Business metadata.</p>
1161
1293
  */
1162
1294
  AlexaForBusinessMetadata?: AlexaForBusinessMetadata;
@@ -1166,10 +1298,12 @@ export interface UpdateUserRequestItem {
1166
1298
  */
1167
1299
  export interface BatchUpdateUserRequest {
1168
1300
  /**
1301
+ * @public
1169
1302
  * <p>The Amazon Chime account ID.</p>
1170
1303
  */
1171
1304
  AccountId: string | undefined;
1172
1305
  /**
1306
+ * @public
1173
1307
  * <p>The request containing the user IDs and details to update.</p>
1174
1308
  */
1175
1309
  UpdateUserRequestItems: UpdateUserRequestItem[] | undefined;
@@ -1179,6 +1313,7 @@ export interface BatchUpdateUserRequest {
1179
1313
  */
1180
1314
  export interface BatchUpdateUserResponse {
1181
1315
  /**
1316
+ * @public
1182
1317
  * <p>If the <a>BatchUpdateUser</a> action fails for one or more of the user IDs in the
1183
1318
  * request, a list of the user IDs is returned, along with error codes and error messages.</p>
1184
1319
  */
@@ -1201,38 +1336,47 @@ export type BotType = (typeof BotType)[keyof typeof BotType];
1201
1336
  */
1202
1337
  export interface Bot {
1203
1338
  /**
1339
+ * @public
1204
1340
  * <p>The bot ID.</p>
1205
1341
  */
1206
1342
  BotId?: string;
1207
1343
  /**
1344
+ * @public
1208
1345
  * <p>The unique ID for the bot user.</p>
1209
1346
  */
1210
1347
  UserId?: string;
1211
1348
  /**
1349
+ * @public
1212
1350
  * <p>The bot display name.</p>
1213
1351
  */
1214
1352
  DisplayName?: string;
1215
1353
  /**
1354
+ * @public
1216
1355
  * <p>The bot type.</p>
1217
1356
  */
1218
1357
  BotType?: BotType | string;
1219
1358
  /**
1359
+ * @public
1220
1360
  * <p>When true, the bot is stopped from running in your account.</p>
1221
1361
  */
1222
1362
  Disabled?: boolean;
1223
1363
  /**
1364
+ * @public
1224
1365
  * <p>The bot creation timestamp, in ISO 8601 format.</p>
1225
1366
  */
1226
1367
  CreatedTimestamp?: Date;
1227
1368
  /**
1369
+ * @public
1228
1370
  * <p>The updated bot timestamp, in ISO 8601 format.</p>
1229
1371
  */
1230
1372
  UpdatedTimestamp?: Date;
1231
1373
  /**
1374
+ * @public
1232
1375
  * <p>The bot email address.</p>
1233
1376
  */
1234
1377
  BotEmail?: string;
1235
1378
  /**
1379
+ * @public
1236
1380
  * <p>The security token used to authenticate Amazon Chime with the outgoing event endpoint.</p>
1237
1381
  */
1238
1382
  SecurityToken?: string;
@@ -1244,6 +1388,7 @@ export interface Bot {
1244
1388
  */
1245
1389
  export interface BusinessCallingSettings {
1246
1390
  /**
1391
+ * @public
1247
1392
  * <p>The Amazon S3 bucket designated for call detail record storage.</p>
1248
1393
  */
1249
1394
  CdrBucket?: string;
@@ -1268,30 +1413,37 @@ export type CallingNameStatus = (typeof CallingNameStatus)[keyof typeof CallingN
1268
1413
  */
1269
1414
  export interface CandidateAddress {
1270
1415
  /**
1416
+ * @public
1271
1417
  * <p>The street information of a candidate address</p>
1272
1418
  */
1273
1419
  streetInfo?: string;
1274
1420
  /**
1421
+ * @public
1275
1422
  * <p>The numeric portion of a candidate address.</p>
1276
1423
  */
1277
1424
  streetNumber?: string;
1278
1425
  /**
1426
+ * @public
1279
1427
  * <p>The city of a candidate address.</p>
1280
1428
  */
1281
1429
  city?: string;
1282
1430
  /**
1431
+ * @public
1283
1432
  * <p>The state of a candidate address.</p>
1284
1433
  */
1285
1434
  state?: string;
1286
1435
  /**
1436
+ * @public
1287
1437
  * <p>The postal code of a candidate address.</p>
1288
1438
  */
1289
1439
  postalCode?: string;
1290
1440
  /**
1441
+ * @public
1291
1442
  * <p>The Zip + 4 or postal code + 4 of a candidate address.</p>
1292
1443
  */
1293
1444
  postalCodePlus4?: string;
1294
1445
  /**
1446
+ * @public
1295
1447
  * <p>The country of a candidate address.</p>
1296
1448
  */
1297
1449
  country?: string;
@@ -1338,38 +1490,47 @@ export type ChannelPrivacy = (typeof ChannelPrivacy)[keyof typeof ChannelPrivacy
1338
1490
  */
1339
1491
  export interface Channel {
1340
1492
  /**
1493
+ * @public
1341
1494
  * <p>The name of the channel.</p>
1342
1495
  */
1343
1496
  Name?: string;
1344
1497
  /**
1498
+ * @public
1345
1499
  * <p>The ARN of the channel.</p>
1346
1500
  */
1347
1501
  ChannelArn?: string;
1348
1502
  /**
1503
+ * @public
1349
1504
  * <p>The mode of the channel.</p>
1350
1505
  */
1351
1506
  Mode?: ChannelMode | string;
1352
1507
  /**
1508
+ * @public
1353
1509
  * <p>The channel's privacy setting.</p>
1354
1510
  */
1355
1511
  Privacy?: ChannelPrivacy | string;
1356
1512
  /**
1513
+ * @public
1357
1514
  * <p>The channel's metadata.</p>
1358
1515
  */
1359
1516
  Metadata?: string;
1360
1517
  /**
1518
+ * @public
1361
1519
  * <p>The <code>AppInstanceUser</code> who created the channel.</p>
1362
1520
  */
1363
1521
  CreatedBy?: Identity;
1364
1522
  /**
1523
+ * @public
1365
1524
  * <p>The time at which the <code>AppInstanceUser</code> created the channel.</p>
1366
1525
  */
1367
1526
  CreatedTimestamp?: Date;
1368
1527
  /**
1528
+ * @public
1369
1529
  * <p>The time at which a member sent the last message in the channel.</p>
1370
1530
  */
1371
1531
  LastMessageTimestamp?: Date;
1372
1532
  /**
1533
+ * @public
1373
1534
  * <p>The time at which a channel was last updated.</p>
1374
1535
  */
1375
1536
  LastUpdatedTimestamp?: Date;
@@ -1380,18 +1541,22 @@ export interface Channel {
1380
1541
  */
1381
1542
  export interface ChannelBan {
1382
1543
  /**
1544
+ * @public
1383
1545
  * <p>The member being banned from the channel.</p>
1384
1546
  */
1385
1547
  Member?: Identity;
1386
1548
  /**
1549
+ * @public
1387
1550
  * <p>The ARN of the channel from which a member is being banned.</p>
1388
1551
  */
1389
1552
  ChannelArn?: string;
1390
1553
  /**
1554
+ * @public
1391
1555
  * <p>The time at which the ban was created.</p>
1392
1556
  */
1393
1557
  CreatedTimestamp?: Date;
1394
1558
  /**
1559
+ * @public
1395
1560
  * <p>The <code>AppInstanceUser</code> who created the ban.</p>
1396
1561
  */
1397
1562
  CreatedBy?: Identity;
@@ -1402,6 +1567,7 @@ export interface ChannelBan {
1402
1567
  */
1403
1568
  export interface ChannelBanSummary {
1404
1569
  /**
1570
+ * @public
1405
1571
  * <p>The member being banned from a channel.</p>
1406
1572
  */
1407
1573
  Member?: Identity;
@@ -1412,26 +1578,32 @@ export interface ChannelBanSummary {
1412
1578
  */
1413
1579
  export interface ChannelMembership {
1414
1580
  /**
1581
+ * @public
1415
1582
  * <p>The identifier of the member who invited another member.</p>
1416
1583
  */
1417
1584
  InvitedBy?: Identity;
1418
1585
  /**
1586
+ * @public
1419
1587
  * <p>The membership type set for the channel member.</p>
1420
1588
  */
1421
1589
  Type?: ChannelMembershipType | string;
1422
1590
  /**
1591
+ * @public
1423
1592
  * <p>The data of the channel member.</p>
1424
1593
  */
1425
1594
  Member?: Identity;
1426
1595
  /**
1596
+ * @public
1427
1597
  * <p>The ARN of the member's channel.</p>
1428
1598
  */
1429
1599
  ChannelArn?: string;
1430
1600
  /**
1601
+ * @public
1431
1602
  * <p>The time at which the channel membership was created.</p>
1432
1603
  */
1433
1604
  CreatedTimestamp?: Date;
1434
1605
  /**
1606
+ * @public
1435
1607
  * <p>The time at which a channel membership was last updated.</p>
1436
1608
  */
1437
1609
  LastUpdatedTimestamp?: Date;
@@ -1442,26 +1614,32 @@ export interface ChannelMembership {
1442
1614
  */
1443
1615
  export interface ChannelSummary {
1444
1616
  /**
1617
+ * @public
1445
1618
  * <p>The name of the channel.</p>
1446
1619
  */
1447
1620
  Name?: string;
1448
1621
  /**
1622
+ * @public
1449
1623
  * <p>The ARN of the channel.</p>
1450
1624
  */
1451
1625
  ChannelArn?: string;
1452
1626
  /**
1627
+ * @public
1453
1628
  * <p>The mode of the channel.</p>
1454
1629
  */
1455
1630
  Mode?: ChannelMode | string;
1456
1631
  /**
1632
+ * @public
1457
1633
  * <p>The privacy setting of the channel.</p>
1458
1634
  */
1459
1635
  Privacy?: ChannelPrivacy | string;
1460
1636
  /**
1637
+ * @public
1461
1638
  * <p>The metadata of the channel.</p>
1462
1639
  */
1463
1640
  Metadata?: string;
1464
1641
  /**
1642
+ * @public
1465
1643
  * <p>The time at which the last message in a channel was sent.</p>
1466
1644
  */
1467
1645
  LastMessageTimestamp?: Date;
@@ -1472,10 +1650,12 @@ export interface ChannelSummary {
1472
1650
  */
1473
1651
  export interface ChannelMembershipForAppInstanceUserSummary {
1474
1652
  /**
1653
+ * @public
1475
1654
  * <p>Summary of the details of a <code>Channel</code>.</p>
1476
1655
  */
1477
1656
  ChannelSummary?: ChannelSummary;
1478
1657
  /**
1658
+ * @public
1479
1659
  * <p>Summary of the membership details of an <code>AppInstanceUser</code>.</p>
1480
1660
  */
1481
1661
  AppInstanceUserMembershipSummary?: AppInstanceUserMembershipSummary;
@@ -1486,6 +1666,7 @@ export interface ChannelMembershipForAppInstanceUserSummary {
1486
1666
  */
1487
1667
  export interface ChannelMembershipSummary {
1488
1668
  /**
1669
+ * @public
1489
1670
  * <p>A member's summary data.</p>
1490
1671
  */
1491
1672
  Member?: Identity;
@@ -1520,46 +1701,57 @@ export type ChannelMessageType = (typeof ChannelMessageType)[keyof typeof Channe
1520
1701
  */
1521
1702
  export interface ChannelMessage {
1522
1703
  /**
1704
+ * @public
1523
1705
  * <p>The ARN of the channel.</p>
1524
1706
  */
1525
1707
  ChannelArn?: string;
1526
1708
  /**
1709
+ * @public
1527
1710
  * <p>The ID of a message.</p>
1528
1711
  */
1529
1712
  MessageId?: string;
1530
1713
  /**
1714
+ * @public
1531
1715
  * <p>The message content.</p>
1532
1716
  */
1533
1717
  Content?: string;
1534
1718
  /**
1719
+ * @public
1535
1720
  * <p>The message metadata.</p>
1536
1721
  */
1537
1722
  Metadata?: string;
1538
1723
  /**
1724
+ * @public
1539
1725
  * <p>The message type.</p>
1540
1726
  */
1541
1727
  Type?: ChannelMessageType | string;
1542
1728
  /**
1729
+ * @public
1543
1730
  * <p>The time at which the message was created.</p>
1544
1731
  */
1545
1732
  CreatedTimestamp?: Date;
1546
1733
  /**
1734
+ * @public
1547
1735
  * <p>The time at which a message was edited.</p>
1548
1736
  */
1549
1737
  LastEditedTimestamp?: Date;
1550
1738
  /**
1739
+ * @public
1551
1740
  * <p>The time at which a message was updated.</p>
1552
1741
  */
1553
1742
  LastUpdatedTimestamp?: Date;
1554
1743
  /**
1744
+ * @public
1555
1745
  * <p>The message sender.</p>
1556
1746
  */
1557
1747
  Sender?: Identity;
1558
1748
  /**
1749
+ * @public
1559
1750
  * <p>Hides the content of a message.</p>
1560
1751
  */
1561
1752
  Redacted?: boolean;
1562
1753
  /**
1754
+ * @public
1563
1755
  * <p>The persistence setting for a channel message.</p>
1564
1756
  */
1565
1757
  Persistence?: ChannelMessagePersistenceType | string;
@@ -1570,38 +1762,47 @@ export interface ChannelMessage {
1570
1762
  */
1571
1763
  export interface ChannelMessageSummary {
1572
1764
  /**
1765
+ * @public
1573
1766
  * <p>The ID of the message.</p>
1574
1767
  */
1575
1768
  MessageId?: string;
1576
1769
  /**
1770
+ * @public
1577
1771
  * <p>The content of the message.</p>
1578
1772
  */
1579
1773
  Content?: string;
1580
1774
  /**
1775
+ * @public
1581
1776
  * <p>The metadata of the message.</p>
1582
1777
  */
1583
1778
  Metadata?: string;
1584
1779
  /**
1780
+ * @public
1585
1781
  * <p>The type of message.</p>
1586
1782
  */
1587
1783
  Type?: ChannelMessageType | string;
1588
1784
  /**
1785
+ * @public
1589
1786
  * <p>The time at which the message summary was created.</p>
1590
1787
  */
1591
1788
  CreatedTimestamp?: Date;
1592
1789
  /**
1790
+ * @public
1593
1791
  * <p>The time at which a message was last updated.</p>
1594
1792
  */
1595
1793
  LastUpdatedTimestamp?: Date;
1596
1794
  /**
1795
+ * @public
1597
1796
  * <p>The time at which a message was last edited.</p>
1598
1797
  */
1599
1798
  LastEditedTimestamp?: Date;
1600
1799
  /**
1800
+ * @public
1601
1801
  * <p>The message sender.</p>
1602
1802
  */
1603
1803
  Sender?: Identity;
1604
1804
  /**
1805
+ * @public
1605
1806
  * <p>Indicates whether a message was redacted.</p>
1606
1807
  */
1607
1808
  Redacted?: boolean;
@@ -1612,6 +1813,7 @@ export interface ChannelMessageSummary {
1612
1813
  */
1613
1814
  export interface ChannelModeratedByAppInstanceUserSummary {
1614
1815
  /**
1816
+ * @public
1615
1817
  * <p>Summary of the details of a <code>Channel</code>.</p>
1616
1818
  */
1617
1819
  ChannelSummary?: ChannelSummary;
@@ -1622,18 +1824,22 @@ export interface ChannelModeratedByAppInstanceUserSummary {
1622
1824
  */
1623
1825
  export interface ChannelModerator {
1624
1826
  /**
1827
+ * @public
1625
1828
  * <p>The moderator's data.</p>
1626
1829
  */
1627
1830
  Moderator?: Identity;
1628
1831
  /**
1832
+ * @public
1629
1833
  * <p>The ARN of the moderator's channel.</p>
1630
1834
  */
1631
1835
  ChannelArn?: string;
1632
1836
  /**
1837
+ * @public
1633
1838
  * <p>The time at which the moderator was created.</p>
1634
1839
  */
1635
1840
  CreatedTimestamp?: Date;
1636
1841
  /**
1842
+ * @public
1637
1843
  * <p>The <code>AppInstanceUser</code> who created the moderator.</p>
1638
1844
  */
1639
1845
  CreatedBy?: Identity;
@@ -1644,6 +1850,7 @@ export interface ChannelModerator {
1644
1850
  */
1645
1851
  export interface ChannelModeratorSummary {
1646
1852
  /**
1853
+ * @public
1647
1854
  * <p>The data for a moderator.</p>
1648
1855
  */
1649
1856
  Moderator?: Identity;
@@ -1654,10 +1861,12 @@ export interface ChannelModeratorSummary {
1654
1861
  */
1655
1862
  export interface SelectedVideoStreams {
1656
1863
  /**
1864
+ * @public
1657
1865
  * <p>The attendee IDs of the streams selected for a media capture pipeline. </p>
1658
1866
  */
1659
1867
  AttendeeIds?: string[];
1660
1868
  /**
1869
+ * @public
1661
1870
  * <p>The external user IDs of the streams selected for a media capture pipeline.</p>
1662
1871
  */
1663
1872
  ExternalUserIds?: string[];
@@ -1668,6 +1877,7 @@ export interface SelectedVideoStreams {
1668
1877
  */
1669
1878
  export interface SourceConfiguration {
1670
1879
  /**
1880
+ * @public
1671
1881
  * <p>The selected video streams to capture for a specified media capture pipeline. The number of video streams can't exceed 25.</p>
1672
1882
  */
1673
1883
  SelectedVideoStreams?: SelectedVideoStreams;
@@ -1678,10 +1888,12 @@ export interface SourceConfiguration {
1678
1888
  */
1679
1889
  export interface ChimeSdkMeetingConfiguration {
1680
1890
  /**
1891
+ * @public
1681
1892
  * <p>The source configuration for a specified media capture pipeline.</p>
1682
1893
  */
1683
1894
  SourceConfiguration?: SourceConfiguration;
1684
1895
  /**
1896
+ * @public
1685
1897
  * <p>The configuration for the artifacts in an Amazon Chime SDK meeting.</p>
1686
1898
  */
1687
1899
  ArtifactsConfiguration?: ArtifactsConfiguration;
@@ -1707,6 +1919,7 @@ export declare class ConflictException extends __BaseException {
1707
1919
  */
1708
1920
  export interface ConversationRetentionSettings {
1709
1921
  /**
1922
+ * @public
1710
1923
  * <p>The number of days for which to retain conversation messages.</p>
1711
1924
  */
1712
1925
  RetentionDays?: number;
@@ -1716,6 +1929,7 @@ export interface ConversationRetentionSettings {
1716
1929
  */
1717
1930
  export interface CreateAccountRequest {
1718
1931
  /**
1932
+ * @public
1719
1933
  * <p>The name of the Amazon Chime account.</p>
1720
1934
  */
1721
1935
  Name: string | undefined;
@@ -1725,6 +1939,7 @@ export interface CreateAccountRequest {
1725
1939
  */
1726
1940
  export interface CreateAccountResponse {
1727
1941
  /**
1942
+ * @public
1728
1943
  * <p>The Amazon Chime account details.</p>
1729
1944
  */
1730
1945
  Account?: Account;
@@ -1734,18 +1949,22 @@ export interface CreateAccountResponse {
1734
1949
  */
1735
1950
  export interface CreateAppInstanceRequest {
1736
1951
  /**
1952
+ * @public
1737
1953
  * <p>The name of the <code>AppInstance</code>.</p>
1738
1954
  */
1739
1955
  Name: string | undefined;
1740
1956
  /**
1957
+ * @public
1741
1958
  * <p>The metadata of the <code>AppInstance</code>. Limited to a 1KB string in UTF-8.</p>
1742
1959
  */
1743
1960
  Metadata?: string;
1744
1961
  /**
1962
+ * @public
1745
1963
  * <p>The <code>ClientRequestToken</code> of the <code>AppInstance</code>.</p>
1746
1964
  */
1747
1965
  ClientRequestToken?: string;
1748
1966
  /**
1967
+ * @public
1749
1968
  * <p>Tags assigned to the <code>AppInstance</code>.</p>
1750
1969
  */
1751
1970
  Tags?: Tag[];
@@ -1755,6 +1974,7 @@ export interface CreateAppInstanceRequest {
1755
1974
  */
1756
1975
  export interface CreateAppInstanceResponse {
1757
1976
  /**
1977
+ * @public
1758
1978
  * <p>The Amazon Resource Number (ARN) of the <code>AppInstance</code>.</p>
1759
1979
  */
1760
1980
  AppInstanceArn?: string;
@@ -1764,10 +1984,12 @@ export interface CreateAppInstanceResponse {
1764
1984
  */
1765
1985
  export interface CreateAppInstanceAdminRequest {
1766
1986
  /**
1987
+ * @public
1767
1988
  * <p>The ARN of the administrator of the current <code>AppInstance</code>.</p>
1768
1989
  */
1769
1990
  AppInstanceAdminArn: string | undefined;
1770
1991
  /**
1992
+ * @public
1771
1993
  * <p>The ARN of the <code>AppInstance</code>.</p>
1772
1994
  */
1773
1995
  AppInstanceArn: string | undefined;
@@ -1777,10 +1999,12 @@ export interface CreateAppInstanceAdminRequest {
1777
1999
  */
1778
2000
  export interface CreateAppInstanceAdminResponse {
1779
2001
  /**
2002
+ * @public
1780
2003
  * <p>The name and ARN of the admin for the <code>AppInstance</code>.</p>
1781
2004
  */
1782
2005
  AppInstanceAdmin?: Identity;
1783
2006
  /**
2007
+ * @public
1784
2008
  * <p>The ARN of the of the admin for the <code>AppInstance</code>.</p>
1785
2009
  */
1786
2010
  AppInstanceArn?: string;
@@ -1790,26 +2014,32 @@ export interface CreateAppInstanceAdminResponse {
1790
2014
  */
1791
2015
  export interface CreateAppInstanceUserRequest {
1792
2016
  /**
2017
+ * @public
1793
2018
  * <p>The ARN of the <code>AppInstance</code> request.</p>
1794
2019
  */
1795
2020
  AppInstanceArn: string | undefined;
1796
2021
  /**
2022
+ * @public
1797
2023
  * <p>The user ID of the <code>AppInstance</code>.</p>
1798
2024
  */
1799
2025
  AppInstanceUserId: string | undefined;
1800
2026
  /**
2027
+ * @public
1801
2028
  * <p>The user's name.</p>
1802
2029
  */
1803
2030
  Name: string | undefined;
1804
2031
  /**
2032
+ * @public
1805
2033
  * <p>The request's metadata. Limited to a 1KB string in UTF-8.</p>
1806
2034
  */
1807
2035
  Metadata?: string;
1808
2036
  /**
2037
+ * @public
1809
2038
  * <p>The token assigned to the user requesting an <code>AppInstance</code>.</p>
1810
2039
  */
1811
2040
  ClientRequestToken?: string;
1812
2041
  /**
2042
+ * @public
1813
2043
  * <p>Tags assigned to the <code>AppInstanceUser</code>.</p>
1814
2044
  */
1815
2045
  Tags?: Tag[];
@@ -1819,6 +2049,7 @@ export interface CreateAppInstanceUserRequest {
1819
2049
  */
1820
2050
  export interface CreateAppInstanceUserResponse {
1821
2051
  /**
2052
+ * @public
1822
2053
  * <p>The user's ARN.</p>
1823
2054
  */
1824
2055
  AppInstanceUserArn?: string;
@@ -1828,14 +2059,17 @@ export interface CreateAppInstanceUserResponse {
1828
2059
  */
1829
2060
  export interface CreateAttendeeRequest {
1830
2061
  /**
2062
+ * @public
1831
2063
  * <p>The Amazon Chime SDK meeting ID.</p>
1832
2064
  */
1833
2065
  MeetingId: string | undefined;
1834
2066
  /**
2067
+ * @public
1835
2068
  * <p>The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.</p>
1836
2069
  */
1837
2070
  ExternalUserId: string | undefined;
1838
2071
  /**
2072
+ * @public
1839
2073
  * <p>The tag key-value pairs.</p>
1840
2074
  */
1841
2075
  Tags?: Tag[];
@@ -1845,6 +2079,7 @@ export interface CreateAttendeeRequest {
1845
2079
  */
1846
2080
  export interface CreateAttendeeResponse {
1847
2081
  /**
2082
+ * @public
1848
2083
  * <p>The attendee information, including attendee ID and join token.</p>
1849
2084
  */
1850
2085
  Attendee?: Attendee;
@@ -1854,14 +2089,17 @@ export interface CreateAttendeeResponse {
1854
2089
  */
1855
2090
  export interface CreateBotRequest {
1856
2091
  /**
2092
+ * @public
1857
2093
  * <p>The Amazon Chime account ID.</p>
1858
2094
  */
1859
2095
  AccountId: string | undefined;
1860
2096
  /**
2097
+ * @public
1861
2098
  * <p>The bot display name.</p>
1862
2099
  */
1863
2100
  DisplayName: string | undefined;
1864
2101
  /**
2102
+ * @public
1865
2103
  * <p>The domain of the Amazon Chime Enterprise account.</p>
1866
2104
  */
1867
2105
  Domain?: string;
@@ -1871,6 +2109,7 @@ export interface CreateBotRequest {
1871
2109
  */
1872
2110
  export interface CreateBotResponse {
1873
2111
  /**
2112
+ * @public
1874
2113
  * <p>The bot details.</p>
1875
2114
  */
1876
2115
  Bot?: Bot;
@@ -1880,38 +2119,46 @@ export interface CreateBotResponse {
1880
2119
  */
1881
2120
  export interface CreateChannelRequest {
1882
2121
  /**
2122
+ * @public
1883
2123
  * <p>The ARN of the channel request.</p>
1884
2124
  */
1885
2125
  AppInstanceArn: string | undefined;
1886
2126
  /**
2127
+ * @public
1887
2128
  * <p>The name of the channel.</p>
1888
2129
  */
1889
2130
  Name: string | undefined;
1890
2131
  /**
2132
+ * @public
1891
2133
  * <p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators,
1892
2134
  * moderators, and channel members can add themselves and other members to unrestricted
1893
2135
  * channels. Only administrators and moderators can add members to restricted channels.</p>
1894
2136
  */
1895
2137
  Mode?: ChannelMode | string;
1896
2138
  /**
2139
+ * @public
1897
2140
  * <p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private
1898
2141
  * channels aren't discoverable by users outside the channel. Public channels are discoverable
1899
2142
  * by anyone in the <code>AppInstance</code>.</p>
1900
2143
  */
1901
2144
  Privacy?: ChannelPrivacy | string;
1902
2145
  /**
2146
+ * @public
1903
2147
  * <p>The metadata of the creation request. Limited to 1KB and UTF-8.</p>
1904
2148
  */
1905
2149
  Metadata?: string;
1906
2150
  /**
2151
+ * @public
1907
2152
  * <p>The client token for the request. An <code>Idempotency</code> token.</p>
1908
2153
  */
1909
2154
  ClientRequestToken?: string;
1910
2155
  /**
2156
+ * @public
1911
2157
  * <p>The tags for the creation request.</p>
1912
2158
  */
1913
2159
  Tags?: Tag[];
1914
2160
  /**
2161
+ * @public
1915
2162
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
1916
2163
  */
1917
2164
  ChimeBearer?: string;
@@ -1921,6 +2168,7 @@ export interface CreateChannelRequest {
1921
2168
  */
1922
2169
  export interface CreateChannelResponse {
1923
2170
  /**
2171
+ * @public
1924
2172
  * <p>The ARN of the channel.</p>
1925
2173
  */
1926
2174
  ChannelArn?: string;
@@ -1930,14 +2178,17 @@ export interface CreateChannelResponse {
1930
2178
  */
1931
2179
  export interface CreateChannelBanRequest {
1932
2180
  /**
2181
+ * @public
1933
2182
  * <p>The ARN of the ban request.</p>
1934
2183
  */
1935
2184
  ChannelArn: string | undefined;
1936
2185
  /**
2186
+ * @public
1937
2187
  * <p>The ARN of the member being banned.</p>
1938
2188
  */
1939
2189
  MemberArn: string | undefined;
1940
2190
  /**
2191
+ * @public
1941
2192
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
1942
2193
  */
1943
2194
  ChimeBearer?: string;
@@ -1947,10 +2198,12 @@ export interface CreateChannelBanRequest {
1947
2198
  */
1948
2199
  export interface CreateChannelBanResponse {
1949
2200
  /**
2201
+ * @public
1950
2202
  * <p>The ARN of the response to the ban request.</p>
1951
2203
  */
1952
2204
  ChannelArn?: string;
1953
2205
  /**
2206
+ * @public
1954
2207
  * <p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban
1955
2208
  * response.</p>
1956
2209
  */
@@ -1961,14 +2214,17 @@ export interface CreateChannelBanResponse {
1961
2214
  */
1962
2215
  export interface CreateChannelMembershipRequest {
1963
2216
  /**
2217
+ * @public
1964
2218
  * <p>The ARN of the channel to which you're adding users.</p>
1965
2219
  */
1966
2220
  ChannelArn: string | undefined;
1967
2221
  /**
2222
+ * @public
1968
2223
  * <p>The ARN of the member you want to add to the channel.</p>
1969
2224
  */
1970
2225
  MemberArn: string | undefined;
1971
2226
  /**
2227
+ * @public
1972
2228
  * <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
1973
2229
  * members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
1974
2230
  * are only returned if the type filter in <code>ListChannelMemberships</code> equals
@@ -1977,6 +2233,7 @@ export interface CreateChannelMembershipRequest {
1977
2233
  */
1978
2234
  Type: ChannelMembershipType | string | undefined;
1979
2235
  /**
2236
+ * @public
1980
2237
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
1981
2238
  */
1982
2239
  ChimeBearer?: string;
@@ -1986,10 +2243,12 @@ export interface CreateChannelMembershipRequest {
1986
2243
  */
1987
2244
  export interface CreateChannelMembershipResponse {
1988
2245
  /**
2246
+ * @public
1989
2247
  * <p>The ARN of the channel.</p>
1990
2248
  */
1991
2249
  ChannelArn?: string;
1992
2250
  /**
2251
+ * @public
1993
2252
  * <p>The ARN and metadata of the member being added.</p>
1994
2253
  */
1995
2254
  Member?: Identity;
@@ -1999,14 +2258,17 @@ export interface CreateChannelMembershipResponse {
1999
2258
  */
2000
2259
  export interface CreateChannelModeratorRequest {
2001
2260
  /**
2261
+ * @public
2002
2262
  * <p>The ARN of the channel.</p>
2003
2263
  */
2004
2264
  ChannelArn: string | undefined;
2005
2265
  /**
2266
+ * @public
2006
2267
  * <p>The ARN of the moderator.</p>
2007
2268
  */
2008
2269
  ChannelModeratorArn: string | undefined;
2009
2270
  /**
2271
+ * @public
2010
2272
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
2011
2273
  */
2012
2274
  ChimeBearer?: string;
@@ -2016,10 +2278,12 @@ export interface CreateChannelModeratorRequest {
2016
2278
  */
2017
2279
  export interface CreateChannelModeratorResponse {
2018
2280
  /**
2281
+ * @public
2019
2282
  * <p>The ARN of the channel.</p>
2020
2283
  */
2021
2284
  ChannelArn?: string;
2022
2285
  /**
2286
+ * @public
2023
2287
  * <p>The ARNs of the channel and the moderator.</p>
2024
2288
  */
2025
2289
  ChannelModerator?: Identity;
@@ -2051,27 +2315,33 @@ export type MediaPipelineSourceType = (typeof MediaPipelineSourceType)[keyof typ
2051
2315
  */
2052
2316
  export interface CreateMediaCapturePipelineRequest {
2053
2317
  /**
2318
+ * @public
2054
2319
  * <p>Source type from which the media artifacts will be captured. A Chime SDK Meeting
2055
2320
  * is the only supported source.</p>
2056
2321
  */
2057
2322
  SourceType: MediaPipelineSourceType | string | undefined;
2058
2323
  /**
2324
+ * @public
2059
2325
  * <p>ARN of the source from which the media artifacts are captured.</p>
2060
2326
  */
2061
2327
  SourceArn: string | undefined;
2062
2328
  /**
2329
+ * @public
2063
2330
  * <p>Destination type to which the media artifacts are saved. You must use an S3 bucket. </p>
2064
2331
  */
2065
2332
  SinkType: MediaPipelineSinkType | string | undefined;
2066
2333
  /**
2334
+ * @public
2067
2335
  * <p>The ARN of the sink type.</p>
2068
2336
  */
2069
2337
  SinkArn: string | undefined;
2070
2338
  /**
2339
+ * @public
2071
2340
  * <p>The unique identifier for the client request. The token makes the API request idempotent. Use a different token for different media pipeline requests.</p>
2072
2341
  */
2073
2342
  ClientRequestToken?: string;
2074
2343
  /**
2344
+ * @public
2075
2345
  * <p>The configuration for a specified media capture pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>
2076
2346
  */
2077
2347
  ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
@@ -2097,38 +2367,47 @@ export type MediaPipelineStatus = (typeof MediaPipelineStatus)[keyof typeof Medi
2097
2367
  */
2098
2368
  export interface MediaCapturePipeline {
2099
2369
  /**
2370
+ * @public
2100
2371
  * <p>The ID of a media capture pipeline.</p>
2101
2372
  */
2102
2373
  MediaPipelineId?: string;
2103
2374
  /**
2375
+ * @public
2104
2376
  * <p>Source type from which media artifacts are saved. You must use <code>ChimeMeeting</code>.</p>
2105
2377
  */
2106
2378
  SourceType?: MediaPipelineSourceType | string;
2107
2379
  /**
2380
+ * @public
2108
2381
  * <p>ARN of the source from which the media artifacts will be saved.</p>
2109
2382
  */
2110
2383
  SourceArn?: string;
2111
2384
  /**
2385
+ * @public
2112
2386
  * <p>The status of the media capture pipeline.</p>
2113
2387
  */
2114
2388
  Status?: MediaPipelineStatus | string;
2115
2389
  /**
2390
+ * @public
2116
2391
  * <p>Destination type to which the media artifacts are saved. You must use an S3 Bucket.</p>
2117
2392
  */
2118
2393
  SinkType?: MediaPipelineSinkType | string;
2119
2394
  /**
2395
+ * @public
2120
2396
  * <p>ARN of the destination to which the media artifacts are saved.</p>
2121
2397
  */
2122
2398
  SinkArn?: string;
2123
2399
  /**
2400
+ * @public
2124
2401
  * <p>The time at which the capture pipeline was created, in ISO 8601 format.</p>
2125
2402
  */
2126
2403
  CreatedTimestamp?: Date;
2127
2404
  /**
2405
+ * @public
2128
2406
  * <p>The time at which the capture pipeline was updated, in ISO 8601 format.</p>
2129
2407
  */
2130
2408
  UpdatedTimestamp?: Date;
2131
2409
  /**
2410
+ * @public
2132
2411
  * <p>The configuration for a specified media capture pipeline. <code>SourceType</code> must be <code>ChimeSdkMeeting</code>.</p>
2133
2412
  */
2134
2413
  ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
@@ -2138,6 +2417,7 @@ export interface MediaCapturePipeline {
2138
2417
  */
2139
2418
  export interface CreateMediaCapturePipelineResponse {
2140
2419
  /**
2420
+ * @public
2141
2421
  * <p>A media capture pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media capture pipeline object.</p>
2142
2422
  */
2143
2423
  MediaCapturePipeline?: MediaCapturePipeline;
@@ -2150,10 +2430,12 @@ export interface CreateMediaCapturePipelineResponse {
2150
2430
  */
2151
2431
  export interface MeetingNotificationConfiguration {
2152
2432
  /**
2433
+ * @public
2153
2434
  * <p>The SNS topic ARN.</p>
2154
2435
  */
2155
2436
  SnsTopicArn?: string;
2156
2437
  /**
2438
+ * @public
2157
2439
  * <p>The SQS queue ARN.</p>
2158
2440
  */
2159
2441
  SqsQueueArn?: string;
@@ -2163,18 +2445,22 @@ export interface MeetingNotificationConfiguration {
2163
2445
  */
2164
2446
  export interface CreateMeetingRequest {
2165
2447
  /**
2448
+ * @public
2166
2449
  * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
2167
2450
  */
2168
2451
  ClientRequestToken?: string;
2169
2452
  /**
2453
+ * @public
2170
2454
  * <p>The external meeting ID.</p>
2171
2455
  */
2172
2456
  ExternalMeetingId?: string;
2173
2457
  /**
2458
+ * @public
2174
2459
  * <p>Reserved.</p>
2175
2460
  */
2176
2461
  MeetingHostId?: string;
2177
2462
  /**
2463
+ * @public
2178
2464
  * <p>
2179
2465
  * The Region in which to create the meeting. Default: <code>us-east-1</code>.
2180
2466
  * </p>
@@ -2220,10 +2506,12 @@ export interface CreateMeetingRequest {
2220
2506
  */
2221
2507
  MediaRegion?: string;
2222
2508
  /**
2509
+ * @public
2223
2510
  * <p>The tag key-value pairs.</p>
2224
2511
  */
2225
2512
  Tags?: Tag[];
2226
2513
  /**
2514
+ * @public
2227
2515
  * <p>The configuration for resource targets to receive notifications when meeting and attendee events occur.</p>
2228
2516
  */
2229
2517
  NotificationsConfiguration?: MeetingNotificationConfiguration;
@@ -2234,14 +2522,17 @@ export interface CreateMeetingRequest {
2234
2522
  */
2235
2523
  export interface MediaPlacement {
2236
2524
  /**
2525
+ * @public
2237
2526
  * <p>The audio host URL.</p>
2238
2527
  */
2239
2528
  AudioHostUrl?: string;
2240
2529
  /**
2530
+ * @public
2241
2531
  * <p>The audio fallback URL.</p>
2242
2532
  */
2243
2533
  AudioFallbackUrl?: string;
2244
2534
  /**
2535
+ * @public
2245
2536
  * <p>The screen data URL.</p>
2246
2537
  * <important>
2247
2538
  * <p>
@@ -2251,6 +2542,7 @@ export interface MediaPlacement {
2251
2542
  */
2252
2543
  ScreenDataUrl?: string;
2253
2544
  /**
2545
+ * @public
2254
2546
  * <p>The screen sharing URL.</p>
2255
2547
  * <important>
2256
2548
  * <p>
@@ -2259,6 +2551,7 @@ export interface MediaPlacement {
2259
2551
  */
2260
2552
  ScreenSharingUrl?: string;
2261
2553
  /**
2554
+ * @public
2262
2555
  * <p>The screen viewing URL.</p>
2263
2556
  * <important>
2264
2557
  * <p>
@@ -2268,10 +2561,12 @@ export interface MediaPlacement {
2268
2561
  */
2269
2562
  ScreenViewingUrl?: string;
2270
2563
  /**
2564
+ * @public
2271
2565
  * <p>The signaling URL.</p>
2272
2566
  */
2273
2567
  SignalingUrl?: string;
2274
2568
  /**
2569
+ * @public
2275
2570
  * <p>The turn control URL.</p>
2276
2571
  * <important>
2277
2572
  * <p>
@@ -2281,6 +2576,7 @@ export interface MediaPlacement {
2281
2576
  */
2282
2577
  TurnControlUrl?: string;
2283
2578
  /**
2579
+ * @public
2284
2580
  * <p>The event ingestion URL to which you send client meeting events.</p>
2285
2581
  */
2286
2582
  EventIngestionUrl?: string;
@@ -2291,18 +2587,22 @@ export interface MediaPlacement {
2291
2587
  */
2292
2588
  export interface Meeting {
2293
2589
  /**
2590
+ * @public
2294
2591
  * <p>The Amazon Chime SDK meeting ID.</p>
2295
2592
  */
2296
2593
  MeetingId?: string;
2297
2594
  /**
2595
+ * @public
2298
2596
  * <p>The external meeting ID.</p>
2299
2597
  */
2300
2598
  ExternalMeetingId?: string;
2301
2599
  /**
2600
+ * @public
2302
2601
  * <p>The media placement for the meeting.</p>
2303
2602
  */
2304
2603
  MediaPlacement?: MediaPlacement;
2305
2604
  /**
2605
+ * @public
2306
2606
  * <p>The Region in which you create the meeting. Available values: <code>af-south-1</code>, <code>ap-northeast-1</code>,
2307
2607
  * <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>,
2308
2608
  * <code>eu-central-1</code>, <code>eu-north-1</code>, <code>eu-south-1</code>,
@@ -2317,6 +2617,7 @@ export interface Meeting {
2317
2617
  */
2318
2618
  export interface CreateMeetingResponse {
2319
2619
  /**
2620
+ * @public
2320
2621
  * <p>
2321
2622
  * The meeting information, including the meeting ID and
2322
2623
  * <code>MediaPlacement</code>
@@ -2330,18 +2631,22 @@ export interface CreateMeetingResponse {
2330
2631
  */
2331
2632
  export interface CreateMeetingDialOutRequest {
2332
2633
  /**
2634
+ * @public
2333
2635
  * <p>The Amazon Chime SDK meeting ID.</p>
2334
2636
  */
2335
2637
  MeetingId: string | undefined;
2336
2638
  /**
2639
+ * @public
2337
2640
  * <p>Phone number used as the caller ID when the remote party receives a call.</p>
2338
2641
  */
2339
2642
  FromPhoneNumber: string | undefined;
2340
2643
  /**
2644
+ * @public
2341
2645
  * <p>Phone number called when inviting someone to a meeting.</p>
2342
2646
  */
2343
2647
  ToPhoneNumber: string | undefined;
2344
2648
  /**
2649
+ * @public
2345
2650
  * <p>Token used by the Amazon Chime SDK attendee. Call the <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_CreateAttendee.html">CreateAttendee</a> action to get a join token.</p>
2346
2651
  */
2347
2652
  JoinToken: string | undefined;
@@ -2351,6 +2656,7 @@ export interface CreateMeetingDialOutRequest {
2351
2656
  */
2352
2657
  export interface CreateMeetingDialOutResponse {
2353
2658
  /**
2659
+ * @public
2354
2660
  * <p>Unique ID that tracks API calls.</p>
2355
2661
  */
2356
2662
  TransactionId?: string;
@@ -2360,18 +2666,22 @@ export interface CreateMeetingDialOutResponse {
2360
2666
  */
2361
2667
  export interface CreateMeetingWithAttendeesRequest {
2362
2668
  /**
2669
+ * @public
2363
2670
  * <p>The unique identifier for the client request. Use a different token for different meetings.</p>
2364
2671
  */
2365
2672
  ClientRequestToken?: string;
2366
2673
  /**
2674
+ * @public
2367
2675
  * <p>The external meeting ID.</p>
2368
2676
  */
2369
2677
  ExternalMeetingId?: string;
2370
2678
  /**
2679
+ * @public
2371
2680
  * <p>Reserved.</p>
2372
2681
  */
2373
2682
  MeetingHostId?: string;
2374
2683
  /**
2684
+ * @public
2375
2685
  * <p>
2376
2686
  * The Region in which to create the meeting. Default: <code>us-east-1</code>
2377
2687
  * .
@@ -2418,16 +2728,19 @@ export interface CreateMeetingWithAttendeesRequest {
2418
2728
  */
2419
2729
  MediaRegion?: string;
2420
2730
  /**
2731
+ * @public
2421
2732
  * <p>The tag key-value pairs.</p>
2422
2733
  */
2423
2734
  Tags?: Tag[];
2424
2735
  /**
2736
+ * @public
2425
2737
  * <p>The resource target configurations for receiving Amazon Chime SDK meeting and attendee event
2426
2738
  * notifications. The Amazon Chime SDK supports resource targets located in the US East (N. Virginia) AWS
2427
2739
  * Region (us-east-1).</p>
2428
2740
  */
2429
2741
  NotificationsConfiguration?: MeetingNotificationConfiguration;
2430
2742
  /**
2743
+ * @public
2431
2744
  * <p>The request containing the attendees to create.</p>
2432
2745
  */
2433
2746
  Attendees?: CreateAttendeeRequestItem[];
@@ -2437,14 +2750,17 @@ export interface CreateMeetingWithAttendeesRequest {
2437
2750
  */
2438
2751
  export interface CreateMeetingWithAttendeesResponse {
2439
2752
  /**
2753
+ * @public
2440
2754
  * <p>A meeting created using the Amazon Chime SDK.</p>
2441
2755
  */
2442
2756
  Meeting?: Meeting;
2443
2757
  /**
2758
+ * @public
2444
2759
  * <p>The attendee information, including attendees IDs and join tokens.</p>
2445
2760
  */
2446
2761
  Attendees?: Attendee[];
2447
2762
  /**
2763
+ * @public
2448
2764
  * <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>
2449
2765
  */
2450
2766
  Errors?: CreateAttendeeError[];
@@ -2454,10 +2770,12 @@ export interface CreateMeetingWithAttendeesResponse {
2454
2770
  */
2455
2771
  export interface CreatePhoneNumberOrderRequest {
2456
2772
  /**
2773
+ * @public
2457
2774
  * <p>The phone number product type.</p>
2458
2775
  */
2459
2776
  ProductType: PhoneNumberProductType | string | undefined;
2460
2777
  /**
2778
+ * @public
2461
2779
  * <p>List of phone numbers, in E.164 format.</p>
2462
2780
  */
2463
2781
  E164PhoneNumbers: string[] | undefined;
@@ -2481,10 +2799,12 @@ export type OrderedPhoneNumberStatus = (typeof OrderedPhoneNumberStatus)[keyof t
2481
2799
  */
2482
2800
  export interface OrderedPhoneNumber {
2483
2801
  /**
2802
+ * @public
2484
2803
  * <p>The phone number, in E.164 format.</p>
2485
2804
  */
2486
2805
  E164PhoneNumber?: string;
2487
2806
  /**
2807
+ * @public
2488
2808
  * <p>The phone number status.</p>
2489
2809
  */
2490
2810
  Status?: OrderedPhoneNumberStatus | string;
@@ -2509,27 +2829,33 @@ export type PhoneNumberOrderStatus = (typeof PhoneNumberOrderStatus)[keyof typeo
2509
2829
  */
2510
2830
  export interface PhoneNumberOrder {
2511
2831
  /**
2832
+ * @public
2512
2833
  * <p>The phone number order ID.</p>
2513
2834
  */
2514
2835
  PhoneNumberOrderId?: string;
2515
2836
  /**
2837
+ * @public
2516
2838
  * <p>The phone number order product type.</p>
2517
2839
  */
2518
2840
  ProductType?: PhoneNumberProductType | string;
2519
2841
  /**
2842
+ * @public
2520
2843
  * <p>The status of the phone number order.</p>
2521
2844
  */
2522
2845
  Status?: PhoneNumberOrderStatus | string;
2523
2846
  /**
2847
+ * @public
2524
2848
  * <p>The ordered phone number details, such as the phone number in E.164 format and the phone
2525
2849
  * number status.</p>
2526
2850
  */
2527
2851
  OrderedPhoneNumbers?: OrderedPhoneNumber[];
2528
2852
  /**
2853
+ * @public
2529
2854
  * <p>The phone number order creation time stamp, in ISO 8601 format.</p>
2530
2855
  */
2531
2856
  CreatedTimestamp?: Date;
2532
2857
  /**
2858
+ * @public
2533
2859
  * <p>The updated phone number order time stamp, in ISO 8601 format.</p>
2534
2860
  */
2535
2861
  UpdatedTimestamp?: Date;
@@ -2539,6 +2865,7 @@ export interface PhoneNumberOrder {
2539
2865
  */
2540
2866
  export interface CreatePhoneNumberOrderResponse {
2541
2867
  /**
2868
+ * @public
2542
2869
  * <p>The phone number order details.</p>
2543
2870
  */
2544
2871
  PhoneNumberOrder?: PhoneNumberOrder;
@@ -2561,10 +2888,12 @@ export type GeoMatchLevel = (typeof GeoMatchLevel)[keyof typeof GeoMatchLevel];
2561
2888
  */
2562
2889
  export interface GeoMatchParams {
2563
2890
  /**
2891
+ * @public
2564
2892
  * <p>The country.</p>
2565
2893
  */
2566
2894
  Country: string | undefined;
2567
2895
  /**
2896
+ * @public
2568
2897
  * <p>The area code.</p>
2569
2898
  */
2570
2899
  AreaCode: string | undefined;
@@ -2586,34 +2915,42 @@ export type NumberSelectionBehavior = (typeof NumberSelectionBehavior)[keyof typ
2586
2915
  */
2587
2916
  export interface CreateProxySessionRequest {
2588
2917
  /**
2918
+ * @public
2589
2919
  * <p>The Amazon Chime voice connector ID.</p>
2590
2920
  */
2591
2921
  VoiceConnectorId: string | undefined;
2592
2922
  /**
2923
+ * @public
2593
2924
  * <p>The participant phone numbers.</p>
2594
2925
  */
2595
2926
  ParticipantPhoneNumbers: string[] | undefined;
2596
2927
  /**
2928
+ * @public
2597
2929
  * <p>The name of the proxy session.</p>
2598
2930
  */
2599
2931
  Name?: string;
2600
2932
  /**
2933
+ * @public
2601
2934
  * <p>The number of minutes allowed for the proxy session.</p>
2602
2935
  */
2603
2936
  ExpiryMinutes?: number;
2604
2937
  /**
2938
+ * @public
2605
2939
  * <p>The proxy session capabilities.</p>
2606
2940
  */
2607
2941
  Capabilities: (Capability | string)[] | undefined;
2608
2942
  /**
2943
+ * @public
2609
2944
  * <p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>
2610
2945
  */
2611
2946
  NumberSelectionBehavior?: NumberSelectionBehavior | string;
2612
2947
  /**
2948
+ * @public
2613
2949
  * <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
2614
2950
  */
2615
2951
  GeoMatchLevel?: GeoMatchLevel | string;
2616
2952
  /**
2953
+ * @public
2617
2954
  * <p>The country and area code for the proxy phone number.</p>
2618
2955
  */
2619
2956
  GeoMatchParams?: GeoMatchParams;
@@ -2624,10 +2961,12 @@ export interface CreateProxySessionRequest {
2624
2961
  */
2625
2962
  export interface Participant {
2626
2963
  /**
2964
+ * @public
2627
2965
  * <p>The participant's phone number.</p>
2628
2966
  */
2629
2967
  PhoneNumber?: string;
2630
2968
  /**
2969
+ * @public
2631
2970
  * <p>The participant's proxy phone number.</p>
2632
2971
  */
2633
2972
  ProxyPhoneNumber?: string;
@@ -2651,54 +2990,67 @@ export type ProxySessionStatus = (typeof ProxySessionStatus)[keyof typeof ProxyS
2651
2990
  */
2652
2991
  export interface ProxySession {
2653
2992
  /**
2993
+ * @public
2654
2994
  * <p>The Amazon Chime voice connector ID.</p>
2655
2995
  */
2656
2996
  VoiceConnectorId?: string;
2657
2997
  /**
2998
+ * @public
2658
2999
  * <p>The proxy session ID.</p>
2659
3000
  */
2660
3001
  ProxySessionId?: string;
2661
3002
  /**
3003
+ * @public
2662
3004
  * <p>The name of the proxy session.</p>
2663
3005
  */
2664
3006
  Name?: string;
2665
3007
  /**
3008
+ * @public
2666
3009
  * <p>The status of the proxy session.</p>
2667
3010
  */
2668
3011
  Status?: ProxySessionStatus | string;
2669
3012
  /**
3013
+ * @public
2670
3014
  * <p>The number of minutes allowed for the proxy session.</p>
2671
3015
  */
2672
3016
  ExpiryMinutes?: number;
2673
3017
  /**
3018
+ * @public
2674
3019
  * <p>The proxy session capabilities.</p>
2675
3020
  */
2676
3021
  Capabilities?: (Capability | string)[];
2677
3022
  /**
3023
+ * @public
2678
3024
  * <p>The created time stamp, in ISO 8601 format.</p>
2679
3025
  */
2680
3026
  CreatedTimestamp?: Date;
2681
3027
  /**
3028
+ * @public
2682
3029
  * <p>The updated time stamp, in ISO 8601 format.</p>
2683
3030
  */
2684
3031
  UpdatedTimestamp?: Date;
2685
3032
  /**
3033
+ * @public
2686
3034
  * <p>The ended time stamp, in ISO 8601 format.</p>
2687
3035
  */
2688
3036
  EndedTimestamp?: Date;
2689
3037
  /**
3038
+ * @public
2690
3039
  * <p>The proxy session participants.</p>
2691
3040
  */
2692
3041
  Participants?: Participant[];
2693
3042
  /**
3043
+ * @public
2694
3044
  * <p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>
2695
3045
  */
2696
3046
  NumberSelectionBehavior?: NumberSelectionBehavior | string;
2697
3047
  /**
3048
+ * @public
2698
3049
  * <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
2699
3050
  */
2700
3051
  GeoMatchLevel?: GeoMatchLevel | string;
2701
3052
  /**
3053
+ * @public
2702
3054
  * <p>The country and area code for the proxy phone number.</p>
2703
3055
  */
2704
3056
  GeoMatchParams?: GeoMatchParams;
@@ -2708,6 +3060,7 @@ export interface ProxySession {
2708
3060
  */
2709
3061
  export interface CreateProxySessionResponse {
2710
3062
  /**
3063
+ * @public
2711
3064
  * <p>The proxy session details.</p>
2712
3065
  */
2713
3066
  ProxySession?: ProxySession;
@@ -2717,14 +3070,17 @@ export interface CreateProxySessionResponse {
2717
3070
  */
2718
3071
  export interface CreateRoomRequest {
2719
3072
  /**
3073
+ * @public
2720
3074
  * <p>The Amazon Chime account ID.</p>
2721
3075
  */
2722
3076
  AccountId: string | undefined;
2723
3077
  /**
3078
+ * @public
2724
3079
  * <p>The room name.</p>
2725
3080
  */
2726
3081
  Name: string | undefined;
2727
3082
  /**
3083
+ * @public
2728
3084
  * <p>The idempotency token for the request.</p>
2729
3085
  */
2730
3086
  ClientRequestToken?: string;
@@ -2735,26 +3091,32 @@ export interface CreateRoomRequest {
2735
3091
  */
2736
3092
  export interface Room {
2737
3093
  /**
3094
+ * @public
2738
3095
  * <p>The room ID.</p>
2739
3096
  */
2740
3097
  RoomId?: string;
2741
3098
  /**
3099
+ * @public
2742
3100
  * <p>The room name.</p>
2743
3101
  */
2744
3102
  Name?: string;
2745
3103
  /**
3104
+ * @public
2746
3105
  * <p>The Amazon Chime account ID.</p>
2747
3106
  */
2748
3107
  AccountId?: string;
2749
3108
  /**
3109
+ * @public
2750
3110
  * <p>The identifier of the room creator.</p>
2751
3111
  */
2752
3112
  CreatedBy?: string;
2753
3113
  /**
3114
+ * @public
2754
3115
  * <p>The room creation timestamp, in ISO 8601 format.</p>
2755
3116
  */
2756
3117
  CreatedTimestamp?: Date;
2757
3118
  /**
3119
+ * @public
2758
3120
  * <p>The room update timestamp, in ISO 8601 format.</p>
2759
3121
  */
2760
3122
  UpdatedTimestamp?: Date;
@@ -2764,6 +3126,7 @@ export interface Room {
2764
3126
  */
2765
3127
  export interface CreateRoomResponse {
2766
3128
  /**
3129
+ * @public
2767
3130
  * <p>The room details.</p>
2768
3131
  */
2769
3132
  Room?: Room;
@@ -2773,18 +3136,22 @@ export interface CreateRoomResponse {
2773
3136
  */
2774
3137
  export interface CreateRoomMembershipRequest {
2775
3138
  /**
3139
+ * @public
2776
3140
  * <p>The Amazon Chime account ID.</p>
2777
3141
  */
2778
3142
  AccountId: string | undefined;
2779
3143
  /**
3144
+ * @public
2780
3145
  * <p>The room ID.</p>
2781
3146
  */
2782
3147
  RoomId: string | undefined;
2783
3148
  /**
3149
+ * @public
2784
3150
  * <p>The Amazon Chime member ID (user ID or bot ID).</p>
2785
3151
  */
2786
3152
  MemberId: string | undefined;
2787
3153
  /**
3154
+ * @public
2788
3155
  * <p>The role of the member.</p>
2789
3156
  */
2790
3157
  Role?: RoomMembershipRole | string;
@@ -2808,22 +3175,27 @@ export type MemberType = (typeof MemberType)[keyof typeof MemberType];
2808
3175
  */
2809
3176
  export interface Member {
2810
3177
  /**
3178
+ * @public
2811
3179
  * <p>The member ID (user ID or bot ID).</p>
2812
3180
  */
2813
3181
  MemberId?: string;
2814
3182
  /**
3183
+ * @public
2815
3184
  * <p>The member type.</p>
2816
3185
  */
2817
3186
  MemberType?: MemberType | string;
2818
3187
  /**
3188
+ * @public
2819
3189
  * <p>The member email address.</p>
2820
3190
  */
2821
3191
  Email?: string;
2822
3192
  /**
3193
+ * @public
2823
3194
  * <p>The member name.</p>
2824
3195
  */
2825
3196
  FullName?: string;
2826
3197
  /**
3198
+ * @public
2827
3199
  * <p>The Amazon Chime account ID.</p>
2828
3200
  */
2829
3201
  AccountId?: string;
@@ -2834,22 +3206,27 @@ export interface Member {
2834
3206
  */
2835
3207
  export interface RoomMembership {
2836
3208
  /**
3209
+ * @public
2837
3210
  * <p>The room ID.</p>
2838
3211
  */
2839
3212
  RoomId?: string;
2840
3213
  /**
3214
+ * @public
2841
3215
  * <p>The member details, such as email address, name, member ID, and member type.</p>
2842
3216
  */
2843
3217
  Member?: Member;
2844
3218
  /**
3219
+ * @public
2845
3220
  * <p>The membership role.</p>
2846
3221
  */
2847
3222
  Role?: RoomMembershipRole | string;
2848
3223
  /**
3224
+ * @public
2849
3225
  * <p>The identifier of the user that invited the room member.</p>
2850
3226
  */
2851
3227
  InvitedBy?: string;
2852
3228
  /**
3229
+ * @public
2853
3230
  * <p>The room membership update timestamp, in ISO 8601 format.</p>
2854
3231
  */
2855
3232
  UpdatedTimestamp?: Date;
@@ -2859,6 +3236,7 @@ export interface RoomMembership {
2859
3236
  */
2860
3237
  export interface CreateRoomMembershipResponse {
2861
3238
  /**
3239
+ * @public
2862
3240
  * <p>The room membership details.</p>
2863
3241
  */
2864
3242
  RoomMembership?: RoomMembership;
@@ -2869,6 +3247,7 @@ export interface CreateRoomMembershipResponse {
2869
3247
  */
2870
3248
  export interface SipMediaApplicationEndpoint {
2871
3249
  /**
3250
+ * @public
2872
3251
  * <p>Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The function must be created in the same AWS Region as the SIP media application.</p>
2873
3252
  */
2874
3253
  LambdaArn?: string;
@@ -2878,14 +3257,17 @@ export interface SipMediaApplicationEndpoint {
2878
3257
  */
2879
3258
  export interface CreateSipMediaApplicationRequest {
2880
3259
  /**
3260
+ * @public
2881
3261
  * <p>The AWS Region assigned to the SIP media application.</p>
2882
3262
  */
2883
3263
  AwsRegion: string | undefined;
2884
3264
  /**
3265
+ * @public
2885
3266
  * <p>The SIP media application name.</p>
2886
3267
  */
2887
3268
  Name: string | undefined;
2888
3269
  /**
3270
+ * @public
2889
3271
  * <p>List of endpoints (Lambda Amazon Resource Names) specified for the SIP media application. Currently, only one endpoint is supported.</p>
2890
3272
  */
2891
3273
  Endpoints: SipMediaApplicationEndpoint[] | undefined;
@@ -2896,26 +3278,32 @@ export interface CreateSipMediaApplicationRequest {
2896
3278
  */
2897
3279
  export interface SipMediaApplication {
2898
3280
  /**
3281
+ * @public
2899
3282
  * <p>The SIP media application ID.</p>
2900
3283
  */
2901
3284
  SipMediaApplicationId?: string;
2902
3285
  /**
3286
+ * @public
2903
3287
  * <p>The AWS Region in which the SIP media application is created.</p>
2904
3288
  */
2905
3289
  AwsRegion?: string;
2906
3290
  /**
3291
+ * @public
2907
3292
  * <p>The name of the SIP media application.</p>
2908
3293
  */
2909
3294
  Name?: string;
2910
3295
  /**
3296
+ * @public
2911
3297
  * <p>List of endpoints for SIP media application. Currently, only one endpoint per SIP media application is permitted.</p>
2912
3298
  */
2913
3299
  Endpoints?: SipMediaApplicationEndpoint[];
2914
3300
  /**
3301
+ * @public
2915
3302
  * <p>The SIP media application creation timestamp, in ISO 8601 format.</p>
2916
3303
  */
2917
3304
  CreatedTimestamp?: Date;
2918
3305
  /**
3306
+ * @public
2919
3307
  * <p>The SIP media application updated timestamp, in ISO 8601 format.</p>
2920
3308
  */
2921
3309
  UpdatedTimestamp?: Date;
@@ -2925,6 +3313,7 @@ export interface SipMediaApplication {
2925
3313
  */
2926
3314
  export interface CreateSipMediaApplicationResponse {
2927
3315
  /**
3316
+ * @public
2928
3317
  * <p>The SIP media application details.</p>
2929
3318
  */
2930
3319
  SipMediaApplication?: SipMediaApplication;
@@ -2934,18 +3323,22 @@ export interface CreateSipMediaApplicationResponse {
2934
3323
  */
2935
3324
  export interface CreateSipMediaApplicationCallRequest {
2936
3325
  /**
3326
+ * @public
2937
3327
  * <p>The phone number that a user calls from. This is a phone number in your Amazon Chime phone number inventory.</p>
2938
3328
  */
2939
3329
  FromPhoneNumber: string | undefined;
2940
3330
  /**
3331
+ * @public
2941
3332
  * <p>The phone number that the service should call.</p>
2942
3333
  */
2943
3334
  ToPhoneNumber: string | undefined;
2944
3335
  /**
3336
+ * @public
2945
3337
  * <p>The ID of the SIP media application.</p>
2946
3338
  */
2947
3339
  SipMediaApplicationId: string | undefined;
2948
3340
  /**
3341
+ * @public
2949
3342
  * <p>The SIP headers added to an outbound call leg.</p>
2950
3343
  */
2951
3344
  SipHeaders?: Record<string, string>;
@@ -2956,6 +3349,7 @@ export interface CreateSipMediaApplicationCallRequest {
2956
3349
  */
2957
3350
  export interface SipMediaApplicationCall {
2958
3351
  /**
3352
+ * @public
2959
3353
  * <p>The transaction ID of a call.</p>
2960
3354
  */
2961
3355
  TransactionId?: string;
@@ -2965,6 +3359,7 @@ export interface SipMediaApplicationCall {
2965
3359
  */
2966
3360
  export interface CreateSipMediaApplicationCallResponse {
2967
3361
  /**
3362
+ * @public
2968
3363
  * <p>The actual call.</p>
2969
3364
  */
2970
3365
  SipMediaApplicationCall?: SipMediaApplicationCall;
@@ -2976,14 +3371,17 @@ export interface CreateSipMediaApplicationCallResponse {
2976
3371
  */
2977
3372
  export interface SipRuleTargetApplication {
2978
3373
  /**
3374
+ * @public
2979
3375
  * <p>The SIP media application ID.</p>
2980
3376
  */
2981
3377
  SipMediaApplicationId?: string;
2982
3378
  /**
3379
+ * @public
2983
3380
  * <p>Priority of the SIP media application in the target list.</p>
2984
3381
  */
2985
3382
  Priority?: number;
2986
3383
  /**
3384
+ * @public
2987
3385
  * <p>The AWS Region of the target application.</p>
2988
3386
  */
2989
3387
  AwsRegion?: string;
@@ -3005,14 +3403,17 @@ export type SipRuleTriggerType = (typeof SipRuleTriggerType)[keyof typeof SipRul
3005
3403
  */
3006
3404
  export interface CreateSipRuleRequest {
3007
3405
  /**
3406
+ * @public
3008
3407
  * <p>The name of the SIP rule.</p>
3009
3408
  */
3010
3409
  Name: string | undefined;
3011
3410
  /**
3411
+ * @public
3012
3412
  * <p>The type of trigger assigned to the SIP rule in <code>TriggerValue</code>, currently <code>RequestUriHostname</code> or <code>ToPhoneNumber</code>.</p>
3013
3413
  */
3014
3414
  TriggerType: SipRuleTriggerType | string | undefined;
3015
3415
  /**
3416
+ * @public
3016
3417
  * <p>If <code>TriggerType</code> is <code>RequestUriHostname</code>, the value can be the outbound
3017
3418
  * host name of an Amazon Chime Voice Connector. If <code>TriggerType</code> is
3018
3419
  * <code>ToPhoneNumber</code>, the value can be a customer-owned phone number in the
@@ -3022,10 +3423,12 @@ export interface CreateSipRuleRequest {
3022
3423
  */
3023
3424
  TriggerValue: string | undefined;
3024
3425
  /**
3426
+ * @public
3025
3427
  * <p>Enables or disables a rule. You must disable rules before you can delete them.</p>
3026
3428
  */
3027
3429
  Disabled?: boolean;
3028
3430
  /**
3431
+ * @public
3029
3432
  * <p>List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used.</p>
3030
3433
  */
3031
3434
  TargetApplications: SipRuleTargetApplication[] | undefined;
@@ -3036,23 +3439,28 @@ export interface CreateSipRuleRequest {
3036
3439
  */
3037
3440
  export interface SipRule {
3038
3441
  /**
3442
+ * @public
3039
3443
  * <p>The SIP rule ID.</p>
3040
3444
  */
3041
3445
  SipRuleId?: string;
3042
3446
  /**
3447
+ * @public
3043
3448
  * <p>The name of the SIP rule.</p>
3044
3449
  */
3045
3450
  Name?: string;
3046
3451
  /**
3452
+ * @public
3047
3453
  * <p>Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.</p>
3048
3454
  */
3049
3455
  Disabled?: boolean;
3050
3456
  /**
3457
+ * @public
3051
3458
  * <p>The type of trigger assigned to the SIP rule in <code>TriggerValue</code>, currently <code>RequestUriHostname</code> or
3052
3459
  * <code>ToPhoneNumber</code>.</p>
3053
3460
  */
3054
3461
  TriggerType?: SipRuleTriggerType | string;
3055
3462
  /**
3463
+ * @public
3056
3464
  * <p>If <code>TriggerType</code> is <code>RequestUriHostname</code>, then the value can be the
3057
3465
  * outbound host name of the Amazon Chime Voice Connector. If <code>TriggerType</code> is
3058
3466
  * <code>ToPhoneNumber</code>, then the value can be a customer-owned phone number in
@@ -3061,15 +3469,18 @@ export interface SipRule {
3061
3469
  */
3062
3470
  TriggerValue?: string;
3063
3471
  /**
3472
+ * @public
3064
3473
  * <p>Target SIP media application and other details, such as priority and AWS Region, to be
3065
3474
  * specified in the SIP rule. Only one SIP rule per AWS Region can be provided.</p>
3066
3475
  */
3067
3476
  TargetApplications?: SipRuleTargetApplication[];
3068
3477
  /**
3478
+ * @public
3069
3479
  * <p>The time at which the SIP rule was created, in ISO 8601 format.</p>
3070
3480
  */
3071
3481
  CreatedTimestamp?: Date;
3072
3482
  /**
3483
+ * @public
3073
3484
  * <p>The time at which the SIP rule was last updated, in ISO 8601 format.</p>
3074
3485
  */
3075
3486
  UpdatedTimestamp?: Date;
@@ -3079,6 +3490,7 @@ export interface SipRule {
3079
3490
  */
3080
3491
  export interface CreateSipRuleResponse {
3081
3492
  /**
3493
+ * @public
3082
3494
  * <p>Returns the SIP rule information, including the rule ID, triggers, and target applications.</p>
3083
3495
  */
3084
3496
  SipRule?: SipRule;
@@ -3088,18 +3500,22 @@ export interface CreateSipRuleResponse {
3088
3500
  */
3089
3501
  export interface CreateUserRequest {
3090
3502
  /**
3503
+ * @public
3091
3504
  * <p>The Amazon Chime account ID.</p>
3092
3505
  */
3093
3506
  AccountId: string | undefined;
3094
3507
  /**
3508
+ * @public
3095
3509
  * <p>The user name.</p>
3096
3510
  */
3097
3511
  Username?: string;
3098
3512
  /**
3513
+ * @public
3099
3514
  * <p>The user's email address.</p>
3100
3515
  */
3101
3516
  Email?: string;
3102
3517
  /**
3518
+ * @public
3103
3519
  * <p>The user type.</p>
3104
3520
  */
3105
3521
  UserType?: UserType | string;
@@ -3136,54 +3552,67 @@ export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof Regist
3136
3552
  */
3137
3553
  export interface User {
3138
3554
  /**
3555
+ * @public
3139
3556
  * <p>The user ID.</p>
3140
3557
  */
3141
3558
  UserId: string | undefined;
3142
3559
  /**
3560
+ * @public
3143
3561
  * <p>The Amazon Chime account ID.</p>
3144
3562
  */
3145
3563
  AccountId?: string;
3146
3564
  /**
3565
+ * @public
3147
3566
  * <p>The primary email address of the user.</p>
3148
3567
  */
3149
3568
  PrimaryEmail?: string;
3150
3569
  /**
3570
+ * @public
3151
3571
  * <p>The primary phone number associated with the user.</p>
3152
3572
  */
3153
3573
  PrimaryProvisionedNumber?: string;
3154
3574
  /**
3575
+ * @public
3155
3576
  * <p>The display name of the user.</p>
3156
3577
  */
3157
3578
  DisplayName?: string;
3158
3579
  /**
3580
+ * @public
3159
3581
  * <p>The license type for the user.</p>
3160
3582
  */
3161
3583
  LicenseType?: License | string;
3162
3584
  /**
3585
+ * @public
3163
3586
  * <p>The user type.</p>
3164
3587
  */
3165
3588
  UserType?: UserType | string;
3166
3589
  /**
3590
+ * @public
3167
3591
  * <p>The user registration status.</p>
3168
3592
  */
3169
3593
  UserRegistrationStatus?: RegistrationStatus | string;
3170
3594
  /**
3595
+ * @public
3171
3596
  * <p>The user invite status.</p>
3172
3597
  */
3173
3598
  UserInvitationStatus?: InviteStatus | string;
3174
3599
  /**
3600
+ * @public
3175
3601
  * <p>Date and time when the user is registered, in ISO 8601 format.</p>
3176
3602
  */
3177
3603
  RegisteredOn?: Date;
3178
3604
  /**
3605
+ * @public
3179
3606
  * <p>Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.</p>
3180
3607
  */
3181
3608
  InvitedOn?: Date;
3182
3609
  /**
3610
+ * @public
3183
3611
  * <p>The Alexa for Business metadata.</p>
3184
3612
  */
3185
3613
  AlexaForBusinessMetadata?: AlexaForBusinessMetadata;
3186
3614
  /**
3615
+ * @public
3187
3616
  * <p>The user's personal meeting PIN.</p>
3188
3617
  */
3189
3618
  PersonalPIN?: string;
@@ -3193,6 +3622,7 @@ export interface User {
3193
3622
  */
3194
3623
  export interface CreateUserResponse {
3195
3624
  /**
3625
+ * @public
3196
3626
  * <p>The user on the Amazon Chime account.</p>
3197
3627
  */
3198
3628
  User?: User;
@@ -3214,10 +3644,12 @@ export type VoiceConnectorAwsRegion = (typeof VoiceConnectorAwsRegion)[keyof typ
3214
3644
  */
3215
3645
  export interface CreateVoiceConnectorRequest {
3216
3646
  /**
3647
+ * @public
3217
3648
  * <p>The name of the Amazon Chime Voice Connector.</p>
3218
3649
  */
3219
3650
  Name: string | undefined;
3220
3651
  /**
3652
+ * @public
3221
3653
  * <p>
3222
3654
  * The AWS Region in which the Amazon Chime Voice Connector is created. Default value:
3223
3655
  * <code>us-east-1</code>
@@ -3226,6 +3658,7 @@ export interface CreateVoiceConnectorRequest {
3226
3658
  */
3227
3659
  AwsRegion?: VoiceConnectorAwsRegion | string;
3228
3660
  /**
3661
+ * @public
3229
3662
  * <p>When enabled, requires encryption for the Amazon Chime Voice Connector.</p>
3230
3663
  */
3231
3664
  RequireEncryption: boolean | undefined;
@@ -3237,10 +3670,12 @@ export interface CreateVoiceConnectorRequest {
3237
3670
  */
3238
3671
  export interface VoiceConnector {
3239
3672
  /**
3673
+ * @public
3240
3674
  * <p>The Amazon Chime Voice Connector ID.</p>
3241
3675
  */
3242
3676
  VoiceConnectorId?: string;
3243
3677
  /**
3678
+ * @public
3244
3679
  * <p>
3245
3680
  * The AWS Region in which the Amazon Chime Voice Connector is created. Default:
3246
3681
  * <code>us-east-1</code>.
@@ -3248,26 +3683,32 @@ export interface VoiceConnector {
3248
3683
  */
3249
3684
  AwsRegion?: VoiceConnectorAwsRegion | string;
3250
3685
  /**
3686
+ * @public
3251
3687
  * <p>The name of the Amazon Chime Voice Connector.</p>
3252
3688
  */
3253
3689
  Name?: string;
3254
3690
  /**
3691
+ * @public
3255
3692
  * <p>The outbound host name for the Amazon Chime Voice Connector.</p>
3256
3693
  */
3257
3694
  OutboundHostName?: string;
3258
3695
  /**
3696
+ * @public
3259
3697
  * <p>Designates whether encryption is required for the Amazon Chime Voice Connector.</p>
3260
3698
  */
3261
3699
  RequireEncryption?: boolean;
3262
3700
  /**
3701
+ * @public
3263
3702
  * <p>The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.</p>
3264
3703
  */
3265
3704
  CreatedTimestamp?: Date;
3266
3705
  /**
3706
+ * @public
3267
3707
  * <p>The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.</p>
3268
3708
  */
3269
3709
  UpdatedTimestamp?: Date;
3270
3710
  /**
3711
+ * @public
3271
3712
  * <p>The ARN of the specified Amazon Chime Voice Connector.</p>
3272
3713
  */
3273
3714
  VoiceConnectorArn?: string;
@@ -3277,6 +3718,7 @@ export interface VoiceConnector {
3277
3718
  */
3278
3719
  export interface CreateVoiceConnectorResponse {
3279
3720
  /**
3721
+ * @public
3280
3722
  * <p>The Amazon Chime Voice Connector details.</p>
3281
3723
  */
3282
3724
  VoiceConnector?: VoiceConnector;
@@ -3289,10 +3731,12 @@ export interface CreateVoiceConnectorResponse {
3289
3731
  */
3290
3732
  export interface VoiceConnectorItem {
3291
3733
  /**
3734
+ * @public
3292
3735
  * <p>The Amazon Chime Voice Connector ID.</p>
3293
3736
  */
3294
3737
  VoiceConnectorId: string | undefined;
3295
3738
  /**
3739
+ * @public
3296
3740
  * <p>The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.</p>
3297
3741
  */
3298
3742
  Priority: number | undefined;
@@ -3302,10 +3746,12 @@ export interface VoiceConnectorItem {
3302
3746
  */
3303
3747
  export interface CreateVoiceConnectorGroupRequest {
3304
3748
  /**
3749
+ * @public
3305
3750
  * <p>The name of the Amazon Chime Voice Connector group.</p>
3306
3751
  */
3307
3752
  Name: string | undefined;
3308
3753
  /**
3754
+ * @public
3309
3755
  * <p>The Amazon Chime Voice Connectors to route inbound calls to.</p>
3310
3756
  */
3311
3757
  VoiceConnectorItems?: VoiceConnectorItem[];
@@ -3319,26 +3765,32 @@ export interface CreateVoiceConnectorGroupRequest {
3319
3765
  */
3320
3766
  export interface VoiceConnectorGroup {
3321
3767
  /**
3768
+ * @public
3322
3769
  * <p>The Amazon Chime Voice Connector group ID.</p>
3323
3770
  */
3324
3771
  VoiceConnectorGroupId?: string;
3325
3772
  /**
3773
+ * @public
3326
3774
  * <p>The name of the Amazon Chime Voice Connector group.</p>
3327
3775
  */
3328
3776
  Name?: string;
3329
3777
  /**
3778
+ * @public
3330
3779
  * <p>The Amazon Chime Voice Connectors to which to route inbound calls.</p>
3331
3780
  */
3332
3781
  VoiceConnectorItems?: VoiceConnectorItem[];
3333
3782
  /**
3783
+ * @public
3334
3784
  * <p>The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.</p>
3335
3785
  */
3336
3786
  CreatedTimestamp?: Date;
3337
3787
  /**
3788
+ * @public
3338
3789
  * <p>The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.</p>
3339
3790
  */
3340
3791
  UpdatedTimestamp?: Date;
3341
3792
  /**
3793
+ * @public
3342
3794
  * <p>The ARN of the specified Amazon Chime Voice Connector group.</p>
3343
3795
  */
3344
3796
  VoiceConnectorGroupArn?: string;
@@ -3348,6 +3800,7 @@ export interface VoiceConnectorGroup {
3348
3800
  */
3349
3801
  export interface CreateVoiceConnectorGroupResponse {
3350
3802
  /**
3803
+ * @public
3351
3804
  * <p>The Amazon Chime Voice Connector group details.</p>
3352
3805
  */
3353
3806
  VoiceConnectorGroup?: VoiceConnectorGroup;
@@ -3358,11 +3811,13 @@ export interface CreateVoiceConnectorGroupResponse {
3358
3811
  */
3359
3812
  export interface Credential {
3360
3813
  /**
3814
+ * @public
3361
3815
  * <p>The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII
3362
3816
  * format.</p>
3363
3817
  */
3364
3818
  Username?: string;
3365
3819
  /**
3820
+ * @public
3366
3821
  * <p>The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.</p>
3367
3822
  */
3368
3823
  Password?: string;
@@ -3372,6 +3827,7 @@ export interface Credential {
3372
3827
  */
3373
3828
  export interface DeleteAccountRequest {
3374
3829
  /**
3830
+ * @public
3375
3831
  * <p>The Amazon Chime account ID.</p>
3376
3832
  */
3377
3833
  AccountId: string | undefined;
@@ -3400,6 +3856,7 @@ export declare class UnprocessableEntityException extends __BaseException {
3400
3856
  */
3401
3857
  export interface DeleteAppInstanceRequest {
3402
3858
  /**
3859
+ * @public
3403
3860
  * <p>The ARN of the <code>AppInstance</code>.</p>
3404
3861
  */
3405
3862
  AppInstanceArn: string | undefined;
@@ -3409,10 +3866,12 @@ export interface DeleteAppInstanceRequest {
3409
3866
  */
3410
3867
  export interface DeleteAppInstanceAdminRequest {
3411
3868
  /**
3869
+ * @public
3412
3870
  * <p>The ARN of the <code>AppInstance</code>'s administrator.</p>
3413
3871
  */
3414
3872
  AppInstanceAdminArn: string | undefined;
3415
3873
  /**
3874
+ * @public
3416
3875
  * <p>The ARN of the <code>AppInstance</code>.</p>
3417
3876
  */
3418
3877
  AppInstanceArn: string | undefined;
@@ -3422,6 +3881,7 @@ export interface DeleteAppInstanceAdminRequest {
3422
3881
  */
3423
3882
  export interface DeleteAppInstanceStreamingConfigurationsRequest {
3424
3883
  /**
3884
+ * @public
3425
3885
  * <p>The ARN of the streaming configurations being deleted.</p>
3426
3886
  */
3427
3887
  AppInstanceArn: string | undefined;
@@ -3431,6 +3891,7 @@ export interface DeleteAppInstanceStreamingConfigurationsRequest {
3431
3891
  */
3432
3892
  export interface DeleteAppInstanceUserRequest {
3433
3893
  /**
3894
+ * @public
3434
3895
  * <p>The ARN of the user request being deleted.</p>
3435
3896
  */
3436
3897
  AppInstanceUserArn: string | undefined;
@@ -3440,10 +3901,12 @@ export interface DeleteAppInstanceUserRequest {
3440
3901
  */
3441
3902
  export interface DeleteAttendeeRequest {
3442
3903
  /**
3904
+ * @public
3443
3905
  * <p>The Amazon Chime SDK meeting ID.</p>
3444
3906
  */
3445
3907
  MeetingId: string | undefined;
3446
3908
  /**
3909
+ * @public
3447
3910
  * <p>The Amazon Chime SDK attendee ID.</p>
3448
3911
  */
3449
3912
  AttendeeId: string | undefined;
@@ -3453,10 +3916,12 @@ export interface DeleteAttendeeRequest {
3453
3916
  */
3454
3917
  export interface DeleteChannelRequest {
3455
3918
  /**
3919
+ * @public
3456
3920
  * <p>The ARN of the channel being deleted.</p>
3457
3921
  */
3458
3922
  ChannelArn: string | undefined;
3459
3923
  /**
3924
+ * @public
3460
3925
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3461
3926
  */
3462
3927
  ChimeBearer?: string;
@@ -3466,14 +3931,17 @@ export interface DeleteChannelRequest {
3466
3931
  */
3467
3932
  export interface DeleteChannelBanRequest {
3468
3933
  /**
3934
+ * @public
3469
3935
  * <p>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</p>
3470
3936
  */
3471
3937
  ChannelArn: string | undefined;
3472
3938
  /**
3939
+ * @public
3473
3940
  * <p>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</p>
3474
3941
  */
3475
3942
  MemberArn: string | undefined;
3476
3943
  /**
3944
+ * @public
3477
3945
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3478
3946
  */
3479
3947
  ChimeBearer?: string;
@@ -3483,14 +3951,17 @@ export interface DeleteChannelBanRequest {
3483
3951
  */
3484
3952
  export interface DeleteChannelMembershipRequest {
3485
3953
  /**
3954
+ * @public
3486
3955
  * <p>The ARN of the channel from which you want to remove the user.</p>
3487
3956
  */
3488
3957
  ChannelArn: string | undefined;
3489
3958
  /**
3959
+ * @public
3490
3960
  * <p>The ARN of the member that you're removing from the channel.</p>
3491
3961
  */
3492
3962
  MemberArn: string | undefined;
3493
3963
  /**
3964
+ * @public
3494
3965
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3495
3966
  */
3496
3967
  ChimeBearer?: string;
@@ -3500,14 +3971,17 @@ export interface DeleteChannelMembershipRequest {
3500
3971
  */
3501
3972
  export interface DeleteChannelMessageRequest {
3502
3973
  /**
3974
+ * @public
3503
3975
  * <p>The ARN of the channel.</p>
3504
3976
  */
3505
3977
  ChannelArn: string | undefined;
3506
3978
  /**
3979
+ * @public
3507
3980
  * <p>The ID of the message being deleted.</p>
3508
3981
  */
3509
3982
  MessageId: string | undefined;
3510
3983
  /**
3984
+ * @public
3511
3985
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3512
3986
  */
3513
3987
  ChimeBearer?: string;
@@ -3517,14 +3991,17 @@ export interface DeleteChannelMessageRequest {
3517
3991
  */
3518
3992
  export interface DeleteChannelModeratorRequest {
3519
3993
  /**
3994
+ * @public
3520
3995
  * <p>The ARN of the channel.</p>
3521
3996
  */
3522
3997
  ChannelArn: string | undefined;
3523
3998
  /**
3999
+ * @public
3524
4000
  * <p>The ARN of the moderator being deleted.</p>
3525
4001
  */
3526
4002
  ChannelModeratorArn: string | undefined;
3527
4003
  /**
4004
+ * @public
3528
4005
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3529
4006
  */
3530
4007
  ChimeBearer?: string;
@@ -3534,10 +4011,12 @@ export interface DeleteChannelModeratorRequest {
3534
4011
  */
3535
4012
  export interface DeleteEventsConfigurationRequest {
3536
4013
  /**
4014
+ * @public
3537
4015
  * <p>The Amazon Chime account ID.</p>
3538
4016
  */
3539
4017
  AccountId: string | undefined;
3540
4018
  /**
4019
+ * @public
3541
4020
  * <p>The bot ID.</p>
3542
4021
  */
3543
4022
  BotId: string | undefined;
@@ -3547,6 +4026,7 @@ export interface DeleteEventsConfigurationRequest {
3547
4026
  */
3548
4027
  export interface DeleteMediaCapturePipelineRequest {
3549
4028
  /**
4029
+ * @public
3550
4030
  * <p>The ID of the media capture pipeline being deleted. </p>
3551
4031
  */
3552
4032
  MediaPipelineId: string | undefined;
@@ -3556,6 +4036,7 @@ export interface DeleteMediaCapturePipelineRequest {
3556
4036
  */
3557
4037
  export interface DeleteMeetingRequest {
3558
4038
  /**
4039
+ * @public
3559
4040
  * <p>The Amazon Chime SDK meeting ID.</p>
3560
4041
  */
3561
4042
  MeetingId: string | undefined;
@@ -3565,6 +4046,7 @@ export interface DeleteMeetingRequest {
3565
4046
  */
3566
4047
  export interface DeletePhoneNumberRequest {
3567
4048
  /**
4049
+ * @public
3568
4050
  * <p>The phone number ID.</p>
3569
4051
  */
3570
4052
  PhoneNumberId: string | undefined;
@@ -3574,10 +4056,12 @@ export interface DeletePhoneNumberRequest {
3574
4056
  */
3575
4057
  export interface DeleteProxySessionRequest {
3576
4058
  /**
4059
+ * @public
3577
4060
  * <p>The Amazon Chime voice connector ID.</p>
3578
4061
  */
3579
4062
  VoiceConnectorId: string | undefined;
3580
4063
  /**
4064
+ * @public
3581
4065
  * <p>The proxy session ID.</p>
3582
4066
  */
3583
4067
  ProxySessionId: string | undefined;
@@ -3587,10 +4071,12 @@ export interface DeleteProxySessionRequest {
3587
4071
  */
3588
4072
  export interface DeleteRoomRequest {
3589
4073
  /**
4074
+ * @public
3590
4075
  * <p>The Amazon Chime account ID.</p>
3591
4076
  */
3592
4077
  AccountId: string | undefined;
3593
4078
  /**
4079
+ * @public
3594
4080
  * <p>The chat room ID.</p>
3595
4081
  */
3596
4082
  RoomId: string | undefined;
@@ -3600,14 +4086,17 @@ export interface DeleteRoomRequest {
3600
4086
  */
3601
4087
  export interface DeleteRoomMembershipRequest {
3602
4088
  /**
4089
+ * @public
3603
4090
  * <p>The Amazon Chime account ID.</p>
3604
4091
  */
3605
4092
  AccountId: string | undefined;
3606
4093
  /**
4094
+ * @public
3607
4095
  * <p>The room ID.</p>
3608
4096
  */
3609
4097
  RoomId: string | undefined;
3610
4098
  /**
4099
+ * @public
3611
4100
  * <p>The member ID (user ID or bot ID).</p>
3612
4101
  */
3613
4102
  MemberId: string | undefined;
@@ -3617,6 +4106,7 @@ export interface DeleteRoomMembershipRequest {
3617
4106
  */
3618
4107
  export interface DeleteSipMediaApplicationRequest {
3619
4108
  /**
4109
+ * @public
3620
4110
  * <p>The SIP media application ID.</p>
3621
4111
  */
3622
4112
  SipMediaApplicationId: string | undefined;
@@ -3626,6 +4116,7 @@ export interface DeleteSipMediaApplicationRequest {
3626
4116
  */
3627
4117
  export interface DeleteSipRuleRequest {
3628
4118
  /**
4119
+ * @public
3629
4120
  * <p>The SIP rule ID.</p>
3630
4121
  */
3631
4122
  SipRuleId: string | undefined;
@@ -3635,6 +4126,7 @@ export interface DeleteSipRuleRequest {
3635
4126
  */
3636
4127
  export interface DeleteVoiceConnectorRequest {
3637
4128
  /**
4129
+ * @public
3638
4130
  * <p>The Amazon Chime Voice Connector ID.</p>
3639
4131
  */
3640
4132
  VoiceConnectorId: string | undefined;
@@ -3644,6 +4136,7 @@ export interface DeleteVoiceConnectorRequest {
3644
4136
  */
3645
4137
  export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest {
3646
4138
  /**
4139
+ * @public
3647
4140
  * <p>The Amazon Chime Voice Connector ID.</p>
3648
4141
  */
3649
4142
  VoiceConnectorId: string | undefined;
@@ -3653,6 +4146,7 @@ export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest {
3653
4146
  */
3654
4147
  export interface DeleteVoiceConnectorGroupRequest {
3655
4148
  /**
4149
+ * @public
3656
4150
  * <p>The Amazon Chime Voice Connector group ID.</p>
3657
4151
  */
3658
4152
  VoiceConnectorGroupId: string | undefined;
@@ -3662,6 +4156,7 @@ export interface DeleteVoiceConnectorGroupRequest {
3662
4156
  */
3663
4157
  export interface DeleteVoiceConnectorOriginationRequest {
3664
4158
  /**
4159
+ * @public
3665
4160
  * <p>The Amazon Chime Voice Connector ID.</p>
3666
4161
  */
3667
4162
  VoiceConnectorId: string | undefined;
@@ -3671,6 +4166,7 @@ export interface DeleteVoiceConnectorOriginationRequest {
3671
4166
  */
3672
4167
  export interface DeleteVoiceConnectorProxyRequest {
3673
4168
  /**
4169
+ * @public
3674
4170
  * <p>The Amazon Chime Voice Connector ID.</p>
3675
4171
  */
3676
4172
  VoiceConnectorId: string | undefined;
@@ -3680,6 +4176,7 @@ export interface DeleteVoiceConnectorProxyRequest {
3680
4176
  */
3681
4177
  export interface DeleteVoiceConnectorStreamingConfigurationRequest {
3682
4178
  /**
4179
+ * @public
3683
4180
  * <p>The Amazon Chime Voice Connector ID.</p>
3684
4181
  */
3685
4182
  VoiceConnectorId: string | undefined;
@@ -3689,6 +4186,7 @@ export interface DeleteVoiceConnectorStreamingConfigurationRequest {
3689
4186
  */
3690
4187
  export interface DeleteVoiceConnectorTerminationRequest {
3691
4188
  /**
4189
+ * @public
3692
4190
  * <p>The Amazon Chime Voice Connector ID.</p>
3693
4191
  */
3694
4192
  VoiceConnectorId: string | undefined;
@@ -3698,10 +4196,12 @@ export interface DeleteVoiceConnectorTerminationRequest {
3698
4196
  */
3699
4197
  export interface DeleteVoiceConnectorTerminationCredentialsRequest {
3700
4198
  /**
4199
+ * @public
3701
4200
  * <p>The Amazon Chime Voice Connector ID.</p>
3702
4201
  */
3703
4202
  VoiceConnectorId: string | undefined;
3704
4203
  /**
4204
+ * @public
3705
4205
  * <p>The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.</p>
3706
4206
  */
3707
4207
  Usernames: string[] | undefined;
@@ -3711,6 +4211,7 @@ export interface DeleteVoiceConnectorTerminationCredentialsRequest {
3711
4211
  */
3712
4212
  export interface DescribeAppInstanceRequest {
3713
4213
  /**
4214
+ * @public
3714
4215
  * <p>The ARN of the <code>AppInstance</code>.</p>
3715
4216
  */
3716
4217
  AppInstanceArn: string | undefined;
@@ -3720,6 +4221,7 @@ export interface DescribeAppInstanceRequest {
3720
4221
  */
3721
4222
  export interface DescribeAppInstanceResponse {
3722
4223
  /**
4224
+ * @public
3723
4225
  * <p>The ARN, metadata, created and last-updated timestamps, and the name of the <code>AppInstance</code>. All
3724
4226
  * timestamps use epoch milliseconds.</p>
3725
4227
  */
@@ -3730,10 +4232,12 @@ export interface DescribeAppInstanceResponse {
3730
4232
  */
3731
4233
  export interface DescribeAppInstanceAdminRequest {
3732
4234
  /**
4235
+ * @public
3733
4236
  * <p>The ARN of the <code>AppInstanceAdmin</code>.</p>
3734
4237
  */
3735
4238
  AppInstanceAdminArn: string | undefined;
3736
4239
  /**
4240
+ * @public
3737
4241
  * <p>The ARN of the <code>AppInstance</code>.</p>
3738
4242
  */
3739
4243
  AppInstanceArn: string | undefined;
@@ -3743,6 +4247,7 @@ export interface DescribeAppInstanceAdminRequest {
3743
4247
  */
3744
4248
  export interface DescribeAppInstanceAdminResponse {
3745
4249
  /**
4250
+ * @public
3746
4251
  * <p>The ARN and name of the <code>AppInstanceUser</code>, the ARN of the <code>AppInstance</code>, and the created and
3747
4252
  * last-updated timestamps. All timestamps use epoch milliseconds.</p>
3748
4253
  */
@@ -3753,6 +4258,7 @@ export interface DescribeAppInstanceAdminResponse {
3753
4258
  */
3754
4259
  export interface DescribeAppInstanceUserRequest {
3755
4260
  /**
4261
+ * @public
3756
4262
  * <p>The ARN of the <code>AppInstanceUser</code>.</p>
3757
4263
  */
3758
4264
  AppInstanceUserArn: string | undefined;
@@ -3762,6 +4268,7 @@ export interface DescribeAppInstanceUserRequest {
3762
4268
  */
3763
4269
  export interface DescribeAppInstanceUserResponse {
3764
4270
  /**
4271
+ * @public
3765
4272
  * <p>The name of the <code>AppInstanceUser</code>.</p>
3766
4273
  */
3767
4274
  AppInstanceUser?: AppInstanceUser;
@@ -3771,10 +4278,12 @@ export interface DescribeAppInstanceUserResponse {
3771
4278
  */
3772
4279
  export interface DescribeChannelRequest {
3773
4280
  /**
4281
+ * @public
3774
4282
  * <p>The ARN of the channel.</p>
3775
4283
  */
3776
4284
  ChannelArn: string | undefined;
3777
4285
  /**
4286
+ * @public
3778
4287
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3779
4288
  */
3780
4289
  ChimeBearer?: string;
@@ -3784,6 +4293,7 @@ export interface DescribeChannelRequest {
3784
4293
  */
3785
4294
  export interface DescribeChannelResponse {
3786
4295
  /**
4296
+ * @public
3787
4297
  * <p>The channel details.</p>
3788
4298
  */
3789
4299
  Channel?: Channel;
@@ -3793,14 +4303,17 @@ export interface DescribeChannelResponse {
3793
4303
  */
3794
4304
  export interface DescribeChannelBanRequest {
3795
4305
  /**
4306
+ * @public
3796
4307
  * <p>The ARN of the channel from which the user is banned.</p>
3797
4308
  */
3798
4309
  ChannelArn: string | undefined;
3799
4310
  /**
4311
+ * @public
3800
4312
  * <p>The ARN of the member being banned.</p>
3801
4313
  */
3802
4314
  MemberArn: string | undefined;
3803
4315
  /**
4316
+ * @public
3804
4317
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3805
4318
  */
3806
4319
  ChimeBearer?: string;
@@ -3810,6 +4323,7 @@ export interface DescribeChannelBanRequest {
3810
4323
  */
3811
4324
  export interface DescribeChannelBanResponse {
3812
4325
  /**
4326
+ * @public
3813
4327
  * <p>The details of the ban.</p>
3814
4328
  */
3815
4329
  ChannelBan?: ChannelBan;
@@ -3819,14 +4333,17 @@ export interface DescribeChannelBanResponse {
3819
4333
  */
3820
4334
  export interface DescribeChannelMembershipRequest {
3821
4335
  /**
4336
+ * @public
3822
4337
  * <p>The ARN of the channel.</p>
3823
4338
  */
3824
4339
  ChannelArn: string | undefined;
3825
4340
  /**
4341
+ * @public
3826
4342
  * <p>The ARN of the member.</p>
3827
4343
  */
3828
4344
  MemberArn: string | undefined;
3829
4345
  /**
4346
+ * @public
3830
4347
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3831
4348
  */
3832
4349
  ChimeBearer?: string;
@@ -3836,6 +4353,7 @@ export interface DescribeChannelMembershipRequest {
3836
4353
  */
3837
4354
  export interface DescribeChannelMembershipResponse {
3838
4355
  /**
4356
+ * @public
3839
4357
  * <p>The details of the membership.</p>
3840
4358
  */
3841
4359
  ChannelMembership?: ChannelMembership;
@@ -3845,14 +4363,17 @@ export interface DescribeChannelMembershipResponse {
3845
4363
  */
3846
4364
  export interface DescribeChannelMembershipForAppInstanceUserRequest {
3847
4365
  /**
4366
+ * @public
3848
4367
  * <p>The ARN of the channel to which the user belongs.</p>
3849
4368
  */
3850
4369
  ChannelArn: string | undefined;
3851
4370
  /**
4371
+ * @public
3852
4372
  * <p>The ARN of the user in a channel.</p>
3853
4373
  */
3854
4374
  AppInstanceUserArn: string | undefined;
3855
4375
  /**
4376
+ * @public
3856
4377
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3857
4378
  */
3858
4379
  ChimeBearer?: string;
@@ -3862,6 +4383,7 @@ export interface DescribeChannelMembershipForAppInstanceUserRequest {
3862
4383
  */
3863
4384
  export interface DescribeChannelMembershipForAppInstanceUserResponse {
3864
4385
  /**
4386
+ * @public
3865
4387
  * <p>The channel to which a user belongs.</p>
3866
4388
  */
3867
4389
  ChannelMembership?: ChannelMembershipForAppInstanceUserSummary;
@@ -3871,14 +4393,17 @@ export interface DescribeChannelMembershipForAppInstanceUserResponse {
3871
4393
  */
3872
4394
  export interface DescribeChannelModeratedByAppInstanceUserRequest {
3873
4395
  /**
4396
+ * @public
3874
4397
  * <p>The ARN of the moderated channel.</p>
3875
4398
  */
3876
4399
  ChannelArn: string | undefined;
3877
4400
  /**
4401
+ * @public
3878
4402
  * <p>The ARN of the <code>AppInstanceUser</code> in the moderated channel.</p>
3879
4403
  */
3880
4404
  AppInstanceUserArn: string | undefined;
3881
4405
  /**
4406
+ * @public
3882
4407
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3883
4408
  */
3884
4409
  ChimeBearer?: string;
@@ -3888,6 +4413,7 @@ export interface DescribeChannelModeratedByAppInstanceUserRequest {
3888
4413
  */
3889
4414
  export interface DescribeChannelModeratedByAppInstanceUserResponse {
3890
4415
  /**
4416
+ * @public
3891
4417
  * <p>The moderated channel.</p>
3892
4418
  */
3893
4419
  Channel?: ChannelModeratedByAppInstanceUserSummary;
@@ -3897,14 +4423,17 @@ export interface DescribeChannelModeratedByAppInstanceUserResponse {
3897
4423
  */
3898
4424
  export interface DescribeChannelModeratorRequest {
3899
4425
  /**
4426
+ * @public
3900
4427
  * <p>The ARN of the channel.</p>
3901
4428
  */
3902
4429
  ChannelArn: string | undefined;
3903
4430
  /**
4431
+ * @public
3904
4432
  * <p>The ARN of the channel moderator.</p>
3905
4433
  */
3906
4434
  ChannelModeratorArn: string | undefined;
3907
4435
  /**
4436
+ * @public
3908
4437
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
3909
4438
  */
3910
4439
  ChimeBearer?: string;
@@ -3914,6 +4443,7 @@ export interface DescribeChannelModeratorRequest {
3914
4443
  */
3915
4444
  export interface DescribeChannelModeratorResponse {
3916
4445
  /**
4446
+ * @public
3917
4447
  * <p>The details of the channel moderator.</p>
3918
4448
  */
3919
4449
  ChannelModerator?: ChannelModerator;
@@ -3923,10 +4453,12 @@ export interface DescribeChannelModeratorResponse {
3923
4453
  */
3924
4454
  export interface DisassociatePhoneNumberFromUserRequest {
3925
4455
  /**
4456
+ * @public
3926
4457
  * <p>The Amazon Chime account ID.</p>
3927
4458
  */
3928
4459
  AccountId: string | undefined;
3929
4460
  /**
4461
+ * @public
3930
4462
  * <p>The user ID.</p>
3931
4463
  */
3932
4464
  UserId: string | undefined;
@@ -3941,10 +4473,12 @@ export interface DisassociatePhoneNumberFromUserResponse {
3941
4473
  */
3942
4474
  export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
3943
4475
  /**
4476
+ * @public
3944
4477
  * <p>The Amazon Chime Voice Connector ID.</p>
3945
4478
  */
3946
4479
  VoiceConnectorId: string | undefined;
3947
4480
  /**
4481
+ * @public
3948
4482
  * <p>List of phone numbers, in E.164 format.</p>
3949
4483
  */
3950
4484
  E164PhoneNumbers: string[] | undefined;
@@ -3954,6 +4488,7 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
3954
4488
  */
3955
4489
  export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
3956
4490
  /**
4491
+ * @public
3957
4492
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
3958
4493
  */
3959
4494
  PhoneNumberErrors?: PhoneNumberError[];
@@ -3963,10 +4498,12 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
3963
4498
  */
3964
4499
  export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
3965
4500
  /**
4501
+ * @public
3966
4502
  * <p>The Amazon Chime Voice Connector group ID.</p>
3967
4503
  */
3968
4504
  VoiceConnectorGroupId: string | undefined;
3969
4505
  /**
4506
+ * @public
3970
4507
  * <p>List of phone numbers, in E.164 format.</p>
3971
4508
  */
3972
4509
  E164PhoneNumbers: string[] | undefined;
@@ -3976,6 +4513,7 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
3976
4513
  */
3977
4514
  export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
3978
4515
  /**
4516
+ * @public
3979
4517
  * <p>If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.</p>
3980
4518
  */
3981
4519
  PhoneNumberErrors?: PhoneNumberError[];
@@ -3985,10 +4523,12 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
3985
4523
  */
3986
4524
  export interface DisassociateSigninDelegateGroupsFromAccountRequest {
3987
4525
  /**
4526
+ * @public
3988
4527
  * <p>The Amazon Chime account ID.</p>
3989
4528
  */
3990
4529
  AccountId: string | undefined;
3991
4530
  /**
4531
+ * @public
3992
4532
  * <p>The sign-in delegate group names.</p>
3993
4533
  */
3994
4534
  GroupNames: string[] | undefined;
@@ -4004,14 +4544,17 @@ export interface DisassociateSigninDelegateGroupsFromAccountResponse {
4004
4544
  */
4005
4545
  export interface DNISEmergencyCallingConfiguration {
4006
4546
  /**
4547
+ * @public
4007
4548
  * <p>The DNIS phone number to route emergency calls to, in E.164 format.</p>
4008
4549
  */
4009
4550
  EmergencyPhoneNumber: string | undefined;
4010
4551
  /**
4552
+ * @public
4011
4553
  * <p>The DNIS phone number to route test emergency calls to, in E.164 format.</p>
4012
4554
  */
4013
4555
  TestPhoneNumber?: string;
4014
4556
  /**
4557
+ * @public
4015
4558
  * <p>The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.</p>
4016
4559
  */
4017
4560
  CallingCountry: string | undefined;
@@ -4035,6 +4578,7 @@ export type EmailStatus = (typeof EmailStatus)[keyof typeof EmailStatus];
4035
4578
  */
4036
4579
  export interface EmergencyCallingConfiguration {
4037
4580
  /**
4581
+ * @public
4038
4582
  * <p>The Dialed Number Identification Service (DNIS) emergency calling configuration details.</p>
4039
4583
  */
4040
4584
  DNIS?: DNISEmergencyCallingConfiguration[];
@@ -4112,26 +4656,32 @@ export type TranscribeMedicalType = (typeof TranscribeMedicalType)[keyof typeof
4112
4656
  */
4113
4657
  export interface EngineTranscribeMedicalSettings {
4114
4658
  /**
4659
+ * @public
4115
4660
  * <p>The language code specified for the Amazon Transcribe Medical engine.</p>
4116
4661
  */
4117
4662
  LanguageCode: TranscribeMedicalLanguageCode | string | undefined;
4118
4663
  /**
4664
+ * @public
4119
4665
  * <p>The specialty specified for the Amazon Transcribe Medical engine.</p>
4120
4666
  */
4121
4667
  Specialty: TranscribeMedicalSpecialty | string | undefined;
4122
4668
  /**
4669
+ * @public
4123
4670
  * <p>The type of transcription.</p>
4124
4671
  */
4125
4672
  Type: TranscribeMedicalType | string | undefined;
4126
4673
  /**
4674
+ * @public
4127
4675
  * <p>The name of the vocabulary passed to Amazon Transcribe Medical.</p>
4128
4676
  */
4129
4677
  VocabularyName?: string;
4130
4678
  /**
4679
+ * @public
4131
4680
  * <p>The AWS Region passed to Amazon Transcribe Medical. If you don't specify a Region, Amazon Chime uses the meeting's Region.</p>
4132
4681
  */
4133
4682
  Region?: TranscribeMedicalRegion | string;
4134
4683
  /**
4684
+ * @public
4135
4685
  * <p>Labels all personally identifiable information (PII) identified in your transcript. If you don't include <code>PiiEntityTypes</code>, all PII is identified.</p>
4136
4686
  * <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>.</p>
4137
4687
  */
@@ -4241,11 +4791,13 @@ export type TranscribeVocabularyFilterMethod = (typeof TranscribeVocabularyFilte
4241
4791
  */
4242
4792
  export interface EngineTranscribeSettings {
4243
4793
  /**
4794
+ * @public
4244
4795
  * <p>Specify the language code that represents the language spoken.</p>
4245
4796
  * <p>If you're unsure of the language spoken in your audio, consider using <code>IdentifyLanguage</code> to enable automatic language identification.</p>
4246
4797
  */
4247
4798
  LanguageCode?: TranscribeLanguageCode | string;
4248
4799
  /**
4800
+ * @public
4249
4801
  * <p>Specify how you want your vocabulary filter applied to your transcript.</p>
4250
4802
  * <p> To replace words with <code>***</code>, choose <code>mask</code>.</p>
4251
4803
  * <p>To delete words, choose <code>remove</code>.</p>
@@ -4253,18 +4805,21 @@ export interface EngineTranscribeSettings {
4253
4805
  */
4254
4806
  VocabularyFilterMethod?: TranscribeVocabularyFilterMethod | string;
4255
4807
  /**
4808
+ * @public
4256
4809
  * <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>
4257
4810
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
4258
4811
  * <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>
4259
4812
  */
4260
4813
  VocabularyFilterName?: string;
4261
4814
  /**
4815
+ * @public
4262
4816
  * <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>
4263
4817
  * <p>If you use Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
4264
4818
  * <p>If you include <code>IdentifyLanguage</code> and want to use one or more custom vocabularies with your transcription, use the <code>VocabularyNames</code> parameter instead.</p>
4265
4819
  */
4266
4820
  VocabularyName?: string;
4267
4821
  /**
4822
+ * @public
4268
4823
  * <p>The AWS Region in which to use Amazon Transcribe.</p>
4269
4824
  * <p>If you don't specify a Region, then the <code>MediaRegion</code> parameter of the
4270
4825
  * <a href="https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html">CreateMeeting.html</a> API will be used. However, if Amazon Transcribe is not
@@ -4275,25 +4830,30 @@ export interface EngineTranscribeSettings {
4275
4830
  */
4276
4831
  Region?: TranscribeRegion | string;
4277
4832
  /**
4833
+ * @public
4278
4834
  * <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</p>
4279
4835
  */
4280
4836
  EnablePartialResultsStabilization?: boolean;
4281
4837
  /**
4838
+ * @public
4282
4839
  * <p>Specify the level of stability to use when you enable partial results stabilization (<code>EnablePartialResultsStabilization</code>).</p>
4283
4840
  * <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
4284
4841
  */
4285
4842
  PartialResultsStability?: TranscribePartialResultsStability | string;
4286
4843
  /**
4844
+ * @public
4287
4845
  * <p>Labels all personally identifiable information (PII) identified in your transcript. If you don't include <code>PiiEntityTypes</code>, all PII is identified.</p>
4288
4846
  * <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>.</p>
4289
4847
  */
4290
4848
  ContentIdentificationType?: TranscribeContentIdentificationType | string;
4291
4849
  /**
4850
+ * @public
4292
4851
  * <p>Content redaction is performed at the segment level. If you don't include <code>PiiEntityTypes</code>, all PII is redacted.</p>
4293
4852
  * <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code>.</p>
4294
4853
  */
4295
4854
  ContentRedactionType?: TranscribeContentRedactionType | string;
4296
4855
  /**
4856
+ * @public
4297
4857
  * <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>
4298
4858
  * <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>
4299
4859
  * <code>CREDIT_DEBIT_NUMBER</code>, <code>EMAIL</code>,<code>NAME</code>, <code>PHONE</code>, <code>PIN</code>,
@@ -4303,6 +4863,7 @@ export interface EngineTranscribeSettings {
4303
4863
  */
4304
4864
  PiiEntityTypes?: string;
4305
4865
  /**
4866
+ * @public
4306
4867
  * <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>
4307
4868
  * <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
4308
4869
  * with a language mismatch.</p>
@@ -4310,6 +4871,7 @@ export interface EngineTranscribeSettings {
4310
4871
  */
4311
4872
  LanguageModelName?: string;
4312
4873
  /**
4874
+ * @public
4313
4875
  * <p>Enables automatic language identification for your transcription.</p>
4314
4876
  * <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.
4315
4877
  * Including language options can improve transcription accuracy.</p>
@@ -4319,6 +4881,7 @@ export interface EngineTranscribeSettings {
4319
4881
  */
4320
4882
  IdentifyLanguage?: boolean;
4321
4883
  /**
4884
+ * @public
4322
4885
  * <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
4323
4886
  * are present, do not include this parameter.</p>
4324
4887
  * <p>Including language options can improve the accuracy of language identification.</p>
@@ -4329,17 +4892,20 @@ export interface EngineTranscribeSettings {
4329
4892
  */
4330
4893
  LanguageOptions?: string;
4331
4894
  /**
4895
+ * @public
4332
4896
  * <p>Specify a preferred language from the subset of languages codes you specified in <code>LanguageOptions</code>.</p>
4333
4897
  * <p>You can only use this parameter if you include <code>IdentifyLanguage</code> and <code>LanguageOptions</code>.</p>
4334
4898
  */
4335
4899
  PreferredLanguage?: TranscribeLanguageCode | string;
4336
4900
  /**
4901
+ * @public
4337
4902
  * <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>
4338
4903
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary must be available in Amazon Transcribe in each Region.</p>
4339
4904
  * <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>
4340
4905
  */
4341
4906
  VocabularyNames?: string;
4342
4907
  /**
4908
+ * @public
4343
4909
  * <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>
4344
4910
  * <p>If you use Amazon Transcribe in multiple Regions, the vocabulary filter must be available in Amazon Transcribe in each Region.</p>
4345
4911
  * <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>
@@ -4353,14 +4919,17 @@ export interface EngineTranscribeSettings {
4353
4919
  */
4354
4920
  export interface EventsConfiguration {
4355
4921
  /**
4922
+ * @public
4356
4923
  * <p>The bot ID.</p>
4357
4924
  */
4358
4925
  BotId?: string;
4359
4926
  /**
4927
+ * @public
4360
4928
  * <p>HTTPS endpoint that allows a bot to receive outgoing events.</p>
4361
4929
  */
4362
4930
  OutboundEventsHTTPSEndpoint?: string;
4363
4931
  /**
4932
+ * @public
4364
4933
  * <p>Lambda function ARN that allows a bot to receive outgoing events.</p>
4365
4934
  */
4366
4935
  LambdaFunctionArn?: string;
@@ -4370,6 +4939,7 @@ export interface EventsConfiguration {
4370
4939
  */
4371
4940
  export interface GetAccountRequest {
4372
4941
  /**
4942
+ * @public
4373
4943
  * <p>The Amazon Chime account ID.</p>
4374
4944
  */
4375
4945
  AccountId: string | undefined;
@@ -4379,6 +4949,7 @@ export interface GetAccountRequest {
4379
4949
  */
4380
4950
  export interface GetAccountResponse {
4381
4951
  /**
4952
+ * @public
4382
4953
  * <p>The Amazon Chime account details.</p>
4383
4954
  */
4384
4955
  Account?: Account;
@@ -4388,6 +4959,7 @@ export interface GetAccountResponse {
4388
4959
  */
4389
4960
  export interface GetAccountSettingsRequest {
4390
4961
  /**
4962
+ * @public
4391
4963
  * <p>The Amazon Chime account ID.</p>
4392
4964
  */
4393
4965
  AccountId: string | undefined;
@@ -4397,6 +4969,7 @@ export interface GetAccountSettingsRequest {
4397
4969
  */
4398
4970
  export interface GetAccountSettingsResponse {
4399
4971
  /**
4972
+ * @public
4400
4973
  * <p>The Amazon Chime account settings.</p>
4401
4974
  */
4402
4975
  AccountSettings?: AccountSettings;
@@ -4406,6 +4979,7 @@ export interface GetAccountSettingsResponse {
4406
4979
  */
4407
4980
  export interface GetAppInstanceRetentionSettingsRequest {
4408
4981
  /**
4982
+ * @public
4409
4983
  * <p>The ARN of the <code>AppInstance</code>.</p>
4410
4984
  */
4411
4985
  AppInstanceArn: string | undefined;
@@ -4415,10 +4989,12 @@ export interface GetAppInstanceRetentionSettingsRequest {
4415
4989
  */
4416
4990
  export interface GetAppInstanceRetentionSettingsResponse {
4417
4991
  /**
4992
+ * @public
4418
4993
  * <p>The retention settings for the <code>AppInstance</code>.</p>
4419
4994
  */
4420
4995
  AppInstanceRetentionSettings?: AppInstanceRetentionSettings;
4421
4996
  /**
4997
+ * @public
4422
4998
  * <p>The timestamp representing the time at which the specified items are retained, in Epoch Seconds.</p>
4423
4999
  */
4424
5000
  InitiateDeletionTimestamp?: Date;
@@ -4428,6 +5004,7 @@ export interface GetAppInstanceRetentionSettingsResponse {
4428
5004
  */
4429
5005
  export interface GetAppInstanceStreamingConfigurationsRequest {
4430
5006
  /**
5007
+ * @public
4431
5008
  * <p>The ARN of the <code>AppInstance</code>.</p>
4432
5009
  */
4433
5010
  AppInstanceArn: string | undefined;
@@ -4437,6 +5014,7 @@ export interface GetAppInstanceStreamingConfigurationsRequest {
4437
5014
  */
4438
5015
  export interface GetAppInstanceStreamingConfigurationsResponse {
4439
5016
  /**
5017
+ * @public
4440
5018
  * <p>The streaming settings.</p>
4441
5019
  */
4442
5020
  AppInstanceStreamingConfigurations?: AppInstanceStreamingConfiguration[];
@@ -4446,10 +5024,12 @@ export interface GetAppInstanceStreamingConfigurationsResponse {
4446
5024
  */
4447
5025
  export interface GetAttendeeRequest {
4448
5026
  /**
5027
+ * @public
4449
5028
  * <p>The Amazon Chime SDK meeting ID.</p>
4450
5029
  */
4451
5030
  MeetingId: string | undefined;
4452
5031
  /**
5032
+ * @public
4453
5033
  * <p>The Amazon Chime SDK attendee ID.</p>
4454
5034
  */
4455
5035
  AttendeeId: string | undefined;
@@ -4459,6 +5039,7 @@ export interface GetAttendeeRequest {
4459
5039
  */
4460
5040
  export interface GetAttendeeResponse {
4461
5041
  /**
5042
+ * @public
4462
5043
  * <p>The Amazon Chime SDK attendee information.</p>
4463
5044
  */
4464
5045
  Attendee?: Attendee;
@@ -4468,10 +5049,12 @@ export interface GetAttendeeResponse {
4468
5049
  */
4469
5050
  export interface GetBotRequest {
4470
5051
  /**
5052
+ * @public
4471
5053
  * <p>The Amazon Chime account ID.</p>
4472
5054
  */
4473
5055
  AccountId: string | undefined;
4474
5056
  /**
5057
+ * @public
4475
5058
  * <p>The bot ID.</p>
4476
5059
  */
4477
5060
  BotId: string | undefined;
@@ -4481,6 +5064,7 @@ export interface GetBotRequest {
4481
5064
  */
4482
5065
  export interface GetBotResponse {
4483
5066
  /**
5067
+ * @public
4484
5068
  * <p>The chat bot details.</p>
4485
5069
  */
4486
5070
  Bot?: Bot;
@@ -4490,14 +5074,17 @@ export interface GetBotResponse {
4490
5074
  */
4491
5075
  export interface GetChannelMessageRequest {
4492
5076
  /**
5077
+ * @public
4493
5078
  * <p>The ARN of the channel.</p>
4494
5079
  */
4495
5080
  ChannelArn: string | undefined;
4496
5081
  /**
5082
+ * @public
4497
5083
  * <p>The ID of the message.</p>
4498
5084
  */
4499
5085
  MessageId: string | undefined;
4500
5086
  /**
5087
+ * @public
4501
5088
  * <p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>
4502
5089
  */
4503
5090
  ChimeBearer?: string;
@@ -4507,6 +5094,7 @@ export interface GetChannelMessageRequest {
4507
5094
  */
4508
5095
  export interface GetChannelMessageResponse {
4509
5096
  /**
5097
+ * @public
4510
5098
  * <p>The details of and content in the message.</p>
4511
5099
  */
4512
5100
  ChannelMessage?: ChannelMessage;
@@ -4516,10 +5104,12 @@ export interface GetChannelMessageResponse {
4516
5104
  */
4517
5105
  export interface GetEventsConfigurationRequest {
4518
5106
  /**
5107
+ * @public
4519
5108
  * <p>The Amazon Chime account ID.</p>
4520
5109
  */
4521
5110
  AccountId: string | undefined;
4522
5111
  /**
5112
+ * @public
4523
5113
  * <p>The bot ID.</p>
4524
5114
  */
4525
5115
  BotId: string | undefined;
@@ -4529,6 +5119,7 @@ export interface GetEventsConfigurationRequest {
4529
5119
  */
4530
5120
  export interface GetEventsConfigurationResponse {
4531
5121
  /**
5122
+ * @public
4532
5123
  * <p>The events configuration details.</p>
4533
5124
  */
4534
5125
  EventsConfiguration?: EventsConfiguration;
@@ -4540,6 +5131,7 @@ export interface GetEventsConfigurationResponse {
4540
5131
  */
4541
5132
  export interface VoiceConnectorSettings {
4542
5133
  /**
5134
+ * @public
4543
5135
  * <p>The Amazon S3 bucket designated for call detail record storage.</p>
4544
5136
  */
4545
5137
  CdrBucket?: string;
@@ -4549,10 +5141,12 @@ export interface VoiceConnectorSettings {
4549
5141
  */
4550
5142
  export interface GetGlobalSettingsResponse {
4551
5143
  /**
5144
+ * @public
4552
5145
  * <p>The Amazon Chime Business Calling settings.</p>
4553
5146
  */
4554
5147
  BusinessCalling?: BusinessCallingSettings;
4555
5148
  /**
5149
+ * @public
4556
5150
  * <p>The Amazon Chime Voice Connector settings.</p>
4557
5151
  */
4558
5152
  VoiceConnector?: VoiceConnectorSettings;
@@ -4562,6 +5156,7 @@ export interface GetGlobalSettingsResponse {
4562
5156
  */
4563
5157
  export interface GetMediaCapturePipelineRequest {
4564
5158
  /**
5159
+ * @public
4565
5160
  * <p>The ID of the pipeline that you want to get.</p>
4566
5161
  */
4567
5162
  MediaPipelineId: string | undefined;
@@ -4571,6 +5166,7 @@ export interface GetMediaCapturePipelineRequest {
4571
5166
  */
4572
5167
  export interface GetMediaCapturePipelineResponse {
4573
5168
  /**
5169
+ * @public
4574
5170
  * <p>The media capture pipeline object.</p>
4575
5171
  */
4576
5172
  MediaCapturePipeline?: MediaCapturePipeline;
@@ -4580,6 +5176,7 @@ export interface GetMediaCapturePipelineResponse {
4580
5176
  */
4581
5177
  export interface GetMeetingRequest {
4582
5178
  /**
5179
+ * @public
4583
5180
  * <p>The Amazon Chime SDK meeting ID.</p>
4584
5181
  */
4585
5182
  MeetingId: string | undefined;
@@ -4589,6 +5186,7 @@ export interface GetMeetingRequest {
4589
5186
  */
4590
5187
  export interface GetMeetingResponse {
4591
5188
  /**
5189
+ * @public
4592
5190
  * <p>The Amazon Chime SDK meeting information.</p>
4593
5191
  */
4594
5192
  Meeting?: Meeting;
@@ -4604,6 +5202,7 @@ export interface GetMessagingSessionEndpointRequest {
4604
5202
  */
4605
5203
  export interface MessagingSessionEndpoint {
4606
5204
  /**
5205
+ * @public
4607
5206
  * <p>The endpoint to which you establish a websocket connection.</p>
4608
5207
  */
4609
5208
  Url?: string;
@@ -4613,6 +5212,7 @@ export interface MessagingSessionEndpoint {
4613
5212
  */
4614
5213
  export interface GetMessagingSessionEndpointResponse {
4615
5214
  /**
5215
+ * @public
4616
5216
  * <p>The endpoint returned in the response.</p>
4617
5217
  */
4618
5218
  Endpoint?: MessagingSessionEndpoint;
@@ -4622,6 +5222,7 @@ export interface GetMessagingSessionEndpointResponse {
4622
5222
  */
4623
5223
  export interface GetPhoneNumberRequest {
4624
5224
  /**
5225
+ * @public
4625
5226
  * <p>The phone number ID.</p>
4626
5227
  */
4627
5228
  PhoneNumberId: string | undefined;
@@ -4648,15 +5249,18 @@ export type PhoneNumberAssociationName = (typeof PhoneNumberAssociationName)[key
4648
5249
  */
4649
5250
  export interface PhoneNumberAssociation {
4650
5251
  /**
5252
+ * @public
4651
5253
  * <p>Contains the ID for the entity specified in Name.</p>
4652
5254
  */
4653
5255
  Value?: string;
4654
5256
  /**
5257
+ * @public
4655
5258
  * <p>Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector
4656
5259
  * ID, or Amazon Chime Voice Connector group ID.</p>
4657
5260
  */
4658
5261
  Name?: PhoneNumberAssociationName | string;
4659
5262
  /**
5263
+ * @public
4660
5264
  * <p>The timestamp of the phone number association, in ISO 8601 format.</p>
4661
5265
  */
4662
5266
  AssociatedTimestamp?: Date;
@@ -4668,26 +5272,32 @@ export interface PhoneNumberAssociation {
4668
5272
  */
4669
5273
  export interface PhoneNumberCapabilities {
4670
5274
  /**
5275
+ * @public
4671
5276
  * <p>Allows or denies inbound calling for the specified phone number.</p>
4672
5277
  */
4673
5278
  InboundCall?: boolean;
4674
5279
  /**
5280
+ * @public
4675
5281
  * <p>Allows or denies outbound calling for the specified phone number.</p>
4676
5282
  */
4677
5283
  OutboundCall?: boolean;
4678
5284
  /**
5285
+ * @public
4679
5286
  * <p>Allows or denies inbound SMS messaging for the specified phone number.</p>
4680
5287
  */
4681
5288
  InboundSMS?: boolean;
4682
5289
  /**
5290
+ * @public
4683
5291
  * <p>Allows or denies outbound SMS messaging for the specified phone number.</p>
4684
5292
  */
4685
5293
  OutboundSMS?: boolean;
4686
5294
  /**
5295
+ * @public
4687
5296
  * <p>Allows or denies inbound MMS messaging for the specified phone number.</p>
4688
5297
  */
4689
5298
  InboundMMS?: boolean;
4690
5299
  /**
5300
+ * @public
4691
5301
  * <p>Allows or denies outbound MMS messaging for the specified phone number.</p>
4692
5302
  */
4693
5303
  OutboundMMS?: boolean;
@@ -4729,54 +5339,67 @@ export type PhoneNumberType = (typeof PhoneNumberType)[keyof typeof PhoneNumberT
4729
5339
  */
4730
5340
  export interface PhoneNumber {
4731
5341
  /**
5342
+ * @public
4732
5343
  * <p>The phone number ID.</p>
4733
5344
  */
4734
5345
  PhoneNumberId?: string;
4735
5346
  /**
5347
+ * @public
4736
5348
  * <p>The phone number, in E.164 format.</p>
4737
5349
  */
4738
5350
  E164PhoneNumber?: string;
4739
5351
  /**
5352
+ * @public
4740
5353
  * <p>The phone number country. Format: ISO 3166-1 alpha-2.</p>
4741
5354
  */
4742
5355
  Country?: string;
4743
5356
  /**
5357
+ * @public
4744
5358
  * <p>The phone number type.</p>
4745
5359
  */
4746
5360
  Type?: PhoneNumberType | string;
4747
5361
  /**
5362
+ * @public
4748
5363
  * <p>The phone number product type.</p>
4749
5364
  */
4750
5365
  ProductType?: PhoneNumberProductType | string;
4751
5366
  /**
5367
+ * @public
4752
5368
  * <p>The phone number status.</p>
4753
5369
  */
4754
5370
  Status?: PhoneNumberStatus | string;
4755
5371
  /**
5372
+ * @public
4756
5373
  * <p>The phone number capabilities.</p>
4757
5374
  */
4758
5375
  Capabilities?: PhoneNumberCapabilities;
4759
5376
  /**
5377
+ * @public
4760
5378
  * <p>The phone number associations.</p>
4761
5379
  */
4762
5380
  Associations?: PhoneNumberAssociation[];
4763
5381
  /**
5382
+ * @public
4764
5383
  * <p>The outbound calling name associated with the phone number.</p>
4765
5384
  */
4766
5385
  CallingName?: string;
4767
5386
  /**
5387
+ * @public
4768
5388
  * <p>The outbound calling name status.</p>
4769
5389
  */
4770
5390
  CallingNameStatus?: CallingNameStatus | string;
4771
5391
  /**
5392
+ * @public
4772
5393
  * <p>The phone number creation timestamp, in ISO 8601 format.</p>
4773
5394
  */
4774
5395
  CreatedTimestamp?: Date;
4775
5396
  /**
5397
+ * @public
4776
5398
  * <p>The updated phone number timestamp, in ISO 8601 format.</p>
4777
5399
  */
4778
5400
  UpdatedTimestamp?: Date;
4779
5401
  /**
5402
+ * @public
4780
5403
  * <p>The deleted phone number timestamp, in ISO 8601 format.</p>
4781
5404
  */
4782
5405
  DeletionTimestamp?: Date;
@@ -4786,6 +5409,7 @@ export interface PhoneNumber {
4786
5409
  */
4787
5410
  export interface GetPhoneNumberResponse {
4788
5411
  /**
5412
+ * @public
4789
5413
  * <p>The phone number details.</p>
4790
5414
  */
4791
5415
  PhoneNumber?: PhoneNumber;
@@ -4795,6 +5419,7 @@ export interface GetPhoneNumberResponse {
4795
5419
  */
4796
5420
  export interface GetPhoneNumberOrderRequest {
4797
5421
  /**
5422
+ * @public
4798
5423
  * <p>The ID for the phone number order.</p>
4799
5424
  */
4800
5425
  PhoneNumberOrderId: string | undefined;
@@ -4804,6 +5429,7 @@ export interface GetPhoneNumberOrderRequest {
4804
5429
  */
4805
5430
  export interface GetPhoneNumberOrderResponse {
4806
5431
  /**
5432
+ * @public
4807
5433
  * <p>The phone number order details.</p>
4808
5434
  */
4809
5435
  PhoneNumberOrder?: PhoneNumberOrder;
@@ -4813,10 +5439,12 @@ export interface GetPhoneNumberOrderResponse {
4813
5439
  */
4814
5440
  export interface GetPhoneNumberSettingsResponse {
4815
5441
  /**
5442
+ * @public
4816
5443
  * <p>The default outbound calling name for the account.</p>
4817
5444
  */
4818
5445
  CallingName?: string;
4819
5446
  /**
5447
+ * @public
4820
5448
  * <p>The updated outbound calling name timestamp, in ISO 8601 format.</p>
4821
5449
  */
4822
5450
  CallingNameUpdatedTimestamp?: Date;
@@ -4826,10 +5454,12 @@ export interface GetPhoneNumberSettingsResponse {
4826
5454
  */
4827
5455
  export interface GetProxySessionRequest {
4828
5456
  /**
5457
+ * @public
4829
5458
  * <p>The Amazon Chime voice connector ID.</p>
4830
5459
  */
4831
5460
  VoiceConnectorId: string | undefined;
4832
5461
  /**
5462
+ * @public
4833
5463
  * <p>The proxy session ID.</p>
4834
5464
  */
4835
5465
  ProxySessionId: string | undefined;
@@ -4839,6 +5469,7 @@ export interface GetProxySessionRequest {
4839
5469
  */
4840
5470
  export interface GetProxySessionResponse {
4841
5471
  /**
5472
+ * @public
4842
5473
  * <p>The proxy session details.</p>
4843
5474
  */
4844
5475
  ProxySession?: ProxySession;
@@ -4848,6 +5479,7 @@ export interface GetProxySessionResponse {
4848
5479
  */
4849
5480
  export interface GetRetentionSettingsRequest {
4850
5481
  /**
5482
+ * @public
4851
5483
  * <p>The Amazon Chime account ID.</p>
4852
5484
  */
4853
5485
  AccountId: string | undefined;