ds-2015-04-16.min.json (24386B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2015-04-16", 5 "endpointPrefix": "ds", 6 "jsonVersion": "1.1", 7 "protocol": "json", 8 "serviceAbbreviation": "Directory Service", 9 "serviceFullName": "AWS Directory Service", 10 "signatureVersion": "v4", 11 "targetPrefix": "DirectoryService_20150416" 12 }, 13 "operations": { 14 "AddIpRoutes": { 15 "input": { 16 "type": "structure", 17 "required": [ 18 "DirectoryId", 19 "IpRoutes" 20 ], 21 "members": { 22 "DirectoryId": {}, 23 "IpRoutes": { 24 "type": "list", 25 "member": { 26 "type": "structure", 27 "members": { 28 "CidrIp": {}, 29 "Description": {} 30 } 31 } 32 }, 33 "UpdateSecurityGroupForDirectoryControllers": { 34 "type": "boolean" 35 } 36 } 37 }, 38 "output": { 39 "type": "structure", 40 "members": {} 41 } 42 }, 43 "AddTagsToResource": { 44 "input": { 45 "type": "structure", 46 "required": [ 47 "ResourceId", 48 "Tags" 49 ], 50 "members": { 51 "ResourceId": {}, 52 "Tags": { 53 "shape": "Sb" 54 } 55 } 56 }, 57 "output": { 58 "type": "structure", 59 "members": {} 60 } 61 }, 62 "CancelSchemaExtension": { 63 "input": { 64 "type": "structure", 65 "required": [ 66 "DirectoryId", 67 "SchemaExtensionId" 68 ], 69 "members": { 70 "DirectoryId": {}, 71 "SchemaExtensionId": {} 72 } 73 }, 74 "output": { 75 "type": "structure", 76 "members": {} 77 } 78 }, 79 "ConnectDirectory": { 80 "input": { 81 "type": "structure", 82 "required": [ 83 "Name", 84 "Password", 85 "Size", 86 "ConnectSettings" 87 ], 88 "members": { 89 "Name": {}, 90 "ShortName": {}, 91 "Password": { 92 "shape": "Sm" 93 }, 94 "Description": {}, 95 "Size": {}, 96 "ConnectSettings": { 97 "type": "structure", 98 "required": [ 99 "VpcId", 100 "SubnetIds", 101 "CustomerDnsIps", 102 "CustomerUserName" 103 ], 104 "members": { 105 "VpcId": {}, 106 "SubnetIds": { 107 "shape": "Sq" 108 }, 109 "CustomerDnsIps": { 110 "shape": "Ss" 111 }, 112 "CustomerUserName": {} 113 } 114 } 115 } 116 }, 117 "output": { 118 "type": "structure", 119 "members": { 120 "DirectoryId": {} 121 } 122 } 123 }, 124 "CreateAlias": { 125 "input": { 126 "type": "structure", 127 "required": [ 128 "DirectoryId", 129 "Alias" 130 ], 131 "members": { 132 "DirectoryId": {}, 133 "Alias": {} 134 } 135 }, 136 "output": { 137 "type": "structure", 138 "members": { 139 "DirectoryId": {}, 140 "Alias": {} 141 } 142 } 143 }, 144 "CreateComputer": { 145 "input": { 146 "type": "structure", 147 "required": [ 148 "DirectoryId", 149 "ComputerName", 150 "Password" 151 ], 152 "members": { 153 "DirectoryId": {}, 154 "ComputerName": {}, 155 "Password": { 156 "type": "string", 157 "sensitive": true 158 }, 159 "OrganizationalUnitDistinguishedName": {}, 160 "ComputerAttributes": { 161 "shape": "S13" 162 } 163 } 164 }, 165 "output": { 166 "type": "structure", 167 "members": { 168 "Computer": { 169 "type": "structure", 170 "members": { 171 "ComputerId": {}, 172 "ComputerName": {}, 173 "ComputerAttributes": { 174 "shape": "S13" 175 } 176 } 177 } 178 } 179 } 180 }, 181 "CreateConditionalForwarder": { 182 "input": { 183 "type": "structure", 184 "required": [ 185 "DirectoryId", 186 "RemoteDomainName", 187 "DnsIpAddrs" 188 ], 189 "members": { 190 "DirectoryId": {}, 191 "RemoteDomainName": {}, 192 "DnsIpAddrs": { 193 "shape": "Ss" 194 } 195 } 196 }, 197 "output": { 198 "type": "structure", 199 "members": {} 200 } 201 }, 202 "CreateDirectory": { 203 "input": { 204 "type": "structure", 205 "required": [ 206 "Name", 207 "Password", 208 "Size" 209 ], 210 "members": { 211 "Name": {}, 212 "ShortName": {}, 213 "Password": { 214 "shape": "S1e" 215 }, 216 "Description": {}, 217 "Size": {}, 218 "VpcSettings": { 219 "shape": "S1f" 220 } 221 } 222 }, 223 "output": { 224 "type": "structure", 225 "members": { 226 "DirectoryId": {} 227 } 228 } 229 }, 230 "CreateMicrosoftAD": { 231 "input": { 232 "type": "structure", 233 "required": [ 234 "Name", 235 "Password", 236 "VpcSettings" 237 ], 238 "members": { 239 "Name": {}, 240 "ShortName": {}, 241 "Password": { 242 "shape": "S1e" 243 }, 244 "Description": {}, 245 "VpcSettings": { 246 "shape": "S1f" 247 } 248 } 249 }, 250 "output": { 251 "type": "structure", 252 "members": { 253 "DirectoryId": {} 254 } 255 } 256 }, 257 "CreateSnapshot": { 258 "input": { 259 "type": "structure", 260 "required": [ 261 "DirectoryId" 262 ], 263 "members": { 264 "DirectoryId": {}, 265 "Name": {} 266 } 267 }, 268 "output": { 269 "type": "structure", 270 "members": { 271 "SnapshotId": {} 272 } 273 } 274 }, 275 "CreateTrust": { 276 "input": { 277 "type": "structure", 278 "required": [ 279 "DirectoryId", 280 "RemoteDomainName", 281 "TrustPassword", 282 "TrustDirection" 283 ], 284 "members": { 285 "DirectoryId": {}, 286 "RemoteDomainName": {}, 287 "TrustPassword": { 288 "type": "string", 289 "sensitive": true 290 }, 291 "TrustDirection": {}, 292 "TrustType": {}, 293 "ConditionalForwarderIpAddrs": { 294 "shape": "Ss" 295 } 296 } 297 }, 298 "output": { 299 "type": "structure", 300 "members": { 301 "TrustId": {} 302 } 303 } 304 }, 305 "DeleteConditionalForwarder": { 306 "input": { 307 "type": "structure", 308 "required": [ 309 "DirectoryId", 310 "RemoteDomainName" 311 ], 312 "members": { 313 "DirectoryId": {}, 314 "RemoteDomainName": {} 315 } 316 }, 317 "output": { 318 "type": "structure", 319 "members": {} 320 } 321 }, 322 "DeleteDirectory": { 323 "input": { 324 "type": "structure", 325 "required": [ 326 "DirectoryId" 327 ], 328 "members": { 329 "DirectoryId": {} 330 } 331 }, 332 "output": { 333 "type": "structure", 334 "members": { 335 "DirectoryId": {} 336 } 337 } 338 }, 339 "DeleteSnapshot": { 340 "input": { 341 "type": "structure", 342 "required": [ 343 "SnapshotId" 344 ], 345 "members": { 346 "SnapshotId": {} 347 } 348 }, 349 "output": { 350 "type": "structure", 351 "members": { 352 "SnapshotId": {} 353 } 354 } 355 }, 356 "DeleteTrust": { 357 "input": { 358 "type": "structure", 359 "required": [ 360 "TrustId" 361 ], 362 "members": { 363 "TrustId": {}, 364 "DeleteAssociatedConditionalForwarder": { 365 "type": "boolean" 366 } 367 } 368 }, 369 "output": { 370 "type": "structure", 371 "members": { 372 "TrustId": {} 373 } 374 } 375 }, 376 "DeregisterEventTopic": { 377 "input": { 378 "type": "structure", 379 "required": [ 380 "DirectoryId", 381 "TopicName" 382 ], 383 "members": { 384 "DirectoryId": {}, 385 "TopicName": {} 386 } 387 }, 388 "output": { 389 "type": "structure", 390 "members": {} 391 } 392 }, 393 "DescribeConditionalForwarders": { 394 "input": { 395 "type": "structure", 396 "required": [ 397 "DirectoryId" 398 ], 399 "members": { 400 "DirectoryId": {}, 401 "RemoteDomainNames": { 402 "type": "list", 403 "member": {} 404 } 405 } 406 }, 407 "output": { 408 "type": "structure", 409 "members": { 410 "ConditionalForwarders": { 411 "type": "list", 412 "member": { 413 "type": "structure", 414 "members": { 415 "RemoteDomainName": {}, 416 "DnsIpAddrs": { 417 "shape": "Ss" 418 }, 419 "ReplicationScope": {} 420 } 421 } 422 } 423 } 424 } 425 }, 426 "DescribeDirectories": { 427 "input": { 428 "type": "structure", 429 "members": { 430 "DirectoryIds": { 431 "type": "list", 432 "member": {} 433 }, 434 "NextToken": {}, 435 "Limit": { 436 "type": "integer" 437 } 438 } 439 }, 440 "output": { 441 "type": "structure", 442 "members": { 443 "DirectoryDescriptions": { 444 "type": "list", 445 "member": { 446 "type": "structure", 447 "members": { 448 "DirectoryId": {}, 449 "Name": {}, 450 "ShortName": {}, 451 "Size": {}, 452 "Alias": {}, 453 "AccessUrl": {}, 454 "Description": {}, 455 "DnsIpAddrs": { 456 "shape": "Ss" 457 }, 458 "Stage": {}, 459 "LaunchTime": { 460 "type": "timestamp" 461 }, 462 "StageLastUpdatedDateTime": { 463 "type": "timestamp" 464 }, 465 "Type": {}, 466 "VpcSettings": { 467 "type": "structure", 468 "members": { 469 "VpcId": {}, 470 "SubnetIds": { 471 "shape": "Sq" 472 }, 473 "SecurityGroupId": {}, 474 "AvailabilityZones": { 475 "shape": "S2p" 476 } 477 } 478 }, 479 "ConnectSettings": { 480 "type": "structure", 481 "members": { 482 "VpcId": {}, 483 "SubnetIds": { 484 "shape": "Sq" 485 }, 486 "CustomerUserName": {}, 487 "SecurityGroupId": {}, 488 "AvailabilityZones": { 489 "shape": "S2p" 490 }, 491 "ConnectIps": { 492 "type": "list", 493 "member": {} 494 } 495 } 496 }, 497 "RadiusSettings": { 498 "shape": "S2t" 499 }, 500 "RadiusStatus": {}, 501 "StageReason": {}, 502 "SsoEnabled": { 503 "type": "boolean" 504 } 505 } 506 } 507 }, 508 "NextToken": {} 509 } 510 } 511 }, 512 "DescribeEventTopics": { 513 "input": { 514 "type": "structure", 515 "members": { 516 "DirectoryId": {}, 517 "TopicNames": { 518 "type": "list", 519 "member": {} 520 } 521 } 522 }, 523 "output": { 524 "type": "structure", 525 "members": { 526 "EventTopics": { 527 "type": "list", 528 "member": { 529 "type": "structure", 530 "members": { 531 "DirectoryId": {}, 532 "TopicName": {}, 533 "TopicArn": {}, 534 "CreatedDateTime": { 535 "type": "timestamp" 536 }, 537 "Status": {} 538 } 539 } 540 } 541 } 542 } 543 }, 544 "DescribeSnapshots": { 545 "input": { 546 "type": "structure", 547 "members": { 548 "DirectoryId": {}, 549 "SnapshotIds": { 550 "type": "list", 551 "member": {} 552 }, 553 "NextToken": {}, 554 "Limit": { 555 "type": "integer" 556 } 557 } 558 }, 559 "output": { 560 "type": "structure", 561 "members": { 562 "Snapshots": { 563 "type": "list", 564 "member": { 565 "type": "structure", 566 "members": { 567 "DirectoryId": {}, 568 "SnapshotId": {}, 569 "Type": {}, 570 "Name": {}, 571 "Status": {}, 572 "StartTime": { 573 "type": "timestamp" 574 } 575 } 576 } 577 }, 578 "NextToken": {} 579 } 580 } 581 }, 582 "DescribeTrusts": { 583 "input": { 584 "type": "structure", 585 "members": { 586 "DirectoryId": {}, 587 "TrustIds": { 588 "type": "list", 589 "member": {} 590 }, 591 "NextToken": {}, 592 "Limit": { 593 "type": "integer" 594 } 595 } 596 }, 597 "output": { 598 "type": "structure", 599 "members": { 600 "Trusts": { 601 "type": "list", 602 "member": { 603 "type": "structure", 604 "members": { 605 "DirectoryId": {}, 606 "TrustId": {}, 607 "RemoteDomainName": {}, 608 "TrustType": {}, 609 "TrustDirection": {}, 610 "TrustState": {}, 611 "CreatedDateTime": { 612 "type": "timestamp" 613 }, 614 "LastUpdatedDateTime": { 615 "type": "timestamp" 616 }, 617 "StateLastUpdatedDateTime": { 618 "type": "timestamp" 619 }, 620 "TrustStateReason": {} 621 } 622 } 623 }, 624 "NextToken": {} 625 } 626 } 627 }, 628 "DisableRadius": { 629 "input": { 630 "type": "structure", 631 "required": [ 632 "DirectoryId" 633 ], 634 "members": { 635 "DirectoryId": {} 636 } 637 }, 638 "output": { 639 "type": "structure", 640 "members": {} 641 } 642 }, 643 "DisableSso": { 644 "input": { 645 "type": "structure", 646 "required": [ 647 "DirectoryId" 648 ], 649 "members": { 650 "DirectoryId": {}, 651 "UserName": {}, 652 "Password": { 653 "shape": "Sm" 654 } 655 } 656 }, 657 "output": { 658 "type": "structure", 659 "members": {} 660 } 661 }, 662 "EnableRadius": { 663 "input": { 664 "type": "structure", 665 "required": [ 666 "DirectoryId", 667 "RadiusSettings" 668 ], 669 "members": { 670 "DirectoryId": {}, 671 "RadiusSettings": { 672 "shape": "S2t" 673 } 674 } 675 }, 676 "output": { 677 "type": "structure", 678 "members": {} 679 } 680 }, 681 "EnableSso": { 682 "input": { 683 "type": "structure", 684 "required": [ 685 "DirectoryId" 686 ], 687 "members": { 688 "DirectoryId": {}, 689 "UserName": {}, 690 "Password": { 691 "shape": "Sm" 692 } 693 } 694 }, 695 "output": { 696 "type": "structure", 697 "members": {} 698 } 699 }, 700 "GetDirectoryLimits": { 701 "input": { 702 "type": "structure", 703 "members": {} 704 }, 705 "output": { 706 "type": "structure", 707 "members": { 708 "DirectoryLimits": { 709 "type": "structure", 710 "members": { 711 "CloudOnlyDirectoriesLimit": { 712 "type": "integer" 713 }, 714 "CloudOnlyDirectoriesCurrentCount": { 715 "type": "integer" 716 }, 717 "CloudOnlyDirectoriesLimitReached": { 718 "type": "boolean" 719 }, 720 "CloudOnlyMicrosoftADLimit": { 721 "type": "integer" 722 }, 723 "CloudOnlyMicrosoftADCurrentCount": { 724 "type": "integer" 725 }, 726 "CloudOnlyMicrosoftADLimitReached": { 727 "type": "boolean" 728 }, 729 "ConnectedDirectoriesLimit": { 730 "type": "integer" 731 }, 732 "ConnectedDirectoriesCurrentCount": { 733 "type": "integer" 734 }, 735 "ConnectedDirectoriesLimitReached": { 736 "type": "boolean" 737 } 738 } 739 } 740 } 741 } 742 }, 743 "GetSnapshotLimits": { 744 "input": { 745 "type": "structure", 746 "required": [ 747 "DirectoryId" 748 ], 749 "members": { 750 "DirectoryId": {} 751 } 752 }, 753 "output": { 754 "type": "structure", 755 "members": { 756 "SnapshotLimits": { 757 "type": "structure", 758 "members": { 759 "ManualSnapshotsLimit": { 760 "type": "integer" 761 }, 762 "ManualSnapshotsCurrentCount": { 763 "type": "integer" 764 }, 765 "ManualSnapshotsLimitReached": { 766 "type": "boolean" 767 } 768 } 769 } 770 } 771 } 772 }, 773 "ListIpRoutes": { 774 "input": { 775 "type": "structure", 776 "required": [ 777 "DirectoryId" 778 ], 779 "members": { 780 "DirectoryId": {}, 781 "NextToken": {}, 782 "Limit": { 783 "type": "integer" 784 } 785 } 786 }, 787 "output": { 788 "type": "structure", 789 "members": { 790 "IpRoutesInfo": { 791 "type": "list", 792 "member": { 793 "type": "structure", 794 "members": { 795 "DirectoryId": {}, 796 "CidrIp": {}, 797 "IpRouteStatusMsg": {}, 798 "AddedDateTime": { 799 "type": "timestamp" 800 }, 801 "IpRouteStatusReason": {}, 802 "Description": {} 803 } 804 } 805 }, 806 "NextToken": {} 807 } 808 } 809 }, 810 "ListSchemaExtensions": { 811 "input": { 812 "type": "structure", 813 "required": [ 814 "DirectoryId" 815 ], 816 "members": { 817 "DirectoryId": {}, 818 "NextToken": {}, 819 "Limit": { 820 "type": "integer" 821 } 822 } 823 }, 824 "output": { 825 "type": "structure", 826 "members": { 827 "SchemaExtensionsInfo": { 828 "type": "list", 829 "member": { 830 "type": "structure", 831 "members": { 832 "DirectoryId": {}, 833 "SchemaExtensionId": {}, 834 "Description": {}, 835 "SchemaExtensionStatus": {}, 836 "SchemaExtensionStatusReason": {}, 837 "StartDateTime": { 838 "type": "timestamp" 839 }, 840 "EndDateTime": { 841 "type": "timestamp" 842 } 843 } 844 } 845 }, 846 "NextToken": {} 847 } 848 } 849 }, 850 "ListTagsForResource": { 851 "input": { 852 "type": "structure", 853 "required": [ 854 "ResourceId" 855 ], 856 "members": { 857 "ResourceId": {}, 858 "NextToken": {}, 859 "Limit": { 860 "type": "integer" 861 } 862 } 863 }, 864 "output": { 865 "type": "structure", 866 "members": { 867 "Tags": { 868 "shape": "Sb" 869 }, 870 "NextToken": {} 871 } 872 } 873 }, 874 "RegisterEventTopic": { 875 "input": { 876 "type": "structure", 877 "required": [ 878 "DirectoryId", 879 "TopicName" 880 ], 881 "members": { 882 "DirectoryId": {}, 883 "TopicName": {} 884 } 885 }, 886 "output": { 887 "type": "structure", 888 "members": {} 889 } 890 }, 891 "RemoveIpRoutes": { 892 "input": { 893 "type": "structure", 894 "required": [ 895 "DirectoryId", 896 "CidrIps" 897 ], 898 "members": { 899 "DirectoryId": {}, 900 "CidrIps": { 901 "type": "list", 902 "member": {} 903 } 904 } 905 }, 906 "output": { 907 "type": "structure", 908 "members": {} 909 } 910 }, 911 "RemoveTagsFromResource": { 912 "input": { 913 "type": "structure", 914 "required": [ 915 "ResourceId", 916 "TagKeys" 917 ], 918 "members": { 919 "ResourceId": {}, 920 "TagKeys": { 921 "type": "list", 922 "member": {} 923 } 924 } 925 }, 926 "output": { 927 "type": "structure", 928 "members": {} 929 } 930 }, 931 "RestoreFromSnapshot": { 932 "input": { 933 "type": "structure", 934 "required": [ 935 "SnapshotId" 936 ], 937 "members": { 938 "SnapshotId": {} 939 } 940 }, 941 "output": { 942 "type": "structure", 943 "members": {} 944 } 945 }, 946 "StartSchemaExtension": { 947 "input": { 948 "type": "structure", 949 "required": [ 950 "DirectoryId", 951 "CreateSnapshotBeforeSchemaExtension", 952 "LdifContent", 953 "Description" 954 ], 955 "members": { 956 "DirectoryId": {}, 957 "CreateSnapshotBeforeSchemaExtension": { 958 "type": "boolean" 959 }, 960 "LdifContent": {}, 961 "Description": {} 962 } 963 }, 964 "output": { 965 "type": "structure", 966 "members": { 967 "SchemaExtensionId": {} 968 } 969 } 970 }, 971 "UpdateConditionalForwarder": { 972 "input": { 973 "type": "structure", 974 "required": [ 975 "DirectoryId", 976 "RemoteDomainName", 977 "DnsIpAddrs" 978 ], 979 "members": { 980 "DirectoryId": {}, 981 "RemoteDomainName": {}, 982 "DnsIpAddrs": { 983 "shape": "Ss" 984 } 985 } 986 }, 987 "output": { 988 "type": "structure", 989 "members": {} 990 } 991 }, 992 "UpdateRadius": { 993 "input": { 994 "type": "structure", 995 "required": [ 996 "DirectoryId", 997 "RadiusSettings" 998 ], 999 "members": { 1000 "DirectoryId": {}, 1001 "RadiusSettings": { 1002 "shape": "S2t" 1003 } 1004 } 1005 }, 1006 "output": { 1007 "type": "structure", 1008 "members": {} 1009 } 1010 }, 1011 "VerifyTrust": { 1012 "input": { 1013 "type": "structure", 1014 "required": [ 1015 "TrustId" 1016 ], 1017 "members": { 1018 "TrustId": {} 1019 } 1020 }, 1021 "output": { 1022 "type": "structure", 1023 "members": { 1024 "TrustId": {} 1025 } 1026 } 1027 } 1028 }, 1029 "shapes": { 1030 "Sb": { 1031 "type": "list", 1032 "member": { 1033 "type": "structure", 1034 "required": [ 1035 "Key", 1036 "Value" 1037 ], 1038 "members": { 1039 "Key": {}, 1040 "Value": {} 1041 } 1042 } 1043 }, 1044 "Sm": { 1045 "type": "string", 1046 "sensitive": true 1047 }, 1048 "Sq": { 1049 "type": "list", 1050 "member": {} 1051 }, 1052 "Ss": { 1053 "type": "list", 1054 "member": {} 1055 }, 1056 "S13": { 1057 "type": "list", 1058 "member": { 1059 "type": "structure", 1060 "members": { 1061 "Name": {}, 1062 "Value": {} 1063 } 1064 } 1065 }, 1066 "S1e": { 1067 "type": "string", 1068 "sensitive": true 1069 }, 1070 "S1f": { 1071 "type": "structure", 1072 "required": [ 1073 "VpcId", 1074 "SubnetIds" 1075 ], 1076 "members": { 1077 "VpcId": {}, 1078 "SubnetIds": { 1079 "shape": "Sq" 1080 } 1081 } 1082 }, 1083 "S2p": { 1084 "type": "list", 1085 "member": {} 1086 }, 1087 "S2t": { 1088 "type": "structure", 1089 "members": { 1090 "RadiusServers": { 1091 "type": "list", 1092 "member": {} 1093 }, 1094 "RadiusPort": { 1095 "type": "integer" 1096 }, 1097 "RadiusTimeout": { 1098 "type": "integer" 1099 }, 1100 "RadiusRetries": { 1101 "type": "integer" 1102 }, 1103 "SharedSecret": { 1104 "type": "string", 1105 "sensitive": true 1106 }, 1107 "AuthenticationProtocol": {}, 1108 "DisplayLabel": {}, 1109 "UseSameUsername": { 1110 "type": "boolean" 1111 } 1112 } 1113 } 1114 } 1115 }