/
ds-2015-04-16.normal.json
3079 lines (3079 loc) · 117 KB
/
ds-2015-04-16.normal.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-04-16",
"endpointPrefix":"ds",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Directory Service",
"serviceFullName":"AWS Directory Service",
"serviceId":"Directory Service",
"signatureVersion":"v4",
"targetPrefix":"DirectoryService_20150416",
"uid":"ds-2015-04-16"
},
"operations":{
"AddIpRoutes":{
"name":"AddIpRoutes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddIpRoutesRequest"},
"output":{"shape":"AddIpRoutesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"InvalidParameterException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"IpRouteLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. <i>AddIpRoutes</i> adds this address block. You can also use <i>AddIpRoutes</i> to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC. </p> <p>Before you call <i>AddIpRoutes</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>AddIpRoutes</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"AddTagsToResource":{
"name":"AddTagsToResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToResourceRequest"},
"output":{"shape":"AddTagsToResourceResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"TagLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.</p>"
},
"CancelSchemaExtension":{
"name":"CancelSchemaExtension",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CancelSchemaExtensionRequest"},
"output":{"shape":"CancelSchemaExtensionResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; <code>Initializing</code>, <code>CreatingSnapshot</code>, and <code>UpdatingSchema</code>.</p>"
},
"ConnectDirectory":{
"name":"ConnectDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ConnectDirectoryRequest"},
"output":{"shape":"ConnectDirectoryResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates an AD Connector to connect to an on-premises directory.</p> <p>Before you call <i>ConnectDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>ConnectDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateAlias":{
"name":"CreateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAliasRequest"},
"output":{"shape":"CreateAliasResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as <code>http://<alias>.awsapps.com</code>.</p> <important> <p>After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.</p> </important>"
},
"CreateComputer":{
"name":"CreateComputer",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateComputerRequest"},
"output":{"shape":"CreateComputerResult"},
"errors":[
{"shape":"AuthenticationFailedException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a computer account in the specified directory, and joins the computer to the directory.</p>"
},
"CreateConditionalForwarder":{
"name":"CreateConditionalForwarder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConditionalForwarderRequest"},
"output":{"shape":"CreateConditionalForwarderResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.</p>"
},
"CreateDirectory":{
"name":"CreateDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDirectoryRequest"},
"output":{"shape":"CreateDirectoryResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a Simple AD directory.</p> <p>Before you call <i>CreateDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateMicrosoftAD":{
"name":"CreateMicrosoftAD",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateMicrosoftADRequest"},
"output":{"shape":"CreateMicrosoftADResult"},
"errors":[
{"shape":"DirectoryLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Creates a Microsoft AD in the AWS cloud.</p> <p>Before you call <i>CreateMicrosoftAD</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>CreateMicrosoftAD</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"CreateSnapshot":{
"name":"CreateSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSnapshotRequest"},
"output":{"shape":"CreateSnapshotResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"SnapshotLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.</p> <note> <p>You cannot take snapshots of AD Connector directories.</p> </note>"
},
"CreateTrust":{
"name":"CreateTrust",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTrustRequest"},
"output":{"shape":"CreateTrustResult"},
"errors":[
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your Microsoft AD in the AWS cloud, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.</p> <p>This action initiates the creation of the AWS side of a trust relationship between a Microsoft AD in the AWS cloud and an external domain.</p>"
},
"DeleteConditionalForwarder":{
"name":"DeleteConditionalForwarder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConditionalForwarderRequest"},
"output":{"shape":"DeleteConditionalForwarderResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes a conditional forwarder that has been set up for your AWS directory.</p>"
},
"DeleteDirectory":{
"name":"DeleteDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDirectoryRequest"},
"output":{"shape":"DeleteDirectoryResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes an AWS Directory Service directory.</p> <p>Before you call <i>DeleteDirectory</i>, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the <i>DeleteDirectory</i> operation, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/UsingWithDS_IAM_ResourcePermissions.html\">AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference</a>.</p>"
},
"DeleteSnapshot":{
"name":"DeleteSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSnapshotRequest"},
"output":{"shape":"DeleteSnapshotResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Deletes a directory snapshot.</p>"
},
"DeleteTrust":{
"name":"DeleteTrust",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTrustRequest"},
"output":{"shape":"DeleteTrustResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Deletes an existing trust relationship between your Microsoft AD in the AWS cloud and an external domain.</p>"
},
"DeregisterEventTopic":{
"name":"DeregisterEventTopic",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterEventTopicRequest"},
"output":{"shape":"DeregisterEventTopicResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Removes the specified directory as a publisher to the specified SNS topic.</p>"
},
"DescribeConditionalForwarders":{
"name":"DescribeConditionalForwarders",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConditionalForwardersRequest"},
"output":{"shape":"DescribeConditionalForwardersResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about the conditional forwarders for this account.</p> <p>If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.</p>"
},
"DescribeDirectories":{
"name":"DescribeDirectories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectoriesRequest"},
"output":{"shape":"DescribeDirectoriesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about the directories that belong to this account.</p> <p>You can retrieve information about specific directories by passing the directory identifiers in the <i>DirectoryIds</i> parameter. Otherwise, all directories that belong to the current account are returned.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeDirectoriesResult.NextToken</i> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items.</p> <p>You can also specify a maximum number of return results with the <i>Limit</i> parameter.</p>"
},
"DescribeDomainControllers":{
"name":"DescribeDomainControllers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDomainControllersRequest"},
"output":{"shape":"DescribeDomainControllersResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Provides information about any domain controllers in your directory.</p>"
},
"DescribeEventTopics":{
"name":"DescribeEventTopics",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEventTopicsRequest"},
"output":{"shape":"DescribeEventTopicsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about which SNS topics receive status messages from the specified directory.</p> <p>If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.</p>"
},
"DescribeSnapshots":{
"name":"DescribeSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSnapshotsRequest"},
"output":{"shape":"DescribeSnapshotsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains information about the directory snapshots that belong to this account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> request and response parameters. If more results are available, the <i>DescribeSnapshots.NextToken</i> member contains a token that you pass in the next call to <a>DescribeSnapshots</a> to retrieve the next set of items.</p> <p>You can also specify a maximum number of return results with the <i>Limit</i> parameter.</p>"
},
"DescribeTrusts":{
"name":"DescribeTrusts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTrustsRequest"},
"output":{"shape":"DescribeTrustsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>Obtains information about the trust relationships for this account.</p> <p>If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.</p>"
},
"DisableRadius":{
"name":"DisableRadius",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableRadiusRequest"},
"output":{"shape":"DisableRadiusResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.</p>"
},
"DisableSso":{
"name":"DisableSso",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisableSsoRequest"},
"output":{"shape":"DisableSsoResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InsufficientPermissionsException"},
{"shape":"AuthenticationFailedException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Disables single-sign on for a directory.</p>"
},
"EnableRadius":{
"name":"EnableRadius",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableRadiusRequest"},
"output":{"shape":"EnableRadiusResult"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"EntityAlreadyExistsException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector directory.</p>"
},
"EnableSso":{
"name":"EnableSso",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"EnableSsoRequest"},
"output":{"shape":"EnableSsoResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InsufficientPermissionsException"},
{"shape":"AuthenticationFailedException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Enables single sign-on for a directory.</p>"
},
"GetDirectoryLimits":{
"name":"GetDirectoryLimits",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDirectoryLimitsRequest"},
"output":{"shape":"GetDirectoryLimitsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains directory limit information for the current region.</p>"
},
"GetSnapshotLimits":{
"name":"GetSnapshotLimits",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetSnapshotLimitsRequest"},
"output":{"shape":"GetSnapshotLimitsResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Obtains the manual snapshot limits for a directory.</p>"
},
"ListIpRoutes":{
"name":"ListIpRoutes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListIpRoutesRequest"},
"output":{"shape":"ListIpRoutesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Lists the address blocks that you have added to a directory.</p>"
},
"ListSchemaExtensions":{
"name":"ListSchemaExtensions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListSchemaExtensionsRequest"},
"output":{"shape":"ListSchemaExtensionsResult"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Lists all schema extensions applied to a Microsoft AD Directory.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Lists all tags on a directory.</p>"
},
"RegisterEventTopic":{
"name":"RegisterEventTopic",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterEventTopicRequest"},
"output":{"shape":"RegisterEventTopicResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.</p>"
},
"RemoveIpRoutes":{
"name":"RemoveIpRoutes",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveIpRoutesRequest"},
"output":{"shape":"RemoveIpRoutesResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Removes IP address blocks from a directory.</p>"
},
"RemoveTagsFromResource":{
"name":"RemoveTagsFromResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromResourceRequest"},
"output":{"shape":"RemoveTagsFromResourceResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Removes tags from a directory.</p>"
},
"ResetUserPassword":{
"name":"ResetUserPassword",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResetUserPasswordRequest"},
"output":{"shape":"ResetUserPasswordResult"},
"errors":[
{"shape":"DirectoryUnavailableException"},
{"shape":"UserDoesNotExistException"},
{"shape":"InvalidPasswordException"},
{"shape":"UnsupportedOperationException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.</p>"
},
"RestoreFromSnapshot":{
"name":"RestoreFromSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreFromSnapshotRequest"},
"output":{"shape":"RestoreFromSnapshotResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Restores a directory using an existing directory snapshot.</p> <p>When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.</p> <p>This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the <a>DescribeDirectories</a> operation with the directory identifier. When the <b>DirectoryDescription.Stage</b> value changes to <code>Active</code>, the restore operation is complete.</p>"
},
"StartSchemaExtension":{
"name":"StartSchemaExtension",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartSchemaExtensionRequest"},
"output":{"shape":"StartSchemaExtensionResult"},
"errors":[
{"shape":"DirectoryUnavailableException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"SnapshotLimitExceededException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Applies a schema extension to a Microsoft AD directory.</p>"
},
"UpdateConditionalForwarder":{
"name":"UpdateConditionalForwarder",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateConditionalForwarderRequest"},
"output":{"shape":"UpdateConditionalForwarderResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Updates a conditional forwarder that has been set up for your AWS directory.</p>"
},
"UpdateNumberOfDomainControllers":{
"name":"UpdateNumberOfDomainControllers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateNumberOfDomainControllersRequest"},
"output":{"shape":"UpdateNumberOfDomainControllersResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"DirectoryUnavailableException"},
{"shape":"DomainControllerLimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"UnsupportedOperationException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.</p>"
},
"UpdateRadius":{
"name":"UpdateRadius",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateRadiusRequest"},
"output":{"shape":"UpdateRadiusResult"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"EntityDoesNotExistException"},
{"shape":"ClientException"},
{"shape":"ServiceException"}
],
"documentation":"<p>Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector directory.</p>"
},
"VerifyTrust":{
"name":"VerifyTrust",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"VerifyTrustRequest"},
"output":{"shape":"VerifyTrustResult"},
"errors":[
{"shape":"EntityDoesNotExistException"},
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServiceException"},
{"shape":"UnsupportedOperationException"}
],
"documentation":"<p>AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.</p> <p>This action verifies a trust relationship between your Microsoft AD in the AWS cloud and an external domain.</p>"
}
},
"shapes":{
"AccessUrl":{
"type":"string",
"max":128,
"min":1
},
"AddIpRoutesRequest":{
"type":"structure",
"required":[
"DirectoryId",
"IpRoutes"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Identifier (ID) of the directory to which to add the address block.</p>"
},
"IpRoutes":{
"shape":"IpRoutes",
"documentation":"<p>IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.</p>"
},
"UpdateSecurityGroupForDirectoryControllers":{
"shape":"UpdateSecurityGroupForDirectoryControllers",
"documentation":"<p>If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for <i>directory ID</i> directory controllers.\" Following are the new rules: </p> <p>Inbound:</p> <ul> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0</p> </li> <li> <p>Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0</p> </li> <li> <p>Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0</p> </li> <li> <p>Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0</p> </li> <li> <p>Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0</p> </li> </ul> <p/> <p>Outbound:</p> <ul> <li> <p>Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0</p> </li> </ul> <p>These security rules impact an internal network interface that is not exposed publicly.</p>"
}
}
},
"AddIpRoutesResult":{
"type":"structure",
"members":{
}
},
"AddTagsToResourceRequest":{
"type":"structure",
"required":[
"ResourceId",
"Tags"
],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>Identifier (ID) for the directory to which to add the tag.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to be assigned to the directory.</p>"
}
}
},
"AddTagsToResourceResult":{
"type":"structure",
"members":{
}
},
"AddedDateTime":{"type":"timestamp"},
"AliasName":{
"type":"string",
"max":62,
"min":1,
"pattern":"^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*"
},
"Attribute":{
"type":"structure",
"members":{
"Name":{
"shape":"AttributeName",
"documentation":"<p>The name of the attribute.</p>"
},
"Value":{
"shape":"AttributeValue",
"documentation":"<p>The value of the attribute.</p>"
}
},
"documentation":"<p>Represents a named directory attribute.</p>"
},
"AttributeName":{
"type":"string",
"min":1
},
"AttributeValue":{"type":"string"},
"Attributes":{
"type":"list",
"member":{"shape":"Attribute"}
},
"AuthenticationFailedException":{
"type":"structure",
"members":{
"Message":{
"shape":"ExceptionMessage",
"documentation":"<p>The textual message for the exception.</p>"
},
"RequestId":{
"shape":"RequestId",
"documentation":"<p>The identifier of the request that caused the exception.</p>"
}
},
"documentation":"<p>An authentication error occurred.</p>",
"exception":true
},
"AvailabilityZone":{"type":"string"},
"AvailabilityZones":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
},
"CancelSchemaExtensionRequest":{
"type":"structure",
"required":[
"DirectoryId",
"SchemaExtensionId"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the directory whose schema extension will be canceled.</p>"
},
"SchemaExtensionId":{
"shape":"SchemaExtensionId",
"documentation":"<p>The identifier of the schema extension that will be canceled.</p>"
}
}
},
"CancelSchemaExtensionResult":{
"type":"structure",
"members":{
}
},
"CidrIp":{
"type":"string",
"pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/([1-9]|[1-2][0-9]|3[0-2]))$"
},
"CidrIps":{
"type":"list",
"member":{"shape":"CidrIp"}
},
"ClientException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"},
"RequestId":{"shape":"RequestId"}
},
"documentation":"<p>A client exception has occurred.</p>",
"exception":true
},
"CloudOnlyDirectoriesLimitReached":{"type":"boolean"},
"Computer":{
"type":"structure",
"members":{
"ComputerId":{
"shape":"SID",
"documentation":"<p>The identifier of the computer.</p>"
},
"ComputerName":{
"shape":"ComputerName",
"documentation":"<p>The computer name.</p>"
},
"ComputerAttributes":{
"shape":"Attributes",
"documentation":"<p>An array of <a>Attribute</a> objects containing the LDAP attributes that belong to the computer account.</p>"
}
},
"documentation":"<p>Contains information about a computer account in a directory.</p>"
},
"ComputerName":{
"type":"string",
"max":15,
"min":1
},
"ComputerPassword":{
"type":"string",
"max":64,
"min":8,
"pattern":"[\\u0020-\\u00FF]+",
"sensitive":true
},
"ConditionalForwarder":{
"type":"structure",
"members":{
"RemoteDomainName":{
"shape":"RemoteDomainName",
"documentation":"<p>The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.</p>"
},
"DnsIpAddrs":{
"shape":"DnsIpAddrs",
"documentation":"<p>The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.</p>"
},
"ReplicationScope":{
"shape":"ReplicationScope",
"documentation":"<p>The replication scope of the conditional forwarder. The only allowed value is <code>Domain</code>, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.</p>"
}
},
"documentation":"<p>Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.</p>"
},
"ConditionalForwarders":{
"type":"list",
"member":{"shape":"ConditionalForwarder"}
},
"ConnectDirectoryRequest":{
"type":"structure",
"required":[
"Name",
"Password",
"Size",
"ConnectSettings"
],
"members":{
"Name":{
"shape":"DirectoryName",
"documentation":"<p>The fully-qualified name of the on-premises directory, such as <code>corp.example.com</code>.</p>"
},
"ShortName":{
"shape":"DirectoryShortName",
"documentation":"<p>The NetBIOS name of the on-premises directory, such as <code>CORP</code>.</p>"
},
"Password":{
"shape":"ConnectPassword",
"documentation":"<p>The password for the on-premises user account.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>A textual description for the directory.</p>"
},
"Size":{
"shape":"DirectorySize",
"documentation":"<p>The size of the directory.</p>"
},
"ConnectSettings":{
"shape":"DirectoryConnectSettings",
"documentation":"<p>A <a>DirectoryConnectSettings</a> object that contains additional information for the operation.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>ConnectDirectory</a> operation.</p>"
},
"ConnectDirectoryResult":{
"type":"structure",
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the new directory.</p>"
}
},
"documentation":"<p>Contains the results of the <a>ConnectDirectory</a> operation.</p>"
},
"ConnectPassword":{
"type":"string",
"max":128,
"min":1,
"sensitive":true
},
"ConnectedDirectoriesLimitReached":{"type":"boolean"},
"CreateAliasRequest":{
"type":"structure",
"required":[
"DirectoryId",
"Alias"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the directory for which to create the alias.</p>"
},
"Alias":{
"shape":"AliasName",
"documentation":"<p>The requested alias.</p> <p>The alias must be unique amongst all aliases in AWS. This operation throws an <code>EntityAlreadyExistsException</code> error if the alias already exists.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>CreateAlias</a> operation.</p>"
},
"CreateAliasResult":{
"type":"structure",
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the directory.</p>"
},
"Alias":{
"shape":"AliasName",
"documentation":"<p>The alias for the directory.</p>"
}
},
"documentation":"<p>Contains the results of the <a>CreateAlias</a> operation.</p>"
},
"CreateComputerRequest":{
"type":"structure",
"required":[
"DirectoryId",
"ComputerName",
"Password"
],
"members":{