@aws-sdk/client-chime-sdk-voice 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.
@@ -46,44 +46,54 @@ export declare class AccessDeniedException extends __BaseException {
46
46
  */
47
47
  export interface Address {
48
48
  /**
49
+ * @public
49
50
  * <p>The address street, such as <code>8th Avenue</code>.</p>
50
51
  */
51
52
  streetName?: string;
52
53
  /**
54
+ * @public
53
55
  * <p>The address suffix, such as the <code>N</code> in <code>8th Avenue N</code>.</p>
54
56
  */
55
57
  streetSuffix?: string;
56
58
  /**
59
+ * @public
57
60
  * <p>An address suffix location, such as the <code>S. Unit A</code> in
58
61
  * <code>Central Park S. Unit A</code>.</p>
59
62
  */
60
63
  postDirectional?: string;
61
64
  /**
65
+ * @public
62
66
  * <p>An address prefix location, such as the <code>N</code> in <code>N. Third St.</code>
63
67
  * </p>
64
68
  */
65
69
  preDirectional?: string;
66
70
  /**
71
+ * @public
67
72
  * <p>The numeric portion of an address.</p>
68
73
  */
69
74
  streetNumber?: string;
70
75
  /**
76
+ * @public
71
77
  * <p>The city of an address.</p>
72
78
  */
73
79
  city?: string;
74
80
  /**
81
+ * @public
75
82
  * <p>The state of an address.</p>
76
83
  */
77
84
  state?: string;
78
85
  /**
86
+ * @public
79
87
  * <p>The postal code of an address.</p>
80
88
  */
81
89
  postalCode?: string;
82
90
  /**
91
+ * @public
83
92
  * <p>The zip + 4 or postal code + 4 of an address.</p>
84
93
  */
85
94
  postalCodePlus4?: string;
86
95
  /**
96
+ * @public
87
97
  * <p>The country of an address.</p>
88
98
  */
89
99
  country?: string;
@@ -105,14 +115,17 @@ export type AlexaSkillStatus = (typeof AlexaSkillStatus)[keyof typeof AlexaSkill
105
115
  */
106
116
  export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
107
117
  /**
118
+ * @public
108
119
  * <p>The Voice Connector ID.</p>
109
120
  */
110
121
  VoiceConnectorId: string | undefined;
111
122
  /**
123
+ * @public
112
124
  * <p>List of phone numbers, in E.164 format.</p>
113
125
  */
114
126
  E164PhoneNumbers: string[] | undefined;
115
127
  /**
128
+ * @public
116
129
  * <p>If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.</p>
117
130
  */
118
131
  ForceAssociate?: boolean;
@@ -124,14 +137,17 @@ export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
124
137
  */
125
138
  export interface PhoneNumberError {
126
139
  /**
140
+ * @public
127
141
  * <p>The phone number ID for which the action failed.</p>
128
142
  */
129
143
  PhoneNumberId?: string;
130
144
  /**
145
+ * @public
131
146
  * <p>The error code.</p>
132
147
  */
133
148
  ErrorCode?: ErrorCode | string;
134
149
  /**
150
+ * @public
135
151
  * <p>The error message.</p>
136
152
  */
137
153
  ErrorMessage?: string;
@@ -141,6 +157,7 @@ export interface PhoneNumberError {
141
157
  */
142
158
  export interface AssociatePhoneNumbersWithVoiceConnectorResponse {
143
159
  /**
160
+ * @public
144
161
  * <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
145
162
  * error messages.</p>
146
163
  */
@@ -249,14 +266,17 @@ export declare class UnauthorizedClientException extends __BaseException {
249
266
  */
250
267
  export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
251
268
  /**
269
+ * @public
252
270
  * <p>The Amazon Chime SDK Voice Connector group ID.</p>
253
271
  */
254
272
  VoiceConnectorGroupId: string | undefined;
255
273
  /**
274
+ * @public
256
275
  * <p>List of phone numbers, in E.164 format.</p>
257
276
  */
258
277
  E164PhoneNumbers: string[] | undefined;
259
278
  /**
279
+ * @public
260
280
  * <p>If true, associates the provided phone numbers with the provided Amazon Chime SDK Voice Connector Group and removes any previously existing associations.
261
281
  * If false, does not associate any phone numbers that have previously existing associations.</p>
262
282
  */
@@ -267,6 +287,7 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
267
287
  */
268
288
  export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
269
289
  /**
290
+ * @public
270
291
  * <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>
271
292
  */
272
293
  PhoneNumberErrors?: PhoneNumberError[];
@@ -276,6 +297,7 @@ export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
276
297
  */
277
298
  export interface BatchDeletePhoneNumberRequest {
278
299
  /**
300
+ * @public
279
301
  * <p>List of phone number IDs.</p>
280
302
  */
281
303
  PhoneNumberIds: string[] | undefined;
@@ -285,6 +307,7 @@ export interface BatchDeletePhoneNumberRequest {
285
307
  */
286
308
  export interface BatchDeletePhoneNumberResponse {
287
309
  /**
310
+ * @public
288
311
  * <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>
289
312
  */
290
313
  PhoneNumberErrors?: PhoneNumberError[];
@@ -308,14 +331,17 @@ export type PhoneNumberProductType = (typeof PhoneNumberProductType)[keyof typeo
308
331
  */
309
332
  export interface UpdatePhoneNumberRequestItem {
310
333
  /**
334
+ * @public
311
335
  * <p>The phone number ID to update.</p>
312
336
  */
313
337
  PhoneNumberId: string | undefined;
314
338
  /**
339
+ * @public
315
340
  * <p>The product type to update.</p>
316
341
  */
317
342
  ProductType?: PhoneNumberProductType | string;
318
343
  /**
344
+ * @public
319
345
  * <p>The outbound calling name to update.</p>
320
346
  */
321
347
  CallingName?: string;
@@ -325,6 +351,7 @@ export interface UpdatePhoneNumberRequestItem {
325
351
  */
326
352
  export interface BatchUpdatePhoneNumberRequest {
327
353
  /**
354
+ * @public
328
355
  * <p>Lists the phone numbers in the update request.</p>
329
356
  */
330
357
  UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItem[] | undefined;
@@ -334,6 +361,7 @@ export interface BatchUpdatePhoneNumberRequest {
334
361
  */
335
362
  export interface BatchUpdatePhoneNumberResponse {
336
363
  /**
364
+ * @public
337
365
  * <p>A list of failed phone numbers and their error messages.</p>
338
366
  */
339
367
  PhoneNumberErrors?: PhoneNumberError[];
@@ -344,14 +372,17 @@ export interface BatchUpdatePhoneNumberResponse {
344
372
  */
345
373
  export interface CallDetails {
346
374
  /**
375
+ * @public
347
376
  * <p>The Voice Connector ID.</p>
348
377
  */
349
378
  VoiceConnectorId?: string;
350
379
  /**
380
+ * @public
351
381
  * <p>The transaction ID of a Voice Connector call.</p>
352
382
  */
353
383
  TransactionId?: string;
354
384
  /**
385
+ * @public
355
386
  * <p>Identifies a person as the caller or the callee.</p>
356
387
  */
357
388
  IsCaller?: boolean;
@@ -388,30 +419,37 @@ export type CallLegType = (typeof CallLegType)[keyof typeof CallLegType];
388
419
  */
389
420
  export interface CandidateAddress {
390
421
  /**
422
+ * @public
391
423
  * <p>The street information of the candidate address.</p>
392
424
  */
393
425
  streetInfo?: string;
394
426
  /**
427
+ * @public
395
428
  * <p>The numeric portion of the candidate address.</p>
396
429
  */
397
430
  streetNumber?: string;
398
431
  /**
432
+ * @public
399
433
  * <p>The city of the candidate address.</p>
400
434
  */
401
435
  city?: string;
402
436
  /**
437
+ * @public
403
438
  * <p>The state of the candidate address.</p>
404
439
  */
405
440
  state?: string;
406
441
  /**
442
+ * @public
407
443
  * <p>The postal code of the candidate address.</p>
408
444
  */
409
445
  postalCode?: string;
410
446
  /**
447
+ * @public
411
448
  * <p>The zip + 4 or postal code +4 of the candidate address.</p>
412
449
  */
413
450
  postalCodePlus4?: string;
414
451
  /**
452
+ * @public
415
453
  * <p>The country of the candidate address.</p>
416
454
  */
417
455
  country?: string;
@@ -433,10 +471,12 @@ export type Capability = (typeof Capability)[keyof typeof Capability];
433
471
  */
434
472
  export interface CreatePhoneNumberOrderRequest {
435
473
  /**
474
+ * @public
436
475
  * <p>The phone number product type.</p>
437
476
  */
438
477
  ProductType: PhoneNumberProductType | string | undefined;
439
478
  /**
479
+ * @public
440
480
  * <p>List of phone numbers, in E.164 format.</p>
441
481
  */
442
482
  E164PhoneNumbers: string[] | undefined;
@@ -460,10 +500,12 @@ export type OrderedPhoneNumberStatus = (typeof OrderedPhoneNumberStatus)[keyof t
460
500
  */
461
501
  export interface OrderedPhoneNumber {
462
502
  /**
503
+ * @public
463
504
  * <p>The phone number, in E.164 format.</p>
464
505
  */
465
506
  E164PhoneNumber?: string;
466
507
  /**
508
+ * @public
467
509
  * <p>The phone number status.</p>
468
510
  */
469
511
  Status?: OrderedPhoneNumberStatus | string;
@@ -507,31 +549,38 @@ export type PhoneNumberOrderStatus = (typeof PhoneNumberOrderStatus)[keyof typeo
507
549
  */
508
550
  export interface PhoneNumberOrder {
509
551
  /**
552
+ * @public
510
553
  * <p>The ID of the phone order.</p>
511
554
  */
512
555
  PhoneNumberOrderId?: string;
513
556
  /**
557
+ * @public
514
558
  * <p>The phone number order product type.</p>
515
559
  */
516
560
  ProductType?: PhoneNumberProductType | string;
517
561
  /**
562
+ * @public
518
563
  * <p>The status of the phone number order.</p>
519
564
  */
520
565
  Status?: PhoneNumberOrderStatus | string;
521
566
  /**
567
+ * @public
522
568
  * <p>The type of phone number being ordered, local or toll-free.</p>
523
569
  */
524
570
  OrderType?: PhoneNumberOrderType | string;
525
571
  /**
572
+ * @public
526
573
  * <p>The ordered phone number details, such as the phone number in E.164 format
527
574
  * and the phone number status.</p>
528
575
  */
529
576
  OrderedPhoneNumbers?: OrderedPhoneNumber[];
530
577
  /**
578
+ * @public
531
579
  * <p>The phone number order creation time stamp, in ISO 8601 format.</p>
532
580
  */
533
581
  CreatedTimestamp?: Date;
534
582
  /**
583
+ * @public
535
584
  * <p>The updated phone number order time stamp, in ISO 8601 format.</p>
536
585
  */
537
586
  UpdatedTimestamp?: Date;
@@ -541,6 +590,7 @@ export interface PhoneNumberOrder {
541
590
  */
542
591
  export interface CreatePhoneNumberOrderResponse {
543
592
  /**
593
+ * @public
544
594
  * <p>The phone number order details.</p>
545
595
  */
546
596
  PhoneNumberOrder?: PhoneNumberOrder;
@@ -577,10 +627,12 @@ export type GeoMatchLevel = (typeof GeoMatchLevel)[keyof typeof GeoMatchLevel];
577
627
  */
578
628
  export interface GeoMatchParams {
579
629
  /**
630
+ * @public
580
631
  * <p>The country.</p>
581
632
  */
582
633
  Country: string | undefined;
583
634
  /**
635
+ * @public
584
636
  * <p>The area code.</p>
585
637
  */
586
638
  AreaCode: string | undefined;
@@ -602,35 +654,43 @@ export type NumberSelectionBehavior = (typeof NumberSelectionBehavior)[keyof typ
602
654
  */
603
655
  export interface CreateProxySessionRequest {
604
656
  /**
657
+ * @public
605
658
  * <p>The Voice Connector ID.</p>
606
659
  */
607
660
  VoiceConnectorId: string | undefined;
608
661
  /**
662
+ * @public
609
663
  * <p>The participant phone numbers.</p>
610
664
  */
611
665
  ParticipantPhoneNumbers: string[] | undefined;
612
666
  /**
667
+ * @public
613
668
  * <p>The name of the proxy session.</p>
614
669
  */
615
670
  Name?: string;
616
671
  /**
672
+ * @public
617
673
  * <p>The number of minutes allowed for the proxy session.</p>
618
674
  */
619
675
  ExpiryMinutes?: number;
620
676
  /**
677
+ * @public
621
678
  * <p>The proxy session's capabilities.</p>
622
679
  */
623
680
  Capabilities: (Capability | string)[] | undefined;
624
681
  /**
682
+ * @public
625
683
  * <p>The preference for proxy phone number reuse, or stickiness, between the same
626
684
  * participants across sessions.</p>
627
685
  */
628
686
  NumberSelectionBehavior?: NumberSelectionBehavior | string;
629
687
  /**
688
+ * @public
630
689
  * <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
631
690
  */
632
691
  GeoMatchLevel?: GeoMatchLevel | string;
633
692
  /**
693
+ * @public
634
694
  * <p>The country and area code for the proxy phone number.</p>
635
695
  */
636
696
  GeoMatchParams?: GeoMatchParams;
@@ -641,10 +701,12 @@ export interface CreateProxySessionRequest {
641
701
  */
642
702
  export interface Participant {
643
703
  /**
704
+ * @public
644
705
  * <p>The participant's phone number.</p>
645
706
  */
646
707
  PhoneNumber?: string;
647
708
  /**
709
+ * @public
648
710
  * <p>The participant's proxy phone number.</p>
649
711
  */
650
712
  ProxyPhoneNumber?: string;
@@ -668,54 +730,67 @@ export type ProxySessionStatus = (typeof ProxySessionStatus)[keyof typeof ProxyS
668
730
  */
669
731
  export interface ProxySession {
670
732
  /**
733
+ * @public
671
734
  * <p>The Voice Connector ID.</p>
672
735
  */
673
736
  VoiceConnectorId?: string;
674
737
  /**
738
+ * @public
675
739
  * <p>The proxy session ID.</p>
676
740
  */
677
741
  ProxySessionId?: string;
678
742
  /**
743
+ * @public
679
744
  * <p>The proxy session name.</p>
680
745
  */
681
746
  Name?: string;
682
747
  /**
748
+ * @public
683
749
  * <p>The proxy session status.</p>
684
750
  */
685
751
  Status?: ProxySessionStatus | string;
686
752
  /**
753
+ * @public
687
754
  * <p>The number of minutes allowed for the proxy session.</p>
688
755
  */
689
756
  ExpiryMinutes?: number;
690
757
  /**
758
+ * @public
691
759
  * <p>The proxy session capabilities.</p>
692
760
  */
693
761
  Capabilities?: (Capability | string)[];
694
762
  /**
763
+ * @public
695
764
  * <p>The created time stamp, in ISO 8601 format.</p>
696
765
  */
697
766
  CreatedTimestamp?: Date;
698
767
  /**
768
+ * @public
699
769
  * <p>The updated time stamp, in ISO 8601 format.</p>
700
770
  */
701
771
  UpdatedTimestamp?: Date;
702
772
  /**
773
+ * @public
703
774
  * <p>The ended time stamp, in ISO 8601 format.</p>
704
775
  */
705
776
  EndedTimestamp?: Date;
706
777
  /**
778
+ * @public
707
779
  * <p>The proxy session participants.</p>
708
780
  */
709
781
  Participants?: Participant[];
710
782
  /**
783
+ * @public
711
784
  * <p>The preference for proxy phone number reuse, or stickiness, between the same participants across sessions.</p>
712
785
  */
713
786
  NumberSelectionBehavior?: NumberSelectionBehavior | string;
714
787
  /**
788
+ * @public
715
789
  * <p>The preference for matching the country or area code of the proxy phone number with that of the first participant.</p>
716
790
  */
717
791
  GeoMatchLevel?: GeoMatchLevel | string;
718
792
  /**
793
+ * @public
719
794
  * <p>The country and area code for the proxy phone number.</p>
720
795
  */
721
796
  GeoMatchParams?: GeoMatchParams;
@@ -725,6 +800,7 @@ export interface ProxySession {
725
800
  */
726
801
  export interface CreateProxySessionResponse {
727
802
  /**
803
+ * @public
728
804
  * <p>The proxy session details.</p>
729
805
  */
730
806
  ProxySession?: ProxySession;
@@ -749,6 +825,7 @@ export declare class ConflictException extends __BaseException {
749
825
  */
750
826
  export interface SipMediaApplicationEndpoint {
751
827
  /**
828
+ * @public
752
829
  * <p>Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias.
753
830
  * The function must be created in the same AWS Region as the SIP media application.</p>
754
831
  */
@@ -760,10 +837,12 @@ export interface SipMediaApplicationEndpoint {
760
837
  */
761
838
  export interface Tag {
762
839
  /**
840
+ * @public
763
841
  * <p>The tag's key.</p>
764
842
  */
765
843
  Key: string | undefined;
766
844
  /**
845
+ * @public
767
846
  * <p>The tag's value.</p>
768
847
  */
769
848
  Value: string | undefined;
@@ -773,18 +852,22 @@ export interface Tag {
773
852
  */
774
853
  export interface CreateSipMediaApplicationRequest {
775
854
  /**
855
+ * @public
776
856
  * <p>The AWS Region assigned to the SIP media application.</p>
777
857
  */
778
858
  AwsRegion: string | undefined;
779
859
  /**
860
+ * @public
780
861
  * <p>The SIP media application's name.</p>
781
862
  */
782
863
  Name: string | undefined;
783
864
  /**
865
+ * @public
784
866
  * <p>List of endpoints (Lambda ARNs) specified for the SIP media application.</p>
785
867
  */
786
868
  Endpoints: SipMediaApplicationEndpoint[] | undefined;
787
869
  /**
870
+ * @public
788
871
  * <p>The tags assigned to the SIP media application.</p>
789
872
  */
790
873
  Tags?: Tag[];
@@ -796,31 +879,38 @@ export interface CreateSipMediaApplicationRequest {
796
879
  */
797
880
  export interface SipMediaApplication {
798
881
  /**
882
+ * @public
799
883
  * <p>A SIP media application's ID.</p>
800
884
  */
801
885
  SipMediaApplicationId?: string;
802
886
  /**
887
+ * @public
803
888
  * <p>The AWS Region in which the SIP media application is created.</p>
804
889
  */
805
890
  AwsRegion?: string;
806
891
  /**
892
+ * @public
807
893
  * <p>The SIP media application's name.</p>
808
894
  */
809
895
  Name?: string;
810
896
  /**
897
+ * @public
811
898
  * <p>List of endpoints for a SIP media application. Currently, only one endpoint per
812
899
  * SIP media application is permitted.</p>
813
900
  */
814
901
  Endpoints?: SipMediaApplicationEndpoint[];
815
902
  /**
903
+ * @public
816
904
  * <p>The SIP media application creation timestamp, in ISO 8601 format.</p>
817
905
  */
818
906
  CreatedTimestamp?: Date;
819
907
  /**
908
+ * @public
820
909
  * <p>The time at which the SIP media application was updated.</p>
821
910
  */
822
911
  UpdatedTimestamp?: Date;
823
912
  /**
913
+ * @public
824
914
  * <p>The ARN of the SIP media application.</p>
825
915
  */
826
916
  SipMediaApplicationArn?: string;
@@ -830,6 +920,7 @@ export interface SipMediaApplication {
830
920
  */
831
921
  export interface CreateSipMediaApplicationResponse {
832
922
  /**
923
+ * @public
833
924
  * <p>The SIP media application details.</p>
834
925
  */
835
926
  SipMediaApplication?: SipMediaApplication;
@@ -839,23 +930,28 @@ export interface CreateSipMediaApplicationResponse {
839
930
  */
840
931
  export interface CreateSipMediaApplicationCallRequest {
841
932
  /**
933
+ * @public
842
934
  * <p>The phone number that a user calls from. This is a phone number in your
843
935
  * Amazon Chime SDK phone number inventory.</p>
844
936
  */
845
937
  FromPhoneNumber: string | undefined;
846
938
  /**
939
+ * @public
847
940
  * <p>The phone number that the service should call.</p>
848
941
  */
849
942
  ToPhoneNumber: string | undefined;
850
943
  /**
944
+ * @public
851
945
  * <p>The ID of the SIP media application.</p>
852
946
  */
853
947
  SipMediaApplicationId: string | undefined;
854
948
  /**
949
+ * @public
855
950
  * <p>The SIP headers added to an outbound call leg.</p>
856
951
  */
857
952
  SipHeaders?: Record<string, string>;
858
953
  /**
954
+ * @public
859
955
  * <p>Context passed to a CreateSipMediaApplication API call. For example, you could pass
860
956
  * key-value pairs such as: <code>"FirstName": "John", "LastName": "Doe"</code>
861
957
  * </p>
@@ -868,6 +964,7 @@ export interface CreateSipMediaApplicationCallRequest {
868
964
  */
869
965
  export interface SipMediaApplicationCall {
870
966
  /**
967
+ * @public
871
968
  * <p>The call's transaction ID.</p>
872
969
  */
873
970
  TransactionId?: string;
@@ -877,6 +974,7 @@ export interface SipMediaApplicationCall {
877
974
  */
878
975
  export interface CreateSipMediaApplicationCallResponse {
879
976
  /**
977
+ * @public
880
978
  * <p>The actual call.</p>
881
979
  */
882
980
  SipMediaApplicationCall?: SipMediaApplicationCall;
@@ -888,14 +986,17 @@ export interface CreateSipMediaApplicationCallResponse {
888
986
  */
889
987
  export interface SipRuleTargetApplication {
890
988
  /**
989
+ * @public
891
990
  * <p>The ID of a rule's target SIP media application.</p>
892
991
  */
893
992
  SipMediaApplicationId?: string;
894
993
  /**
994
+ * @public
895
995
  * <p>The priority setting of a rule's target SIP media application.</p>
896
996
  */
897
997
  Priority?: number;
898
998
  /**
999
+ * @public
899
1000
  * <p>The AWS Region of a rule's target SIP media application.</p>
900
1001
  */
901
1002
  AwsRegion?: string;
@@ -917,15 +1018,18 @@ export type SipRuleTriggerType = (typeof SipRuleTriggerType)[keyof typeof SipRul
917
1018
  */
918
1019
  export interface CreateSipRuleRequest {
919
1020
  /**
1021
+ * @public
920
1022
  * <p>The name of the SIP rule.</p>
921
1023
  */
922
1024
  Name: string | undefined;
923
1025
  /**
1026
+ * @public
924
1027
  * <p>The type of trigger assigned to the SIP rule in <code>TriggerValue</code>,
925
1028
  * currently <code>RequestUriHostname</code> or <code>ToPhoneNumber</code>.</p>
926
1029
  */
927
1030
  TriggerType: SipRuleTriggerType | string | undefined;
928
1031
  /**
1032
+ * @public
929
1033
  * <p>If <code>TriggerType</code> is <code>RequestUriHostname</code>, the
930
1034
  * value can be the outbound host name of a Voice Connector. If
931
1035
  * <code>TriggerType</code> is <code>ToPhoneNumber</code>, the value can
@@ -937,11 +1041,13 @@ export interface CreateSipRuleRequest {
937
1041
  */
938
1042
  TriggerValue: string | undefined;
939
1043
  /**
1044
+ * @public
940
1045
  * <p>Disables or enables a SIP rule. You must disable SIP rules
941
1046
  * before you can delete them.</p>
942
1047
  */
943
1048
  Disabled?: boolean;
944
1049
  /**
1050
+ * @public
945
1051
  * <p>List of SIP media applications, with priority and AWS Region. Only one SIP
946
1052
  * application per AWS Region can be used.</p>
947
1053
  */
@@ -954,35 +1060,43 @@ export interface CreateSipRuleRequest {
954
1060
  */
955
1061
  export interface SipRule {
956
1062
  /**
1063
+ * @public
957
1064
  * <p>A SIP rule's ID.</p>
958
1065
  */
959
1066
  SipRuleId?: string;
960
1067
  /**
1068
+ * @public
961
1069
  * <p>A SIP rule's name.</p>
962
1070
  */
963
1071
  Name?: string;
964
1072
  /**
1073
+ * @public
965
1074
  * <p>Indicates whether the SIP rule is enabled or disabled. You must disable a rule before you can delete it.</p>
966
1075
  */
967
1076
  Disabled?: boolean;
968
1077
  /**
1078
+ * @public
969
1079
  * <p>The type of trigger set for a SIP rule, either a phone number or a URI request host name.</p>
970
1080
  */
971
1081
  TriggerType?: SipRuleTriggerType | string;
972
1082
  /**
1083
+ * @public
973
1084
  * <p>The value set for a SIP rule's trigger type. Either a phone number or a URI hostname.</p>
974
1085
  */
975
1086
  TriggerValue?: string;
976
1087
  /**
1088
+ * @public
977
1089
  * <p>The target SIP media application and other details, such as priority and AWS Region,
978
1090
  * to be specified in the SIP rule. Only one SIP rule per AWS Region can be provided.</p>
979
1091
  */
980
1092
  TargetApplications?: SipRuleTargetApplication[];
981
1093
  /**
1094
+ * @public
982
1095
  * <p>The time at which the SIP rule was created, in ISO 8601 format.</p>
983
1096
  */
984
1097
  CreatedTimestamp?: Date;
985
1098
  /**
1099
+ * @public
986
1100
  * <p>The time at which the SIP rule was updated, in ISO 8601 format.</p>
987
1101
  */
988
1102
  UpdatedTimestamp?: Date;
@@ -992,6 +1106,7 @@ export interface SipRule {
992
1106
  */
993
1107
  export interface CreateSipRuleResponse {
994
1108
  /**
1109
+ * @public
995
1110
  * <p>The SIP rule information, including the rule ID, triggers, and target applications.</p>
996
1111
  */
997
1112
  SipRule?: SipRule;
@@ -1021,19 +1136,23 @@ export type VoiceConnectorAwsRegion = (typeof VoiceConnectorAwsRegion)[keyof typ
1021
1136
  */
1022
1137
  export interface CreateVoiceConnectorRequest {
1023
1138
  /**
1139
+ * @public
1024
1140
  * <p>The name of the Voice Connector.</p>
1025
1141
  */
1026
1142
  Name: string | undefined;
1027
1143
  /**
1144
+ * @public
1028
1145
  * <p>The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value:
1029
1146
  * <code>us-east-1</code> .</p>
1030
1147
  */
1031
1148
  AwsRegion?: VoiceConnectorAwsRegion | string;
1032
1149
  /**
1150
+ * @public
1033
1151
  * <p>Enables or disables encryption for the Voice Connector.</p>
1034
1152
  */
1035
1153
  RequireEncryption: boolean | undefined;
1036
1154
  /**
1155
+ * @public
1037
1156
  * <p>The tags assigned to the Voice Connector.</p>
1038
1157
  */
1039
1158
  Tags?: Tag[];
@@ -1045,35 +1164,43 @@ export interface CreateVoiceConnectorRequest {
1045
1164
  */
1046
1165
  export interface VoiceConnector {
1047
1166
  /**
1167
+ * @public
1048
1168
  * <p>The Voice Connector's ID.</p>
1049
1169
  */
1050
1170
  VoiceConnectorId?: string;
1051
1171
  /**
1172
+ * @public
1052
1173
  * <p>The AWS Region in which the Voice Connector is created.
1053
1174
  * Default: us-east-1.</p>
1054
1175
  */
1055
1176
  AwsRegion?: VoiceConnectorAwsRegion | string;
1056
1177
  /**
1178
+ * @public
1057
1179
  * <p>The Voice Connector's name.</p>
1058
1180
  */
1059
1181
  Name?: string;
1060
1182
  /**
1183
+ * @public
1061
1184
  * <p>The outbound host name for the Voice Connector.</p>
1062
1185
  */
1063
1186
  OutboundHostName?: string;
1064
1187
  /**
1188
+ * @public
1065
1189
  * <p>Enables or disables encryption for the Voice Connector.</p>
1066
1190
  */
1067
1191
  RequireEncryption?: boolean;
1068
1192
  /**
1193
+ * @public
1069
1194
  * <p>The Voice Connector's creation timestamp, in ISO 8601 format.</p>
1070
1195
  */
1071
1196
  CreatedTimestamp?: Date;
1072
1197
  /**
1198
+ * @public
1073
1199
  * <p>The Voice Connector's updated timestamp, in ISO 8601 format.</p>
1074
1200
  */
1075
1201
  UpdatedTimestamp?: Date;
1076
1202
  /**
1203
+ * @public
1077
1204
  * <p>The ARN of the Voice Connector.</p>
1078
1205
  */
1079
1206
  VoiceConnectorArn?: string;
@@ -1083,6 +1210,7 @@ export interface VoiceConnector {
1083
1210
  */
1084
1211
  export interface CreateVoiceConnectorResponse {
1085
1212
  /**
1213
+ * @public
1086
1214
  * <p>The details of the Voice Connector.</p>
1087
1215
  */
1088
1216
  VoiceConnector?: VoiceConnector;
@@ -1095,10 +1223,12 @@ export interface CreateVoiceConnectorResponse {
1095
1223
  */
1096
1224
  export interface VoiceConnectorItem {
1097
1225
  /**
1226
+ * @public
1098
1227
  * <p>The Voice Connector ID.</p>
1099
1228
  */
1100
1229
  VoiceConnectorId: string | undefined;
1101
1230
  /**
1231
+ * @public
1102
1232
  * <p>The priority setting of a Voice Connector item. Calls are routed to hosts
1103
1233
  * in priority order, with 1 as the highest priority. When hosts have equal priority,
1104
1234
  * the system distributes calls among them based on their relative weight.</p>
@@ -1110,10 +1240,12 @@ export interface VoiceConnectorItem {
1110
1240
  */
1111
1241
  export interface CreateVoiceConnectorGroupRequest {
1112
1242
  /**
1243
+ * @public
1113
1244
  * <p>The name of the Voice Connector group.</p>
1114
1245
  */
1115
1246
  Name: string | undefined;
1116
1247
  /**
1248
+ * @public
1117
1249
  * <p>Lists the Voice Connectors that inbound calls are routed to.</p>
1118
1250
  */
1119
1251
  VoiceConnectorItems?: VoiceConnectorItem[];
@@ -1127,26 +1259,32 @@ export interface CreateVoiceConnectorGroupRequest {
1127
1259
  */
1128
1260
  export interface VoiceConnectorGroup {
1129
1261
  /**
1262
+ * @public
1130
1263
  * <p>The ID of a Voice Connector group.</p>
1131
1264
  */
1132
1265
  VoiceConnectorGroupId?: string;
1133
1266
  /**
1267
+ * @public
1134
1268
  * <p>The name of a Voice Connector group.</p>
1135
1269
  */
1136
1270
  Name?: string;
1137
1271
  /**
1272
+ * @public
1138
1273
  * <p>The Voice Connectors to which you route inbound calls.</p>
1139
1274
  */
1140
1275
  VoiceConnectorItems?: VoiceConnectorItem[];
1141
1276
  /**
1277
+ * @public
1142
1278
  * <p>The Voice Connector group's creation time stamp, in ISO 8601 format.</p>
1143
1279
  */
1144
1280
  CreatedTimestamp?: Date;
1145
1281
  /**
1282
+ * @public
1146
1283
  * <p>The Voice Connector group's creation time stamp, in ISO 8601 format.</p>
1147
1284
  */
1148
1285
  UpdatedTimestamp?: Date;
1149
1286
  /**
1287
+ * @public
1150
1288
  * <p>The ARN of the Voice Connector group.</p>
1151
1289
  */
1152
1290
  VoiceConnectorGroupArn?: string;
@@ -1156,6 +1294,7 @@ export interface VoiceConnectorGroup {
1156
1294
  */
1157
1295
  export interface CreateVoiceConnectorGroupResponse {
1158
1296
  /**
1297
+ * @public
1159
1298
  * <p>The details of the Voice Connector group.</p>
1160
1299
  */
1161
1300
  VoiceConnectorGroup?: VoiceConnectorGroup;
@@ -1165,6 +1304,7 @@ export interface CreateVoiceConnectorGroupResponse {
1165
1304
  */
1166
1305
  export interface CreateVoiceProfileRequest {
1167
1306
  /**
1307
+ * @public
1168
1308
  * <p>The ID of the speaker search task.</p>
1169
1309
  */
1170
1310
  SpeakerSearchTaskId: string | undefined;
@@ -1175,26 +1315,32 @@ export interface CreateVoiceProfileRequest {
1175
1315
  */
1176
1316
  export interface VoiceProfile {
1177
1317
  /**
1318
+ * @public
1178
1319
  * <p>The ID of the voice profile.</p>
1179
1320
  */
1180
1321
  VoiceProfileId?: string;
1181
1322
  /**
1323
+ * @public
1182
1324
  * <p>The ARN of the voice profile.</p>
1183
1325
  */
1184
1326
  VoiceProfileArn?: string;
1185
1327
  /**
1328
+ * @public
1186
1329
  * <p>The ID of the domain that contains the voice profile.</p>
1187
1330
  */
1188
1331
  VoiceProfileDomainId?: string;
1189
1332
  /**
1333
+ * @public
1190
1334
  * <p>The time at which the voice profile was created and enrolled.</p>
1191
1335
  */
1192
1336
  CreatedTimestamp?: Date;
1193
1337
  /**
1338
+ * @public
1194
1339
  * <p>The time at which the voice profile was last updated.</p>
1195
1340
  */
1196
1341
  UpdatedTimestamp?: Date;
1197
1342
  /**
1343
+ * @public
1198
1344
  * <p>The time at which a voice profile expires unless you re-enroll the caller via the
1199
1345
  * <code>UpdateVoiceProfile</code> API.</p>
1200
1346
  */
@@ -1205,6 +1351,7 @@ export interface VoiceProfile {
1205
1351
  */
1206
1352
  export interface CreateVoiceProfileResponse {
1207
1353
  /**
1354
+ * @public
1208
1355
  * <p>The requested voice profile.</p>
1209
1356
  */
1210
1357
  VoiceProfile?: VoiceProfile;
@@ -1232,6 +1379,7 @@ export declare class GoneException extends __BaseException {
1232
1379
  */
1233
1380
  export interface ServerSideEncryptionConfiguration {
1234
1381
  /**
1382
+ * @public
1235
1383
  * <p>The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain.
1236
1384
  * Asymmetric customer managed keys are not supported.</p>
1237
1385
  */
@@ -1242,22 +1390,27 @@ export interface ServerSideEncryptionConfiguration {
1242
1390
  */
1243
1391
  export interface CreateVoiceProfileDomainRequest {
1244
1392
  /**
1393
+ * @public
1245
1394
  * <p>The name of the voice profile domain.</p>
1246
1395
  */
1247
1396
  Name: string | undefined;
1248
1397
  /**
1398
+ * @public
1249
1399
  * <p>A description of the voice profile domain.</p>
1250
1400
  */
1251
1401
  Description?: string;
1252
1402
  /**
1403
+ * @public
1253
1404
  * <p>The server-side encryption configuration for the request.</p>
1254
1405
  */
1255
1406
  ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
1256
1407
  /**
1408
+ * @public
1257
1409
  * <p>The unique identifier for the client request. Use a different token for different domain creation requests.</p>
1258
1410
  */
1259
1411
  ClientRequestToken?: string;
1260
1412
  /**
1413
+ * @public
1261
1414
  * <p>The tags assigned to the domain.</p>
1262
1415
  */
1263
1416
  Tags?: Tag[];
@@ -1268,30 +1421,37 @@ export interface CreateVoiceProfileDomainRequest {
1268
1421
  */
1269
1422
  export interface VoiceProfileDomain {
1270
1423
  /**
1424
+ * @public
1271
1425
  * <p>The ID of the voice profile domain.</p>
1272
1426
  */
1273
1427
  VoiceProfileDomainId?: string;
1274
1428
  /**
1429
+ * @public
1275
1430
  * <p>The voice profile domain's Amazon Resource Number (ARN).</p>
1276
1431
  */
1277
1432
  VoiceProfileDomainArn?: string;
1278
1433
  /**
1434
+ * @public
1279
1435
  * <p>The name of the voice profile domain.</p>
1280
1436
  */
1281
1437
  Name?: string;
1282
1438
  /**
1439
+ * @public
1283
1440
  * <p>The description of the voice profile domain.</p>
1284
1441
  */
1285
1442
  Description?: string;
1286
1443
  /**
1444
+ * @public
1287
1445
  * <p>A structure that contains the configuration settings for server-side encryption.</p>
1288
1446
  */
1289
1447
  ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1290
1448
  /**
1449
+ * @public
1291
1450
  * <p>The time at which the voice profile domain was created.</p>
1292
1451
  */
1293
1452
  CreatedTimestamp?: Date;
1294
1453
  /**
1454
+ * @public
1295
1455
  * <p>The time at which the voice profile was last updated.</p>
1296
1456
  */
1297
1457
  UpdatedTimestamp?: Date;
@@ -1301,6 +1461,7 @@ export interface VoiceProfileDomain {
1301
1461
  */
1302
1462
  export interface CreateVoiceProfileDomainResponse {
1303
1463
  /**
1464
+ * @public
1304
1465
  * <p>The requested voice profile domain.</p>
1305
1466
  */
1306
1467
  VoiceProfileDomain?: VoiceProfileDomain;
@@ -1310,6 +1471,7 @@ export interface CreateVoiceProfileDomainResponse {
1310
1471
  */
1311
1472
  export interface DeletePhoneNumberRequest {
1312
1473
  /**
1474
+ * @public
1313
1475
  * <p>The phone number ID.</p>
1314
1476
  */
1315
1477
  PhoneNumberId: string | undefined;
@@ -1319,10 +1481,12 @@ export interface DeletePhoneNumberRequest {
1319
1481
  */
1320
1482
  export interface DeleteProxySessionRequest {
1321
1483
  /**
1484
+ * @public
1322
1485
  * <p>The Voice Connector ID.</p>
1323
1486
  */
1324
1487
  VoiceConnectorId: string | undefined;
1325
1488
  /**
1489
+ * @public
1326
1490
  * <p>The proxy session ID.</p>
1327
1491
  */
1328
1492
  ProxySessionId: string | undefined;
@@ -1332,6 +1496,7 @@ export interface DeleteProxySessionRequest {
1332
1496
  */
1333
1497
  export interface DeleteSipMediaApplicationRequest {
1334
1498
  /**
1499
+ * @public
1335
1500
  * <p>The SIP media application ID.</p>
1336
1501
  */
1337
1502
  SipMediaApplicationId: string | undefined;
@@ -1341,6 +1506,7 @@ export interface DeleteSipMediaApplicationRequest {
1341
1506
  */
1342
1507
  export interface DeleteSipRuleRequest {
1343
1508
  /**
1509
+ * @public
1344
1510
  * <p>The SIP rule ID.</p>
1345
1511
  */
1346
1512
  SipRuleId: string | undefined;
@@ -1350,6 +1516,7 @@ export interface DeleteSipRuleRequest {
1350
1516
  */
1351
1517
  export interface DeleteVoiceConnectorRequest {
1352
1518
  /**
1519
+ * @public
1353
1520
  * <p>The Voice Connector ID.</p>
1354
1521
  */
1355
1522
  VoiceConnectorId: string | undefined;
@@ -1359,6 +1526,7 @@ export interface DeleteVoiceConnectorRequest {
1359
1526
  */
1360
1527
  export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest {
1361
1528
  /**
1529
+ * @public
1362
1530
  * <p>The Voice Connector ID.</p>
1363
1531
  */
1364
1532
  VoiceConnectorId: string | undefined;
@@ -1368,6 +1536,7 @@ export interface DeleteVoiceConnectorEmergencyCallingConfigurationRequest {
1368
1536
  */
1369
1537
  export interface DeleteVoiceConnectorGroupRequest {
1370
1538
  /**
1539
+ * @public
1371
1540
  * <p>The Voice Connector Group ID.</p>
1372
1541
  */
1373
1542
  VoiceConnectorGroupId: string | undefined;
@@ -1377,6 +1546,7 @@ export interface DeleteVoiceConnectorGroupRequest {
1377
1546
  */
1378
1547
  export interface DeleteVoiceConnectorOriginationRequest {
1379
1548
  /**
1549
+ * @public
1380
1550
  * <p>The Voice Connector ID.</p>
1381
1551
  */
1382
1552
  VoiceConnectorId: string | undefined;
@@ -1386,6 +1556,7 @@ export interface DeleteVoiceConnectorOriginationRequest {
1386
1556
  */
1387
1557
  export interface DeleteVoiceConnectorProxyRequest {
1388
1558
  /**
1559
+ * @public
1389
1560
  * <p>The Voice Connector ID.</p>
1390
1561
  */
1391
1562
  VoiceConnectorId: string | undefined;
@@ -1395,6 +1566,7 @@ export interface DeleteVoiceConnectorProxyRequest {
1395
1566
  */
1396
1567
  export interface DeleteVoiceConnectorStreamingConfigurationRequest {
1397
1568
  /**
1569
+ * @public
1398
1570
  * <p>The Voice Connector ID.</p>
1399
1571
  */
1400
1572
  VoiceConnectorId: string | undefined;
@@ -1404,6 +1576,7 @@ export interface DeleteVoiceConnectorStreamingConfigurationRequest {
1404
1576
  */
1405
1577
  export interface DeleteVoiceConnectorTerminationRequest {
1406
1578
  /**
1579
+ * @public
1407
1580
  * <p>The Voice Connector ID.</p>
1408
1581
  */
1409
1582
  VoiceConnectorId: string | undefined;
@@ -1413,10 +1586,12 @@ export interface DeleteVoiceConnectorTerminationRequest {
1413
1586
  */
1414
1587
  export interface DeleteVoiceConnectorTerminationCredentialsRequest {
1415
1588
  /**
1589
+ * @public
1416
1590
  * <p>The Voice Connector ID.</p>
1417
1591
  */
1418
1592
  VoiceConnectorId: string | undefined;
1419
1593
  /**
1594
+ * @public
1420
1595
  * <p>The RFC2617 compliant username associated with the SIP credentials,
1421
1596
  * in US-ASCII format.</p>
1422
1597
  */
@@ -1427,6 +1602,7 @@ export interface DeleteVoiceConnectorTerminationCredentialsRequest {
1427
1602
  */
1428
1603
  export interface DeleteVoiceProfileRequest {
1429
1604
  /**
1605
+ * @public
1430
1606
  * <p>The voice profile ID.</p>
1431
1607
  */
1432
1608
  VoiceProfileId: string | undefined;
@@ -1436,6 +1612,7 @@ export interface DeleteVoiceProfileRequest {
1436
1612
  */
1437
1613
  export interface DeleteVoiceProfileDomainRequest {
1438
1614
  /**
1615
+ * @public
1439
1616
  * <p>The voice profile domain ID.</p>
1440
1617
  */
1441
1618
  VoiceProfileDomainId: string | undefined;
@@ -1445,10 +1622,12 @@ export interface DeleteVoiceProfileDomainRequest {
1445
1622
  */
1446
1623
  export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
1447
1624
  /**
1625
+ * @public
1448
1626
  * <p>The Voice Connector ID.</p>
1449
1627
  */
1450
1628
  VoiceConnectorId: string | undefined;
1451
1629
  /**
1630
+ * @public
1452
1631
  * <p>List of phone numbers, in E.164 format.</p>
1453
1632
  */
1454
1633
  E164PhoneNumbers: string[] | undefined;
@@ -1458,6 +1637,7 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
1458
1637
  */
1459
1638
  export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
1460
1639
  /**
1640
+ * @public
1461
1641
  * <p>If the action fails for one or more of the phone numbers in the request, a
1462
1642
  * list of the phone numbers is returned, along with error codes and error messages.</p>
1463
1643
  */
@@ -1468,10 +1648,12 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
1468
1648
  */
1469
1649
  export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
1470
1650
  /**
1651
+ * @public
1471
1652
  * <p>The Voice Connector group ID.</p>
1472
1653
  */
1473
1654
  VoiceConnectorGroupId: string | undefined;
1474
1655
  /**
1656
+ * @public
1475
1657
  * <p>The list of phone numbers, in E.164 format.</p>
1476
1658
  */
1477
1659
  E164PhoneNumbers: string[] | undefined;
@@ -1481,6 +1663,7 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
1481
1663
  */
1482
1664
  export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
1483
1665
  /**
1666
+ * @public
1484
1667
  * <p>If the action fails for one or more of the phone numbers in the request,
1485
1668
  * a list of the phone numbers is returned, along with error codes and error messages.</p>
1486
1669
  */
@@ -1493,6 +1676,7 @@ export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
1493
1676
  */
1494
1677
  export interface VoiceConnectorSettings {
1495
1678
  /**
1679
+ * @public
1496
1680
  * <p>The S3 bucket that stores the Voice Connector's call detail records.</p>
1497
1681
  */
1498
1682
  CdrBucket?: string;
@@ -1502,6 +1686,7 @@ export interface VoiceConnectorSettings {
1502
1686
  */
1503
1687
  export interface GetGlobalSettingsResponse {
1504
1688
  /**
1689
+ * @public
1505
1690
  * <p>The Voice Connector settings.</p>
1506
1691
  */
1507
1692
  VoiceConnector?: VoiceConnectorSettings;
@@ -1511,6 +1696,7 @@ export interface GetGlobalSettingsResponse {
1511
1696
  */
1512
1697
  export interface GetPhoneNumberRequest {
1513
1698
  /**
1699
+ * @public
1514
1700
  * <p>The phone number ID.</p>
1515
1701
  */
1516
1702
  PhoneNumberId: string | undefined;
@@ -1535,14 +1721,17 @@ export type PhoneNumberAssociationName = (typeof PhoneNumberAssociationName)[key
1535
1721
  */
1536
1722
  export interface PhoneNumberAssociation {
1537
1723
  /**
1724
+ * @public
1538
1725
  * <p>Contains the ID for the entity specified in Name.</p>
1539
1726
  */
1540
1727
  Value?: string;
1541
1728
  /**
1729
+ * @public
1542
1730
  * <p>Defines the association with an Amazon Chime SDK account ID, user ID, Voice Connector ID, or Voice Connector group ID.</p>
1543
1731
  */
1544
1732
  Name?: PhoneNumberAssociationName | string;
1545
1733
  /**
1734
+ * @public
1546
1735
  * <p>The timestamp of the phone number association, in ISO 8601 format.</p>
1547
1736
  */
1548
1737
  AssociatedTimestamp?: Date;
@@ -1554,26 +1743,32 @@ export interface PhoneNumberAssociation {
1554
1743
  */
1555
1744
  export interface PhoneNumberCapabilities {
1556
1745
  /**
1746
+ * @public
1557
1747
  * <p>Allows or denies inbound calling for the specified phone number.</p>
1558
1748
  */
1559
1749
  InboundCall?: boolean;
1560
1750
  /**
1751
+ * @public
1561
1752
  * <p>Allows or denies outbound calling for the specified phone number.</p>
1562
1753
  */
1563
1754
  OutboundCall?: boolean;
1564
1755
  /**
1756
+ * @public
1565
1757
  * <p>Allows or denies inbound SMS messaging for the specified phone number.</p>
1566
1758
  */
1567
1759
  InboundSMS?: boolean;
1568
1760
  /**
1761
+ * @public
1569
1762
  * <p>Allows or denies outbound SMS messaging for the specified phone number.</p>
1570
1763
  */
1571
1764
  OutboundSMS?: boolean;
1572
1765
  /**
1766
+ * @public
1573
1767
  * <p>Allows or denies inbound MMS messaging for the specified phone number.</p>
1574
1768
  */
1575
1769
  InboundMMS?: boolean;
1576
1770
  /**
1771
+ * @public
1577
1772
  * <p>Allows or denies inbound MMS messaging for the specified phone number.</p>
1578
1773
  */
1579
1774
  OutboundMMS?: boolean;
@@ -1618,58 +1813,72 @@ export type PhoneNumberType = (typeof PhoneNumberType)[keyof typeof PhoneNumberT
1618
1813
  */
1619
1814
  export interface PhoneNumber {
1620
1815
  /**
1816
+ * @public
1621
1817
  * <p>The phone number's ID.</p>
1622
1818
  */
1623
1819
  PhoneNumberId?: string;
1624
1820
  /**
1821
+ * @public
1625
1822
  * <p>The phone number, in E.164 format.</p>
1626
1823
  */
1627
1824
  E164PhoneNumber?: string;
1628
1825
  /**
1826
+ * @public
1629
1827
  * <p>The phone number's country. Format: ISO 3166-1 alpha-2.</p>
1630
1828
  */
1631
1829
  Country?: string;
1632
1830
  /**
1831
+ * @public
1633
1832
  * <p>The phone number's type.</p>
1634
1833
  */
1635
1834
  Type?: PhoneNumberType | string;
1636
1835
  /**
1836
+ * @public
1637
1837
  * <p>The phone number's product type.</p>
1638
1838
  */
1639
1839
  ProductType?: PhoneNumberProductType | string;
1640
1840
  /**
1841
+ * @public
1641
1842
  * <p>The phone number's status.</p>
1642
1843
  */
1643
1844
  Status?: PhoneNumberStatus | string;
1644
1845
  /**
1846
+ * @public
1645
1847
  * <p>The phone number's capabilities.</p>
1646
1848
  */
1647
1849
  Capabilities?: PhoneNumberCapabilities;
1648
1850
  /**
1851
+ * @public
1649
1852
  * <p>The phone number's associations.</p>
1650
1853
  */
1651
1854
  Associations?: PhoneNumberAssociation[];
1652
1855
  /**
1856
+ * @public
1653
1857
  * <p>The outbound calling name associated with the phone number.</p>
1654
1858
  */
1655
1859
  CallingName?: string;
1656
1860
  /**
1861
+ * @public
1657
1862
  * <p>The outbound calling name status.</p>
1658
1863
  */
1659
1864
  CallingNameStatus?: CallingNameStatus | string;
1660
1865
  /**
1866
+ * @public
1661
1867
  * <p>The phone number creation timestamp, in ISO 8601 format.</p>
1662
1868
  */
1663
1869
  CreatedTimestamp?: Date;
1664
1870
  /**
1871
+ * @public
1665
1872
  * <p>The updated phone number timestamp, in ISO 8601 format.</p>
1666
1873
  */
1667
1874
  UpdatedTimestamp?: Date;
1668
1875
  /**
1876
+ * @public
1669
1877
  * <p>The deleted phone number timestamp, in ISO 8601 format.</p>
1670
1878
  */
1671
1879
  DeletionTimestamp?: Date;
1672
1880
  /**
1881
+ * @public
1673
1882
  * <p>The phone number's order ID.</p>
1674
1883
  */
1675
1884
  OrderId?: string;
@@ -1679,6 +1888,7 @@ export interface PhoneNumber {
1679
1888
  */
1680
1889
  export interface GetPhoneNumberResponse {
1681
1890
  /**
1891
+ * @public
1682
1892
  * <p>The phone number details.</p>
1683
1893
  */
1684
1894
  PhoneNumber?: PhoneNumber;
@@ -1688,6 +1898,7 @@ export interface GetPhoneNumberResponse {
1688
1898
  */
1689
1899
  export interface GetPhoneNumberOrderRequest {
1690
1900
  /**
1901
+ * @public
1691
1902
  * <p>The ID of the phone number order .</p>
1692
1903
  */
1693
1904
  PhoneNumberOrderId: string | undefined;
@@ -1697,6 +1908,7 @@ export interface GetPhoneNumberOrderRequest {
1697
1908
  */
1698
1909
  export interface GetPhoneNumberOrderResponse {
1699
1910
  /**
1911
+ * @public
1700
1912
  * <p>The phone number order details.</p>
1701
1913
  */
1702
1914
  PhoneNumberOrder?: PhoneNumberOrder;
@@ -1706,10 +1918,12 @@ export interface GetPhoneNumberOrderResponse {
1706
1918
  */
1707
1919
  export interface GetPhoneNumberSettingsResponse {
1708
1920
  /**
1921
+ * @public
1709
1922
  * <p>The default outbound calling name for the account.</p>
1710
1923
  */
1711
1924
  CallingName?: string;
1712
1925
  /**
1926
+ * @public
1713
1927
  * <p>The updated outbound calling name timestamp, in ISO 8601 format.</p>
1714
1928
  */
1715
1929
  CallingNameUpdatedTimestamp?: Date;
@@ -1719,10 +1933,12 @@ export interface GetPhoneNumberSettingsResponse {
1719
1933
  */
1720
1934
  export interface GetProxySessionRequest {
1721
1935
  /**
1936
+ * @public
1722
1937
  * <p>The Voice Connector ID.</p>
1723
1938
  */
1724
1939
  VoiceConnectorId: string | undefined;
1725
1940
  /**
1941
+ * @public
1726
1942
  * <p>The proxy session ID.</p>
1727
1943
  */
1728
1944
  ProxySessionId: string | undefined;
@@ -1732,6 +1948,7 @@ export interface GetProxySessionRequest {
1732
1948
  */
1733
1949
  export interface GetProxySessionResponse {
1734
1950
  /**
1951
+ * @public
1735
1952
  * <p>The proxy session details.</p>
1736
1953
  */
1737
1954
  ProxySession?: ProxySession;
@@ -1741,6 +1958,7 @@ export interface GetProxySessionResponse {
1741
1958
  */
1742
1959
  export interface GetSipMediaApplicationRequest {
1743
1960
  /**
1961
+ * @public
1744
1962
  * <p>The SIP media application ID .</p>
1745
1963
  */
1746
1964
  SipMediaApplicationId: string | undefined;
@@ -1750,6 +1968,7 @@ export interface GetSipMediaApplicationRequest {
1750
1968
  */
1751
1969
  export interface GetSipMediaApplicationResponse {
1752
1970
  /**
1971
+ * @public
1753
1972
  * <p>The details of the SIP media application.</p>
1754
1973
  */
1755
1974
  SipMediaApplication?: SipMediaApplication;
@@ -1759,6 +1978,7 @@ export interface GetSipMediaApplicationResponse {
1759
1978
  */
1760
1979
  export interface GetSipMediaApplicationAlexaSkillConfigurationRequest {
1761
1980
  /**
1981
+ * @public
1762
1982
  * <p>The SIP media application ID.</p>
1763
1983
  */
1764
1984
  SipMediaApplicationId: string | undefined;
@@ -1769,10 +1989,12 @@ export interface GetSipMediaApplicationAlexaSkillConfigurationRequest {
1769
1989
  */
1770
1990
  export interface SipMediaApplicationAlexaSkillConfiguration {
1771
1991
  /**
1992
+ * @public
1772
1993
  * <p>The status of the Alexa Skill configuration.</p>
1773
1994
  */
1774
1995
  AlexaSkillStatus: AlexaSkillStatus | string | undefined;
1775
1996
  /**
1997
+ * @public
1776
1998
  * <p>The ID of the Alexa Skill configuration.</p>
1777
1999
  */
1778
2000
  AlexaSkillIds: string[] | undefined;
@@ -1782,6 +2004,7 @@ export interface SipMediaApplicationAlexaSkillConfiguration {
1782
2004
  */
1783
2005
  export interface GetSipMediaApplicationAlexaSkillConfigurationResponse {
1784
2006
  /**
2007
+ * @public
1785
2008
  * <p>Returns the Alexa Skill configuration.</p>
1786
2009
  */
1787
2010
  SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
@@ -1791,6 +2014,7 @@ export interface GetSipMediaApplicationAlexaSkillConfigurationResponse {
1791
2014
  */
1792
2015
  export interface GetSipMediaApplicationLoggingConfigurationRequest {
1793
2016
  /**
2017
+ * @public
1794
2018
  * <p>The SIP media application ID.</p>
1795
2019
  */
1796
2020
  SipMediaApplicationId: string | undefined;
@@ -1801,6 +2025,7 @@ export interface GetSipMediaApplicationLoggingConfigurationRequest {
1801
2025
  */
1802
2026
  export interface SipMediaApplicationLoggingConfiguration {
1803
2027
  /**
2028
+ * @public
1804
2029
  * <p>Enables message logging for the specified SIP media application.</p>
1805
2030
  */
1806
2031
  EnableSipMediaApplicationMessageLogs?: boolean;
@@ -1810,6 +2035,7 @@ export interface SipMediaApplicationLoggingConfiguration {
1810
2035
  */
1811
2036
  export interface GetSipMediaApplicationLoggingConfigurationResponse {
1812
2037
  /**
2038
+ * @public
1813
2039
  * <p>The actual logging configuration.</p>
1814
2040
  */
1815
2041
  SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
@@ -1819,6 +2045,7 @@ export interface GetSipMediaApplicationLoggingConfigurationResponse {
1819
2045
  */
1820
2046
  export interface GetSipRuleRequest {
1821
2047
  /**
2048
+ * @public
1822
2049
  * <p>The SIP rule ID.</p>
1823
2050
  */
1824
2051
  SipRuleId: string | undefined;
@@ -1828,6 +2055,7 @@ export interface GetSipRuleRequest {
1828
2055
  */
1829
2056
  export interface GetSipRuleResponse {
1830
2057
  /**
2058
+ * @public
1831
2059
  * <p>The SIP rule details.</p>
1832
2060
  */
1833
2061
  SipRule?: SipRule;
@@ -1837,10 +2065,12 @@ export interface GetSipRuleResponse {
1837
2065
  */
1838
2066
  export interface GetSpeakerSearchTaskRequest {
1839
2067
  /**
2068
+ * @public
1840
2069
  * <p>The Voice Connector ID.</p>
1841
2070
  */
1842
2071
  VoiceConnectorId: string | undefined;
1843
2072
  /**
2073
+ * @public
1844
2074
  * <p>The ID of the speaker search task.</p>
1845
2075
  */
1846
2076
  SpeakerSearchTaskId: string | undefined;
@@ -1851,10 +2081,12 @@ export interface GetSpeakerSearchTaskRequest {
1851
2081
  */
1852
2082
  export interface SpeakerSearchResult {
1853
2083
  /**
2084
+ * @public
1854
2085
  * <p>The confidence score in the speaker search analysis.</p>
1855
2086
  */
1856
2087
  ConfidenceScore?: number;
1857
2088
  /**
2089
+ * @public
1858
2090
  * <p>The voice profile ID.</p>
1859
2091
  */
1860
2092
  VoiceProfileId?: string;
@@ -1865,10 +2097,12 @@ export interface SpeakerSearchResult {
1865
2097
  */
1866
2098
  export interface SpeakerSearchDetails {
1867
2099
  /**
2100
+ * @public
1868
2101
  * <p>The result value in the speaker search details.</p>
1869
2102
  */
1870
2103
  Results?: SpeakerSearchResult[];
1871
2104
  /**
2105
+ * @public
1872
2106
  * <p>The status of a voice print generation operation, <code>VoiceprintGenerationSuccess</code> or <code>VoiceprintGenerationFailure</code>..</p>
1873
2107
  */
1874
2108
  VoiceprintGenerationStatus?: string;
@@ -1880,35 +2114,43 @@ export interface SpeakerSearchDetails {
1880
2114
  */
1881
2115
  export interface SpeakerSearchTask {
1882
2116
  /**
2117
+ * @public
1883
2118
  * <p>The speaker search task ID.</p>
1884
2119
  */
1885
2120
  SpeakerSearchTaskId?: string;
1886
2121
  /**
2122
+ * @public
1887
2123
  * <p>The status of the speaker search task, <code>IN_QUEUE</code>, <code>IN_PROGRESS</code>, <code>PARTIAL_SUCCESS</code>, <code>SUCCEEDED</code>,
1888
2124
  * <code>FAILED</code>, or <code>STOPPED</code>.</p>
1889
2125
  */
1890
2126
  SpeakerSearchTaskStatus?: string;
1891
2127
  /**
2128
+ * @public
1892
2129
  * <p>The call details of a speaker search task.</p>
1893
2130
  */
1894
2131
  CallDetails?: CallDetails;
1895
2132
  /**
2133
+ * @public
1896
2134
  * <p>The details of a speaker search task.</p>
1897
2135
  */
1898
2136
  SpeakerSearchDetails?: SpeakerSearchDetails;
1899
2137
  /**
2138
+ * @public
1900
2139
  * <p>The time at which a speaker search task was created.</p>
1901
2140
  */
1902
2141
  CreatedTimestamp?: Date;
1903
2142
  /**
2143
+ * @public
1904
2144
  * <p>The time at which a speaker search task was updated.</p>
1905
2145
  */
1906
2146
  UpdatedTimestamp?: Date;
1907
2147
  /**
2148
+ * @public
1908
2149
  * <p>The time at which the speaker search task began.</p>
1909
2150
  */
1910
2151
  StartedTimestamp?: Date;
1911
2152
  /**
2153
+ * @public
1912
2154
  * <p>A detailed message about the status of a speaker search.</p>
1913
2155
  */
1914
2156
  StatusMessage?: string;
@@ -1918,6 +2160,7 @@ export interface SpeakerSearchTask {
1918
2160
  */
1919
2161
  export interface GetSpeakerSearchTaskResponse {
1920
2162
  /**
2163
+ * @public
1921
2164
  * <p>The details of the speaker search task.</p>
1922
2165
  */
1923
2166
  SpeakerSearchTask?: SpeakerSearchTask;
@@ -1927,6 +2170,7 @@ export interface GetSpeakerSearchTaskResponse {
1927
2170
  */
1928
2171
  export interface GetVoiceConnectorRequest {
1929
2172
  /**
2173
+ * @public
1930
2174
  * <p>The Voice Connector ID.</p>
1931
2175
  */
1932
2176
  VoiceConnectorId: string | undefined;
@@ -1936,6 +2180,7 @@ export interface GetVoiceConnectorRequest {
1936
2180
  */
1937
2181
  export interface GetVoiceConnectorResponse {
1938
2182
  /**
2183
+ * @public
1939
2184
  * <p>The Voice Connector details.</p>
1940
2185
  */
1941
2186
  VoiceConnector?: VoiceConnector;
@@ -1945,6 +2190,7 @@ export interface GetVoiceConnectorResponse {
1945
2190
  */
1946
2191
  export interface GetVoiceConnectorEmergencyCallingConfigurationRequest {
1947
2192
  /**
2193
+ * @public
1948
2194
  * <p>The Voice Connector ID.</p>
1949
2195
  */
1950
2196
  VoiceConnectorId: string | undefined;
@@ -1957,14 +2203,17 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationRequest {
1957
2203
  */
1958
2204
  export interface DNISEmergencyCallingConfiguration {
1959
2205
  /**
2206
+ * @public
1960
2207
  * <p>The DNIS phone number that you route emergency calls to, in E.164 format.</p>
1961
2208
  */
1962
2209
  EmergencyPhoneNumber: string | undefined;
1963
2210
  /**
2211
+ * @public
1964
2212
  * <p>The DNIS phone number for routing test emergency calls to, in E.164 format.</p>
1965
2213
  */
1966
2214
  TestPhoneNumber?: string;
1967
2215
  /**
2216
+ * @public
1968
2217
  * <p>The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.</p>
1969
2218
  */
1970
2219
  CallingCountry: string | undefined;
@@ -1976,6 +2225,7 @@ export interface DNISEmergencyCallingConfiguration {
1976
2225
  */
1977
2226
  export interface EmergencyCallingConfiguration {
1978
2227
  /**
2228
+ * @public
1979
2229
  * <p>The Dialed Number Identification Service (DNIS) emergency calling configuration
1980
2230
  * details.</p>
1981
2231
  */
@@ -1986,6 +2236,7 @@ export interface EmergencyCallingConfiguration {
1986
2236
  */
1987
2237
  export interface GetVoiceConnectorEmergencyCallingConfigurationResponse {
1988
2238
  /**
2239
+ * @public
1989
2240
  * <p>The details of the emergency calling configuration.</p>
1990
2241
  */
1991
2242
  EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
@@ -1995,6 +2246,7 @@ export interface GetVoiceConnectorEmergencyCallingConfigurationResponse {
1995
2246
  */
1996
2247
  export interface GetVoiceConnectorGroupRequest {
1997
2248
  /**
2249
+ * @public
1998
2250
  * <p>The Voice Connector group ID.</p>
1999
2251
  */
2000
2252
  VoiceConnectorGroupId: string | undefined;
@@ -2004,6 +2256,7 @@ export interface GetVoiceConnectorGroupRequest {
2004
2256
  */
2005
2257
  export interface GetVoiceConnectorGroupResponse {
2006
2258
  /**
2259
+ * @public
2007
2260
  * <p>The details of the Voice Connector group.</p>
2008
2261
  */
2009
2262
  VoiceConnectorGroup?: VoiceConnectorGroup;
@@ -2013,6 +2266,7 @@ export interface GetVoiceConnectorGroupResponse {
2013
2266
  */
2014
2267
  export interface GetVoiceConnectorLoggingConfigurationRequest {
2015
2268
  /**
2269
+ * @public
2016
2270
  * <p>The Voice Connector ID.</p>
2017
2271
  */
2018
2272
  VoiceConnectorId: string | undefined;
@@ -2024,10 +2278,12 @@ export interface GetVoiceConnectorLoggingConfigurationRequest {
2024
2278
  */
2025
2279
  export interface LoggingConfiguration {
2026
2280
  /**
2281
+ * @public
2027
2282
  * <p>Boolean that enables sending SIP message logs to Amazon CloudWatch.</p>
2028
2283
  */
2029
2284
  EnableSIPLogs?: boolean;
2030
2285
  /**
2286
+ * @public
2031
2287
  * <p>Enables or disables media metrics logging.</p>
2032
2288
  */
2033
2289
  EnableMediaMetricLogs?: boolean;
@@ -2037,6 +2293,7 @@ export interface LoggingConfiguration {
2037
2293
  */
2038
2294
  export interface GetVoiceConnectorLoggingConfigurationResponse {
2039
2295
  /**
2296
+ * @public
2040
2297
  * <p>The logging configuration details .</p>
2041
2298
  */
2042
2299
  LoggingConfiguration?: LoggingConfiguration;
@@ -2046,6 +2303,7 @@ export interface GetVoiceConnectorLoggingConfigurationResponse {
2046
2303
  */
2047
2304
  export interface GetVoiceConnectorOriginationRequest {
2048
2305
  /**
2306
+ * @public
2049
2307
  * <p>The Voice Connector ID.</p>
2050
2308
  */
2051
2309
  VoiceConnectorId: string | undefined;
@@ -2073,24 +2331,29 @@ export type OriginationRouteProtocol = (typeof OriginationRouteProtocol)[keyof t
2073
2331
  */
2074
2332
  export interface OriginationRoute {
2075
2333
  /**
2334
+ * @public
2076
2335
  * <p>The FQDN or IP address to contact for origination traffic.</p>
2077
2336
  */
2078
2337
  Host?: string;
2079
2338
  /**
2339
+ * @public
2080
2340
  * <p>The designated origination route port. Defaults to 5060.</p>
2081
2341
  */
2082
2342
  Port?: number;
2083
2343
  /**
2344
+ * @public
2084
2345
  * <p>The protocol to use for the origination route. Encryption-enabled Amazon Chime SDK Voice Connectors use
2085
2346
  * TCP protocol by default.</p>
2086
2347
  */
2087
2348
  Protocol?: OriginationRouteProtocol | string;
2088
2349
  /**
2350
+ * @public
2089
2351
  * <p>The priority associated with the host, with 1 being the highest priority. Higher
2090
2352
  * priority hosts are attempted first.</p>
2091
2353
  */
2092
2354
  Priority?: number;
2093
2355
  /**
2356
+ * @public
2094
2357
  * <p>The weight assigned to an origination route. When hosts have equal priority,
2095
2358
  * calls are distributed between them based on their relative weights.</p>
2096
2359
  */
@@ -2107,12 +2370,14 @@ export interface OriginationRoute {
2107
2370
  */
2108
2371
  export interface Origination {
2109
2372
  /**
2373
+ * @public
2110
2374
  * <p>The call distribution properties defined for your SIP hosts. Valid range: Minimum
2111
2375
  * value of 1. Maximum value of 20. This parameter is not required, but you must specify
2112
2376
  * this parameter or <code>Disabled</code>.</p>
2113
2377
  */
2114
2378
  Routes?: OriginationRoute[];
2115
2379
  /**
2380
+ * @public
2116
2381
  * <p>When origination settings are disabled, inbound calls are not enabled for your
2117
2382
  * Amazon Chime SDK Voice Connector.
2118
2383
  * This parameter is not required, but you must specify this parameter or
@@ -2125,6 +2390,7 @@ export interface Origination {
2125
2390
  */
2126
2391
  export interface GetVoiceConnectorOriginationResponse {
2127
2392
  /**
2393
+ * @public
2128
2394
  * <p>The origination setting details.</p>
2129
2395
  */
2130
2396
  Origination?: Origination;
@@ -2134,6 +2400,7 @@ export interface GetVoiceConnectorOriginationResponse {
2134
2400
  */
2135
2401
  export interface GetVoiceConnectorProxyRequest {
2136
2402
  /**
2403
+ * @public
2137
2404
  * <p>The Voice Connector ID.</p>
2138
2405
  */
2139
2406
  VoiceConnectorId: string | undefined;
@@ -2144,18 +2411,22 @@ export interface GetVoiceConnectorProxyRequest {
2144
2411
  */
2145
2412
  export interface Proxy {
2146
2413
  /**
2414
+ * @public
2147
2415
  * <p>The default number of minutes allowed for proxy sessions.</p>
2148
2416
  */
2149
2417
  DefaultSessionExpiryMinutes?: number;
2150
2418
  /**
2419
+ * @public
2151
2420
  * <p>When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.</p>
2152
2421
  */
2153
2422
  Disabled?: boolean;
2154
2423
  /**
2424
+ * @public
2155
2425
  * <p>The phone number to route calls to after a proxy session expires.</p>
2156
2426
  */
2157
2427
  FallBackPhoneNumber?: string;
2158
2428
  /**
2429
+ * @public
2159
2430
  * <p>The countries for proxy phone numbers to be selected from.</p>
2160
2431
  */
2161
2432
  PhoneNumberCountries?: string[];
@@ -2165,6 +2436,7 @@ export interface Proxy {
2165
2436
  */
2166
2437
  export interface GetVoiceConnectorProxyResponse {
2167
2438
  /**
2439
+ * @public
2168
2440
  * <p>The proxy configuration details.</p>
2169
2441
  */
2170
2442
  Proxy?: Proxy;
@@ -2174,6 +2446,7 @@ export interface GetVoiceConnectorProxyResponse {
2174
2446
  */
2175
2447
  export interface GetVoiceConnectorStreamingConfigurationRequest {
2176
2448
  /**
2449
+ * @public
2177
2450
  * <p>The Voice Connector ID.</p>
2178
2451
  */
2179
2452
  VoiceConnectorId: string | undefined;
@@ -2184,10 +2457,12 @@ export interface GetVoiceConnectorStreamingConfigurationRequest {
2184
2457
  */
2185
2458
  export interface MediaInsightsConfiguration {
2186
2459
  /**
2460
+ * @public
2187
2461
  * <p>Denotes the configration as enabled or disabled.</p>
2188
2462
  */
2189
2463
  Disabled?: boolean;
2190
2464
  /**
2465
+ * @public
2191
2466
  * <p>The configuration's ARN.</p>
2192
2467
  */
2193
2468
  ConfigurationArn?: string;
@@ -2211,6 +2486,7 @@ export type NotificationTarget = (typeof NotificationTarget)[keyof typeof Notifi
2211
2486
  */
2212
2487
  export interface StreamingNotificationTarget {
2213
2488
  /**
2489
+ * @public
2214
2490
  * <p>The streaming notification target.</p>
2215
2491
  */
2216
2492
  NotificationTarget?: NotificationTarget | string;
@@ -2223,18 +2499,22 @@ export interface StreamingNotificationTarget {
2223
2499
  */
2224
2500
  export interface StreamingConfiguration {
2225
2501
  /**
2502
+ * @public
2226
2503
  * <p>The amount of time, in hours, to the Kinesis data.</p>
2227
2504
  */
2228
2505
  DataRetentionInHours: number | undefined;
2229
2506
  /**
2507
+ * @public
2230
2508
  * <p>When true, streaming to Kinesis is off.</p>
2231
2509
  */
2232
2510
  Disabled: boolean | undefined;
2233
2511
  /**
2512
+ * @public
2234
2513
  * <p>The streaming notification targets.</p>
2235
2514
  */
2236
2515
  StreamingNotificationTargets?: StreamingNotificationTarget[];
2237
2516
  /**
2517
+ * @public
2238
2518
  * <p>The call analytics configuration.</p>
2239
2519
  */
2240
2520
  MediaInsightsConfiguration?: MediaInsightsConfiguration;
@@ -2244,6 +2524,7 @@ export interface StreamingConfiguration {
2244
2524
  */
2245
2525
  export interface GetVoiceConnectorStreamingConfigurationResponse {
2246
2526
  /**
2527
+ * @public
2247
2528
  * <p>The details of the streaming configuration.</p>
2248
2529
  */
2249
2530
  StreamingConfiguration?: StreamingConfiguration;
@@ -2253,6 +2534,7 @@ export interface GetVoiceConnectorStreamingConfigurationResponse {
2253
2534
  */
2254
2535
  export interface GetVoiceConnectorTerminationRequest {
2255
2536
  /**
2537
+ * @public
2256
2538
  * <p>The Voice Connector ID.</p>
2257
2539
  */
2258
2540
  VoiceConnectorId: string | undefined;
@@ -2263,22 +2545,27 @@ export interface GetVoiceConnectorTerminationRequest {
2263
2545
  */
2264
2546
  export interface Termination {
2265
2547
  /**
2548
+ * @public
2266
2549
  * <p>The limit on calls per second. Max value based on account service quota. Default value of 1.</p>
2267
2550
  */
2268
2551
  CpsLimit?: number;
2269
2552
  /**
2553
+ * @public
2270
2554
  * <p>The default outbound calling number.</p>
2271
2555
  */
2272
2556
  DefaultPhoneNumber?: string;
2273
2557
  /**
2558
+ * @public
2274
2559
  * <p>The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.</p>
2275
2560
  */
2276
2561
  CallingRegions?: string[];
2277
2562
  /**
2563
+ * @public
2278
2564
  * <p>The IP addresses allowed to make calls, in CIDR format.</p>
2279
2565
  */
2280
2566
  CidrAllowedList?: string[];
2281
2567
  /**
2568
+ * @public
2282
2569
  * <p>When termination is disabled, outbound calls cannot be made.</p>
2283
2570
  */
2284
2571
  Disabled?: boolean;
@@ -2288,6 +2575,7 @@ export interface Termination {
2288
2575
  */
2289
2576
  export interface GetVoiceConnectorTerminationResponse {
2290
2577
  /**
2578
+ * @public
2291
2579
  * <p>The termination setting details.</p>
2292
2580
  */
2293
2581
  Termination?: Termination;
@@ -2297,6 +2585,7 @@ export interface GetVoiceConnectorTerminationResponse {
2297
2585
  */
2298
2586
  export interface GetVoiceConnectorTerminationHealthRequest {
2299
2587
  /**
2588
+ * @public
2300
2589
  * <p>The Voice Connector ID.</p>
2301
2590
  */
2302
2591
  VoiceConnectorId: string | undefined;
@@ -2307,10 +2596,12 @@ export interface GetVoiceConnectorTerminationHealthRequest {
2307
2596
  */
2308
2597
  export interface TerminationHealth {
2309
2598
  /**
2599
+ * @public
2310
2600
  * <p>The timestamp, in ISO 8601 format.</p>
2311
2601
  */
2312
2602
  Timestamp?: Date;
2313
2603
  /**
2604
+ * @public
2314
2605
  * <p>The source IP address.</p>
2315
2606
  */
2316
2607
  Source?: string;
@@ -2320,6 +2611,7 @@ export interface TerminationHealth {
2320
2611
  */
2321
2612
  export interface GetVoiceConnectorTerminationHealthResponse {
2322
2613
  /**
2614
+ * @public
2323
2615
  * <p>The termination health details.</p>
2324
2616
  */
2325
2617
  TerminationHealth?: TerminationHealth;
@@ -2329,6 +2621,7 @@ export interface GetVoiceConnectorTerminationHealthResponse {
2329
2621
  */
2330
2622
  export interface GetVoiceProfileRequest {
2331
2623
  /**
2624
+ * @public
2332
2625
  * <p>The voice profile ID.</p>
2333
2626
  */
2334
2627
  VoiceProfileId: string | undefined;
@@ -2338,6 +2631,7 @@ export interface GetVoiceProfileRequest {
2338
2631
  */
2339
2632
  export interface GetVoiceProfileResponse {
2340
2633
  /**
2634
+ * @public
2341
2635
  * <p>The voice profile details.</p>
2342
2636
  */
2343
2637
  VoiceProfile?: VoiceProfile;
@@ -2347,6 +2641,7 @@ export interface GetVoiceProfileResponse {
2347
2641
  */
2348
2642
  export interface GetVoiceProfileDomainRequest {
2349
2643
  /**
2644
+ * @public
2350
2645
  * <p>The voice profile domain ID.</p>
2351
2646
  */
2352
2647
  VoiceProfileDomainId: string | undefined;
@@ -2356,6 +2651,7 @@ export interface GetVoiceProfileDomainRequest {
2356
2651
  */
2357
2652
  export interface GetVoiceProfileDomainResponse {
2358
2653
  /**
2654
+ * @public
2359
2655
  * <p>The details of the voice profile domain.</p>
2360
2656
  */
2361
2657
  VoiceProfileDomain?: VoiceProfileDomain;
@@ -2365,14 +2661,17 @@ export interface GetVoiceProfileDomainResponse {
2365
2661
  */
2366
2662
  export interface GetVoiceToneAnalysisTaskRequest {
2367
2663
  /**
2664
+ * @public
2368
2665
  * <p>The Voice Connector ID.</p>
2369
2666
  */
2370
2667
  VoiceConnectorId: string | undefined;
2371
2668
  /**
2669
+ * @public
2372
2670
  * <p>The ID of the voice tone anlysis task.</p>
2373
2671
  */
2374
2672
  VoiceToneAnalysisTaskId: string | undefined;
2375
2673
  /**
2674
+ * @public
2376
2675
  * <p>Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).</p>
2377
2676
  */
2378
2677
  IsCaller: boolean | undefined;
@@ -2383,31 +2682,38 @@ export interface GetVoiceToneAnalysisTaskRequest {
2383
2682
  */
2384
2683
  export interface VoiceToneAnalysisTask {
2385
2684
  /**
2685
+ * @public
2386
2686
  * <p>The ID of the voice tone analysis task.</p>
2387
2687
  */
2388
2688
  VoiceToneAnalysisTaskId?: string;
2389
2689
  /**
2690
+ * @public
2390
2691
  * <p>The status of a voice tone analysis task, <code>IN_QUEUE</code>, <code>IN_PROGRESS</code>, <code>PARTIAL_SUCCESS</code>, <code>SUCCEEDED</code>,
2391
2692
  * <code>FAILED</code>, or <code>STOPPED</code>.</p>
2392
2693
  */
2393
2694
  VoiceToneAnalysisTaskStatus?: string;
2394
2695
  /**
2696
+ * @public
2395
2697
  * <p>The call details of a voice tone analysis task.</p>
2396
2698
  */
2397
2699
  CallDetails?: CallDetails;
2398
2700
  /**
2701
+ * @public
2399
2702
  * <p>The time at which a voice tone analysis task was created.</p>
2400
2703
  */
2401
2704
  CreatedTimestamp?: Date;
2402
2705
  /**
2706
+ * @public
2403
2707
  * <p>The time at which a voice tone analysis task was updated.</p>
2404
2708
  */
2405
2709
  UpdatedTimestamp?: Date;
2406
2710
  /**
2711
+ * @public
2407
2712
  * <p>The time at which a voice tone analysis task started.</p>
2408
2713
  */
2409
2714
  StartedTimestamp?: Date;
2410
2715
  /**
2716
+ * @public
2411
2717
  * <p>The status of a voice tone analysis task.</p>
2412
2718
  */
2413
2719
  StatusMessage?: string;
@@ -2417,6 +2723,7 @@ export interface VoiceToneAnalysisTask {
2417
2723
  */
2418
2724
  export interface GetVoiceToneAnalysisTaskResponse {
2419
2725
  /**
2726
+ * @public
2420
2727
  * <p>The details of the voice tone analysis task.</p>
2421
2728
  */
2422
2729
  VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
@@ -2426,6 +2733,7 @@ export interface GetVoiceToneAnalysisTaskResponse {
2426
2733
  */
2427
2734
  export interface ListAvailableVoiceConnectorRegionsResponse {
2428
2735
  /**
2736
+ * @public
2429
2737
  * <p>The list of AWS Regions.</p>
2430
2738
  */
2431
2739
  VoiceConnectorRegions?: (VoiceConnectorAwsRegion | string)[];
@@ -2435,10 +2743,12 @@ export interface ListAvailableVoiceConnectorRegionsResponse {
2435
2743
  */
2436
2744
  export interface ListPhoneNumberOrdersRequest {
2437
2745
  /**
2746
+ * @public
2438
2747
  * <p>The token used to retrieve the next page of results.</p>
2439
2748
  */
2440
2749
  NextToken?: string;
2441
2750
  /**
2751
+ * @public
2442
2752
  * <p>The maximum number of results to return in a single call.</p>
2443
2753
  */
2444
2754
  MaxResults?: number;
@@ -2448,10 +2758,12 @@ export interface ListPhoneNumberOrdersRequest {
2448
2758
  */
2449
2759
  export interface ListPhoneNumberOrdersResponse {
2450
2760
  /**
2761
+ * @public
2451
2762
  * <p>The phone number order details.</p>
2452
2763
  */
2453
2764
  PhoneNumberOrders?: PhoneNumberOrder[];
2454
2765
  /**
2766
+ * @public
2455
2767
  * <p>The token used to retrieve the next page of results.</p>
2456
2768
  */
2457
2769
  NextToken?: string;
@@ -2461,26 +2773,32 @@ export interface ListPhoneNumberOrdersResponse {
2461
2773
  */
2462
2774
  export interface ListPhoneNumbersRequest {
2463
2775
  /**
2776
+ * @public
2464
2777
  * <p>The status of your organization's phone numbers.</p>
2465
2778
  */
2466
2779
  Status?: string;
2467
2780
  /**
2781
+ * @public
2468
2782
  * <p>The phone number product types.</p>
2469
2783
  */
2470
2784
  ProductType?: PhoneNumberProductType | string;
2471
2785
  /**
2786
+ * @public
2472
2787
  * <p>The filter to limit the number of results.</p>
2473
2788
  */
2474
2789
  FilterName?: PhoneNumberAssociationName | string;
2475
2790
  /**
2791
+ * @public
2476
2792
  * <p>The filter value.</p>
2477
2793
  */
2478
2794
  FilterValue?: string;
2479
2795
  /**
2796
+ * @public
2480
2797
  * <p>The maximum number of results to return in a single call.</p>
2481
2798
  */
2482
2799
  MaxResults?: number;
2483
2800
  /**
2801
+ * @public
2484
2802
  * <p>The token used to return the next page of results.</p>
2485
2803
  */
2486
2804
  NextToken?: string;
@@ -2490,10 +2808,12 @@ export interface ListPhoneNumbersRequest {
2490
2808
  */
2491
2809
  export interface ListPhoneNumbersResponse {
2492
2810
  /**
2811
+ * @public
2493
2812
  * <p>The phone number details.</p>
2494
2813
  */
2495
2814
  PhoneNumbers?: PhoneNumber[];
2496
2815
  /**
2816
+ * @public
2497
2817
  * <p>The token used to return the next page of results.</p>
2498
2818
  */
2499
2819
  NextToken?: string;
@@ -2503,18 +2823,22 @@ export interface ListPhoneNumbersResponse {
2503
2823
  */
2504
2824
  export interface ListProxySessionsRequest {
2505
2825
  /**
2826
+ * @public
2506
2827
  * <p>The Voice Connector ID.</p>
2507
2828
  */
2508
2829
  VoiceConnectorId: string | undefined;
2509
2830
  /**
2831
+ * @public
2510
2832
  * <p>The proxy session status.</p>
2511
2833
  */
2512
2834
  Status?: ProxySessionStatus | string;
2513
2835
  /**
2836
+ * @public
2514
2837
  * <p>The token used to retrieve the next page of results.</p>
2515
2838
  */
2516
2839
  NextToken?: string;
2517
2840
  /**
2841
+ * @public
2518
2842
  * <p>The maximum number of results to return in a single call.</p>
2519
2843
  */
2520
2844
  MaxResults?: number;
@@ -2524,10 +2848,12 @@ export interface ListProxySessionsRequest {
2524
2848
  */
2525
2849
  export interface ListProxySessionsResponse {
2526
2850
  /**
2851
+ * @public
2527
2852
  * <p>The proxy sessions' details.</p>
2528
2853
  */
2529
2854
  ProxySessions?: ProxySession[];
2530
2855
  /**
2856
+ * @public
2531
2857
  * <p>The token used to retrieve the next page of results.</p>
2532
2858
  */
2533
2859
  NextToken?: string;
@@ -2537,10 +2863,12 @@ export interface ListProxySessionsResponse {
2537
2863
  */
2538
2864
  export interface ListSipMediaApplicationsRequest {
2539
2865
  /**
2866
+ * @public
2540
2867
  * <p>The maximum number of results to return in a single call. Defaults to 100.</p>
2541
2868
  */
2542
2869
  MaxResults?: number;
2543
2870
  /**
2871
+ * @public
2544
2872
  * <p>The token used to return the next page of results.</p>
2545
2873
  */
2546
2874
  NextToken?: string;
@@ -2550,10 +2878,12 @@ export interface ListSipMediaApplicationsRequest {
2550
2878
  */
2551
2879
  export interface ListSipMediaApplicationsResponse {
2552
2880
  /**
2881
+ * @public
2553
2882
  * <p>The list of SIP media applications and application details.</p>
2554
2883
  */
2555
2884
  SipMediaApplications?: SipMediaApplication[];
2556
2885
  /**
2886
+ * @public
2557
2887
  * <p>The token used to return the next page of results.</p>
2558
2888
  */
2559
2889
  NextToken?: string;
@@ -2563,14 +2893,17 @@ export interface ListSipMediaApplicationsResponse {
2563
2893
  */
2564
2894
  export interface ListSipRulesRequest {
2565
2895
  /**
2896
+ * @public
2566
2897
  * <p>The SIP media application ID.</p>
2567
2898
  */
2568
2899
  SipMediaApplicationId?: string;
2569
2900
  /**
2901
+ * @public
2570
2902
  * <p>The maximum number of results to return in a single call. Defaults to 100.</p>
2571
2903
  */
2572
2904
  MaxResults?: number;
2573
2905
  /**
2906
+ * @public
2574
2907
  * <p>The token used to return the next page of results.</p>
2575
2908
  */
2576
2909
  NextToken?: string;
@@ -2580,10 +2913,12 @@ export interface ListSipRulesRequest {
2580
2913
  */
2581
2914
  export interface ListSipRulesResponse {
2582
2915
  /**
2916
+ * @public
2583
2917
  * <p>The list of SIP rules and details.</p>
2584
2918
  */
2585
2919
  SipRules?: SipRule[];
2586
2920
  /**
2921
+ * @public
2587
2922
  * <p>The token used to return the next page of results.</p>
2588
2923
  */
2589
2924
  NextToken?: string;
@@ -2593,6 +2928,7 @@ export interface ListSipRulesResponse {
2593
2928
  */
2594
2929
  export interface ListSupportedPhoneNumberCountriesRequest {
2595
2930
  /**
2931
+ * @public
2596
2932
  * <p>The phone number product type.</p>
2597
2933
  */
2598
2934
  ProductType: PhoneNumberProductType | string | undefined;
@@ -2603,10 +2939,12 @@ export interface ListSupportedPhoneNumberCountriesRequest {
2603
2939
  */
2604
2940
  export interface PhoneNumberCountry {
2605
2941
  /**
2942
+ * @public
2606
2943
  * <p>The phone number country code. Format: ISO 3166-1 alpha-2.</p>
2607
2944
  */
2608
2945
  CountryCode?: string;
2609
2946
  /**
2947
+ * @public
2610
2948
  * <p>The supported phone number types.</p>
2611
2949
  */
2612
2950
  SupportedPhoneNumberTypes?: (PhoneNumberType | string)[];
@@ -2616,6 +2954,7 @@ export interface PhoneNumberCountry {
2616
2954
  */
2617
2955
  export interface ListSupportedPhoneNumberCountriesResponse {
2618
2956
  /**
2957
+ * @public
2619
2958
  * <p>The supported phone number countries.</p>
2620
2959
  */
2621
2960
  PhoneNumberCountries?: PhoneNumberCountry[];
@@ -2625,6 +2964,7 @@ export interface ListSupportedPhoneNumberCountriesResponse {
2625
2964
  */
2626
2965
  export interface ListTagsForResourceRequest {
2627
2966
  /**
2967
+ * @public
2628
2968
  * <p>The resource ARN.</p>
2629
2969
  */
2630
2970
  ResourceARN: string | undefined;
@@ -2634,6 +2974,7 @@ export interface ListTagsForResourceRequest {
2634
2974
  */
2635
2975
  export interface ListTagsForResourceResponse {
2636
2976
  /**
2977
+ * @public
2637
2978
  * <p>The tags in the list.</p>
2638
2979
  */
2639
2980
  Tags?: Tag[];
@@ -2643,10 +2984,12 @@ export interface ListTagsForResourceResponse {
2643
2984
  */
2644
2985
  export interface ListVoiceConnectorGroupsRequest {
2645
2986
  /**
2987
+ * @public
2646
2988
  * <p>The token used to return the next page of results.</p>
2647
2989
  */
2648
2990
  NextToken?: string;
2649
2991
  /**
2992
+ * @public
2650
2993
  * <p>The maximum number of results to return in a single call. </p>
2651
2994
  */
2652
2995
  MaxResults?: number;
@@ -2656,10 +2999,12 @@ export interface ListVoiceConnectorGroupsRequest {
2656
2999
  */
2657
3000
  export interface ListVoiceConnectorGroupsResponse {
2658
3001
  /**
3002
+ * @public
2659
3003
  * <p>The details of the Voice Connector groups.</p>
2660
3004
  */
2661
3005
  VoiceConnectorGroups?: VoiceConnectorGroup[];
2662
3006
  /**
3007
+ * @public
2663
3008
  * <p>The token used to return the next page of results.</p>
2664
3009
  */
2665
3010
  NextToken?: string;
@@ -2669,10 +3014,12 @@ export interface ListVoiceConnectorGroupsResponse {
2669
3014
  */
2670
3015
  export interface ListVoiceConnectorsRequest {
2671
3016
  /**
3017
+ * @public
2672
3018
  * <p>The token used to return the next page of results.</p>
2673
3019
  */
2674
3020
  NextToken?: string;
2675
3021
  /**
3022
+ * @public
2676
3023
  * <p>The maximum number of results to return in a single call.</p>
2677
3024
  */
2678
3025
  MaxResults?: number;
@@ -2682,10 +3029,12 @@ export interface ListVoiceConnectorsRequest {
2682
3029
  */
2683
3030
  export interface ListVoiceConnectorsResponse {
2684
3031
  /**
3032
+ * @public
2685
3033
  * <p>The details of the Voice Connectors.</p>
2686
3034
  */
2687
3035
  VoiceConnectors?: VoiceConnector[];
2688
3036
  /**
3037
+ * @public
2689
3038
  * <p>The token used to return the next page of results.</p>
2690
3039
  */
2691
3040
  NextToken?: string;
@@ -2695,6 +3044,7 @@ export interface ListVoiceConnectorsResponse {
2695
3044
  */
2696
3045
  export interface ListVoiceConnectorTerminationCredentialsRequest {
2697
3046
  /**
3047
+ * @public
2698
3048
  * <p>The Voice Connector ID.</p>
2699
3049
  */
2700
3050
  VoiceConnectorId: string | undefined;
@@ -2704,6 +3054,7 @@ export interface ListVoiceConnectorTerminationCredentialsRequest {
2704
3054
  */
2705
3055
  export interface ListVoiceConnectorTerminationCredentialsResponse {
2706
3056
  /**
3057
+ * @public
2707
3058
  * <p>A list of user names.</p>
2708
3059
  */
2709
3060
  Usernames?: string[];
@@ -2713,10 +3064,12 @@ export interface ListVoiceConnectorTerminationCredentialsResponse {
2713
3064
  */
2714
3065
  export interface ListVoiceProfileDomainsRequest {
2715
3066
  /**
3067
+ * @public
2716
3068
  * <p>The token used to return the next page of results.</p>
2717
3069
  */
2718
3070
  NextToken?: string;
2719
3071
  /**
3072
+ * @public
2720
3073
  * <p>The maximum number of results to return in a single call.</p>
2721
3074
  */
2722
3075
  MaxResults?: number;
@@ -2727,26 +3080,32 @@ export interface ListVoiceProfileDomainsRequest {
2727
3080
  */
2728
3081
  export interface VoiceProfileDomainSummary {
2729
3082
  /**
3083
+ * @public
2730
3084
  * <p>The ID of the voice profile domain summary.</p>
2731
3085
  */
2732
3086
  VoiceProfileDomainId?: string;
2733
3087
  /**
3088
+ * @public
2734
3089
  * <p>The ARN of a voice profile in a voice profile domain summary.</p>
2735
3090
  */
2736
3091
  VoiceProfileDomainArn?: string;
2737
3092
  /**
3093
+ * @public
2738
3094
  * <p>The name of the voice profile domain summary.</p>
2739
3095
  */
2740
3096
  Name?: string;
2741
3097
  /**
3098
+ * @public
2742
3099
  * <p>Describes the voice profile domain summary.</p>
2743
3100
  */
2744
3101
  Description?: string;
2745
3102
  /**
3103
+ * @public
2746
3104
  * <p>The time at which the voice profile domain summary was created.</p>
2747
3105
  */
2748
3106
  CreatedTimestamp?: Date;
2749
3107
  /**
3108
+ * @public
2750
3109
  * <p>The time at which the voice profile domain summary was last updated.</p>
2751
3110
  */
2752
3111
  UpdatedTimestamp?: Date;
@@ -2756,10 +3115,12 @@ export interface VoiceProfileDomainSummary {
2756
3115
  */
2757
3116
  export interface ListVoiceProfileDomainsResponse {
2758
3117
  /**
3118
+ * @public
2759
3119
  * <p>The list of voice profile domains.</p>
2760
3120
  */
2761
3121
  VoiceProfileDomains?: VoiceProfileDomainSummary[];
2762
3122
  /**
3123
+ * @public
2763
3124
  * <p>The token used to return the next page of results.</p>
2764
3125
  */
2765
3126
  NextToken?: string;
@@ -2769,14 +3130,17 @@ export interface ListVoiceProfileDomainsResponse {
2769
3130
  */
2770
3131
  export interface ListVoiceProfilesRequest {
2771
3132
  /**
3133
+ * @public
2772
3134
  * <p>The ID of the voice profile domain.</p>
2773
3135
  */
2774
3136
  VoiceProfileDomainId: string | undefined;
2775
3137
  /**
3138
+ * @public
2776
3139
  * <p>The token used to retrieve the next page of results.</p>
2777
3140
  */
2778
3141
  NextToken?: string;
2779
3142
  /**
3143
+ * @public
2780
3144
  * <p>The maximum number of results in the request.</p>
2781
3145
  */
2782
3146
  MaxResults?: number;
@@ -2787,26 +3151,32 @@ export interface ListVoiceProfilesRequest {
2787
3151
  */
2788
3152
  export interface VoiceProfileSummary {
2789
3153
  /**
3154
+ * @public
2790
3155
  * <p>The ID of the voice profile in a voice profile summary.</p>
2791
3156
  */
2792
3157
  VoiceProfileId?: string;
2793
3158
  /**
3159
+ * @public
2794
3160
  * <p>The ARN of the voice profile in a voice profile summary.</p>
2795
3161
  */
2796
3162
  VoiceProfileArn?: string;
2797
3163
  /**
3164
+ * @public
2798
3165
  * <p>The ID of the voice profile domain in a voice profile summary.</p>
2799
3166
  */
2800
3167
  VoiceProfileDomainId?: string;
2801
3168
  /**
3169
+ * @public
2802
3170
  * <p>The time at which a voice profile summary was created.</p>
2803
3171
  */
2804
3172
  CreatedTimestamp?: Date;
2805
3173
  /**
3174
+ * @public
2806
3175
  * <p>The time at which a voice profile summary was last updated.</p>
2807
3176
  */
2808
3177
  UpdatedTimestamp?: Date;
2809
3178
  /**
3179
+ * @public
2810
3180
  * <p>Extends the life of the voice profile. You can use <code>UpdateVoiceProfile</code> to refresh an existing voice profile's voice print and extend the life of the summary.</p>
2811
3181
  */
2812
3182
  ExpirationTimestamp?: Date;
@@ -2816,10 +3186,12 @@ export interface VoiceProfileSummary {
2816
3186
  */
2817
3187
  export interface ListVoiceProfilesResponse {
2818
3188
  /**
3189
+ * @public
2819
3190
  * <p>The list of voice profiles.</p>
2820
3191
  */
2821
3192
  VoiceProfiles?: VoiceProfileSummary[];
2822
3193
  /**
3194
+ * @public
2823
3195
  * <p>The token used to retrieve the next page of results.</p>
2824
3196
  */
2825
3197
  NextToken?: string;
@@ -2829,10 +3201,12 @@ export interface ListVoiceProfilesResponse {
2829
3201
  */
2830
3202
  export interface PutSipMediaApplicationAlexaSkillConfigurationRequest {
2831
3203
  /**
3204
+ * @public
2832
3205
  * <p>The SIP media application ID.</p>
2833
3206
  */
2834
3207
  SipMediaApplicationId: string | undefined;
2835
3208
  /**
3209
+ * @public
2836
3210
  * <p>The Alexa Skill configuration.</p>
2837
3211
  */
2838
3212
  SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
@@ -2842,6 +3216,7 @@ export interface PutSipMediaApplicationAlexaSkillConfigurationRequest {
2842
3216
  */
2843
3217
  export interface PutSipMediaApplicationAlexaSkillConfigurationResponse {
2844
3218
  /**
3219
+ * @public
2845
3220
  * <p>Returns the Alexa Skill configuration.</p>
2846
3221
  */
2847
3222
  SipMediaApplicationAlexaSkillConfiguration?: SipMediaApplicationAlexaSkillConfiguration;
@@ -2851,10 +3226,12 @@ export interface PutSipMediaApplicationAlexaSkillConfigurationResponse {
2851
3226
  */
2852
3227
  export interface PutSipMediaApplicationLoggingConfigurationRequest {
2853
3228
  /**
3229
+ * @public
2854
3230
  * <p>The SIP media application ID.</p>
2855
3231
  */
2856
3232
  SipMediaApplicationId: string | undefined;
2857
3233
  /**
3234
+ * @public
2858
3235
  * <p>The logging configuration for the specified SIP media application.</p>
2859
3236
  */
2860
3237
  SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
@@ -2864,6 +3241,7 @@ export interface PutSipMediaApplicationLoggingConfigurationRequest {
2864
3241
  */
2865
3242
  export interface PutSipMediaApplicationLoggingConfigurationResponse {
2866
3243
  /**
3244
+ * @public
2867
3245
  * <p>The updated logging configuration for the specified SIP media application.</p>
2868
3246
  */
2869
3247
  SipMediaApplicationLoggingConfiguration?: SipMediaApplicationLoggingConfiguration;
@@ -2873,10 +3251,12 @@ export interface PutSipMediaApplicationLoggingConfigurationResponse {
2873
3251
  */
2874
3252
  export interface PutVoiceConnectorEmergencyCallingConfigurationRequest {
2875
3253
  /**
3254
+ * @public
2876
3255
  * <p>The Voice Connector ID.</p>
2877
3256
  */
2878
3257
  VoiceConnectorId: string | undefined;
2879
3258
  /**
3259
+ * @public
2880
3260
  * <p>The configuration being updated.</p>
2881
3261
  */
2882
3262
  EmergencyCallingConfiguration: EmergencyCallingConfiguration | undefined;
@@ -2886,6 +3266,7 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationRequest {
2886
3266
  */
2887
3267
  export interface PutVoiceConnectorEmergencyCallingConfigurationResponse {
2888
3268
  /**
3269
+ * @public
2889
3270
  * <p>The updated configuration.</p>
2890
3271
  */
2891
3272
  EmergencyCallingConfiguration?: EmergencyCallingConfiguration;
@@ -2895,10 +3276,12 @@ export interface PutVoiceConnectorEmergencyCallingConfigurationResponse {
2895
3276
  */
2896
3277
  export interface PutVoiceConnectorLoggingConfigurationRequest {
2897
3278
  /**
3279
+ * @public
2898
3280
  * <p>The Voice Connector ID.</p>
2899
3281
  */
2900
3282
  VoiceConnectorId: string | undefined;
2901
3283
  /**
3284
+ * @public
2902
3285
  * <p>The logging configuration being updated.</p>
2903
3286
  */
2904
3287
  LoggingConfiguration: LoggingConfiguration | undefined;
@@ -2908,6 +3291,7 @@ export interface PutVoiceConnectorLoggingConfigurationRequest {
2908
3291
  */
2909
3292
  export interface PutVoiceConnectorLoggingConfigurationResponse {
2910
3293
  /**
3294
+ * @public
2911
3295
  * <p>The updated logging configuration.</p>
2912
3296
  */
2913
3297
  LoggingConfiguration?: LoggingConfiguration;
@@ -2917,10 +3301,12 @@ export interface PutVoiceConnectorLoggingConfigurationResponse {
2917
3301
  */
2918
3302
  export interface PutVoiceConnectorOriginationRequest {
2919
3303
  /**
3304
+ * @public
2920
3305
  * <p>The Voice Connector ID.</p>
2921
3306
  */
2922
3307
  VoiceConnectorId: string | undefined;
2923
3308
  /**
3309
+ * @public
2924
3310
  * <p>The origination settings being updated.</p>
2925
3311
  */
2926
3312
  Origination: Origination | undefined;
@@ -2930,6 +3316,7 @@ export interface PutVoiceConnectorOriginationRequest {
2930
3316
  */
2931
3317
  export interface PutVoiceConnectorOriginationResponse {
2932
3318
  /**
3319
+ * @public
2933
3320
  * <p>The updated origination settings.</p>
2934
3321
  */
2935
3322
  Origination?: Origination;
@@ -2939,22 +3326,27 @@ export interface PutVoiceConnectorOriginationResponse {
2939
3326
  */
2940
3327
  export interface PutVoiceConnectorProxyRequest {
2941
3328
  /**
3329
+ * @public
2942
3330
  * <p>The Voice Connector ID.</p>
2943
3331
  */
2944
3332
  VoiceConnectorId: string | undefined;
2945
3333
  /**
3334
+ * @public
2946
3335
  * <p>The default number of minutes allowed for proxy session.</p>
2947
3336
  */
2948
3337
  DefaultSessionExpiryMinutes: number | undefined;
2949
3338
  /**
3339
+ * @public
2950
3340
  * <p>The countries for proxy phone numbers to be selected from.</p>
2951
3341
  */
2952
3342
  PhoneNumberPoolCountries: string[] | undefined;
2953
3343
  /**
3344
+ * @public
2954
3345
  * <p>The phone number to route calls to after a proxy session expires.</p>
2955
3346
  */
2956
3347
  FallBackPhoneNumber?: string;
2957
3348
  /**
3349
+ * @public
2958
3350
  * <p>When true, stops proxy sessions from being created on the specified Amazon Chime SDK Voice Connector.</p>
2959
3351
  */
2960
3352
  Disabled?: boolean;
@@ -2964,6 +3356,7 @@ export interface PutVoiceConnectorProxyRequest {
2964
3356
  */
2965
3357
  export interface PutVoiceConnectorProxyResponse {
2966
3358
  /**
3359
+ * @public
2967
3360
  * <p>The proxy configuration details.</p>
2968
3361
  */
2969
3362
  Proxy?: Proxy;
@@ -2973,10 +3366,12 @@ export interface PutVoiceConnectorProxyResponse {
2973
3366
  */
2974
3367
  export interface PutVoiceConnectorStreamingConfigurationRequest {
2975
3368
  /**
3369
+ * @public
2976
3370
  * <p>The Voice Connector ID.</p>
2977
3371
  */
2978
3372
  VoiceConnectorId: string | undefined;
2979
3373
  /**
3374
+ * @public
2980
3375
  * <p>The streaming settings being updated.</p>
2981
3376
  */
2982
3377
  StreamingConfiguration: StreamingConfiguration | undefined;
@@ -2986,6 +3381,7 @@ export interface PutVoiceConnectorStreamingConfigurationRequest {
2986
3381
  */
2987
3382
  export interface PutVoiceConnectorStreamingConfigurationResponse {
2988
3383
  /**
3384
+ * @public
2989
3385
  * <p>The updated streaming settings.</p>
2990
3386
  */
2991
3387
  StreamingConfiguration?: StreamingConfiguration;
@@ -2995,10 +3391,12 @@ export interface PutVoiceConnectorStreamingConfigurationResponse {
2995
3391
  */
2996
3392
  export interface PutVoiceConnectorTerminationRequest {
2997
3393
  /**
3394
+ * @public
2998
3395
  * <p>The Voice Connector ID.</p>
2999
3396
  */
3000
3397
  VoiceConnectorId: string | undefined;
3001
3398
  /**
3399
+ * @public
3002
3400
  * <p>The termination settings to be updated.</p>
3003
3401
  */
3004
3402
  Termination: Termination | undefined;
@@ -3008,6 +3406,7 @@ export interface PutVoiceConnectorTerminationRequest {
3008
3406
  */
3009
3407
  export interface PutVoiceConnectorTerminationResponse {
3010
3408
  /**
3409
+ * @public
3011
3410
  * <p>The updated termination settings.</p>
3012
3411
  */
3013
3412
  Termination?: Termination;
@@ -3018,11 +3417,13 @@ export interface PutVoiceConnectorTerminationResponse {
3018
3417
  */
3019
3418
  export interface Credential {
3020
3419
  /**
3420
+ * @public
3021
3421
  * <p>The RFC2617 compliant user name associated with the SIP credentials, in
3022
3422
  * US-ASCII format.</p>
3023
3423
  */
3024
3424
  Username?: string;
3025
3425
  /**
3426
+ * @public
3026
3427
  * <p>The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.</p>
3027
3428
  */
3028
3429
  Password?: string;
@@ -3032,10 +3433,12 @@ export interface Credential {
3032
3433
  */
3033
3434
  export interface PutVoiceConnectorTerminationCredentialsRequest {
3034
3435
  /**
3436
+ * @public
3035
3437
  * <p>The Voice Connector ID.</p>
3036
3438
  */
3037
3439
  VoiceConnectorId: string | undefined;
3038
3440
  /**
3441
+ * @public
3039
3442
  * <p>The termination credentials being updated.</p>
3040
3443
  */
3041
3444
  Credentials?: Credential[];
@@ -3045,6 +3448,7 @@ export interface PutVoiceConnectorTerminationCredentialsRequest {
3045
3448
  */
3046
3449
  export interface RestorePhoneNumberRequest {
3047
3450
  /**
3451
+ * @public
3048
3452
  * <p>The ID of the phone number being restored.</p>
3049
3453
  */
3050
3454
  PhoneNumberId: string | undefined;
@@ -3054,6 +3458,7 @@ export interface RestorePhoneNumberRequest {
3054
3458
  */
3055
3459
  export interface RestorePhoneNumberResponse {
3056
3460
  /**
3461
+ * @public
3057
3462
  * <p>The restored phone number.</p>
3058
3463
  */
3059
3464
  PhoneNumber?: PhoneNumber;
@@ -3063,34 +3468,42 @@ export interface RestorePhoneNumberResponse {
3063
3468
  */
3064
3469
  export interface SearchAvailablePhoneNumbersRequest {
3065
3470
  /**
3471
+ * @public
3066
3472
  * <p>Confines a search to just the phone numbers associated with the specified area code.</p>
3067
3473
  */
3068
3474
  AreaCode?: string;
3069
3475
  /**
3476
+ * @public
3070
3477
  * <p>Confines a search to just the phone numbers associated with the specified city.</p>
3071
3478
  */
3072
3479
  City?: string;
3073
3480
  /**
3481
+ * @public
3074
3482
  * <p>Confines a search to just the phone numbers associated with the specified country.</p>
3075
3483
  */
3076
3484
  Country?: string;
3077
3485
  /**
3486
+ * @public
3078
3487
  * <p>Confines a search to just the phone numbers associated with the specified state.</p>
3079
3488
  */
3080
3489
  State?: string;
3081
3490
  /**
3491
+ * @public
3082
3492
  * <p>Confines a search to just the phone numbers associated with the specified toll-free prefix.</p>
3083
3493
  */
3084
3494
  TollFreePrefix?: string;
3085
3495
  /**
3496
+ * @public
3086
3497
  * <p>Confines a search to just the phone numbers associated with the specified phone number type, either <b>local</b> or <b>toll-free</b>.</p>
3087
3498
  */
3088
3499
  PhoneNumberType?: PhoneNumberType | string;
3089
3500
  /**
3501
+ * @public
3090
3502
  * <p>The maximum number of results to return.</p>
3091
3503
  */
3092
3504
  MaxResults?: number;
3093
3505
  /**
3506
+ * @public
3094
3507
  * <p>The token used to return the next page of results.</p>
3095
3508
  */
3096
3509
  NextToken?: string;
@@ -3100,10 +3513,12 @@ export interface SearchAvailablePhoneNumbersRequest {
3100
3513
  */
3101
3514
  export interface SearchAvailablePhoneNumbersResponse {
3102
3515
  /**
3516
+ * @public
3103
3517
  * <p>Confines a search to just the phone numbers in the E.164 format.</p>
3104
3518
  */
3105
3519
  E164PhoneNumbers?: string[];
3106
3520
  /**
3521
+ * @public
3107
3522
  * <p>The token used to return the next page of results.</p>
3108
3523
  */
3109
3524
  NextToken?: string;
@@ -3113,22 +3528,27 @@ export interface SearchAvailablePhoneNumbersResponse {
3113
3528
  */
3114
3529
  export interface StartSpeakerSearchTaskRequest {
3115
3530
  /**
3531
+ * @public
3116
3532
  * <p>The Voice Connector ID.</p>
3117
3533
  */
3118
3534
  VoiceConnectorId: string | undefined;
3119
3535
  /**
3536
+ * @public
3120
3537
  * <p>The transaction ID of the call being analyzed.</p>
3121
3538
  */
3122
3539
  TransactionId: string | undefined;
3123
3540
  /**
3541
+ * @public
3124
3542
  * <p>The ID of the voice profile domain that will store the voice profile.</p>
3125
3543
  */
3126
3544
  VoiceProfileDomainId: string | undefined;
3127
3545
  /**
3546
+ * @public
3128
3547
  * <p>The unique identifier for the client request. Use a different token for different speaker search tasks.</p>
3129
3548
  */
3130
3549
  ClientRequestToken?: string;
3131
3550
  /**
3551
+ * @public
3132
3552
  * <p>Specifies which call leg to stream for speaker search.</p>
3133
3553
  */
3134
3554
  CallLeg?: CallLegType | string;
@@ -3138,6 +3558,7 @@ export interface StartSpeakerSearchTaskRequest {
3138
3558
  */
3139
3559
  export interface StartSpeakerSearchTaskResponse {
3140
3560
  /**
3561
+ * @public
3141
3562
  * <p>The details of the speaker search task.</p>
3142
3563
  */
3143
3564
  SpeakerSearchTask?: SpeakerSearchTask;
@@ -3172,18 +3593,22 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
3172
3593
  */
3173
3594
  export interface StartVoiceToneAnalysisTaskRequest {
3174
3595
  /**
3596
+ * @public
3175
3597
  * <p>The Voice Connector ID.</p>
3176
3598
  */
3177
3599
  VoiceConnectorId: string | undefined;
3178
3600
  /**
3601
+ * @public
3179
3602
  * <p>The transaction ID.</p>
3180
3603
  */
3181
3604
  TransactionId: string | undefined;
3182
3605
  /**
3606
+ * @public
3183
3607
  * <p>The language code.</p>
3184
3608
  */
3185
3609
  LanguageCode: LanguageCode | string | undefined;
3186
3610
  /**
3611
+ * @public
3187
3612
  * <p>The unique identifier for the client request. Use a different token for different voice tone analysis
3188
3613
  * tasks.</p>
3189
3614
  */
@@ -3194,6 +3619,7 @@ export interface StartVoiceToneAnalysisTaskRequest {
3194
3619
  */
3195
3620
  export interface StartVoiceToneAnalysisTaskResponse {
3196
3621
  /**
3622
+ * @public
3197
3623
  * <p>The details of the voice tone analysis task.</p>
3198
3624
  */
3199
3625
  VoiceToneAnalysisTask?: VoiceToneAnalysisTask;
@@ -3203,10 +3629,12 @@ export interface StartVoiceToneAnalysisTaskResponse {
3203
3629
  */
3204
3630
  export interface StopSpeakerSearchTaskRequest {
3205
3631
  /**
3632
+ * @public
3206
3633
  * <p>The Voice Connector ID.</p>
3207
3634
  */
3208
3635
  VoiceConnectorId: string | undefined;
3209
3636
  /**
3637
+ * @public
3210
3638
  * <p>The speaker search task ID.</p>
3211
3639
  */
3212
3640
  SpeakerSearchTaskId: string | undefined;
@@ -3216,10 +3644,12 @@ export interface StopSpeakerSearchTaskRequest {
3216
3644
  */
3217
3645
  export interface StopVoiceToneAnalysisTaskRequest {
3218
3646
  /**
3647
+ * @public
3219
3648
  * <p>The Voice Connector ID.</p>
3220
3649
  */
3221
3650
  VoiceConnectorId: string | undefined;
3222
3651
  /**
3652
+ * @public
3223
3653
  * <p>The ID of the voice tone analysis task.</p>
3224
3654
  */
3225
3655
  VoiceToneAnalysisTaskId: string | undefined;
@@ -3229,10 +3659,12 @@ export interface StopVoiceToneAnalysisTaskRequest {
3229
3659
  */
3230
3660
  export interface TagResourceRequest {
3231
3661
  /**
3662
+ * @public
3232
3663
  * <p>The ARN of the resource being tagged. </p>
3233
3664
  */
3234
3665
  ResourceARN: string | undefined;
3235
3666
  /**
3667
+ * @public
3236
3668
  * <p>A list of the tags being added to the resource.</p>
3237
3669
  */
3238
3670
  Tags: Tag[] | undefined;
@@ -3242,10 +3674,12 @@ export interface TagResourceRequest {
3242
3674
  */
3243
3675
  export interface UntagResourceRequest {
3244
3676
  /**
3677
+ * @public
3245
3678
  * <p>The ARN of the resource having its tags removed.</p>
3246
3679
  */
3247
3680
  ResourceARN: string | undefined;
3248
3681
  /**
3682
+ * @public
3249
3683
  * <p>The keys of the tags being removed from the resource.</p>
3250
3684
  */
3251
3685
  TagKeys: string[] | undefined;
@@ -3255,6 +3689,7 @@ export interface UntagResourceRequest {
3255
3689
  */
3256
3690
  export interface UpdateGlobalSettingsRequest {
3257
3691
  /**
3692
+ * @public
3258
3693
  * <p>The Voice Connector settings.</p>
3259
3694
  */
3260
3695
  VoiceConnector?: VoiceConnectorSettings;
@@ -3264,14 +3699,17 @@ export interface UpdateGlobalSettingsRequest {
3264
3699
  */
3265
3700
  export interface UpdatePhoneNumberRequest {
3266
3701
  /**
3702
+ * @public
3267
3703
  * <p>The phone number ID.</p>
3268
3704
  */
3269
3705
  PhoneNumberId: string | undefined;
3270
3706
  /**
3707
+ * @public
3271
3708
  * <p>The product type.</p>
3272
3709
  */
3273
3710
  ProductType?: PhoneNumberProductType | string;
3274
3711
  /**
3712
+ * @public
3275
3713
  * <p>The outbound calling name associated with the phone number.</p>
3276
3714
  */
3277
3715
  CallingName?: string;
@@ -3281,6 +3719,7 @@ export interface UpdatePhoneNumberRequest {
3281
3719
  */
3282
3720
  export interface UpdatePhoneNumberResponse {
3283
3721
  /**
3722
+ * @public
3284
3723
  * <p>The updated phone number details.</p>
3285
3724
  */
3286
3725
  PhoneNumber?: PhoneNumber;
@@ -3290,6 +3729,7 @@ export interface UpdatePhoneNumberResponse {
3290
3729
  */
3291
3730
  export interface UpdatePhoneNumberSettingsRequest {
3292
3731
  /**
3732
+ * @public
3293
3733
  * <p>The default outbound calling name for the account.</p>
3294
3734
  */
3295
3735
  CallingName: string | undefined;
@@ -3299,18 +3739,22 @@ export interface UpdatePhoneNumberSettingsRequest {
3299
3739
  */
3300
3740
  export interface UpdateProxySessionRequest {
3301
3741
  /**
3742
+ * @public
3302
3743
  * <p>The Voice Connector ID.</p>
3303
3744
  */
3304
3745
  VoiceConnectorId: string | undefined;
3305
3746
  /**
3747
+ * @public
3306
3748
  * <p>The proxy session ID.</p>
3307
3749
  */
3308
3750
  ProxySessionId: string | undefined;
3309
3751
  /**
3752
+ * @public
3310
3753
  * <p>The proxy session capabilities.</p>
3311
3754
  */
3312
3755
  Capabilities: (Capability | string)[] | undefined;
3313
3756
  /**
3757
+ * @public
3314
3758
  * <p>The number of minutes allowed for the proxy session.</p>
3315
3759
  */
3316
3760
  ExpiryMinutes?: number;
@@ -3320,6 +3764,7 @@ export interface UpdateProxySessionRequest {
3320
3764
  */
3321
3765
  export interface UpdateProxySessionResponse {
3322
3766
  /**
3767
+ * @public
3323
3768
  * <p>The updated proxy session details.</p>
3324
3769
  */
3325
3770
  ProxySession?: ProxySession;
@@ -3329,14 +3774,17 @@ export interface UpdateProxySessionResponse {
3329
3774
  */
3330
3775
  export interface UpdateSipMediaApplicationRequest {
3331
3776
  /**
3777
+ * @public
3332
3778
  * <p>The SIP media application ID.</p>
3333
3779
  */
3334
3780
  SipMediaApplicationId: string | undefined;
3335
3781
  /**
3782
+ * @public
3336
3783
  * <p>The new name for the specified SIP media application.</p>
3337
3784
  */
3338
3785
  Name?: string;
3339
3786
  /**
3787
+ * @public
3340
3788
  * <p>The new set of endpoints for the specified SIP media application.</p>
3341
3789
  */
3342
3790
  Endpoints?: SipMediaApplicationEndpoint[];
@@ -3346,6 +3794,7 @@ export interface UpdateSipMediaApplicationRequest {
3346
3794
  */
3347
3795
  export interface UpdateSipMediaApplicationResponse {
3348
3796
  /**
3797
+ * @public
3349
3798
  * <p>The updated SIP media application’s details.</p>
3350
3799
  */
3351
3800
  SipMediaApplication?: SipMediaApplication;
@@ -3355,14 +3804,17 @@ export interface UpdateSipMediaApplicationResponse {
3355
3804
  */
3356
3805
  export interface UpdateSipMediaApplicationCallRequest {
3357
3806
  /**
3807
+ * @public
3358
3808
  * <p>The ID of the SIP media application handling the call.</p>
3359
3809
  */
3360
3810
  SipMediaApplicationId: string | undefined;
3361
3811
  /**
3812
+ * @public
3362
3813
  * <p>The ID of the call transaction.</p>
3363
3814
  */
3364
3815
  TransactionId: string | undefined;
3365
3816
  /**
3817
+ * @public
3366
3818
  * <p>Arguments made available to the Lambda function as part of the
3367
3819
  * <code>CALL_UPDATE_REQUESTED</code> event. Can contain 0-20 key-value pairs.</p>
3368
3820
  */
@@ -3373,6 +3825,7 @@ export interface UpdateSipMediaApplicationCallRequest {
3373
3825
  */
3374
3826
  export interface UpdateSipMediaApplicationCallResponse {
3375
3827
  /**
3828
+ * @public
3376
3829
  * <p>A <code>Call</code> instance for a SIP media application.</p>
3377
3830
  */
3378
3831
  SipMediaApplicationCall?: SipMediaApplicationCall;
@@ -3382,18 +3835,22 @@ export interface UpdateSipMediaApplicationCallResponse {
3382
3835
  */
3383
3836
  export interface UpdateSipRuleRequest {
3384
3837
  /**
3838
+ * @public
3385
3839
  * <p>The SIP rule ID.</p>
3386
3840
  */
3387
3841
  SipRuleId: string | undefined;
3388
3842
  /**
3843
+ * @public
3389
3844
  * <p>The new name for the specified SIP rule.</p>
3390
3845
  */
3391
3846
  Name: string | undefined;
3392
3847
  /**
3848
+ * @public
3393
3849
  * <p>The new value that indicates whether the rule is disabled.</p>
3394
3850
  */
3395
3851
  Disabled?: boolean;
3396
3852
  /**
3853
+ * @public
3397
3854
  * <p>The new list of target applications.</p>
3398
3855
  */
3399
3856
  TargetApplications?: SipRuleTargetApplication[];
@@ -3403,6 +3860,7 @@ export interface UpdateSipRuleRequest {
3403
3860
  */
3404
3861
  export interface UpdateSipRuleResponse {
3405
3862
  /**
3863
+ * @public
3406
3864
  * <p>The updated SIP rule details.</p>
3407
3865
  */
3408
3866
  SipRule?: SipRule;
@@ -3412,14 +3870,17 @@ export interface UpdateSipRuleResponse {
3412
3870
  */
3413
3871
  export interface UpdateVoiceConnectorRequest {
3414
3872
  /**
3873
+ * @public
3415
3874
  * <p>The Voice Connector ID.</p>
3416
3875
  */
3417
3876
  VoiceConnectorId: string | undefined;
3418
3877
  /**
3878
+ * @public
3419
3879
  * <p>The name of the Voice Connector.</p>
3420
3880
  */
3421
3881
  Name: string | undefined;
3422
3882
  /**
3883
+ * @public
3423
3884
  * <p>When enabled, requires encryption for the Voice Connector.</p>
3424
3885
  */
3425
3886
  RequireEncryption: boolean | undefined;
@@ -3429,6 +3890,7 @@ export interface UpdateVoiceConnectorRequest {
3429
3890
  */
3430
3891
  export interface UpdateVoiceConnectorResponse {
3431
3892
  /**
3893
+ * @public
3432
3894
  * <p>The updated Voice Connector details.</p>
3433
3895
  */
3434
3896
  VoiceConnector?: VoiceConnector;
@@ -3438,14 +3900,17 @@ export interface UpdateVoiceConnectorResponse {
3438
3900
  */
3439
3901
  export interface UpdateVoiceConnectorGroupRequest {
3440
3902
  /**
3903
+ * @public
3441
3904
  * <p>The Voice Connector ID.</p>
3442
3905
  */
3443
3906
  VoiceConnectorGroupId: string | undefined;
3444
3907
  /**
3908
+ * @public
3445
3909
  * <p>The name of the Voice Connector group.</p>
3446
3910
  */
3447
3911
  Name: string | undefined;
3448
3912
  /**
3913
+ * @public
3449
3914
  * <p>The <code>VoiceConnectorItems</code> to associate with the Voice Connector
3450
3915
  * group.</p>
3451
3916
  */
@@ -3456,6 +3921,7 @@ export interface UpdateVoiceConnectorGroupRequest {
3456
3921
  */
3457
3922
  export interface UpdateVoiceConnectorGroupResponse {
3458
3923
  /**
3924
+ * @public
3459
3925
  * <p>The updated Voice Connector group.</p>
3460
3926
  */
3461
3927
  VoiceConnectorGroup?: VoiceConnectorGroup;
@@ -3465,10 +3931,12 @@ export interface UpdateVoiceConnectorGroupResponse {
3465
3931
  */
3466
3932
  export interface UpdateVoiceProfileRequest {
3467
3933
  /**
3934
+ * @public
3468
3935
  * <p>The profile ID.</p>
3469
3936
  */
3470
3937
  VoiceProfileId: string | undefined;
3471
3938
  /**
3939
+ * @public
3472
3940
  * <p>The ID of the speaker search task.</p>
3473
3941
  */
3474
3942
  SpeakerSearchTaskId: string | undefined;
@@ -3478,6 +3946,7 @@ export interface UpdateVoiceProfileRequest {
3478
3946
  */
3479
3947
  export interface UpdateVoiceProfileResponse {
3480
3948
  /**
3949
+ * @public
3481
3950
  * <p>The updated voice profile settings.</p>
3482
3951
  */
3483
3952
  VoiceProfile?: VoiceProfile;
@@ -3487,14 +3956,17 @@ export interface UpdateVoiceProfileResponse {
3487
3956
  */
3488
3957
  export interface UpdateVoiceProfileDomainRequest {
3489
3958
  /**
3959
+ * @public
3490
3960
  * <p>The domain ID.</p>
3491
3961
  */
3492
3962
  VoiceProfileDomainId: string | undefined;
3493
3963
  /**
3964
+ * @public
3494
3965
  * <p>The name of the voice profile domain.</p>
3495
3966
  */
3496
3967
  Name?: string;
3497
3968
  /**
3969
+ * @public
3498
3970
  * <p>The description of the voice profile domain.</p>
3499
3971
  */
3500
3972
  Description?: string;
@@ -3504,6 +3976,7 @@ export interface UpdateVoiceProfileDomainRequest {
3504
3976
  */
3505
3977
  export interface UpdateVoiceProfileDomainResponse {
3506
3978
  /**
3979
+ * @public
3507
3980
  * <p>The updated details of the voice profile domain.</p>
3508
3981
  */
3509
3982
  VoiceProfileDomain?: VoiceProfileDomain;
@@ -3513,30 +3986,37 @@ export interface UpdateVoiceProfileDomainResponse {
3513
3986
  */
3514
3987
  export interface ValidateE911AddressRequest {
3515
3988
  /**
3989
+ * @public
3516
3990
  * <p>The AWS account ID.</p>
3517
3991
  */
3518
3992
  AwsAccountId: string | undefined;
3519
3993
  /**
3994
+ * @public
3520
3995
  * <p>The address street number, such as <code>200</code> or <code>2121</code>.</p>
3521
3996
  */
3522
3997
  StreetNumber: string | undefined;
3523
3998
  /**
3999
+ * @public
3524
4000
  * <p>The address street information, such as <code>8th Avenue</code>.</p>
3525
4001
  */
3526
4002
  StreetInfo: string | undefined;
3527
4003
  /**
4004
+ * @public
3528
4005
  * <p>The address city, such as <code>Portland</code>.</p>
3529
4006
  */
3530
4007
  City: string | undefined;
3531
4008
  /**
4009
+ * @public
3532
4010
  * <p>The address state, such as <code>ME</code>.</p>
3533
4011
  */
3534
4012
  State: string | undefined;
3535
4013
  /**
4014
+ * @public
3536
4015
  * <p>The country in the address being validated.</p>
3537
4016
  */
3538
4017
  Country: string | undefined;
3539
4018
  /**
4019
+ * @public
3540
4020
  * <p>The dress postal code, such <code>04352</code>.</p>
3541
4021
  */
3542
4022
  PostalCode: string | undefined;
@@ -3546,6 +4026,7 @@ export interface ValidateE911AddressRequest {
3546
4026
  */
3547
4027
  export interface ValidateE911AddressResponse {
3548
4028
  /**
4029
+ * @public
3549
4030
  * <p>Number indicating the result of address validation. <code>0</code> means the
3550
4031
  * address was perfect as-is and successfully validated. <code>1</code> means the
3551
4032
  * address was corrected. <code>2</code> means the address sent was not close
@@ -3553,14 +4034,17 @@ export interface ValidateE911AddressResponse {
3553
4034
  */
3554
4035
  ValidationResult?: number;
3555
4036
  /**
4037
+ * @public
3556
4038
  * <p>The ID that represents the address.</p>
3557
4039
  */
3558
4040
  AddressExternalId?: string;
3559
4041
  /**
4042
+ * @public
3560
4043
  * <p>The validated address.</p>
3561
4044
  */
3562
4045
  Address?: Address;
3563
4046
  /**
4047
+ * @public
3564
4048
  * <p>The list of address suggestions..</p>
3565
4049
  */
3566
4050
  CandidateAddressList?: CandidateAddress[];