@aws-sdk/client-directory-service 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +508 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -5,6 +5,7 @@ import { DirectoryServiceServiceException as __BaseException } from "./Directory
5
5
  */
6
6
  export interface AcceptSharedDirectoryRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>Identifier of the shared directory in the directory consumer account. This identifier is
9
10
  * different for each directory owner account. </p>
10
11
  */
@@ -48,45 +49,54 @@ export type ShareStatus = (typeof ShareStatus)[keyof typeof ShareStatus];
48
49
  */
49
50
  export interface SharedDirectory {
50
51
  /**
52
+ * @public
51
53
  * <p>Identifier of the directory owner account, which contains the directory that has been
52
54
  * shared to the consumer account.</p>
53
55
  */
54
56
  OwnerAccountId?: string;
55
57
  /**
58
+ * @public
56
59
  * <p>Identifier of the directory in the directory owner account. </p>
57
60
  */
58
61
  OwnerDirectoryId?: string;
59
62
  /**
63
+ * @public
60
64
  * <p>The method used when sharing a directory to determine whether the directory should be
61
65
  * shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by
62
66
  * sending a shared directory request (<code>HANDSHAKE</code>).</p>
63
67
  */
64
68
  ShareMethod?: ShareMethod | string;
65
69
  /**
70
+ * @public
66
71
  * <p>Identifier of the directory consumer account that has access to the shared directory
67
72
  * (<code>OwnerDirectoryId</code>) in the directory owner account.</p>
68
73
  */
69
74
  SharedAccountId?: string;
70
75
  /**
76
+ * @public
71
77
  * <p>Identifier of the shared directory in the directory consumer account. This identifier is
72
78
  * different for each directory owner account.</p>
73
79
  */
74
80
  SharedDirectoryId?: string;
75
81
  /**
82
+ * @public
76
83
  * <p>Current directory status of the shared Managed Microsoft AD directory.</p>
77
84
  */
78
85
  ShareStatus?: ShareStatus | string;
79
86
  /**
87
+ * @public
80
88
  * <p>A directory share request that is sent by the directory owner to the directory consumer.
81
89
  * The request includes a typed message to help the directory consumer administrator determine
82
90
  * whether to approve or reject the share invitation.</p>
83
91
  */
84
92
  ShareNotes?: string;
85
93
  /**
94
+ * @public
86
95
  * <p>The date and time that the shared directory was created.</p>
87
96
  */
88
97
  CreatedDateTime?: Date;
89
98
  /**
99
+ * @public
90
100
  * <p>The date and time that the shared directory was last updated.</p>
91
101
  */
92
102
  LastUpdatedDateTime?: Date;
@@ -96,6 +106,7 @@ export interface SharedDirectory {
96
106
  */
97
107
  export interface AcceptSharedDirectoryResult {
98
108
  /**
109
+ * @public
99
110
  * <p>The shared directory in the directory consumer account.</p>
100
111
  */
101
112
  SharedDirectory?: SharedDirectory;
@@ -108,10 +119,12 @@ export declare class ClientException extends __BaseException {
108
119
  readonly name: "ClientException";
109
120
  readonly $fault: "client";
110
121
  /**
122
+ * @public
111
123
  * <p>The descriptive message for the exception.</p>
112
124
  */
113
125
  Message?: string;
114
126
  /**
127
+ * @public
115
128
  * <p>The Amazon Web Services request identifier.</p>
116
129
  */
117
130
  RequestId?: string;
@@ -128,10 +141,12 @@ export declare class DirectoryAlreadySharedException extends __BaseException {
128
141
  readonly name: "DirectoryAlreadySharedException";
129
142
  readonly $fault: "client";
130
143
  /**
144
+ * @public
131
145
  * <p>The descriptive message for the exception.</p>
132
146
  */
133
147
  Message?: string;
134
148
  /**
149
+ * @public
135
150
  * <p>The Amazon Web Services request identifier.</p>
136
151
  */
137
152
  RequestId?: string;
@@ -148,10 +163,12 @@ export declare class EntityDoesNotExistException extends __BaseException {
148
163
  readonly name: "EntityDoesNotExistException";
149
164
  readonly $fault: "client";
150
165
  /**
166
+ * @public
151
167
  * <p>The descriptive message for the exception.</p>
152
168
  */
153
169
  Message?: string;
154
170
  /**
171
+ * @public
155
172
  * <p>The Amazon Web Services request identifier.</p>
156
173
  */
157
174
  RequestId?: string;
@@ -168,10 +185,12 @@ export declare class InvalidParameterException extends __BaseException {
168
185
  readonly name: "InvalidParameterException";
169
186
  readonly $fault: "client";
170
187
  /**
188
+ * @public
171
189
  * <p>The descriptive message for the exception.</p>
172
190
  */
173
191
  Message?: string;
174
192
  /**
193
+ * @public
175
194
  * <p>The Amazon Web Services request identifier.</p>
176
195
  */
177
196
  RequestId?: string;
@@ -188,10 +207,12 @@ export declare class ServiceException extends __BaseException {
188
207
  readonly name: "ServiceException";
189
208
  readonly $fault: "server";
190
209
  /**
210
+ * @public
191
211
  * <p>The descriptive message for the exception.</p>
192
212
  */
193
213
  Message?: string;
194
214
  /**
215
+ * @public
195
216
  * <p>The Amazon Web Services request identifier.</p>
196
217
  */
197
218
  RequestId?: string;
@@ -208,10 +229,12 @@ export declare class AccessDeniedException extends __BaseException {
208
229
  readonly name: "AccessDeniedException";
209
230
  readonly $fault: "client";
210
231
  /**
232
+ * @public
211
233
  * <p>The descriptive message for the exception.</p>
212
234
  */
213
235
  Message?: string;
214
236
  /**
237
+ * @public
215
238
  * <p>The Amazon Web Services request identifier.</p>
216
239
  */
217
240
  RequestId?: string;
@@ -227,12 +250,14 @@ export declare class AccessDeniedException extends __BaseException {
227
250
  */
228
251
  export interface IpRoute {
229
252
  /**
253
+ * @public
230
254
  * <p>IP address block using CIDR format, for example 10.0.0.0/24. This is often the
231
255
  * address block of the DNS server used for your self-managed domain. For a single IP address
232
256
  * use a CIDR address block with /32. For example 10.0.0.0/32.</p>
233
257
  */
234
258
  CidrIp?: string;
235
259
  /**
260
+ * @public
236
261
  * <p>Description of the address block.</p>
237
262
  */
238
263
  Description?: string;
@@ -242,15 +267,18 @@ export interface IpRoute {
242
267
  */
243
268
  export interface AddIpRoutesRequest {
244
269
  /**
270
+ * @public
245
271
  * <p>Identifier (ID) of the directory to which to add the address block.</p>
246
272
  */
247
273
  DirectoryId: string | undefined;
248
274
  /**
275
+ * @public
249
276
  * <p>IP address blocks, using CIDR format, of the traffic to route. This is often the IP
250
277
  * address block of the DNS server used for your self-managed domain.</p>
251
278
  */
252
279
  IpRoutes: IpRoute[] | undefined;
253
280
  /**
281
+ * @public
254
282
  * <p>If set to true, updates the inbound and outbound rules of the security group that has
255
283
  * the description: "Amazon Web Services created security group for <i>directory ID</i>
256
284
  * directory controllers." Following are the new rules: </p>
@@ -335,10 +363,12 @@ export declare class DirectoryUnavailableException extends __BaseException {
335
363
  readonly name: "DirectoryUnavailableException";
336
364
  readonly $fault: "client";
337
365
  /**
366
+ * @public
338
367
  * <p>The descriptive message for the exception.</p>
339
368
  */
340
369
  Message?: string;
341
370
  /**
371
+ * @public
342
372
  * <p>The Amazon Web Services request identifier.</p>
343
373
  */
344
374
  RequestId?: string;
@@ -355,10 +385,12 @@ export declare class EntityAlreadyExistsException extends __BaseException {
355
385
  readonly name: "EntityAlreadyExistsException";
356
386
  readonly $fault: "client";
357
387
  /**
388
+ * @public
358
389
  * <p>The descriptive message for the exception.</p>
359
390
  */
360
391
  Message?: string;
361
392
  /**
393
+ * @public
362
394
  * <p>The Amazon Web Services request identifier.</p>
363
395
  */
364
396
  RequestId?: string;
@@ -376,10 +408,12 @@ export declare class IpRouteLimitExceededException extends __BaseException {
376
408
  readonly name: "IpRouteLimitExceededException";
377
409
  readonly $fault: "client";
378
410
  /**
411
+ * @public
379
412
  * <p>The descriptive message for the exception.</p>
380
413
  */
381
414
  Message?: string;
382
415
  /**
416
+ * @public
383
417
  * <p>The Amazon Web Services request identifier.</p>
384
418
  */
385
419
  RequestId?: string;
@@ -394,10 +428,12 @@ export declare class IpRouteLimitExceededException extends __BaseException {
394
428
  */
395
429
  export interface DirectoryVpcSettings {
396
430
  /**
431
+ * @public
397
432
  * <p>The identifier of the VPC in which to create the directory.</p>
398
433
  */
399
434
  VpcId: string | undefined;
400
435
  /**
436
+ * @public
401
437
  * <p>The identifiers of the subnets for the directory servers. The two subnets must be in
402
438
  * different Availability Zones. Directory Service creates a directory server and a DNS
403
439
  * server in each of these subnets.</p>
@@ -409,15 +445,18 @@ export interface DirectoryVpcSettings {
409
445
  */
410
446
  export interface AddRegionRequest {
411
447
  /**
448
+ * @public
412
449
  * <p>The identifier of the directory to which you want to add Region replication.</p>
413
450
  */
414
451
  DirectoryId: string | undefined;
415
452
  /**
453
+ * @public
416
454
  * <p>The name of the Region where you want to add domain controllers for replication. For
417
455
  * example, <code>us-east-1</code>.</p>
418
456
  */
419
457
  RegionName: string | undefined;
420
458
  /**
459
+ * @public
421
460
  * <p>Contains VPC information for the <a>CreateDirectory</a> or <a>CreateMicrosoftAD</a> operation.</p>
422
461
  */
423
462
  VPCSettings: DirectoryVpcSettings | undefined;
@@ -436,10 +475,12 @@ export declare class DirectoryAlreadyInRegionException extends __BaseException {
436
475
  readonly name: "DirectoryAlreadyInRegionException";
437
476
  readonly $fault: "client";
438
477
  /**
478
+ * @public
439
479
  * <p>The descriptive message for the exception.</p>
440
480
  */
441
481
  Message?: string;
442
482
  /**
483
+ * @public
443
484
  * <p>The Amazon Web Services request identifier.</p>
444
485
  */
445
486
  RequestId?: string;
@@ -456,10 +497,12 @@ export declare class DirectoryDoesNotExistException extends __BaseException {
456
497
  readonly name: "DirectoryDoesNotExistException";
457
498
  readonly $fault: "client";
458
499
  /**
500
+ * @public
459
501
  * <p>The descriptive message for the exception.</p>
460
502
  */
461
503
  Message?: string;
462
504
  /**
505
+ * @public
463
506
  * <p>The Amazon Web Services request identifier.</p>
464
507
  */
465
508
  RequestId?: string;
@@ -477,10 +520,12 @@ export declare class RegionLimitExceededException extends __BaseException {
477
520
  readonly name: "RegionLimitExceededException";
478
521
  readonly $fault: "client";
479
522
  /**
523
+ * @public
480
524
  * <p>The descriptive message for the exception.</p>
481
525
  */
482
526
  Message?: string;
483
527
  /**
528
+ * @public
484
529
  * <p>The Amazon Web Services request identifier.</p>
485
530
  */
486
531
  RequestId?: string;
@@ -497,10 +542,12 @@ export declare class UnsupportedOperationException extends __BaseException {
497
542
  readonly name: "UnsupportedOperationException";
498
543
  readonly $fault: "client";
499
544
  /**
545
+ * @public
500
546
  * <p>The descriptive message for the exception.</p>
501
547
  */
502
548
  Message?: string;
503
549
  /**
550
+ * @public
504
551
  * <p>The Amazon Web Services request identifier.</p>
505
552
  */
506
553
  RequestId?: string;
@@ -515,6 +562,7 @@ export declare class UnsupportedOperationException extends __BaseException {
515
562
  */
516
563
  export interface Tag {
517
564
  /**
565
+ * @public
518
566
  * <p>Required name of the tag. The string value can be Unicode characters and cannot be
519
567
  * prefixed with "aws:". The string can contain only the set of Unicode letters, digits,
520
568
  * white-space, '_', '.', '/', '=', '+', '-' (Java regex:
@@ -522,6 +570,7 @@ export interface Tag {
522
570
  */
523
571
  Key: string | undefined;
524
572
  /**
573
+ * @public
525
574
  * <p>The optional value of the tag. The string value can be Unicode characters. The string
526
575
  * can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-'
527
576
  * (Java regex: "^([\\p\{L\}\\p\{Z\}\\p\{N\}_.:/=+\\-]*)$").</p>
@@ -533,10 +582,12 @@ export interface Tag {
533
582
  */
534
583
  export interface AddTagsToResourceRequest {
535
584
  /**
585
+ * @public
536
586
  * <p>Identifier (ID) for the directory to which to add the tag.</p>
537
587
  */
538
588
  ResourceId: string | undefined;
539
589
  /**
590
+ * @public
540
591
  * <p>The tags to be assigned to the directory.</p>
541
592
  */
542
593
  Tags: Tag[] | undefined;
@@ -554,10 +605,12 @@ export declare class TagLimitExceededException extends __BaseException {
554
605
  readonly name: "TagLimitExceededException";
555
606
  readonly $fault: "client";
556
607
  /**
608
+ * @public
557
609
  * <p>The descriptive message for the exception.</p>
558
610
  */
559
611
  Message?: string;
560
612
  /**
613
+ * @public
561
614
  * <p>The Amazon Web Services request identifier.</p>
562
615
  */
563
616
  RequestId?: string;
@@ -572,10 +625,12 @@ export declare class TagLimitExceededException extends __BaseException {
572
625
  */
573
626
  export interface Attribute {
574
627
  /**
628
+ * @public
575
629
  * <p>The name of the attribute.</p>
576
630
  */
577
631
  Name?: string;
578
632
  /**
633
+ * @public
579
634
  * <p>The value of the attribute.</p>
580
635
  */
581
636
  Value?: string;
@@ -588,10 +643,12 @@ export declare class AuthenticationFailedException extends __BaseException {
588
643
  readonly name: "AuthenticationFailedException";
589
644
  readonly $fault: "client";
590
645
  /**
646
+ * @public
591
647
  * <p>The textual message for the exception.</p>
592
648
  */
593
649
  Message?: string;
594
650
  /**
651
+ * @public
595
652
  * <p>The identifier of the request that caused the exception.</p>
596
653
  */
597
654
  RequestId?: string;
@@ -605,10 +662,12 @@ export declare class AuthenticationFailedException extends __BaseException {
605
662
  */
606
663
  export interface CancelSchemaExtensionRequest {
607
664
  /**
665
+ * @public
608
666
  * <p>The identifier of the directory whose schema extension will be canceled.</p>
609
667
  */
610
668
  DirectoryId: string | undefined;
611
669
  /**
670
+ * @public
612
671
  * <p>The identifier of the schema extension that will be canceled.</p>
613
672
  */
614
673
  SchemaExtensionId: string | undefined;
@@ -624,6 +683,7 @@ export interface CancelSchemaExtensionResult {
624
683
  */
625
684
  export interface ClientCertAuthSettings {
626
685
  /**
686
+ * @public
627
687
  * <p>Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.</p>
628
688
  */
629
689
  OCSPUrl?: string;
@@ -662,34 +722,42 @@ export type CertificateType = (typeof CertificateType)[keyof typeof CertificateT
662
722
  */
663
723
  export interface Certificate {
664
724
  /**
725
+ * @public
665
726
  * <p>The identifier of the certificate.</p>
666
727
  */
667
728
  CertificateId?: string;
668
729
  /**
730
+ * @public
669
731
  * <p>The state of the certificate.</p>
670
732
  */
671
733
  State?: CertificateState | string;
672
734
  /**
735
+ * @public
673
736
  * <p>Describes a state change for the certificate.</p>
674
737
  */
675
738
  StateReason?: string;
676
739
  /**
740
+ * @public
677
741
  * <p>The common name for the certificate.</p>
678
742
  */
679
743
  CommonName?: string;
680
744
  /**
745
+ * @public
681
746
  * <p>The date and time that the certificate was registered.</p>
682
747
  */
683
748
  RegisteredDateTime?: Date;
684
749
  /**
750
+ * @public
685
751
  * <p>The date and time when the certificate will expire.</p>
686
752
  */
687
753
  ExpiryDateTime?: Date;
688
754
  /**
755
+ * @public
689
756
  * <p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>
690
757
  */
691
758
  Type?: CertificateType | string;
692
759
  /**
760
+ * @public
693
761
  * <p>A <code>ClientCertAuthSettings</code> object that contains client certificate authentication settings.</p>
694
762
  */
695
763
  ClientCertAuthSettings?: ClientCertAuthSettings;
@@ -702,10 +770,12 @@ export declare class CertificateAlreadyExistsException extends __BaseException {
702
770
  readonly name: "CertificateAlreadyExistsException";
703
771
  readonly $fault: "client";
704
772
  /**
773
+ * @public
705
774
  * <p>The descriptive message for the exception.</p>
706
775
  */
707
776
  Message?: string;
708
777
  /**
778
+ * @public
709
779
  * <p>The Amazon Web Services request identifier.</p>
710
780
  */
711
781
  RequestId?: string;
@@ -722,10 +792,12 @@ export declare class CertificateDoesNotExistException extends __BaseException {
722
792
  readonly name: "CertificateDoesNotExistException";
723
793
  readonly $fault: "client";
724
794
  /**
795
+ * @public
725
796
  * <p>The descriptive message for the exception.</p>
726
797
  */
727
798
  Message?: string;
728
799
  /**
800
+ * @public
729
801
  * <p>The Amazon Web Services request identifier.</p>
730
802
  */
731
803
  RequestId?: string;
@@ -740,22 +812,27 @@ export declare class CertificateDoesNotExistException extends __BaseException {
740
812
  */
741
813
  export interface CertificateInfo {
742
814
  /**
815
+ * @public
743
816
  * <p>The identifier of the certificate.</p>
744
817
  */
745
818
  CertificateId?: string;
746
819
  /**
820
+ * @public
747
821
  * <p>The common name for the certificate.</p>
748
822
  */
749
823
  CommonName?: string;
750
824
  /**
825
+ * @public
751
826
  * <p>The state of the certificate.</p>
752
827
  */
753
828
  State?: CertificateState | string;
754
829
  /**
830
+ * @public
755
831
  * <p>The date and time when the certificate will expire.</p>
756
832
  */
757
833
  ExpiryDateTime?: Date;
758
834
  /**
835
+ * @public
759
836
  * <p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>
760
837
  */
761
838
  Type?: CertificateType | string;
@@ -769,10 +846,12 @@ export declare class CertificateInUseException extends __BaseException {
769
846
  readonly name: "CertificateInUseException";
770
847
  readonly $fault: "client";
771
848
  /**
849
+ * @public
772
850
  * <p>The descriptive message for the exception.</p>
773
851
  */
774
852
  Message?: string;
775
853
  /**
854
+ * @public
776
855
  * <p>The Amazon Web Services request identifier.</p>
777
856
  */
778
857
  RequestId?: string;
@@ -789,10 +868,12 @@ export declare class CertificateLimitExceededException extends __BaseException {
789
868
  readonly name: "CertificateLimitExceededException";
790
869
  readonly $fault: "client";
791
870
  /**
871
+ * @public
792
872
  * <p>The descriptive message for the exception.</p>
793
873
  */
794
874
  Message?: string;
795
875
  /**
876
+ * @public
796
877
  * <p>The Amazon Web Services request identifier.</p>
797
878
  */
798
879
  RequestId?: string;
@@ -831,14 +912,17 @@ export type ClientAuthenticationType = (typeof ClientAuthenticationType)[keyof t
831
912
  */
832
913
  export interface ClientAuthenticationSettingInfo {
833
914
  /**
915
+ * @public
834
916
  * <p>The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved. </p>
835
917
  */
836
918
  Type?: ClientAuthenticationType | string;
837
919
  /**
920
+ * @public
838
921
  * <p>Whether the client authentication type is enabled or disabled for the specified directory.</p>
839
922
  */
840
923
  Status?: ClientAuthenticationStatus | string;
841
924
  /**
925
+ * @public
842
926
  * <p>The date and time when the status of the client authentication type was last updated.</p>
843
927
  */
844
928
  LastUpdatedDateTime?: Date;
@@ -849,14 +933,17 @@ export interface ClientAuthenticationSettingInfo {
849
933
  */
850
934
  export interface Computer {
851
935
  /**
936
+ * @public
852
937
  * <p>The identifier of the computer.</p>
853
938
  */
854
939
  ComputerId?: string;
855
940
  /**
941
+ * @public
856
942
  * <p>The computer name.</p>
857
943
  */
858
944
  ComputerName?: string;
859
945
  /**
946
+ * @public
860
947
  * <p>An array of <a>Attribute</a> objects containing the LDAP attributes that belong to the
861
948
  * computer account.</p>
862
949
  */
@@ -881,16 +968,19 @@ export type ReplicationScope = (typeof ReplicationScope)[keyof typeof Replicatio
881
968
  */
882
969
  export interface ConditionalForwarder {
883
970
  /**
971
+ * @public
884
972
  * <p>The fully qualified domain name (FQDN) of the remote domains pointed to by the
885
973
  * conditional forwarder.</p>
886
974
  */
887
975
  RemoteDomainName?: string;
888
976
  /**
977
+ * @public
889
978
  * <p>The IP addresses of the remote DNS server associated with RemoteDomainName. This is the
890
979
  * IP address of the DNS server that your conditional forwarder points to.</p>
891
980
  */
892
981
  DnsIpAddrs?: string[];
893
982
  /**
983
+ * @public
894
984
  * <p>The replication scope of the conditional forwarder. The only allowed value is
895
985
  * <code>Domain</code>, which will replicate the conditional forwarder to all of the domain
896
986
  * controllers for your Amazon Web Services directory.</p>
@@ -904,19 +994,23 @@ export interface ConditionalForwarder {
904
994
  */
905
995
  export interface DirectoryConnectSettings {
906
996
  /**
997
+ * @public
907
998
  * <p>The identifier of the VPC in which the AD Connector is created.</p>
908
999
  */
909
1000
  VpcId: string | undefined;
910
1001
  /**
1002
+ * @public
911
1003
  * <p>A list of subnet identifiers in the VPC in which the AD Connector is created.</p>
912
1004
  */
913
1005
  SubnetIds: string[] | undefined;
914
1006
  /**
1007
+ * @public
915
1008
  * <p>A list of one or more IP addresses of DNS servers or domain controllers in your self-managed
916
1009
  * directory.</p>
917
1010
  */
918
1011
  CustomerDnsIps: string[] | undefined;
919
1012
  /**
1013
+ * @public
920
1014
  * <p>The user name of an account in your self-managed directory that is used to connect to the
921
1015
  * directory. This account must have the following permissions:</p>
922
1016
  * <ul>
@@ -951,32 +1045,39 @@ export type DirectorySize = (typeof DirectorySize)[keyof typeof DirectorySize];
951
1045
  */
952
1046
  export interface ConnectDirectoryRequest {
953
1047
  /**
1048
+ * @public
954
1049
  * <p>The fully qualified name of your self-managed directory, such as
955
1050
  * <code>corp.example.com</code>.</p>
956
1051
  */
957
1052
  Name: string | undefined;
958
1053
  /**
1054
+ * @public
959
1055
  * <p>The NetBIOS name of your self-managed directory, such as <code>CORP</code>.</p>
960
1056
  */
961
1057
  ShortName?: string;
962
1058
  /**
1059
+ * @public
963
1060
  * <p>The password for your self-managed user account.</p>
964
1061
  */
965
1062
  Password: string | undefined;
966
1063
  /**
1064
+ * @public
967
1065
  * <p>A description for the directory.</p>
968
1066
  */
969
1067
  Description?: string;
970
1068
  /**
1069
+ * @public
971
1070
  * <p>The size of the directory.</p>
972
1071
  */
973
1072
  Size: DirectorySize | string | undefined;
974
1073
  /**
1074
+ * @public
975
1075
  * <p>A <a>DirectoryConnectSettings</a> object that contains additional information
976
1076
  * for the operation.</p>
977
1077
  */
978
1078
  ConnectSettings: DirectoryConnectSettings | undefined;
979
1079
  /**
1080
+ * @public
980
1081
  * <p>The tags to be assigned to AD Connector.</p>
981
1082
  */
982
1083
  Tags?: Tag[];
@@ -987,6 +1088,7 @@ export interface ConnectDirectoryRequest {
987
1088
  */
988
1089
  export interface ConnectDirectoryResult {
989
1090
  /**
1091
+ * @public
990
1092
  * <p>The identifier of the new directory.</p>
991
1093
  */
992
1094
  DirectoryId?: string;
@@ -1001,10 +1103,12 @@ export declare class DirectoryLimitExceededException extends __BaseException {
1001
1103
  readonly name: "DirectoryLimitExceededException";
1002
1104
  readonly $fault: "client";
1003
1105
  /**
1106
+ * @public
1004
1107
  * <p>The descriptive message for the exception.</p>
1005
1108
  */
1006
1109
  Message?: string;
1007
1110
  /**
1111
+ * @public
1008
1112
  * <p>The Amazon Web Services request identifier.</p>
1009
1113
  */
1010
1114
  RequestId?: string;
@@ -1019,10 +1123,12 @@ export declare class DirectoryLimitExceededException extends __BaseException {
1019
1123
  */
1020
1124
  export interface CreateAliasRequest {
1021
1125
  /**
1126
+ * @public
1022
1127
  * <p>The identifier of the directory for which to create the alias.</p>
1023
1128
  */
1024
1129
  DirectoryId: string | undefined;
1025
1130
  /**
1131
+ * @public
1026
1132
  * <p>The requested alias.</p>
1027
1133
  * <p>The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an
1028
1134
  * <code>EntityAlreadyExistsException</code> error if the alias already exists.</p>
@@ -1035,10 +1141,12 @@ export interface CreateAliasRequest {
1035
1141
  */
1036
1142
  export interface CreateAliasResult {
1037
1143
  /**
1144
+ * @public
1038
1145
  * <p>The identifier of the directory.</p>
1039
1146
  */
1040
1147
  DirectoryId?: string;
1041
1148
  /**
1149
+ * @public
1042
1150
  * <p>The alias for the directory.</p>
1043
1151
  */
1044
1152
  Alias?: string;
@@ -1049,22 +1157,27 @@ export interface CreateAliasResult {
1049
1157
  */
1050
1158
  export interface CreateComputerRequest {
1051
1159
  /**
1160
+ * @public
1052
1161
  * <p>The identifier of the directory in which to create the computer account.</p>
1053
1162
  */
1054
1163
  DirectoryId: string | undefined;
1055
1164
  /**
1165
+ * @public
1056
1166
  * <p>The name of the computer account.</p>
1057
1167
  */
1058
1168
  ComputerName: string | undefined;
1059
1169
  /**
1170
+ * @public
1060
1171
  * <p>A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.</p>
1061
1172
  */
1062
1173
  Password: string | undefined;
1063
1174
  /**
1175
+ * @public
1064
1176
  * <p>The fully-qualified distinguished name of the organizational unit to place the computer account in.</p>
1065
1177
  */
1066
1178
  OrganizationalUnitDistinguishedName?: string;
1067
1179
  /**
1180
+ * @public
1068
1181
  * <p>An array of <a>Attribute</a> objects that contain any LDAP attributes to apply to the
1069
1182
  * computer account.</p>
1070
1183
  */
@@ -1076,6 +1189,7 @@ export interface CreateComputerRequest {
1076
1189
  */
1077
1190
  export interface CreateComputerResult {
1078
1191
  /**
1192
+ * @public
1079
1193
  * <p>A <a>Computer</a> object that represents the computer account.</p>
1080
1194
  */
1081
1195
  Computer?: Computer;
@@ -1088,16 +1202,19 @@ export interface CreateComputerResult {
1088
1202
  */
1089
1203
  export interface CreateConditionalForwarderRequest {
1090
1204
  /**
1205
+ * @public
1091
1206
  * <p>The directory ID of the Amazon Web Services directory for which you are creating the conditional
1092
1207
  * forwarder.</p>
1093
1208
  */
1094
1209
  DirectoryId: string | undefined;
1095
1210
  /**
1211
+ * @public
1096
1212
  * <p>The fully qualified domain name (FQDN) of the remote domain with which you will set up
1097
1213
  * a trust relationship.</p>
1098
1214
  */
1099
1215
  RemoteDomainName: string | undefined;
1100
1216
  /**
1217
+ * @public
1101
1218
  * <p>The IP addresses of the remote DNS server associated with RemoteDomainName.</p>
1102
1219
  */
1103
1220
  DnsIpAddrs: string[] | undefined;
@@ -1114,14 +1231,17 @@ export interface CreateConditionalForwarderResult {
1114
1231
  */
1115
1232
  export interface CreateDirectoryRequest {
1116
1233
  /**
1234
+ * @public
1117
1235
  * <p>The fully qualified name for the directory, such as <code>corp.example.com</code>.</p>
1118
1236
  */
1119
1237
  Name: string | undefined;
1120
1238
  /**
1239
+ * @public
1121
1240
  * <p>The NetBIOS name of the directory, such as <code>CORP</code>.</p>
1122
1241
  */
1123
1242
  ShortName?: string;
1124
1243
  /**
1244
+ * @public
1125
1245
  * <p>The password for the directory administrator. The directory creation process creates a
1126
1246
  * directory administrator account with the user name <code>Administrator</code> and this
1127
1247
  * password.</p>
@@ -1154,19 +1274,23 @@ export interface CreateDirectoryRequest {
1154
1274
  */
1155
1275
  Password: string | undefined;
1156
1276
  /**
1277
+ * @public
1157
1278
  * <p>A description for the directory.</p>
1158
1279
  */
1159
1280
  Description?: string;
1160
1281
  /**
1282
+ * @public
1161
1283
  * <p>The size of the directory.</p>
1162
1284
  */
1163
1285
  Size: DirectorySize | string | undefined;
1164
1286
  /**
1287
+ * @public
1165
1288
  * <p>A <a>DirectoryVpcSettings</a> object that contains additional information for
1166
1289
  * the operation.</p>
1167
1290
  */
1168
1291
  VpcSettings?: DirectoryVpcSettings;
1169
1292
  /**
1293
+ * @public
1170
1294
  * <p>The tags to be assigned to the Simple AD directory.</p>
1171
1295
  */
1172
1296
  Tags?: Tag[];
@@ -1177,6 +1301,7 @@ export interface CreateDirectoryRequest {
1177
1301
  */
1178
1302
  export interface CreateDirectoryResult {
1179
1303
  /**
1304
+ * @public
1180
1305
  * <p>The identifier of the directory that was created.</p>
1181
1306
  */
1182
1307
  DirectoryId?: string;
@@ -1186,11 +1311,13 @@ export interface CreateDirectoryResult {
1186
1311
  */
1187
1312
  export interface CreateLogSubscriptionRequest {
1188
1313
  /**
1314
+ * @public
1189
1315
  * <p>Identifier of the directory to which you want to subscribe and receive real-time logs to
1190
1316
  * your specified CloudWatch log group.</p>
1191
1317
  */
1192
1318
  DirectoryId: string | undefined;
1193
1319
  /**
1320
+ * @public
1194
1321
  * <p>The name of the CloudWatch log group where the real-time domain controller logs are
1195
1322
  * forwarded.</p>
1196
1323
  */
@@ -1209,10 +1336,12 @@ export declare class InsufficientPermissionsException extends __BaseException {
1209
1336
  readonly name: "InsufficientPermissionsException";
1210
1337
  readonly $fault: "client";
1211
1338
  /**
1339
+ * @public
1212
1340
  * <p>The descriptive message for the exception.</p>
1213
1341
  */
1214
1342
  Message?: string;
1215
1343
  /**
1344
+ * @public
1216
1345
  * <p>The Amazon Web Services request identifier.</p>
1217
1346
  */
1218
1347
  RequestId?: string;
@@ -1239,37 +1368,44 @@ export type DirectoryEdition = (typeof DirectoryEdition)[keyof typeof DirectoryE
1239
1368
  */
1240
1369
  export interface CreateMicrosoftADRequest {
1241
1370
  /**
1371
+ * @public
1242
1372
  * <p>The fully qualified domain name for the Managed Microsoft AD directory, such as
1243
1373
  * <code>corp.example.com</code>. This name will resolve inside your VPC only. It does not need
1244
1374
  * to be publicly resolvable.</p>
1245
1375
  */
1246
1376
  Name: string | undefined;
1247
1377
  /**
1378
+ * @public
1248
1379
  * <p>The NetBIOS name for your domain, such as <code>CORP</code>. If you don't specify a
1249
1380
  * NetBIOS name, it will default to the first part of your directory DNS. For example,
1250
1381
  * <code>CORP</code> for the directory DNS <code>corp.example.com</code>. </p>
1251
1382
  */
1252
1383
  ShortName?: string;
1253
1384
  /**
1385
+ * @public
1254
1386
  * <p>The password for the default administrative user named <code>Admin</code>.</p>
1255
1387
  * <p>If you need to change the password for the administrator account, you can use the <a>ResetUserPassword</a> API call.</p>
1256
1388
  */
1257
1389
  Password: string | undefined;
1258
1390
  /**
1391
+ * @public
1259
1392
  * <p>A description for the directory. This label will appear on the Amazon Web Services console
1260
1393
  * <code>Directory Details</code> page after the directory is created.</p>
1261
1394
  */
1262
1395
  Description?: string;
1263
1396
  /**
1397
+ * @public
1264
1398
  * <p>Contains VPC information for the <a>CreateDirectory</a> or <a>CreateMicrosoftAD</a> operation.</p>
1265
1399
  */
1266
1400
  VpcSettings: DirectoryVpcSettings | undefined;
1267
1401
  /**
1402
+ * @public
1268
1403
  * <p>Managed Microsoft AD is available in two editions: <code>Standard</code> and
1269
1404
  * <code>Enterprise</code>. <code>Enterprise</code> is the default.</p>
1270
1405
  */
1271
1406
  Edition?: DirectoryEdition | string;
1272
1407
  /**
1408
+ * @public
1273
1409
  * <p>The tags to be assigned to the Managed Microsoft AD directory.</p>
1274
1410
  */
1275
1411
  Tags?: Tag[];
@@ -1280,6 +1416,7 @@ export interface CreateMicrosoftADRequest {
1280
1416
  */
1281
1417
  export interface CreateMicrosoftADResult {
1282
1418
  /**
1419
+ * @public
1283
1420
  * <p>The identifier of the directory that was created.</p>
1284
1421
  */
1285
1422
  DirectoryId?: string;
@@ -1290,10 +1427,12 @@ export interface CreateMicrosoftADResult {
1290
1427
  */
1291
1428
  export interface CreateSnapshotRequest {
1292
1429
  /**
1430
+ * @public
1293
1431
  * <p>The identifier of the directory of which to take a snapshot.</p>
1294
1432
  */
1295
1433
  DirectoryId: string | undefined;
1296
1434
  /**
1435
+ * @public
1297
1436
  * <p>The descriptive name to apply to the snapshot.</p>
1298
1437
  */
1299
1438
  Name?: string;
@@ -1304,6 +1443,7 @@ export interface CreateSnapshotRequest {
1304
1443
  */
1305
1444
  export interface CreateSnapshotResult {
1306
1445
  /**
1446
+ * @public
1307
1447
  * <p>The identifier of the snapshot that was created.</p>
1308
1448
  */
1309
1449
  SnapshotId?: string;
@@ -1318,10 +1458,12 @@ export declare class SnapshotLimitExceededException extends __BaseException {
1318
1458
  readonly name: "SnapshotLimitExceededException";
1319
1459
  readonly $fault: "client";
1320
1460
  /**
1461
+ * @public
1321
1462
  * <p>The descriptive message for the exception.</p>
1322
1463
  */
1323
1464
  Message?: string;
1324
1465
  /**
1466
+ * @public
1325
1467
  * <p>The Amazon Web Services request identifier.</p>
1326
1468
  */
1327
1469
  RequestId?: string;
@@ -1378,33 +1520,40 @@ export type TrustType = (typeof TrustType)[keyof typeof TrustType];
1378
1520
  */
1379
1521
  export interface CreateTrustRequest {
1380
1522
  /**
1523
+ * @public
1381
1524
  * <p>The Directory ID of the Managed Microsoft AD directory for which to establish the trust
1382
1525
  * relationship.</p>
1383
1526
  */
1384
1527
  DirectoryId: string | undefined;
1385
1528
  /**
1529
+ * @public
1386
1530
  * <p>The Fully Qualified Domain Name (FQDN) of the external domain for which to create the
1387
1531
  * trust relationship.</p>
1388
1532
  */
1389
1533
  RemoteDomainName: string | undefined;
1390
1534
  /**
1535
+ * @public
1391
1536
  * <p>The trust password. The must be the same password that was used when creating the trust
1392
1537
  * relationship on the external domain.</p>
1393
1538
  */
1394
1539
  TrustPassword: string | undefined;
1395
1540
  /**
1541
+ * @public
1396
1542
  * <p>The direction of the trust relationship.</p>
1397
1543
  */
1398
1544
  TrustDirection: TrustDirection | string | undefined;
1399
1545
  /**
1546
+ * @public
1400
1547
  * <p>The trust relationship type. <code>Forest</code> is the default.</p>
1401
1548
  */
1402
1549
  TrustType?: TrustType | string;
1403
1550
  /**
1551
+ * @public
1404
1552
  * <p>The IP addresses of the remote DNS server associated with RemoteDomainName.</p>
1405
1553
  */
1406
1554
  ConditionalForwarderIpAddrs?: string[];
1407
1555
  /**
1556
+ * @public
1408
1557
  * <p>Optional parameter to enable selective authentication for the trust.</p>
1409
1558
  */
1410
1559
  SelectiveAuth?: SelectiveAuth | string;
@@ -1415,6 +1564,7 @@ export interface CreateTrustRequest {
1415
1564
  */
1416
1565
  export interface CreateTrustResult {
1417
1566
  /**
1567
+ * @public
1418
1568
  * <p>A unique identifier for the trust relationship that was created.</p>
1419
1569
  */
1420
1570
  TrustId?: string;
@@ -1425,10 +1575,12 @@ export interface CreateTrustResult {
1425
1575
  */
1426
1576
  export interface DeleteConditionalForwarderRequest {
1427
1577
  /**
1578
+ * @public
1428
1579
  * <p>The directory ID for which you are deleting the conditional forwarder.</p>
1429
1580
  */
1430
1581
  DirectoryId: string | undefined;
1431
1582
  /**
1583
+ * @public
1432
1584
  * <p>The fully qualified domain name (FQDN) of the remote domain with which you are deleting
1433
1585
  * the conditional forwarder.</p>
1434
1586
  */
@@ -1446,6 +1598,7 @@ export interface DeleteConditionalForwarderResult {
1446
1598
  */
1447
1599
  export interface DeleteDirectoryRequest {
1448
1600
  /**
1601
+ * @public
1449
1602
  * <p>The identifier of the directory to delete.</p>
1450
1603
  */
1451
1604
  DirectoryId: string | undefined;
@@ -1456,6 +1609,7 @@ export interface DeleteDirectoryRequest {
1456
1609
  */
1457
1610
  export interface DeleteDirectoryResult {
1458
1611
  /**
1612
+ * @public
1459
1613
  * <p>The directory identifier.</p>
1460
1614
  */
1461
1615
  DirectoryId?: string;
@@ -1465,6 +1619,7 @@ export interface DeleteDirectoryResult {
1465
1619
  */
1466
1620
  export interface DeleteLogSubscriptionRequest {
1467
1621
  /**
1622
+ * @public
1468
1623
  * <p>Identifier of the directory whose log subscription you want to delete.</p>
1469
1624
  */
1470
1625
  DirectoryId: string | undefined;
@@ -1480,6 +1635,7 @@ export interface DeleteLogSubscriptionResult {
1480
1635
  */
1481
1636
  export interface DeleteSnapshotRequest {
1482
1637
  /**
1638
+ * @public
1483
1639
  * <p>The identifier of the directory snapshot to be deleted.</p>
1484
1640
  */
1485
1641
  SnapshotId: string | undefined;
@@ -1490,6 +1646,7 @@ export interface DeleteSnapshotRequest {
1490
1646
  */
1491
1647
  export interface DeleteSnapshotResult {
1492
1648
  /**
1649
+ * @public
1493
1650
  * <p>The identifier of the directory snapshot that was deleted.</p>
1494
1651
  */
1495
1652
  SnapshotId?: string;
@@ -1501,10 +1658,12 @@ export interface DeleteSnapshotResult {
1501
1658
  */
1502
1659
  export interface DeleteTrustRequest {
1503
1660
  /**
1661
+ * @public
1504
1662
  * <p>The Trust ID of the trust relationship to be deleted.</p>
1505
1663
  */
1506
1664
  TrustId: string | undefined;
1507
1665
  /**
1666
+ * @public
1508
1667
  * <p>Delete a conditional forwarder as part of a DeleteTrustRequest.</p>
1509
1668
  */
1510
1669
  DeleteAssociatedConditionalForwarder?: boolean;
@@ -1515,6 +1674,7 @@ export interface DeleteTrustRequest {
1515
1674
  */
1516
1675
  export interface DeleteTrustResult {
1517
1676
  /**
1677
+ * @public
1518
1678
  * <p>The Trust ID of the trust relationship that was deleted.</p>
1519
1679
  */
1520
1680
  TrustId?: string;
@@ -1524,10 +1684,12 @@ export interface DeleteTrustResult {
1524
1684
  */
1525
1685
  export interface DeregisterCertificateRequest {
1526
1686
  /**
1687
+ * @public
1527
1688
  * <p>The identifier of the directory.</p>
1528
1689
  */
1529
1690
  DirectoryId: string | undefined;
1530
1691
  /**
1692
+ * @public
1531
1693
  * <p>The identifier of the certificate.</p>
1532
1694
  */
1533
1695
  CertificateId: string | undefined;
@@ -1543,11 +1705,13 @@ export interface DeregisterCertificateResult {
1543
1705
  */
1544
1706
  export interface DeregisterEventTopicRequest {
1545
1707
  /**
1708
+ * @public
1546
1709
  * <p>The Directory ID to remove as a publisher. This directory will no longer send messages
1547
1710
  * to the specified Amazon SNS topic.</p>
1548
1711
  */
1549
1712
  DirectoryId: string | undefined;
1550
1713
  /**
1714
+ * @public
1551
1715
  * <p>The name of the Amazon SNS topic from which to remove the directory as a
1552
1716
  * publisher.</p>
1553
1717
  */
@@ -1564,10 +1728,12 @@ export interface DeregisterEventTopicResult {
1564
1728
  */
1565
1729
  export interface DescribeCertificateRequest {
1566
1730
  /**
1731
+ * @public
1567
1732
  * <p>The identifier of the directory.</p>
1568
1733
  */
1569
1734
  DirectoryId: string | undefined;
1570
1735
  /**
1736
+ * @public
1571
1737
  * <p>The identifier of the certificate.</p>
1572
1738
  */
1573
1739
  CertificateId: string | undefined;
@@ -1577,6 +1743,7 @@ export interface DescribeCertificateRequest {
1577
1743
  */
1578
1744
  export interface DescribeCertificateResult {
1579
1745
  /**
1746
+ * @public
1580
1747
  * <p>Information about the certificate, including registered date time, certificate state, the
1581
1748
  * reason for the state, expiration date time, and certificate common name.</p>
1582
1749
  */
@@ -1587,18 +1754,22 @@ export interface DescribeCertificateResult {
1587
1754
  */
1588
1755
  export interface DescribeClientAuthenticationSettingsRequest {
1589
1756
  /**
1757
+ * @public
1590
1758
  * <p>The identifier of the directory for which to retrieve information.</p>
1591
1759
  */
1592
1760
  DirectoryId: string | undefined;
1593
1761
  /**
1762
+ * @public
1594
1763
  * <p>The type of client authentication for which to retrieve information. If no type is specified, a list of all client authentication types that are supported for the specified directory is retrieved.</p>
1595
1764
  */
1596
1765
  Type?: ClientAuthenticationType | string;
1597
1766
  /**
1767
+ * @public
1598
1768
  * <p>The <i>DescribeClientAuthenticationSettingsResult.NextToken</i> value from a previous call to <a>DescribeClientAuthenticationSettings</a>. Pass null if this is the first call.</p>
1599
1769
  */
1600
1770
  NextToken?: string;
1601
1771
  /**
1772
+ * @public
1602
1773
  * <p>The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation. </p>
1603
1774
  */
1604
1775
  Limit?: number;
@@ -1608,10 +1779,12 @@ export interface DescribeClientAuthenticationSettingsRequest {
1608
1779
  */
1609
1780
  export interface DescribeClientAuthenticationSettingsResult {
1610
1781
  /**
1782
+ * @public
1611
1783
  * <p>Information about the type of client authentication for the specified directory. The following information is retrieved: The date and time when the status of the client authentication type was last updated, whether the client authentication type is enabled or disabled, and the type of client authentication.</p>
1612
1784
  */
1613
1785
  ClientAuthenticationSettingsInfo?: ClientAuthenticationSettingInfo[];
1614
1786
  /**
1787
+ * @public
1615
1788
  * <p>The next token used to retrieve the client authentication settings if the number of setting types exceeds
1616
1789
  * page limit and there is another page.</p>
1617
1790
  */
@@ -1623,11 +1796,13 @@ export interface DescribeClientAuthenticationSettingsResult {
1623
1796
  */
1624
1797
  export interface DescribeConditionalForwardersRequest {
1625
1798
  /**
1799
+ * @public
1626
1800
  * <p>The directory ID for which to get the list of associated conditional
1627
1801
  * forwarders.</p>
1628
1802
  */
1629
1803
  DirectoryId: string | undefined;
1630
1804
  /**
1805
+ * @public
1631
1806
  * <p>The fully qualified domain names (FQDN) of the remote domains for which to get the list
1632
1807
  * of associated conditional forwarders. If this member is null, all conditional forwarders are
1633
1808
  * returned.</p>
@@ -1640,6 +1815,7 @@ export interface DescribeConditionalForwardersRequest {
1640
1815
  */
1641
1816
  export interface DescribeConditionalForwardersResult {
1642
1817
  /**
1818
+ * @public
1643
1819
  * <p>The list of conditional forwarders that have been created.</p>
1644
1820
  */
1645
1821
  ConditionalForwarders?: ConditionalForwarder[];
@@ -1650,16 +1826,19 @@ export interface DescribeConditionalForwardersResult {
1650
1826
  */
1651
1827
  export interface DescribeDirectoriesRequest {
1652
1828
  /**
1829
+ * @public
1653
1830
  * <p>A list of identifiers of the directories for which to obtain the information. If this
1654
1831
  * member is null, all directories that belong to the current account are returned.</p>
1655
1832
  * <p>An empty list results in an <code>InvalidParameterException</code> being thrown.</p>
1656
1833
  */
1657
1834
  DirectoryIds?: string[];
1658
1835
  /**
1836
+ * @public
1659
1837
  * <p>The <code>DescribeDirectoriesResult.NextToken</code> value from a previous call to <a>DescribeDirectories</a>. Pass null if this is the first call.</p>
1660
1838
  */
1661
1839
  NextToken?: string;
1662
1840
  /**
1841
+ * @public
1663
1842
  * <p>The maximum number of items to return. If this value is zero, the maximum number of items
1664
1843
  * is specified by the limitations of the operation.</p>
1665
1844
  */
@@ -1671,26 +1850,32 @@ export interface DescribeDirectoriesRequest {
1671
1850
  */
1672
1851
  export interface DirectoryConnectSettingsDescription {
1673
1852
  /**
1853
+ * @public
1674
1854
  * <p>The identifier of the VPC that the AD Connector is in.</p>
1675
1855
  */
1676
1856
  VpcId?: string;
1677
1857
  /**
1858
+ * @public
1678
1859
  * <p>A list of subnet identifiers in the VPC that the AD Connector is in.</p>
1679
1860
  */
1680
1861
  SubnetIds?: string[];
1681
1862
  /**
1863
+ * @public
1682
1864
  * <p>The user name of the service account in your self-managed directory.</p>
1683
1865
  */
1684
1866
  CustomerUserName?: string;
1685
1867
  /**
1868
+ * @public
1686
1869
  * <p>The security group identifier for the AD Connector directory.</p>
1687
1870
  */
1688
1871
  SecurityGroupId?: string;
1689
1872
  /**
1873
+ * @public
1690
1874
  * <p>A list of the Availability Zones that the directory is in.</p>
1691
1875
  */
1692
1876
  AvailabilityZones?: string[];
1693
1877
  /**
1878
+ * @public
1694
1879
  * <p>The IP addresses of the AD Connector servers.</p>
1695
1880
  */
1696
1881
  ConnectIps?: string[];
@@ -1728,38 +1913,46 @@ export type RadiusAuthenticationProtocol = (typeof RadiusAuthenticationProtocol)
1728
1913
  */
1729
1914
  export interface RadiusSettings {
1730
1915
  /**
1916
+ * @public
1731
1917
  * <p>An array of strings that contains the fully qualified domain name (FQDN) or IP
1732
1918
  * addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server
1733
1919
  * load balancer.</p>
1734
1920
  */
1735
1921
  RadiusServers?: string[];
1736
1922
  /**
1923
+ * @public
1737
1924
  * <p>The port that your RADIUS server is using for communications. Your self-managed
1738
1925
  * network must allow inbound traffic over this port from the Directory Service servers.</p>
1739
1926
  */
1740
1927
  RadiusPort?: number;
1741
1928
  /**
1929
+ * @public
1742
1930
  * <p>The amount of time, in seconds, to wait for the RADIUS server to respond.</p>
1743
1931
  */
1744
1932
  RadiusTimeout?: number;
1745
1933
  /**
1934
+ * @public
1746
1935
  * <p>The maximum number of times that communication with the RADIUS server is
1747
1936
  * attempted.</p>
1748
1937
  */
1749
1938
  RadiusRetries?: number;
1750
1939
  /**
1940
+ * @public
1751
1941
  * <p>Required for enabling RADIUS on the directory.</p>
1752
1942
  */
1753
1943
  SharedSecret?: string;
1754
1944
  /**
1945
+ * @public
1755
1946
  * <p>The protocol specified for your RADIUS endpoints.</p>
1756
1947
  */
1757
1948
  AuthenticationProtocol?: RadiusAuthenticationProtocol | string;
1758
1949
  /**
1950
+ * @public
1759
1951
  * <p>Not currently used.</p>
1760
1952
  */
1761
1953
  DisplayLabel?: string;
1762
1954
  /**
1955
+ * @public
1763
1956
  * <p>Not currently used.</p>
1764
1957
  */
1765
1958
  UseSameUsername?: boolean;
@@ -1783,18 +1976,22 @@ export type RadiusStatus = (typeof RadiusStatus)[keyof typeof RadiusStatus];
1783
1976
  */
1784
1977
  export interface DirectoryVpcSettingsDescription {
1785
1978
  /**
1979
+ * @public
1786
1980
  * <p>The identifier of the VPC that the directory is in.</p>
1787
1981
  */
1788
1982
  VpcId?: string;
1789
1983
  /**
1984
+ * @public
1790
1985
  * <p>The identifiers of the subnets for the directory servers.</p>
1791
1986
  */
1792
1987
  SubnetIds?: string[];
1793
1988
  /**
1989
+ * @public
1794
1990
  * <p>The domain controller security group identifier for the directory.</p>
1795
1991
  */
1796
1992
  SecurityGroupId?: string;
1797
1993
  /**
1994
+ * @public
1798
1995
  * <p>The list of Availability Zones that the directory is in.</p>
1799
1996
  */
1800
1997
  AvailabilityZones?: string[];
@@ -1806,28 +2003,34 @@ export interface DirectoryVpcSettingsDescription {
1806
2003
  */
1807
2004
  export interface OwnerDirectoryDescription {
1808
2005
  /**
2006
+ * @public
1809
2007
  * <p>Identifier of the Managed Microsoft AD directory in the directory owner
1810
2008
  * account.</p>
1811
2009
  */
1812
2010
  DirectoryId?: string;
1813
2011
  /**
2012
+ * @public
1814
2013
  * <p>Identifier of the directory owner account.</p>
1815
2014
  */
1816
2015
  AccountId?: string;
1817
2016
  /**
2017
+ * @public
1818
2018
  * <p>IP address of the directory’s domain controllers.</p>
1819
2019
  */
1820
2020
  DnsIpAddrs?: string[];
1821
2021
  /**
2022
+ * @public
1822
2023
  * <p>Information about the VPC settings for the directory.</p>
1823
2024
  */
1824
2025
  VpcSettings?: DirectoryVpcSettingsDescription;
1825
2026
  /**
2027
+ * @public
1826
2028
  * <p>A <a>RadiusSettings</a> object that contains information about the RADIUS
1827
2029
  * server.</p>
1828
2030
  */
1829
2031
  RadiusSettings?: RadiusSettings;
1830
2032
  /**
2033
+ * @public
1831
2034
  * <p>Information about the status of the RADIUS server.</p>
1832
2035
  */
1833
2036
  RadiusStatus?: RadiusStatus | string;
@@ -1839,10 +2042,12 @@ export interface OwnerDirectoryDescription {
1839
2042
  */
1840
2043
  export interface RegionsInfo {
1841
2044
  /**
2045
+ * @public
1842
2046
  * <p>The Region where the Managed Microsoft AD directory was originally created.</p>
1843
2047
  */
1844
2048
  PrimaryRegion?: string;
1845
2049
  /**
2050
+ * @public
1846
2051
  * <p>Lists the Regions where the directory has been replicated, excluding the primary
1847
2052
  * Region.</p>
1848
2053
  */
@@ -1889,31 +2094,38 @@ export type DirectoryType = (typeof DirectoryType)[keyof typeof DirectoryType];
1889
2094
  */
1890
2095
  export interface DirectoryDescription {
1891
2096
  /**
2097
+ * @public
1892
2098
  * <p>The directory identifier.</p>
1893
2099
  */
1894
2100
  DirectoryId?: string;
1895
2101
  /**
2102
+ * @public
1896
2103
  * <p>The fully qualified name of the directory.</p>
1897
2104
  */
1898
2105
  Name?: string;
1899
2106
  /**
2107
+ * @public
1900
2108
  * <p>The short name of the directory.</p>
1901
2109
  */
1902
2110
  ShortName?: string;
1903
2111
  /**
2112
+ * @public
1904
2113
  * <p>The directory size.</p>
1905
2114
  */
1906
2115
  Size?: DirectorySize | string;
1907
2116
  /**
2117
+ * @public
1908
2118
  * <p>The edition associated with this directory.</p>
1909
2119
  */
1910
2120
  Edition?: DirectoryEdition | string;
1911
2121
  /**
2122
+ * @public
1912
2123
  * <p>The alias for the directory. If no alias has been created for the directory, the alias is
1913
2124
  * the directory identifier, such as <code>d-XXXXXXXXXX</code>.</p>
1914
2125
  */
1915
2126
  Alias?: string;
1916
2127
  /**
2128
+ * @public
1917
2129
  * <p>The access URL for the directory, such as
1918
2130
  * <code>http://<alias>.awsapps.com</code>. If no alias has been created for the
1919
2131
  * directory, <code><alias></code> is the directory identifier, such as
@@ -1921,10 +2133,12 @@ export interface DirectoryDescription {
1921
2133
  */
1922
2134
  AccessUrl?: string;
1923
2135
  /**
2136
+ * @public
1924
2137
  * <p>The description for the directory.</p>
1925
2138
  */
1926
2139
  Description?: string;
1927
2140
  /**
2141
+ * @public
1928
2142
  * <p>The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD
1929
2143
  * directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For
1930
2144
  * an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers
@@ -1932,80 +2146,97 @@ export interface DirectoryDescription {
1932
2146
  */
1933
2147
  DnsIpAddrs?: string[];
1934
2148
  /**
2149
+ * @public
1935
2150
  * <p>The current stage of the directory.</p>
1936
2151
  */
1937
2152
  Stage?: DirectoryStage | string;
1938
2153
  /**
2154
+ * @public
1939
2155
  * <p>Current directory status of the shared Managed Microsoft AD directory.</p>
1940
2156
  */
1941
2157
  ShareStatus?: ShareStatus | string;
1942
2158
  /**
2159
+ * @public
1943
2160
  * <p>The method used when sharing a directory to determine whether the directory should be
1944
2161
  * shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by
1945
2162
  * sending a shared directory request (<code>HANDSHAKE</code>).</p>
1946
2163
  */
1947
2164
  ShareMethod?: ShareMethod | string;
1948
2165
  /**
2166
+ * @public
1949
2167
  * <p>A directory share request that is sent by the directory owner to the directory consumer.
1950
2168
  * The request includes a typed message to help the directory consumer administrator determine
1951
2169
  * whether to approve or reject the share invitation.</p>
1952
2170
  */
1953
2171
  ShareNotes?: string;
1954
2172
  /**
2173
+ * @public
1955
2174
  * <p>Specifies when the directory was created.</p>
1956
2175
  */
1957
2176
  LaunchTime?: Date;
1958
2177
  /**
2178
+ * @public
1959
2179
  * <p>The date and time that the stage was last updated.</p>
1960
2180
  */
1961
2181
  StageLastUpdatedDateTime?: Date;
1962
2182
  /**
2183
+ * @public
1963
2184
  * <p>The directory size.</p>
1964
2185
  */
1965
2186
  Type?: DirectoryType | string;
1966
2187
  /**
2188
+ * @public
1967
2189
  * <p>A <a>DirectoryVpcSettingsDescription</a> object that contains additional
1968
2190
  * information about a directory. This member is only present if the directory is a Simple AD or
1969
2191
  * Managed Microsoft AD directory.</p>
1970
2192
  */
1971
2193
  VpcSettings?: DirectoryVpcSettingsDescription;
1972
2194
  /**
2195
+ * @public
1973
2196
  * <p>A <a>DirectoryConnectSettingsDescription</a> object that contains additional
1974
2197
  * information about an AD Connector directory. This member is only present if the directory is
1975
2198
  * an AD Connector directory.</p>
1976
2199
  */
1977
2200
  ConnectSettings?: DirectoryConnectSettingsDescription;
1978
2201
  /**
2202
+ * @public
1979
2203
  * <p>A <a>RadiusSettings</a> object that contains information about the RADIUS
1980
2204
  * server configured for this directory.</p>
1981
2205
  */
1982
2206
  RadiusSettings?: RadiusSettings;
1983
2207
  /**
2208
+ * @public
1984
2209
  * <p>The status of the RADIUS MFA server connection.</p>
1985
2210
  */
1986
2211
  RadiusStatus?: RadiusStatus | string;
1987
2212
  /**
2213
+ * @public
1988
2214
  * <p>Additional information about the directory stage.</p>
1989
2215
  */
1990
2216
  StageReason?: string;
1991
2217
  /**
2218
+ * @public
1992
2219
  * <p>Indicates if single sign-on is enabled for the directory. For more information, see <a>EnableSso</a> and <a>DisableSso</a>.</p>
1993
2220
  */
1994
2221
  SsoEnabled?: boolean;
1995
2222
  /**
2223
+ * @public
1996
2224
  * <p>The desired number of domain controllers in the directory if the directory is Microsoft
1997
2225
  * AD.</p>
1998
2226
  */
1999
2227
  DesiredNumberOfDomainControllers?: number;
2000
2228
  /**
2229
+ * @public
2001
2230
  * <p>Describes the Managed Microsoft AD directory in the directory owner account.</p>
2002
2231
  */
2003
2232
  OwnerDirectoryDescription?: OwnerDirectoryDescription;
2004
2233
  /**
2234
+ * @public
2005
2235
  * <p>Lists the Regions where the directory has replicated.</p>
2006
2236
  */
2007
2237
  RegionsInfo?: RegionsInfo;
2008
2238
  /**
2239
+ * @public
2009
2240
  * <p>The operating system (OS) version of the directory.</p>
2010
2241
  */
2011
2242
  OsVersion?: OSVersion | string;
@@ -2016,6 +2247,7 @@ export interface DirectoryDescription {
2016
2247
  */
2017
2248
  export interface DescribeDirectoriesResult {
2018
2249
  /**
2250
+ * @public
2019
2251
  * <p>The list of <a>DirectoryDescription</a> objects that were retrieved.</p>
2020
2252
  * <p>It is possible that this list contains less than the number of items specified in the
2021
2253
  * <code>Limit</code> member of the request. This occurs if there are less than the requested
@@ -2024,6 +2256,7 @@ export interface DescribeDirectoriesResult {
2024
2256
  */
2025
2257
  DirectoryDescriptions?: DirectoryDescription[];
2026
2258
  /**
2259
+ * @public
2027
2260
  * <p>If not null, more results are available. Pass this value for the <code>NextToken</code>
2028
2261
  * parameter in a subsequent call to <a>DescribeDirectories</a> to retrieve the next
2029
2262
  * set of items.</p>
@@ -2038,10 +2271,12 @@ export declare class InvalidNextTokenException extends __BaseException {
2038
2271
  readonly name: "InvalidNextTokenException";
2039
2272
  readonly $fault: "client";
2040
2273
  /**
2274
+ * @public
2041
2275
  * <p>The descriptive message for the exception.</p>
2042
2276
  */
2043
2277
  Message?: string;
2044
2278
  /**
2279
+ * @public
2045
2280
  * <p>The Amazon Web Services request identifier.</p>
2046
2281
  */
2047
2282
  RequestId?: string;
@@ -2055,22 +2290,26 @@ export declare class InvalidNextTokenException extends __BaseException {
2055
2290
  */
2056
2291
  export interface DescribeDomainControllersRequest {
2057
2292
  /**
2293
+ * @public
2058
2294
  * <p>Identifier of the directory for which to retrieve the domain controller
2059
2295
  * information.</p>
2060
2296
  */
2061
2297
  DirectoryId: string | undefined;
2062
2298
  /**
2299
+ * @public
2063
2300
  * <p>A list of identifiers for the domain controllers whose information will be
2064
2301
  * provided.</p>
2065
2302
  */
2066
2303
  DomainControllerIds?: string[];
2067
2304
  /**
2305
+ * @public
2068
2306
  * <p>The <i>DescribeDomainControllers.NextToken</i> value from a previous call
2069
2307
  * to <a>DescribeDomainControllers</a>. Pass null if this is the first call.
2070
2308
  * </p>
2071
2309
  */
2072
2310
  NextToken?: string;
2073
2311
  /**
2312
+ * @public
2074
2313
  * <p>The maximum number of items to return.</p>
2075
2314
  */
2076
2315
  Limit?: number;
@@ -2098,42 +2337,52 @@ export type DomainControllerStatus = (typeof DomainControllerStatus)[keyof typeo
2098
2337
  */
2099
2338
  export interface DomainController {
2100
2339
  /**
2340
+ * @public
2101
2341
  * <p>Identifier of the directory where the domain controller resides.</p>
2102
2342
  */
2103
2343
  DirectoryId?: string;
2104
2344
  /**
2345
+ * @public
2105
2346
  * <p>Identifies a specific domain controller in the directory.</p>
2106
2347
  */
2107
2348
  DomainControllerId?: string;
2108
2349
  /**
2350
+ * @public
2109
2351
  * <p>The IP address of the domain controller.</p>
2110
2352
  */
2111
2353
  DnsIpAddr?: string;
2112
2354
  /**
2355
+ * @public
2113
2356
  * <p>The identifier of the VPC that contains the domain controller.</p>
2114
2357
  */
2115
2358
  VpcId?: string;
2116
2359
  /**
2360
+ * @public
2117
2361
  * <p>Identifier of the subnet in the VPC that contains the domain controller.</p>
2118
2362
  */
2119
2363
  SubnetId?: string;
2120
2364
  /**
2365
+ * @public
2121
2366
  * <p>The Availability Zone where the domain controller is located.</p>
2122
2367
  */
2123
2368
  AvailabilityZone?: string;
2124
2369
  /**
2370
+ * @public
2125
2371
  * <p>The status of the domain controller.</p>
2126
2372
  */
2127
2373
  Status?: DomainControllerStatus | string;
2128
2374
  /**
2375
+ * @public
2129
2376
  * <p>A description of the domain controller state.</p>
2130
2377
  */
2131
2378
  StatusReason?: string;
2132
2379
  /**
2380
+ * @public
2133
2381
  * <p>Specifies when the domain controller was created.</p>
2134
2382
  */
2135
2383
  LaunchTime?: Date;
2136
2384
  /**
2385
+ * @public
2137
2386
  * <p>The date and time that the status was last updated.</p>
2138
2387
  */
2139
2388
  StatusLastUpdatedDateTime?: Date;
@@ -2143,10 +2392,12 @@ export interface DomainController {
2143
2392
  */
2144
2393
  export interface DescribeDomainControllersResult {
2145
2394
  /**
2395
+ * @public
2146
2396
  * <p>List of the <a>DomainController</a> objects that were retrieved.</p>
2147
2397
  */
2148
2398
  DomainControllers?: DomainController[];
2149
2399
  /**
2400
+ * @public
2150
2401
  * <p>If not null, more results are available. Pass this value for the <code>NextToken</code>
2151
2402
  * parameter in a subsequent call to <a>DescribeDomainControllers</a> retrieve the
2152
2403
  * next set of items.</p>
@@ -2159,11 +2410,13 @@ export interface DescribeDomainControllersResult {
2159
2410
  */
2160
2411
  export interface DescribeEventTopicsRequest {
2161
2412
  /**
2413
+ * @public
2162
2414
  * <p>The Directory ID for which to get the list of associated Amazon SNS topics. If this member
2163
2415
  * is null, associations for all Directory IDs are returned.</p>
2164
2416
  */
2165
2417
  DirectoryId?: string;
2166
2418
  /**
2419
+ * @public
2167
2420
  * <p>A list of Amazon SNS topic names for which to obtain the information. If this member is
2168
2421
  * null, all associations for the specified Directory ID are returned.</p>
2169
2422
  * <p>An empty list results in an <code>InvalidParameterException</code> being
@@ -2191,23 +2444,28 @@ export type TopicStatus = (typeof TopicStatus)[keyof typeof TopicStatus];
2191
2444
  */
2192
2445
  export interface EventTopic {
2193
2446
  /**
2447
+ * @public
2194
2448
  * <p>The Directory ID of an Directory Service directory that will publish status messages to an Amazon SNS
2195
2449
  * topic.</p>
2196
2450
  */
2197
2451
  DirectoryId?: string;
2198
2452
  /**
2453
+ * @public
2199
2454
  * <p>The name of an Amazon SNS topic the receives status messages from the directory.</p>
2200
2455
  */
2201
2456
  TopicName?: string;
2202
2457
  /**
2458
+ * @public
2203
2459
  * <p>The Amazon SNS topic ARN (Amazon Resource Name).</p>
2204
2460
  */
2205
2461
  TopicArn?: string;
2206
2462
  /**
2463
+ * @public
2207
2464
  * <p>The date and time of when you associated your directory with the Amazon SNS topic.</p>
2208
2465
  */
2209
2466
  CreatedDateTime?: Date;
2210
2467
  /**
2468
+ * @public
2211
2469
  * <p>The topic registration status.</p>
2212
2470
  */
2213
2471
  Status?: TopicStatus | string;
@@ -2218,6 +2476,7 @@ export interface EventTopic {
2218
2476
  */
2219
2477
  export interface DescribeEventTopicsResult {
2220
2478
  /**
2479
+ * @public
2221
2480
  * <p>A list of Amazon SNS topic names that receive status messages from the specified Directory
2222
2481
  * ID.</p>
2223
2482
  */
@@ -2239,19 +2498,23 @@ export type LDAPSType = (typeof LDAPSType)[keyof typeof LDAPSType];
2239
2498
  */
2240
2499
  export interface DescribeLDAPSSettingsRequest {
2241
2500
  /**
2501
+ * @public
2242
2502
  * <p>The identifier of the directory.</p>
2243
2503
  */
2244
2504
  DirectoryId: string | undefined;
2245
2505
  /**
2506
+ * @public
2246
2507
  * <p>The type of LDAP security to enable. Currently only the value <code>Client</code> is
2247
2508
  * supported.</p>
2248
2509
  */
2249
2510
  Type?: LDAPSType | string;
2250
2511
  /**
2512
+ * @public
2251
2513
  * <p>The type of next token used for pagination.</p>
2252
2514
  */
2253
2515
  NextToken?: string;
2254
2516
  /**
2517
+ * @public
2255
2518
  * <p>Specifies the number of items that should be displayed on one page.</p>
2256
2519
  */
2257
2520
  Limit?: number;
@@ -2276,14 +2539,17 @@ export type LDAPSStatus = (typeof LDAPSStatus)[keyof typeof LDAPSStatus];
2276
2539
  */
2277
2540
  export interface LDAPSSettingInfo {
2278
2541
  /**
2542
+ * @public
2279
2543
  * <p>The state of the LDAPS settings.</p>
2280
2544
  */
2281
2545
  LDAPSStatus?: LDAPSStatus | string;
2282
2546
  /**
2547
+ * @public
2283
2548
  * <p>Describes a state change for LDAPS.</p>
2284
2549
  */
2285
2550
  LDAPSStatusReason?: string;
2286
2551
  /**
2552
+ * @public
2287
2553
  * <p>The date and time when the LDAPS settings were last updated.</p>
2288
2554
  */
2289
2555
  LastUpdatedDateTime?: Date;
@@ -2293,11 +2559,13 @@ export interface LDAPSSettingInfo {
2293
2559
  */
2294
2560
  export interface DescribeLDAPSSettingsResult {
2295
2561
  /**
2562
+ * @public
2296
2563
  * <p>Information about LDAP security for the specified directory, including status of
2297
2564
  * enablement, state last updated date time, and the reason for the state.</p>
2298
2565
  */
2299
2566
  LDAPSSettingsInfo?: LDAPSSettingInfo[];
2300
2567
  /**
2568
+ * @public
2301
2569
  * <p>The next token used to retrieve the LDAPS settings if the number of setting types exceeds
2302
2570
  * page limit and there is another page.</p>
2303
2571
  */
@@ -2308,14 +2576,17 @@ export interface DescribeLDAPSSettingsResult {
2308
2576
  */
2309
2577
  export interface DescribeRegionsRequest {
2310
2578
  /**
2579
+ * @public
2311
2580
  * <p>The identifier of the directory.</p>
2312
2581
  */
2313
2582
  DirectoryId: string | undefined;
2314
2583
  /**
2584
+ * @public
2315
2585
  * <p>The name of the Region. For example, <code>us-east-1</code>.</p>
2316
2586
  */
2317
2587
  RegionName?: string;
2318
2588
  /**
2589
+ * @public
2319
2590
  * <p>The <code>DescribeRegionsResult.NextToken</code> value from a previous call to <a>DescribeRegions</a>. Pass null if this is the first call.</p>
2320
2591
  */
2321
2592
  NextToken?: string;
@@ -2338,39 +2609,48 @@ export type RegionType = (typeof RegionType)[keyof typeof RegionType];
2338
2609
  */
2339
2610
  export interface RegionDescription {
2340
2611
  /**
2612
+ * @public
2341
2613
  * <p>The identifier of the directory.</p>
2342
2614
  */
2343
2615
  DirectoryId?: string;
2344
2616
  /**
2617
+ * @public
2345
2618
  * <p>The name of the Region. For example, <code>us-east-1</code>.</p>
2346
2619
  */
2347
2620
  RegionName?: string;
2348
2621
  /**
2622
+ * @public
2349
2623
  * <p>Specifies whether the Region is the primary Region or an additional Region.</p>
2350
2624
  */
2351
2625
  RegionType?: RegionType | string;
2352
2626
  /**
2627
+ * @public
2353
2628
  * <p>The status of the replication process for the specified Region.</p>
2354
2629
  */
2355
2630
  Status?: DirectoryStage | string;
2356
2631
  /**
2632
+ * @public
2357
2633
  * <p>Contains VPC information for the <a>CreateDirectory</a> or <a>CreateMicrosoftAD</a> operation.</p>
2358
2634
  */
2359
2635
  VpcSettings?: DirectoryVpcSettings;
2360
2636
  /**
2637
+ * @public
2361
2638
  * <p>The desired number of domain controllers in the specified Region for the specified
2362
2639
  * directory.</p>
2363
2640
  */
2364
2641
  DesiredNumberOfDomainControllers?: number;
2365
2642
  /**
2643
+ * @public
2366
2644
  * <p>Specifies when the Region replication began.</p>
2367
2645
  */
2368
2646
  LaunchTime?: Date;
2369
2647
  /**
2648
+ * @public
2370
2649
  * <p>The date and time that the Region status was last updated.</p>
2371
2650
  */
2372
2651
  StatusLastUpdatedDateTime?: Date;
2373
2652
  /**
2653
+ * @public
2374
2654
  * <p>The date and time that the Region description was last updated.</p>
2375
2655
  */
2376
2656
  LastUpdatedDateTime?: Date;
@@ -2380,10 +2660,12 @@ export interface RegionDescription {
2380
2660
  */
2381
2661
  export interface DescribeRegionsResult {
2382
2662
  /**
2663
+ * @public
2383
2664
  * <p>List of Region information related to the directory for each replicated Region.</p>
2384
2665
  */
2385
2666
  RegionsDescription?: RegionDescription[];
2386
2667
  /**
2668
+ * @public
2387
2669
  * <p>If not null, more results are available. Pass this value for the <code>NextToken</code>
2388
2670
  * parameter in a subsequent call to <a>DescribeRegions</a> to retrieve the next set
2389
2671
  * of items.</p>
@@ -2410,14 +2692,17 @@ export type DirectoryConfigurationStatus = (typeof DirectoryConfigurationStatus)
2410
2692
  */
2411
2693
  export interface DescribeSettingsRequest {
2412
2694
  /**
2695
+ * @public
2413
2696
  * <p>The identifier of the directory for which to retrieve information.</p>
2414
2697
  */
2415
2698
  DirectoryId: string | undefined;
2416
2699
  /**
2700
+ * @public
2417
2701
  * <p>The status of the directory settings for which to retrieve information.</p>
2418
2702
  */
2419
2703
  Status?: DirectoryConfigurationStatus | string;
2420
2704
  /**
2705
+ * @public
2421
2706
  * <p>The <code>DescribeSettingsResult.NextToken</code> value from a previous call to <a>DescribeSettings</a>. Pass null if this is the first call.</p>
2422
2707
  */
2423
2708
  NextToken?: string;
@@ -2428,11 +2713,13 @@ export interface DescribeSettingsRequest {
2428
2713
  */
2429
2714
  export interface SettingEntry {
2430
2715
  /**
2716
+ * @public
2431
2717
  * <p>The type, or category, of a directory setting. Similar settings have the same type. For example, <code>Protocol</code>, <code>Cipher</code>,
2432
2718
  * or <code>Certificate-Based Authentication</code>.</p>
2433
2719
  */
2434
2720
  Type?: string;
2435
2721
  /**
2722
+ * @public
2436
2723
  * <p>The name of the directory setting. For example:</p>
2437
2724
  * <p>
2438
2725
  * <code>TLS_1_0</code>
@@ -2440,38 +2727,47 @@ export interface SettingEntry {
2440
2727
  */
2441
2728
  Name?: string;
2442
2729
  /**
2730
+ * @public
2443
2731
  * <p>The valid range of values for the directory setting. These values depend on the <code>DataType</code> of your directory.</p>
2444
2732
  */
2445
2733
  AllowedValues?: string;
2446
2734
  /**
2735
+ * @public
2447
2736
  * <p>The value of the directory setting that is applied to the directory.</p>
2448
2737
  */
2449
2738
  AppliedValue?: string;
2450
2739
  /**
2740
+ * @public
2451
2741
  * <p>The value that was last requested for the directory setting.</p>
2452
2742
  */
2453
2743
  RequestedValue?: string;
2454
2744
  /**
2745
+ * @public
2455
2746
  * <p>The overall status of the request to update the directory setting request. If the directory setting is deployed in more than one region, and the request fails in any region, the overall status is <code>Failed</code>.</p>
2456
2747
  */
2457
2748
  RequestStatus?: DirectoryConfigurationStatus | string;
2458
2749
  /**
2750
+ * @public
2459
2751
  * <p>Details about the status of the request to update the directory setting. If the directory setting is deployed in more than one region, status is returned for the request in each region where the setting is deployed.</p>
2460
2752
  */
2461
2753
  RequestDetailedStatus?: Record<string, DirectoryConfigurationStatus | string>;
2462
2754
  /**
2755
+ * @public
2463
2756
  * <p>The last status message for the directory status request.</p>
2464
2757
  */
2465
2758
  RequestStatusMessage?: string;
2466
2759
  /**
2760
+ * @public
2467
2761
  * <p>The date and time when the directory setting was last updated.</p>
2468
2762
  */
2469
2763
  LastUpdatedDateTime?: Date;
2470
2764
  /**
2765
+ * @public
2471
2766
  * <p>The date and time when the request to update a directory setting was last submitted.</p>
2472
2767
  */
2473
2768
  LastRequestedDateTime?: Date;
2474
2769
  /**
2770
+ * @public
2475
2771
  * <p>The data type of a directory setting. This is used to define the <code>AllowedValues</code> of a setting.
2476
2772
  * For example a data type can be <code>Boolean</code>, <code>DurationInSeconds</code>, or <code>Enum</code>.</p>
2477
2773
  */
@@ -2482,10 +2778,12 @@ export interface SettingEntry {
2482
2778
  */
2483
2779
  export interface DescribeSettingsResult {
2484
2780
  /**
2781
+ * @public
2485
2782
  * <p>The identifier of the directory.</p>
2486
2783
  */
2487
2784
  DirectoryId?: string;
2488
2785
  /**
2786
+ * @public
2489
2787
  * <p>The list of <a>SettingEntry</a> objects that were retrieved.</p>
2490
2788
  * <p>It is possible that this list contains less than the number of items specified in the
2491
2789
  * <code>Limit</code> member of the request. This occurs if there are less than the requested
@@ -2494,6 +2792,7 @@ export interface DescribeSettingsResult {
2494
2792
  */
2495
2793
  SettingEntries?: SettingEntry[];
2496
2794
  /**
2795
+ * @public
2497
2796
  * <p>If not null, token that indicates that more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to <code>DescribeSettings</code> to retrieve the next set of items. </p>
2498
2797
  */
2499
2798
  NextToken?: string;
@@ -2503,19 +2802,23 @@ export interface DescribeSettingsResult {
2503
2802
  */
2504
2803
  export interface DescribeSharedDirectoriesRequest {
2505
2804
  /**
2805
+ * @public
2506
2806
  * <p>Returns the identifier of the directory in the directory owner account. </p>
2507
2807
  */
2508
2808
  OwnerDirectoryId: string | undefined;
2509
2809
  /**
2810
+ * @public
2510
2811
  * <p>A list of identifiers of all shared directories in your account. </p>
2511
2812
  */
2512
2813
  SharedDirectoryIds?: string[];
2513
2814
  /**
2815
+ * @public
2514
2816
  * <p>The <code>DescribeSharedDirectoriesResult.NextToken</code> value from a previous call to
2515
2817
  * <a>DescribeSharedDirectories</a>. Pass null if this is the first call. </p>
2516
2818
  */
2517
2819
  NextToken?: string;
2518
2820
  /**
2821
+ * @public
2519
2822
  * <p>The number of shared directories to return in the response object.</p>
2520
2823
  */
2521
2824
  Limit?: number;
@@ -2525,10 +2828,12 @@ export interface DescribeSharedDirectoriesRequest {
2525
2828
  */
2526
2829
  export interface DescribeSharedDirectoriesResult {
2527
2830
  /**
2831
+ * @public
2528
2832
  * <p>A list of all shared directories in your account.</p>
2529
2833
  */
2530
2834
  SharedDirectories?: SharedDirectory[];
2531
2835
  /**
2836
+ * @public
2532
2837
  * <p>If not null, token that indicates that more results are available. Pass this value for the
2533
2838
  * <code>NextToken</code> parameter in a subsequent call to <a>DescribeSharedDirectories</a> to retrieve the next set of items.</p>
2534
2839
  */
@@ -2540,21 +2845,25 @@ export interface DescribeSharedDirectoriesResult {
2540
2845
  */
2541
2846
  export interface DescribeSnapshotsRequest {
2542
2847
  /**
2848
+ * @public
2543
2849
  * <p>The identifier of the directory for which to retrieve snapshot information.</p>
2544
2850
  */
2545
2851
  DirectoryId?: string;
2546
2852
  /**
2853
+ * @public
2547
2854
  * <p>A list of identifiers of the snapshots to obtain the information for. If this member is
2548
2855
  * null or empty, all snapshots are returned using the <i>Limit</i> and <i>NextToken</i>
2549
2856
  * members.</p>
2550
2857
  */
2551
2858
  SnapshotIds?: string[];
2552
2859
  /**
2860
+ * @public
2553
2861
  * <p>The <i>DescribeSnapshotsResult.NextToken</i> value from a previous call to
2554
2862
  * <a>DescribeSnapshots</a>. Pass null if this is the first call.</p>
2555
2863
  */
2556
2864
  NextToken?: string;
2557
2865
  /**
2866
+ * @public
2558
2867
  * <p>The maximum number of objects to return.</p>
2559
2868
  */
2560
2869
  Limit?: number;
@@ -2590,26 +2899,32 @@ export type SnapshotType = (typeof SnapshotType)[keyof typeof SnapshotType];
2590
2899
  */
2591
2900
  export interface Snapshot {
2592
2901
  /**
2902
+ * @public
2593
2903
  * <p>The directory identifier.</p>
2594
2904
  */
2595
2905
  DirectoryId?: string;
2596
2906
  /**
2907
+ * @public
2597
2908
  * <p>The snapshot identifier.</p>
2598
2909
  */
2599
2910
  SnapshotId?: string;
2600
2911
  /**
2912
+ * @public
2601
2913
  * <p>The snapshot type.</p>
2602
2914
  */
2603
2915
  Type?: SnapshotType | string;
2604
2916
  /**
2917
+ * @public
2605
2918
  * <p>The descriptive name of the snapshot.</p>
2606
2919
  */
2607
2920
  Name?: string;
2608
2921
  /**
2922
+ * @public
2609
2923
  * <p>The snapshot status.</p>
2610
2924
  */
2611
2925
  Status?: SnapshotStatus | string;
2612
2926
  /**
2927
+ * @public
2613
2928
  * <p>The date and time that the snapshot was taken.</p>
2614
2929
  */
2615
2930
  StartTime?: Date;
@@ -2620,6 +2935,7 @@ export interface Snapshot {
2620
2935
  */
2621
2936
  export interface DescribeSnapshotsResult {
2622
2937
  /**
2938
+ * @public
2623
2939
  * <p>The list of <a>Snapshot</a> objects that were retrieved.</p>
2624
2940
  * <p>It is possible that this list contains less than the number of items specified in the
2625
2941
  * <i>Limit</i> member of the request. This occurs if there are less than the requested
@@ -2628,6 +2944,7 @@ export interface DescribeSnapshotsResult {
2628
2944
  */
2629
2945
  Snapshots?: Snapshot[];
2630
2946
  /**
2947
+ * @public
2631
2948
  * <p>If not null, more results are available. Pass this value in the <i>NextToken</i> member of
2632
2949
  * a subsequent call to <a>DescribeSnapshots</a>.</p>
2633
2950
  */
@@ -2641,11 +2958,13 @@ export interface DescribeSnapshotsResult {
2641
2958
  */
2642
2959
  export interface DescribeTrustsRequest {
2643
2960
  /**
2961
+ * @public
2644
2962
  * <p>The Directory ID of the Amazon Web Services directory that is a part of the requested trust
2645
2963
  * relationship.</p>
2646
2964
  */
2647
2965
  DirectoryId?: string;
2648
2966
  /**
2967
+ * @public
2649
2968
  * <p>A list of identifiers of the trust relationships for which to obtain the information. If
2650
2969
  * this member is null, all trust relationships that belong to the current account are
2651
2970
  * returned.</p>
@@ -2653,11 +2972,13 @@ export interface DescribeTrustsRequest {
2653
2972
  */
2654
2973
  TrustIds?: string[];
2655
2974
  /**
2975
+ * @public
2656
2976
  * <p>The <i>DescribeTrustsResult.NextToken</i> value from a previous call to
2657
2977
  * <a>DescribeTrusts</a>. Pass null if this is the first call.</p>
2658
2978
  */
2659
2979
  NextToken?: string;
2660
2980
  /**
2981
+ * @public
2661
2982
  * <p>The maximum number of objects to return.</p>
2662
2983
  */
2663
2984
  Limit?: number;
@@ -2690,47 +3011,58 @@ export type TrustState = (typeof TrustState)[keyof typeof TrustState];
2690
3011
  */
2691
3012
  export interface Trust {
2692
3013
  /**
3014
+ * @public
2693
3015
  * <p>The Directory ID of the Amazon Web Services directory involved in the trust relationship.</p>
2694
3016
  */
2695
3017
  DirectoryId?: string;
2696
3018
  /**
3019
+ * @public
2697
3020
  * <p>The unique ID of the trust relationship.</p>
2698
3021
  */
2699
3022
  TrustId?: string;
2700
3023
  /**
3024
+ * @public
2701
3025
  * <p>The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust
2702
3026
  * relationship.</p>
2703
3027
  */
2704
3028
  RemoteDomainName?: string;
2705
3029
  /**
3030
+ * @public
2706
3031
  * <p>The trust relationship type. <code>Forest</code> is the default.</p>
2707
3032
  */
2708
3033
  TrustType?: TrustType | string;
2709
3034
  /**
3035
+ * @public
2710
3036
  * <p>The trust relationship direction.</p>
2711
3037
  */
2712
3038
  TrustDirection?: TrustDirection | string;
2713
3039
  /**
3040
+ * @public
2714
3041
  * <p>The trust relationship state.</p>
2715
3042
  */
2716
3043
  TrustState?: TrustState | string;
2717
3044
  /**
3045
+ * @public
2718
3046
  * <p>The date and time that the trust relationship was created.</p>
2719
3047
  */
2720
3048
  CreatedDateTime?: Date;
2721
3049
  /**
3050
+ * @public
2722
3051
  * <p>The date and time that the trust relationship was last updated.</p>
2723
3052
  */
2724
3053
  LastUpdatedDateTime?: Date;
2725
3054
  /**
3055
+ * @public
2726
3056
  * <p>The date and time that the TrustState was last updated.</p>
2727
3057
  */
2728
3058
  StateLastUpdatedDateTime?: Date;
2729
3059
  /**
3060
+ * @public
2730
3061
  * <p>The reason for the TrustState.</p>
2731
3062
  */
2732
3063
  TrustStateReason?: string;
2733
3064
  /**
3065
+ * @public
2734
3066
  * <p>Current state of selective authentication for the trust.</p>
2735
3067
  */
2736
3068
  SelectiveAuth?: SelectiveAuth | string;
@@ -2741,6 +3073,7 @@ export interface Trust {
2741
3073
  */
2742
3074
  export interface DescribeTrustsResult {
2743
3075
  /**
3076
+ * @public
2744
3077
  * <p>The list of Trust objects that were retrieved.</p>
2745
3078
  * <p>It is possible that this list contains less than the number of items specified in the
2746
3079
  * <i>Limit</i> member of the request. This occurs if there are less than the
@@ -2749,6 +3082,7 @@ export interface DescribeTrustsResult {
2749
3082
  */
2750
3083
  Trusts?: Trust[];
2751
3084
  /**
3085
+ * @public
2752
3086
  * <p>If not null, more results are available. Pass this value for the
2753
3087
  * <i>NextToken</i> parameter in a subsequent call to <a>DescribeTrusts</a> to retrieve the next set of items.</p>
2754
3088
  */
@@ -2770,24 +3104,28 @@ export type UpdateType = (typeof UpdateType)[keyof typeof UpdateType];
2770
3104
  */
2771
3105
  export interface DescribeUpdateDirectoryRequest {
2772
3106
  /**
3107
+ * @public
2773
3108
  * <p>
2774
3109
  * The unique identifier of the directory.
2775
3110
  * </p>
2776
3111
  */
2777
3112
  DirectoryId: string | undefined;
2778
3113
  /**
3114
+ * @public
2779
3115
  * <p>
2780
3116
  * The type of updates you want to describe for the directory.
2781
3117
  * </p>
2782
3118
  */
2783
3119
  UpdateType: UpdateType | string | undefined;
2784
3120
  /**
3121
+ * @public
2785
3122
  * <p>
2786
3123
  * The name of the Region.
2787
3124
  * </p>
2788
3125
  */
2789
3126
  RegionName?: string;
2790
3127
  /**
3128
+ * @public
2791
3129
  * <p>
2792
3130
  * The <code>DescribeUpdateDirectoryResult</code>. NextToken value from a previous call to <a>DescribeUpdateDirectory</a>. Pass null if this is the first call.
2793
3131
  * </p>
@@ -2802,6 +3140,7 @@ export interface DescribeUpdateDirectoryRequest {
2802
3140
  */
2803
3141
  export interface OSUpdateSettings {
2804
3142
  /**
3143
+ * @public
2805
3144
  * <p>
2806
3145
  * OS version that the directory needs to be updated to.
2807
3146
  * </p>
@@ -2816,6 +3155,7 @@ export interface OSUpdateSettings {
2816
3155
  */
2817
3156
  export interface UpdateValue {
2818
3157
  /**
3158
+ * @public
2819
3159
  * <p>
2820
3160
  * The OS update related settings.
2821
3161
  * </p>
@@ -2843,48 +3183,56 @@ export type UpdateStatus = (typeof UpdateStatus)[keyof typeof UpdateStatus];
2843
3183
  */
2844
3184
  export interface UpdateInfoEntry {
2845
3185
  /**
3186
+ * @public
2846
3187
  * <p>
2847
3188
  * The name of the Region.
2848
3189
  * </p>
2849
3190
  */
2850
3191
  Region?: string;
2851
3192
  /**
3193
+ * @public
2852
3194
  * <p>
2853
3195
  * The status of the update performed on the directory.
2854
3196
  * </p>
2855
3197
  */
2856
3198
  Status?: UpdateStatus | string;
2857
3199
  /**
3200
+ * @public
2858
3201
  * <p>
2859
3202
  * The reason for the current status of the update type activity.
2860
3203
  * </p>
2861
3204
  */
2862
3205
  StatusReason?: string;
2863
3206
  /**
3207
+ * @public
2864
3208
  * <p>
2865
3209
  * This specifies if the update was initiated by the customer or by the service team.
2866
3210
  * </p>
2867
3211
  */
2868
3212
  InitiatedBy?: string;
2869
3213
  /**
3214
+ * @public
2870
3215
  * <p>
2871
3216
  * The new value of the target setting.
2872
3217
  * </p>
2873
3218
  */
2874
3219
  NewValue?: UpdateValue;
2875
3220
  /**
3221
+ * @public
2876
3222
  * <p>
2877
3223
  * The old value of the target setting.
2878
3224
  * </p>
2879
3225
  */
2880
3226
  PreviousValue?: UpdateValue;
2881
3227
  /**
3228
+ * @public
2882
3229
  * <p>
2883
3230
  * The start time of the <code>UpdateDirectorySetup</code> for the particular type.
2884
3231
  * </p>
2885
3232
  */
2886
3233
  StartTime?: Date;
2887
3234
  /**
3235
+ * @public
2888
3236
  * <p>
2889
3237
  * The last updated date and time of a particular directory setting.
2890
3238
  * </p>
@@ -2896,12 +3244,14 @@ export interface UpdateInfoEntry {
2896
3244
  */
2897
3245
  export interface DescribeUpdateDirectoryResult {
2898
3246
  /**
3247
+ * @public
2899
3248
  * <p>
2900
3249
  * The list of update activities on a directory for the requested update type.
2901
3250
  * </p>
2902
3251
  */
2903
3252
  UpdateActivities?: UpdateInfoEntry[];
2904
3253
  /**
3254
+ * @public
2905
3255
  * <p>
2906
3256
  * If not null, more results are available. Pass this value for the <code>NextToken</code> parameter.
2907
3257
  * </p>
@@ -2918,10 +3268,12 @@ export declare class DirectoryInDesiredStateException extends __BaseException {
2918
3268
  readonly name: "DirectoryInDesiredStateException";
2919
3269
  readonly $fault: "client";
2920
3270
  /**
3271
+ * @public
2921
3272
  * <p>The descriptive message for the exception.</p>
2922
3273
  */
2923
3274
  Message?: string;
2924
3275
  /**
3276
+ * @public
2925
3277
  * <p>The Amazon Web Services request identifier.</p>
2926
3278
  */
2927
3279
  RequestId?: string;
@@ -2936,38 +3288,47 @@ export declare class DirectoryInDesiredStateException extends __BaseException {
2936
3288
  */
2937
3289
  export interface DirectoryLimits {
2938
3290
  /**
3291
+ * @public
2939
3292
  * <p>The maximum number of cloud directories allowed in the Region.</p>
2940
3293
  */
2941
3294
  CloudOnlyDirectoriesLimit?: number;
2942
3295
  /**
3296
+ * @public
2943
3297
  * <p>The current number of cloud directories in the Region.</p>
2944
3298
  */
2945
3299
  CloudOnlyDirectoriesCurrentCount?: number;
2946
3300
  /**
3301
+ * @public
2947
3302
  * <p>Indicates if the cloud directory limit has been reached.</p>
2948
3303
  */
2949
3304
  CloudOnlyDirectoriesLimitReached?: boolean;
2950
3305
  /**
3306
+ * @public
2951
3307
  * <p>The maximum number of Managed Microsoft AD directories allowed in the region.</p>
2952
3308
  */
2953
3309
  CloudOnlyMicrosoftADLimit?: number;
2954
3310
  /**
3311
+ * @public
2955
3312
  * <p>The current number of Managed Microsoft AD directories in the region.</p>
2956
3313
  */
2957
3314
  CloudOnlyMicrosoftADCurrentCount?: number;
2958
3315
  /**
3316
+ * @public
2959
3317
  * <p>Indicates if the Managed Microsoft AD directory limit has been reached.</p>
2960
3318
  */
2961
3319
  CloudOnlyMicrosoftADLimitReached?: boolean;
2962
3320
  /**
3321
+ * @public
2963
3322
  * <p>The maximum number of connected directories allowed in the Region.</p>
2964
3323
  */
2965
3324
  ConnectedDirectoriesLimit?: number;
2966
3325
  /**
3326
+ * @public
2967
3327
  * <p>The current number of connected directories in the Region.</p>
2968
3328
  */
2969
3329
  ConnectedDirectoriesCurrentCount?: number;
2970
3330
  /**
3331
+ * @public
2971
3332
  * <p>Indicates if the connected directory limit has been reached.</p>
2972
3333
  */
2973
3334
  ConnectedDirectoriesLimitReached?: boolean;
@@ -2980,10 +3341,12 @@ export declare class DirectoryNotSharedException extends __BaseException {
2980
3341
  readonly name: "DirectoryNotSharedException";
2981
3342
  readonly $fault: "client";
2982
3343
  /**
3344
+ * @public
2983
3345
  * <p>The descriptive message for the exception.</p>
2984
3346
  */
2985
3347
  Message?: string;
2986
3348
  /**
3349
+ * @public
2987
3350
  * <p>The Amazon Web Services request identifier.</p>
2988
3351
  */
2989
3352
  RequestId?: string;
@@ -2997,10 +3360,12 @@ export declare class DirectoryNotSharedException extends __BaseException {
2997
3360
  */
2998
3361
  export interface DisableClientAuthenticationRequest {
2999
3362
  /**
3363
+ * @public
3000
3364
  * <p>The identifier of the directory </p>
3001
3365
  */
3002
3366
  DirectoryId: string | undefined;
3003
3367
  /**
3368
+ * @public
3004
3369
  * <p>The type of client authentication to disable. Currently, only the parameter, <code>SmartCard</code> is supported.</p>
3005
3370
  */
3006
3371
  Type: ClientAuthenticationType | string | undefined;
@@ -3018,10 +3383,12 @@ export declare class InvalidClientAuthStatusException extends __BaseException {
3018
3383
  readonly name: "InvalidClientAuthStatusException";
3019
3384
  readonly $fault: "client";
3020
3385
  /**
3386
+ * @public
3021
3387
  * <p>The descriptive message for the exception.</p>
3022
3388
  */
3023
3389
  Message?: string;
3024
3390
  /**
3391
+ * @public
3025
3392
  * <p>The Amazon Web Services request identifier.</p>
3026
3393
  */
3027
3394
  RequestId?: string;
@@ -3035,10 +3402,12 @@ export declare class InvalidClientAuthStatusException extends __BaseException {
3035
3402
  */
3036
3403
  export interface DisableLDAPSRequest {
3037
3404
  /**
3405
+ * @public
3038
3406
  * <p>The identifier of the directory.</p>
3039
3407
  */
3040
3408
  DirectoryId: string | undefined;
3041
3409
  /**
3410
+ * @public
3042
3411
  * <p>The type of LDAP security to enable. Currently only the value <code>Client</code> is
3043
3412
  * supported.</p>
3044
3413
  */
@@ -3058,10 +3427,12 @@ export declare class InvalidLDAPSStatusException extends __BaseException {
3058
3427
  readonly name: "InvalidLDAPSStatusException";
3059
3428
  readonly $fault: "client";
3060
3429
  /**
3430
+ * @public
3061
3431
  * <p>The descriptive message for the exception.</p>
3062
3432
  */
3063
3433
  Message?: string;
3064
3434
  /**
3435
+ * @public
3065
3436
  * <p>The Amazon Web Services request identifier.</p>
3066
3437
  */
3067
3438
  RequestId?: string;
@@ -3076,6 +3447,7 @@ export declare class InvalidLDAPSStatusException extends __BaseException {
3076
3447
  */
3077
3448
  export interface DisableRadiusRequest {
3078
3449
  /**
3450
+ * @public
3079
3451
  * <p>The identifier of the directory for which to disable MFA.</p>
3080
3452
  */
3081
3453
  DirectoryId: string | undefined;
@@ -3092,10 +3464,12 @@ export interface DisableRadiusResult {
3092
3464
  */
3093
3465
  export interface DisableSsoRequest {
3094
3466
  /**
3467
+ * @public
3095
3468
  * <p>The identifier of the directory for which to disable single-sign on.</p>
3096
3469
  */
3097
3470
  DirectoryId: string | undefined;
3098
3471
  /**
3472
+ * @public
3099
3473
  * <p>The username of an alternate account to use to disable single-sign on. This is only used
3100
3474
  * for AD Connector directories. This account must have privileges to remove a service
3101
3475
  * principal name.</p>
@@ -3107,6 +3481,7 @@ export interface DisableSsoRequest {
3107
3481
  */
3108
3482
  UserName?: string;
3109
3483
  /**
3484
+ * @public
3110
3485
  * <p>The password of an alternate account to use to disable single-sign on. This is only used
3111
3486
  * for AD Connector directories. For more information, see the <i>UserName</i>
3112
3487
  * parameter.</p>
@@ -3124,10 +3499,12 @@ export interface DisableSsoResult {
3124
3499
  */
3125
3500
  export interface EnableClientAuthenticationRequest {
3126
3501
  /**
3502
+ * @public
3127
3503
  * <p>The identifier of the specified directory. </p>
3128
3504
  */
3129
3505
  DirectoryId: string | undefined;
3130
3506
  /**
3507
+ * @public
3131
3508
  * <p>The type of client authentication to enable. Currently only the value <code>SmartCard</code> is
3132
3509
  * supported. Smart card authentication in AD Connector requires that you enable Kerberos
3133
3510
  * Constrained Delegation for the Service User to the LDAP service in your self-managed AD.
@@ -3149,10 +3526,12 @@ export declare class NoAvailableCertificateException extends __BaseException {
3149
3526
  readonly name: "NoAvailableCertificateException";
3150
3527
  readonly $fault: "client";
3151
3528
  /**
3529
+ * @public
3152
3530
  * <p>The descriptive message for the exception.</p>
3153
3531
  */
3154
3532
  Message?: string;
3155
3533
  /**
3534
+ * @public
3156
3535
  * <p>The Amazon Web Services request identifier.</p>
3157
3536
  */
3158
3537
  RequestId?: string;
@@ -3166,10 +3545,12 @@ export declare class NoAvailableCertificateException extends __BaseException {
3166
3545
  */
3167
3546
  export interface EnableLDAPSRequest {
3168
3547
  /**
3548
+ * @public
3169
3549
  * <p>The identifier of the directory.</p>
3170
3550
  */
3171
3551
  DirectoryId: string | undefined;
3172
3552
  /**
3553
+ * @public
3173
3554
  * <p>The type of LDAP security to enable. Currently only the value <code>Client</code> is
3174
3555
  * supported.</p>
3175
3556
  */
@@ -3186,10 +3567,12 @@ export interface EnableLDAPSResult {
3186
3567
  */
3187
3568
  export interface EnableRadiusRequest {
3188
3569
  /**
3570
+ * @public
3189
3571
  * <p>The identifier of the directory for which to enable MFA.</p>
3190
3572
  */
3191
3573
  DirectoryId: string | undefined;
3192
3574
  /**
3575
+ * @public
3193
3576
  * <p>A <a>RadiusSettings</a> object that contains information about the RADIUS
3194
3577
  * server.</p>
3195
3578
  */
@@ -3207,10 +3590,12 @@ export interface EnableRadiusResult {
3207
3590
  */
3208
3591
  export interface EnableSsoRequest {
3209
3592
  /**
3593
+ * @public
3210
3594
  * <p>The identifier of the directory for which to enable single-sign on.</p>
3211
3595
  */
3212
3596
  DirectoryId: string | undefined;
3213
3597
  /**
3598
+ * @public
3214
3599
  * <p>The username of an alternate account to use to enable single-sign on. This is only used
3215
3600
  * for AD Connector directories. This account must have privileges to add a service principal
3216
3601
  * name.</p>
@@ -3222,6 +3607,7 @@ export interface EnableSsoRequest {
3222
3607
  */
3223
3608
  UserName?: string;
3224
3609
  /**
3610
+ * @public
3225
3611
  * <p>The password of an alternate account to use to enable single-sign on. This is only used
3226
3612
  * for AD Connector directories. For more information, see the <i>UserName</i>
3227
3613
  * parameter.</p>
@@ -3246,6 +3632,7 @@ export interface GetDirectoryLimitsRequest {
3246
3632
  */
3247
3633
  export interface GetDirectoryLimitsResult {
3248
3634
  /**
3635
+ * @public
3249
3636
  * <p>A <a>DirectoryLimits</a> object that contains the directory limits for the
3250
3637
  * current Region.</p>
3251
3638
  */
@@ -3257,6 +3644,7 @@ export interface GetDirectoryLimitsResult {
3257
3644
  */
3258
3645
  export interface GetSnapshotLimitsRequest {
3259
3646
  /**
3647
+ * @public
3260
3648
  * <p>Contains the identifier of the directory to obtain the limits for.</p>
3261
3649
  */
3262
3650
  DirectoryId: string | undefined;
@@ -3267,14 +3655,17 @@ export interface GetSnapshotLimitsRequest {
3267
3655
  */
3268
3656
  export interface SnapshotLimits {
3269
3657
  /**
3658
+ * @public
3270
3659
  * <p>The maximum number of manual snapshots allowed.</p>
3271
3660
  */
3272
3661
  ManualSnapshotsLimit?: number;
3273
3662
  /**
3663
+ * @public
3274
3664
  * <p>The current number of manual snapshots of the directory.</p>
3275
3665
  */
3276
3666
  ManualSnapshotsCurrentCount?: number;
3277
3667
  /**
3668
+ * @public
3278
3669
  * <p>Indicates if the manual snapshot limit has been reached.</p>
3279
3670
  */
3280
3671
  ManualSnapshotsLimitReached?: boolean;
@@ -3285,6 +3676,7 @@ export interface SnapshotLimits {
3285
3676
  */
3286
3677
  export interface GetSnapshotLimitsResult {
3287
3678
  /**
3679
+ * @public
3288
3680
  * <p>A <a>SnapshotLimits</a> object that contains the manual snapshot limits for the specified
3289
3681
  * directory.</p>
3290
3682
  */
@@ -3295,10 +3687,12 @@ export interface GetSnapshotLimitsResult {
3295
3687
  */
3296
3688
  export interface ListCertificatesRequest {
3297
3689
  /**
3690
+ * @public
3298
3691
  * <p>The identifier of the directory.</p>
3299
3692
  */
3300
3693
  DirectoryId: string | undefined;
3301
3694
  /**
3695
+ * @public
3302
3696
  * <p>A token for requesting another page of certificates if the <code>NextToken</code> response
3303
3697
  * element indicates that more certificates are available. Use the value of the returned
3304
3698
  * <code>NextToken</code> element in your request until the token comes back as
@@ -3306,6 +3700,7 @@ export interface ListCertificatesRequest {
3306
3700
  */
3307
3701
  NextToken?: string;
3308
3702
  /**
3703
+ * @public
3309
3704
  * <p>The number of items that should show up on one page</p>
3310
3705
  */
3311
3706
  Limit?: number;
@@ -3315,11 +3710,13 @@ export interface ListCertificatesRequest {
3315
3710
  */
3316
3711
  export interface ListCertificatesResult {
3317
3712
  /**
3713
+ * @public
3318
3714
  * <p>Indicates whether another page of certificates is available when the number of available
3319
3715
  * certificates exceeds the page limit.</p>
3320
3716
  */
3321
3717
  NextToken?: string;
3322
3718
  /**
3719
+ * @public
3323
3720
  * <p>A list of certificates with basic details including certificate ID, certificate common
3324
3721
  * name, certificate state.</p>
3325
3722
  */
@@ -3330,15 +3727,18 @@ export interface ListCertificatesResult {
3330
3727
  */
3331
3728
  export interface ListIpRoutesRequest {
3332
3729
  /**
3730
+ * @public
3333
3731
  * <p>Identifier (ID) of the directory for which you want to retrieve the IP
3334
3732
  * addresses.</p>
3335
3733
  */
3336
3734
  DirectoryId: string | undefined;
3337
3735
  /**
3736
+ * @public
3338
3737
  * <p>The <i>ListIpRoutes.NextToken</i> value from a previous call to <a>ListIpRoutes</a>. Pass null if this is the first call.</p>
3339
3738
  */
3340
3739
  NextToken?: string;
3341
3740
  /**
3741
+ * @public
3342
3742
  * <p>Maximum number of items to return. If this value is zero, the maximum number of items
3343
3743
  * is specified by the limitations of the operation.</p>
3344
3744
  */
@@ -3366,26 +3766,32 @@ export type IpRouteStatusMsg = (typeof IpRouteStatusMsg)[keyof typeof IpRouteSta
3366
3766
  */
3367
3767
  export interface IpRouteInfo {
3368
3768
  /**
3769
+ * @public
3369
3770
  * <p>Identifier (ID) of the directory associated with the IP addresses.</p>
3370
3771
  */
3371
3772
  DirectoryId?: string;
3372
3773
  /**
3774
+ * @public
3373
3775
  * <p>IP address block in the <a>IpRoute</a>.</p>
3374
3776
  */
3375
3777
  CidrIp?: string;
3376
3778
  /**
3779
+ * @public
3377
3780
  * <p>The status of the IP address block.</p>
3378
3781
  */
3379
3782
  IpRouteStatusMsg?: IpRouteStatusMsg | string;
3380
3783
  /**
3784
+ * @public
3381
3785
  * <p>The date and time the address block was added to the directory.</p>
3382
3786
  */
3383
3787
  AddedDateTime?: Date;
3384
3788
  /**
3789
+ * @public
3385
3790
  * <p>The reason for the IpRouteStatusMsg.</p>
3386
3791
  */
3387
3792
  IpRouteStatusReason?: string;
3388
3793
  /**
3794
+ * @public
3389
3795
  * <p>Description of the <a>IpRouteInfo</a>.</p>
3390
3796
  */
3391
3797
  Description?: string;
@@ -3395,10 +3801,12 @@ export interface IpRouteInfo {
3395
3801
  */
3396
3802
  export interface ListIpRoutesResult {
3397
3803
  /**
3804
+ * @public
3398
3805
  * <p>A list of <a>IpRoute</a>s.</p>
3399
3806
  */
3400
3807
  IpRoutesInfo?: IpRouteInfo[];
3401
3808
  /**
3809
+ * @public
3402
3810
  * <p>If not null, more results are available. Pass this value for the
3403
3811
  * <i>NextToken</i> parameter in a subsequent call to <a>ListIpRoutes</a> to retrieve the next set of items.</p>
3404
3812
  */
@@ -3409,6 +3817,7 @@ export interface ListIpRoutesResult {
3409
3817
  */
3410
3818
  export interface ListLogSubscriptionsRequest {
3411
3819
  /**
3820
+ * @public
3412
3821
  * <p>If a <i>DirectoryID</i> is provided, lists only the log subscription
3413
3822
  * associated with that directory. If no <i>DirectoryId</i> is provided, lists all
3414
3823
  * log subscriptions associated with your Amazon Web Services account. If there are no log subscriptions for the
@@ -3416,10 +3825,12 @@ export interface ListLogSubscriptionsRequest {
3416
3825
  */
3417
3826
  DirectoryId?: string;
3418
3827
  /**
3828
+ * @public
3419
3829
  * <p>The token for the next set of items to return.</p>
3420
3830
  */
3421
3831
  NextToken?: string;
3422
3832
  /**
3833
+ * @public
3423
3834
  * <p>The maximum number of items returned.</p>
3424
3835
  */
3425
3836
  Limit?: number;
@@ -3431,15 +3842,18 @@ export interface ListLogSubscriptionsRequest {
3431
3842
  */
3432
3843
  export interface LogSubscription {
3433
3844
  /**
3845
+ * @public
3434
3846
  * <p>Identifier (ID) of the directory that you want to associate with the log
3435
3847
  * subscription.</p>
3436
3848
  */
3437
3849
  DirectoryId?: string;
3438
3850
  /**
3851
+ * @public
3439
3852
  * <p>The name of the log group.</p>
3440
3853
  */
3441
3854
  LogGroupName?: string;
3442
3855
  /**
3856
+ * @public
3443
3857
  * <p>The date and time that the log subscription was created.</p>
3444
3858
  */
3445
3859
  SubscriptionCreatedDateTime?: Date;
@@ -3449,10 +3863,12 @@ export interface LogSubscription {
3449
3863
  */
3450
3864
  export interface ListLogSubscriptionsResult {
3451
3865
  /**
3866
+ * @public
3452
3867
  * <p>A list of active <a>LogSubscription</a> objects for calling the Amazon Web Services account.</p>
3453
3868
  */
3454
3869
  LogSubscriptions?: LogSubscription[];
3455
3870
  /**
3871
+ * @public
3456
3872
  * <p>The token for the next set of items to return.</p>
3457
3873
  */
3458
3874
  NextToken?: string;
@@ -3462,16 +3878,19 @@ export interface ListLogSubscriptionsResult {
3462
3878
  */
3463
3879
  export interface ListSchemaExtensionsRequest {
3464
3880
  /**
3881
+ * @public
3465
3882
  * <p>The identifier of the directory from which to retrieve the schema extension
3466
3883
  * information.</p>
3467
3884
  */
3468
3885
  DirectoryId: string | undefined;
3469
3886
  /**
3887
+ * @public
3470
3888
  * <p>The <code>ListSchemaExtensions.NextToken</code> value from a previous call to
3471
3889
  * <code>ListSchemaExtensions</code>. Pass null if this is the first call.</p>
3472
3890
  */
3473
3891
  NextToken?: string;
3474
3892
  /**
3893
+ * @public
3475
3894
  * <p>The maximum number of items to return.</p>
3476
3895
  */
3477
3896
  Limit?: number;
@@ -3501,31 +3920,38 @@ export type SchemaExtensionStatus = (typeof SchemaExtensionStatus)[keyof typeof
3501
3920
  */
3502
3921
  export interface SchemaExtensionInfo {
3503
3922
  /**
3923
+ * @public
3504
3924
  * <p>The identifier of the directory to which the schema extension is applied.</p>
3505
3925
  */
3506
3926
  DirectoryId?: string;
3507
3927
  /**
3928
+ * @public
3508
3929
  * <p>The identifier of the schema extension.</p>
3509
3930
  */
3510
3931
  SchemaExtensionId?: string;
3511
3932
  /**
3933
+ * @public
3512
3934
  * <p>A description of the schema extension.</p>
3513
3935
  */
3514
3936
  Description?: string;
3515
3937
  /**
3938
+ * @public
3516
3939
  * <p>The current status of the schema extension.</p>
3517
3940
  */
3518
3941
  SchemaExtensionStatus?: SchemaExtensionStatus | string;
3519
3942
  /**
3943
+ * @public
3520
3944
  * <p>The reason for the <code>SchemaExtensionStatus</code>.</p>
3521
3945
  */
3522
3946
  SchemaExtensionStatusReason?: string;
3523
3947
  /**
3948
+ * @public
3524
3949
  * <p>The date and time that the schema extension started being applied to the
3525
3950
  * directory.</p>
3526
3951
  */
3527
3952
  StartDateTime?: Date;
3528
3953
  /**
3954
+ * @public
3529
3955
  * <p>The date and time that the schema extension was completed.</p>
3530
3956
  */
3531
3957
  EndDateTime?: Date;
@@ -3535,10 +3961,12 @@ export interface SchemaExtensionInfo {
3535
3961
  */
3536
3962
  export interface ListSchemaExtensionsResult {
3537
3963
  /**
3964
+ * @public
3538
3965
  * <p>Information about the schema extensions applied to the directory.</p>
3539
3966
  */
3540
3967
  SchemaExtensionsInfo?: SchemaExtensionInfo[];
3541
3968
  /**
3969
+ * @public
3542
3970
  * <p>If not null, more results are available. Pass this value for the <code>NextToken</code>
3543
3971
  * parameter in a subsequent call to <code>ListSchemaExtensions</code> to retrieve the next set
3544
3972
  * of items.</p>
@@ -3550,14 +3978,17 @@ export interface ListSchemaExtensionsResult {
3550
3978
  */
3551
3979
  export interface ListTagsForResourceRequest {
3552
3980
  /**
3981
+ * @public
3553
3982
  * <p>Identifier (ID) of the directory for which you want to retrieve tags.</p>
3554
3983
  */
3555
3984
  ResourceId: string | undefined;
3556
3985
  /**
3986
+ * @public
3557
3987
  * <p>Reserved for future use.</p>
3558
3988
  */
3559
3989
  NextToken?: string;
3560
3990
  /**
3991
+ * @public
3561
3992
  * <p>Reserved for future use.</p>
3562
3993
  */
3563
3994
  Limit?: number;
@@ -3567,10 +3998,12 @@ export interface ListTagsForResourceRequest {
3567
3998
  */
3568
3999
  export interface ListTagsForResourceResult {
3569
4000
  /**
4001
+ * @public
3570
4002
  * <p>List of tags returned by the ListTagsForResource operation.</p>
3571
4003
  */
3572
4004
  Tags?: Tag[];
3573
4005
  /**
4006
+ * @public
3574
4007
  * <p>Reserved for future use.</p>
3575
4008
  */
3576
4009
  NextToken?: string;
@@ -3583,10 +4016,12 @@ export declare class InvalidCertificateException extends __BaseException {
3583
4016
  readonly name: "InvalidCertificateException";
3584
4017
  readonly $fault: "client";
3585
4018
  /**
4019
+ * @public
3586
4020
  * <p>The descriptive message for the exception.</p>
3587
4021
  */
3588
4022
  Message?: string;
3589
4023
  /**
4024
+ * @public
3590
4025
  * <p>The Amazon Web Services request identifier.</p>
3591
4026
  */
3592
4027
  RequestId?: string;
@@ -3600,18 +4035,22 @@ export declare class InvalidCertificateException extends __BaseException {
3600
4035
  */
3601
4036
  export interface RegisterCertificateRequest {
3602
4037
  /**
4038
+ * @public
3603
4039
  * <p>The identifier of the directory.</p>
3604
4040
  */
3605
4041
  DirectoryId: string | undefined;
3606
4042
  /**
4043
+ * @public
3607
4044
  * <p>The certificate PEM string that needs to be registered.</p>
3608
4045
  */
3609
4046
  CertificateData: string | undefined;
3610
4047
  /**
4048
+ * @public
3611
4049
  * <p>The function that the registered certificate performs. Valid values include <code>ClientLDAPS</code> or <code>ClientCertAuth</code>. The default value is <code>ClientLDAPS</code>.</p>
3612
4050
  */
3613
4051
  Type?: CertificateType | string;
3614
4052
  /**
4053
+ * @public
3615
4054
  * <p>A <code>ClientCertAuthSettings</code> object that contains client certificate authentication settings.</p>
3616
4055
  */
3617
4056
  ClientCertAuthSettings?: ClientCertAuthSettings;
@@ -3621,6 +4060,7 @@ export interface RegisterCertificateRequest {
3621
4060
  */
3622
4061
  export interface RegisterCertificateResult {
3623
4062
  /**
4063
+ * @public
3624
4064
  * <p>The identifier of the certificate.</p>
3625
4065
  */
3626
4066
  CertificateId?: string;
@@ -3631,10 +4071,12 @@ export interface RegisterCertificateResult {
3631
4071
  */
3632
4072
  export interface RegisterEventTopicRequest {
3633
4073
  /**
4074
+ * @public
3634
4075
  * <p>The Directory ID that will publish status messages to the Amazon SNS topic.</p>
3635
4076
  */
3636
4077
  DirectoryId: string | undefined;
3637
4078
  /**
4079
+ * @public
3638
4080
  * <p>The Amazon SNS topic name to which the directory will publish status messages. This Amazon SNS
3639
4081
  * topic must be in the same region as the specified Directory ID.</p>
3640
4082
  */
@@ -3651,6 +4093,7 @@ export interface RegisterEventTopicResult {
3651
4093
  */
3652
4094
  export interface RejectSharedDirectoryRequest {
3653
4095
  /**
4096
+ * @public
3654
4097
  * <p>Identifier of the shared directory in the directory consumer account. This identifier is
3655
4098
  * different for each directory owner account.</p>
3656
4099
  */
@@ -3661,6 +4104,7 @@ export interface RejectSharedDirectoryRequest {
3661
4104
  */
3662
4105
  export interface RejectSharedDirectoryResult {
3663
4106
  /**
4107
+ * @public
3664
4108
  * <p>Identifier of the shared directory in the directory consumer account.</p>
3665
4109
  */
3666
4110
  SharedDirectoryId?: string;
@@ -3670,11 +4114,13 @@ export interface RejectSharedDirectoryResult {
3670
4114
  */
3671
4115
  export interface RemoveIpRoutesRequest {
3672
4116
  /**
4117
+ * @public
3673
4118
  * <p>Identifier (ID) of the directory from which you want to remove the IP
3674
4119
  * addresses.</p>
3675
4120
  */
3676
4121
  DirectoryId: string | undefined;
3677
4122
  /**
4123
+ * @public
3678
4124
  * <p>IP address blocks that you want to remove.</p>
3679
4125
  */
3680
4126
  CidrIps: string[] | undefined;
@@ -3689,6 +4135,7 @@ export interface RemoveIpRoutesResult {
3689
4135
  */
3690
4136
  export interface RemoveRegionRequest {
3691
4137
  /**
4138
+ * @public
3692
4139
  * <p>The identifier of the directory for which you want to remove Region replication.</p>
3693
4140
  */
3694
4141
  DirectoryId: string | undefined;
@@ -3703,10 +4150,12 @@ export interface RemoveRegionResult {
3703
4150
  */
3704
4151
  export interface RemoveTagsFromResourceRequest {
3705
4152
  /**
4153
+ * @public
3706
4154
  * <p>Identifier (ID) of the directory from which to remove the tag.</p>
3707
4155
  */
3708
4156
  ResourceId: string | undefined;
3709
4157
  /**
4158
+ * @public
3710
4159
  * <p>The tag key (name) of the tag to be removed.</p>
3711
4160
  */
3712
4161
  TagKeys: string[] | undefined;
@@ -3725,10 +4174,12 @@ export declare class InvalidPasswordException extends __BaseException {
3725
4174
  readonly name: "InvalidPasswordException";
3726
4175
  readonly $fault: "client";
3727
4176
  /**
4177
+ * @public
3728
4178
  * <p>The descriptive message for the exception.</p>
3729
4179
  */
3730
4180
  Message?: string;
3731
4181
  /**
4182
+ * @public
3732
4183
  * <p>The Amazon Web Services request identifier.</p>
3733
4184
  */
3734
4185
  RequestId?: string;
@@ -3742,15 +4193,18 @@ export declare class InvalidPasswordException extends __BaseException {
3742
4193
  */
3743
4194
  export interface ResetUserPasswordRequest {
3744
4195
  /**
4196
+ * @public
3745
4197
  * <p>Identifier of the Managed Microsoft AD or Simple AD directory in which the user
3746
4198
  * resides.</p>
3747
4199
  */
3748
4200
  DirectoryId: string | undefined;
3749
4201
  /**
4202
+ * @public
3750
4203
  * <p>The user name of the user whose password will be reset.</p>
3751
4204
  */
3752
4205
  UserName: string | undefined;
3753
4206
  /**
4207
+ * @public
3754
4208
  * <p>The new password that will be reset.</p>
3755
4209
  */
3756
4210
  NewPassword: string | undefined;
@@ -3768,10 +4222,12 @@ export declare class UserDoesNotExistException extends __BaseException {
3768
4222
  readonly name: "UserDoesNotExistException";
3769
4223
  readonly $fault: "client";
3770
4224
  /**
4225
+ * @public
3771
4226
  * <p>The descriptive message for the exception.</p>
3772
4227
  */
3773
4228
  Message?: string;
3774
4229
  /**
4230
+ * @public
3775
4231
  * <p>The Amazon Web Services request identifier.</p>
3776
4232
  */
3777
4233
  RequestId?: string;
@@ -3786,6 +4242,7 @@ export declare class UserDoesNotExistException extends __BaseException {
3786
4242
  */
3787
4243
  export interface RestoreFromSnapshotRequest {
3788
4244
  /**
4245
+ * @public
3789
4246
  * <p>The identifier of the snapshot to restore from.</p>
3790
4247
  */
3791
4248
  SnapshotId: string | undefined;
@@ -3804,10 +4261,12 @@ export declare class InvalidTargetException extends __BaseException {
3804
4261
  readonly name: "InvalidTargetException";
3805
4262
  readonly $fault: "client";
3806
4263
  /**
4264
+ * @public
3807
4265
  * <p>The descriptive message for the exception.</p>
3808
4266
  */
3809
4267
  Message?: string;
3810
4268
  /**
4269
+ * @public
3811
4270
  * <p>The Amazon Web Services request identifier.</p>
3812
4271
  */
3813
4272
  RequestId?: string;
@@ -3824,10 +4283,12 @@ export declare class OrganizationsException extends __BaseException {
3824
4283
  readonly name: "OrganizationsException";
3825
4284
  readonly $fault: "client";
3826
4285
  /**
4286
+ * @public
3827
4287
  * <p>The descriptive message for the exception.</p>
3828
4288
  */
3829
4289
  Message?: string;
3830
4290
  /**
4291
+ * @public
3831
4292
  * <p>The Amazon Web Services request identifier.</p>
3832
4293
  */
3833
4294
  RequestId?: string;
@@ -3853,10 +4314,12 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
3853
4314
  */
3854
4315
  export interface ShareTarget {
3855
4316
  /**
4317
+ * @public
3856
4318
  * <p>Identifier of the directory consumer account.</p>
3857
4319
  */
3858
4320
  Id: string | undefined;
3859
4321
  /**
4322
+ * @public
3860
4323
  * <p>Type of identifier to be used in the <code>Id</code> field.</p>
3861
4324
  */
3862
4325
  Type: TargetType | string | undefined;
@@ -3866,21 +4329,25 @@ export interface ShareTarget {
3866
4329
  */
3867
4330
  export interface ShareDirectoryRequest {
3868
4331
  /**
4332
+ * @public
3869
4333
  * <p>Identifier of the Managed Microsoft AD directory that you want to share with other Amazon Web Services accounts.</p>
3870
4334
  */
3871
4335
  DirectoryId: string | undefined;
3872
4336
  /**
4337
+ * @public
3873
4338
  * <p>A directory share request that is sent by the directory owner to the directory consumer.
3874
4339
  * The request includes a typed message to help the directory consumer administrator determine
3875
4340
  * whether to approve or reject the share invitation.</p>
3876
4341
  */
3877
4342
  ShareNotes?: string;
3878
4343
  /**
4344
+ * @public
3879
4345
  * <p>Identifier for the directory consumer account with whom the directory is to be
3880
4346
  * shared.</p>
3881
4347
  */
3882
4348
  ShareTarget: ShareTarget | undefined;
3883
4349
  /**
4350
+ * @public
3884
4351
  * <p>The method used when sharing a directory to determine whether the directory should be
3885
4352
  * shared within your Amazon Web Services organization (<code>ORGANIZATIONS</code>) or with any Amazon Web Services account by
3886
4353
  * sending a directory sharing request (<code>HANDSHAKE</code>).</p>
@@ -3892,6 +4359,7 @@ export interface ShareDirectoryRequest {
3892
4359
  */
3893
4360
  export interface ShareDirectoryResult {
3894
4361
  /**
4362
+ * @public
3895
4363
  * <p>Identifier of the directory that is stored in the directory consumer account that is
3896
4364
  * shared from the specified directory (<code>DirectoryId</code>).</p>
3897
4365
  */
@@ -3906,10 +4374,12 @@ export declare class ShareLimitExceededException extends __BaseException {
3906
4374
  readonly name: "ShareLimitExceededException";
3907
4375
  readonly $fault: "client";
3908
4376
  /**
4377
+ * @public
3909
4378
  * <p>The descriptive message for the exception.</p>
3910
4379
  */
3911
4380
  Message?: string;
3912
4381
  /**
4382
+ * @public
3913
4383
  * <p>The Amazon Web Services request identifier.</p>
3914
4384
  */
3915
4385
  RequestId?: string;
@@ -3923,22 +4393,26 @@ export declare class ShareLimitExceededException extends __BaseException {
3923
4393
  */
3924
4394
  export interface StartSchemaExtensionRequest {
3925
4395
  /**
4396
+ * @public
3926
4397
  * <p>The identifier of the directory for which the schema extension will be applied
3927
4398
  * to.</p>
3928
4399
  */
3929
4400
  DirectoryId: string | undefined;
3930
4401
  /**
4402
+ * @public
3931
4403
  * <p>If true, creates a snapshot of the directory before applying the schema
3932
4404
  * extension.</p>
3933
4405
  */
3934
4406
  CreateSnapshotBeforeSchemaExtension: boolean | undefined;
3935
4407
  /**
4408
+ * @public
3936
4409
  * <p>The LDIF file represented as a string. To construct the LdifContent string, precede
3937
4410
  * each line as it would be formatted in an ldif file with \n. See the example request below for
3938
4411
  * more details. The file size can be no larger than 1MB.</p>
3939
4412
  */
3940
4413
  LdifContent: string | undefined;
3941
4414
  /**
4415
+ * @public
3942
4416
  * <p>A description of the schema extension.</p>
3943
4417
  */
3944
4418
  Description: string | undefined;
@@ -3948,6 +4422,7 @@ export interface StartSchemaExtensionRequest {
3948
4422
  */
3949
4423
  export interface StartSchemaExtensionResult {
3950
4424
  /**
4425
+ * @public
3951
4426
  * <p>The identifier of the schema extension that will be applied.</p>
3952
4427
  */
3953
4428
  SchemaExtensionId?: string;
@@ -3959,10 +4434,12 @@ export interface StartSchemaExtensionResult {
3959
4434
  */
3960
4435
  export interface UnshareTarget {
3961
4436
  /**
4437
+ * @public
3962
4438
  * <p>Identifier of the directory consumer account.</p>
3963
4439
  */
3964
4440
  Id: string | undefined;
3965
4441
  /**
4442
+ * @public
3966
4443
  * <p>Type of identifier to be used in the <i>Id</i> field.</p>
3967
4444
  */
3968
4445
  Type: TargetType | string | undefined;
@@ -3972,11 +4449,13 @@ export interface UnshareTarget {
3972
4449
  */
3973
4450
  export interface UnshareDirectoryRequest {
3974
4451
  /**
4452
+ * @public
3975
4453
  * <p>The identifier of the Managed Microsoft AD directory that you want to stop
3976
4454
  * sharing.</p>
3977
4455
  */
3978
4456
  DirectoryId: string | undefined;
3979
4457
  /**
4458
+ * @public
3980
4459
  * <p>Identifier for the directory consumer account with whom the directory has to be
3981
4460
  * unshared.</p>
3982
4461
  */
@@ -3987,6 +4466,7 @@ export interface UnshareDirectoryRequest {
3987
4466
  */
3988
4467
  export interface UnshareDirectoryResult {
3989
4468
  /**
4469
+ * @public
3990
4470
  * <p>Identifier of the directory stored in the directory consumer account that is to be
3991
4471
  * unshared from the specified directory (<code>DirectoryId</code>).</p>
3992
4472
  */
@@ -3998,16 +4478,19 @@ export interface UnshareDirectoryResult {
3998
4478
  */
3999
4479
  export interface UpdateConditionalForwarderRequest {
4000
4480
  /**
4481
+ * @public
4001
4482
  * <p>The directory ID of the Amazon Web Services directory for which to update the conditional
4002
4483
  * forwarder.</p>
4003
4484
  */
4004
4485
  DirectoryId: string | undefined;
4005
4486
  /**
4487
+ * @public
4006
4488
  * <p>The fully qualified domain name (FQDN) of the remote domain with which you will set up
4007
4489
  * a trust relationship.</p>
4008
4490
  */
4009
4491
  RemoteDomainName: string | undefined;
4010
4492
  /**
4493
+ * @public
4011
4494
  * <p>The updated IP addresses of the remote DNS server associated with the conditional
4012
4495
  * forwarder.</p>
4013
4496
  */
@@ -4024,24 +4507,28 @@ export interface UpdateConditionalForwarderResult {
4024
4507
  */
4025
4508
  export interface UpdateDirectorySetupRequest {
4026
4509
  /**
4510
+ * @public
4027
4511
  * <p>
4028
4512
  * The identifier of the directory on which you want to perform the update.
4029
4513
  * </p>
4030
4514
  */
4031
4515
  DirectoryId: string | undefined;
4032
4516
  /**
4517
+ * @public
4033
4518
  * <p>
4034
4519
  * The type of update that needs to be performed on the directory. For example, OS.
4035
4520
  * </p>
4036
4521
  */
4037
4522
  UpdateType: UpdateType | string | undefined;
4038
4523
  /**
4524
+ * @public
4039
4525
  * <p>
4040
4526
  * The settings for the OS update that needs to be performed on the directory.
4041
4527
  * </p>
4042
4528
  */
4043
4529
  OSUpdateSettings?: OSUpdateSettings;
4044
4530
  /**
4531
+ * @public
4045
4532
  * <p>
4046
4533
  * The boolean that specifies if a snapshot for the directory needs to be taken before updating the directory.
4047
4534
  * </p>
@@ -4062,10 +4549,12 @@ export declare class DomainControllerLimitExceededException extends __BaseExcept
4062
4549
  readonly name: "DomainControllerLimitExceededException";
4063
4550
  readonly $fault: "client";
4064
4551
  /**
4552
+ * @public
4065
4553
  * <p>The descriptive message for the exception.</p>
4066
4554
  */
4067
4555
  Message?: string;
4068
4556
  /**
4557
+ * @public
4069
4558
  * <p>The Amazon Web Services request identifier.</p>
4070
4559
  */
4071
4560
  RequestId?: string;
@@ -4079,11 +4568,13 @@ export declare class DomainControllerLimitExceededException extends __BaseExcept
4079
4568
  */
4080
4569
  export interface UpdateNumberOfDomainControllersRequest {
4081
4570
  /**
4571
+ * @public
4082
4572
  * <p>Identifier of the directory to which the domain controllers will be added or
4083
4573
  * removed.</p>
4084
4574
  */
4085
4575
  DirectoryId: string | undefined;
4086
4576
  /**
4577
+ * @public
4087
4578
  * <p>The number of domain controllers desired in the directory.</p>
4088
4579
  */
4089
4580
  DesiredNumber: number | undefined;
@@ -4099,11 +4590,13 @@ export interface UpdateNumberOfDomainControllersResult {
4099
4590
  */
4100
4591
  export interface UpdateRadiusRequest {
4101
4592
  /**
4593
+ * @public
4102
4594
  * <p>The identifier of the directory for which to update the RADIUS server
4103
4595
  * information.</p>
4104
4596
  */
4105
4597
  DirectoryId: string | undefined;
4106
4598
  /**
4599
+ * @public
4107
4600
  * <p>A <a>RadiusSettings</a> object that contains information about the RADIUS
4108
4601
  * server.</p>
4109
4602
  */
@@ -4123,10 +4616,12 @@ export declare class IncompatibleSettingsException extends __BaseException {
4123
4616
  readonly name: "IncompatibleSettingsException";
4124
4617
  readonly $fault: "client";
4125
4618
  /**
4619
+ * @public
4126
4620
  * <p>The descriptive message for the exception.</p>
4127
4621
  */
4128
4622
  Message?: string;
4129
4623
  /**
4624
+ * @public
4130
4625
  * <p>The Amazon Web Services request identifier.</p>
4131
4626
  */
4132
4627
  RequestId?: string;
@@ -4143,10 +4638,12 @@ export declare class UnsupportedSettingsException extends __BaseException {
4143
4638
  readonly name: "UnsupportedSettingsException";
4144
4639
  readonly $fault: "client";
4145
4640
  /**
4641
+ * @public
4146
4642
  * <p>The descriptive message for the exception.</p>
4147
4643
  */
4148
4644
  Message?: string;
4149
4645
  /**
4646
+ * @public
4150
4647
  * <p>The Amazon Web Services request identifier.</p>
4151
4648
  */
4152
4649
  RequestId?: string;
@@ -4161,6 +4658,7 @@ export declare class UnsupportedSettingsException extends __BaseException {
4161
4658
  */
4162
4659
  export interface Setting {
4163
4660
  /**
4661
+ * @public
4164
4662
  * <p>The name of the directory setting. For example:</p>
4165
4663
  * <p>
4166
4664
  * <code>TLS_1_0</code>
@@ -4168,6 +4666,7 @@ export interface Setting {
4168
4666
  */
4169
4667
  Name: string | undefined;
4170
4668
  /**
4669
+ * @public
4171
4670
  * <p>The value of the directory setting for which to retrieve information. For example, for <code>TLS_1_0</code>, the valid values are: <code>Enable</code> and <code>Disable</code>.</p>
4172
4671
  */
4173
4672
  Value: string | undefined;
@@ -4177,10 +4676,12 @@ export interface Setting {
4177
4676
  */
4178
4677
  export interface UpdateSettingsRequest {
4179
4678
  /**
4679
+ * @public
4180
4680
  * <p>The identifier of the directory for which to update settings.</p>
4181
4681
  */
4182
4682
  DirectoryId: string | undefined;
4183
4683
  /**
4684
+ * @public
4184
4685
  * <p>The list of <a>Setting</a> objects.</p>
4185
4686
  */
4186
4687
  Settings: Setting[] | undefined;
@@ -4190,6 +4691,7 @@ export interface UpdateSettingsRequest {
4190
4691
  */
4191
4692
  export interface UpdateSettingsResult {
4192
4693
  /**
4694
+ * @public
4193
4695
  * <p>The identifier of the directory.</p>
4194
4696
  */
4195
4697
  DirectoryId?: string;
@@ -4199,10 +4701,12 @@ export interface UpdateSettingsResult {
4199
4701
  */
4200
4702
  export interface UpdateTrustRequest {
4201
4703
  /**
4704
+ * @public
4202
4705
  * <p>Identifier of the trust relationship.</p>
4203
4706
  */
4204
4707
  TrustId: string | undefined;
4205
4708
  /**
4709
+ * @public
4206
4710
  * <p>Updates selective authentication for the trust.</p>
4207
4711
  */
4208
4712
  SelectiveAuth?: SelectiveAuth | string;
@@ -4212,10 +4716,12 @@ export interface UpdateTrustRequest {
4212
4716
  */
4213
4717
  export interface UpdateTrustResult {
4214
4718
  /**
4719
+ * @public
4215
4720
  * <p>The Amazon Web Services request identifier.</p>
4216
4721
  */
4217
4722
  RequestId?: string;
4218
4723
  /**
4724
+ * @public
4219
4725
  * <p>Identifier of the trust relationship.</p>
4220
4726
  */
4221
4727
  TrustId?: string;
@@ -4227,6 +4733,7 @@ export interface UpdateTrustResult {
4227
4733
  */
4228
4734
  export interface VerifyTrustRequest {
4229
4735
  /**
4736
+ * @public
4230
4737
  * <p>The unique Trust ID of the trust relationship to verify.</p>
4231
4738
  */
4232
4739
  TrustId: string | undefined;
@@ -4237,6 +4744,7 @@ export interface VerifyTrustRequest {
4237
4744
  */
4238
4745
  export interface VerifyTrustResult {
4239
4746
  /**
4747
+ * @public
4240
4748
  * <p>The unique Trust ID of the trust relationship that was verified.</p>
4241
4749
  */
4242
4750
  TrustId?: string;