Skip to content

Commit eae6937

Browse files
author
AWS
committed
AWS Directory Service Update: Added new APIs for enabling, disabling, and describing access to the AWS Directory Service Data API
1 parent c5ffece commit eae6937

File tree

2 files changed

+135
-13
lines changed

2 files changed

+135
-13
lines changed

‎.changes/next-release/feature-AWSDirectoryService-8008834.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Directory Service",
4+
"contributor": "",
5+
"description": "Added new APIs for enabling, disabling, and describing access to the AWS Directory Service Data API"
6+
}

‎services/directory/src/main/resources/codegen-resources/service-2.json

Lines changed: 129 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,23 @@
452452
],
453453
"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 <code>DirectoryIds</code> parameter. Otherwise, all directories that belong to the current account are returned.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>DescribeDirectoriesResult.NextToken</code> 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 <code>Limit</code> parameter.</p>"
454454
},
455+
"DescribeDirectoryDataAccess":{
456+
"name":"DescribeDirectoryDataAccess",
457+
"http":{
458+
"method":"POST",
459+
"requestUri":"/"
460+
},
461+
"input":{"shape":"DescribeDirectoryDataAccessRequest"},
462+
"output":{"shape":"DescribeDirectoryDataAccessResult"},
463+
"errors":[
464+
{"shape":"DirectoryDoesNotExistException"},
465+
{"shape":"UnsupportedOperationException"},
466+
{"shape":"AccessDeniedException"},
467+
{"shape":"ClientException"},
468+
{"shape":"ServiceException"}
469+
],
470+
"documentation":"<p>Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.</p>"
471+
},
455472
"DescribeDomainControllers":{
456473
"name":"DescribeDomainControllers",
457474
"http":{
@@ -630,6 +647,25 @@
630647
],
631648
"documentation":"<p>Disables alternative client authentication methods for the specified directory. </p>"
632649
},
650+
"DisableDirectoryDataAccess":{
651+
"name":"DisableDirectoryDataAccess",
652+
"http":{
653+
"method":"POST",
654+
"requestUri":"/"
655+
},
656+
"input":{"shape":"DisableDirectoryDataAccessRequest"},
657+
"output":{"shape":"DisableDirectoryDataAccessResult"},
658+
"errors":[
659+
{"shape":"DirectoryDoesNotExistException"},
660+
{"shape":"DirectoryUnavailableException"},
661+
{"shape":"UnsupportedOperationException"},
662+
{"shape":"DirectoryInDesiredStateException"},
663+
{"shape":"AccessDeniedException"},
664+
{"shape":"ClientException"},
665+
{"shape":"ServiceException"}
666+
],
667+
"documentation":"<p>Deactivates access to directory data via the Directory Service Data API for the specified directory.</p>"
668+
},
633669
"DisableLDAPS":{
634670
"name":"DisableLDAPS",
635671
"http":{
@@ -700,6 +736,25 @@
700736
],
701737
"documentation":"<p>Enables alternative client authentication methods for the specified directory.</p>"
702738
},
739+
"EnableDirectoryDataAccess":{
740+
"name":"EnableDirectoryDataAccess",
741+
"http":{
742+
"method":"POST",
743+
"requestUri":"/"
744+
},
745+
"input":{"shape":"EnableDirectoryDataAccessRequest"},
746+
"output":{"shape":"EnableDirectoryDataAccessResult"},
747+
"errors":[
748+
{"shape":"DirectoryDoesNotExistException"},
749+
{"shape":"DirectoryUnavailableException"},
750+
{"shape":"UnsupportedOperationException"},
751+
{"shape":"DirectoryInDesiredStateException"},
752+
{"shape":"AccessDeniedException"},
753+
{"shape":"ClientException"},
754+
{"shape":"ServiceException"}
755+
],
756+
"documentation":"<p>Enables access to directory data via the Directory Service Data API for the specified directory.</p>"
757+
},
703758
"EnableLDAPS":{
704759
"name":"EnableLDAPS",
705760
"http":{
@@ -990,7 +1045,7 @@
9901045
{"shape":"ClientException"},
9911046
{"shape":"ServiceException"}
9921047
],
993-
"documentation":"<p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory.</p> <p>You can reset the password for any user in your directory with the following exceptions:</p> <ul> <li> <p>For Simple AD, you cannot reset the password for any user that is a member of either the <b>Domain Admins</b> or <b>Enterprise Admins</b> group except for the administrator user.</p> </li> <li> <p>For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the <b>Amazon Web Services Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD directory, see <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html\">What Gets Created</a> in the <i>Directory Service Administration Guide</i>.</p> </li> </ul>"
1048+
"documentation":"<p>Resets the password for any user in your Managed Microsoft AD or Simple AD directory. Disabled users will become enabled and can be authenticated following the API call.</p> <p>You can reset the password for any user in your directory with the following exceptions:</p> <ul> <li> <p>For Simple AD, you cannot reset the password for any user that is a member of either the <b>Domain Admins</b> or <b>Enterprise Admins</b> group except for the administrator user.</p> </li> <li> <p>For Managed Microsoft AD, you can only reset the password for a user that is in an OU based off of the NetBIOS name that you typed when you created your directory. For example, you cannot reset the password for a user in the <b>Amazon Web Services Reserved</b> OU. For more information about the OU structure for an Managed Microsoft AD directory, see <a href=\"https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_getting_started_what_gets_created.html\">What Gets Created</a> in the <i>Directory Service Administration Guide</i>.</p> </li> </ul>"
9941049
},
9951050
"RestoreFromSnapshot":{
9961051
"name":"RestoreFromSnapshot",
@@ -1219,7 +1274,7 @@
12191274
"Message":{"shape":"ExceptionMessage"},
12201275
"RequestId":{"shape":"RequestId"}
12211276
},
1222-
"documentation":"<p>Client authentication is not available in this region at this time.</p>",
1277+
"documentation":"<p>You do not have sufficient access to perform this action.</p>",
12231278
"exception":true
12241279
},
12251280
"AccessUrl":{
@@ -1244,7 +1299,7 @@
12441299
},
12451300
"UpdateSecurityGroupForDirectoryControllers":{
12461301
"shape":"UpdateSecurityGroupForDirectoryControllers",
1247-
"documentation":"<p>If set to true, updates the inbound and outbound rules of the security group that has the description: \"Amazon Web Services 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>"
1302+
"documentation":"<p>If set to true, updates the inbound and outbound rules of the security group that has the description: \"Amazon Web Services 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: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: DNS (UDP), Protocol: UDP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: DNS (TCP), Protocol: TCP, Range: 53, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: LDAP, Protocol: TCP, Range: 389, Source: Managed Microsoft AD VPC IPv4 CIDR</p> </li> <li> <p>Type: All ICMP, Protocol: All, Range: N/A, Source: Managed Microsoft AD VPC IPv4 CIDR</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>"
12481303
}
12491304
}
12501305
},
@@ -1951,7 +2006,7 @@
19512006
},
19522007
"TrustPassword":{
19532008
"shape":"TrustPassword",
1954-
"documentation":"<p>The trust password. The must be the same password that was used when creating the trust relationship on the external domain.</p>"
2009+
"documentation":"<p>The trust password. The trust password must be the same password that was used when creating the trust relationship on the external domain.</p>"
19552010
},
19562011
"TrustDirection":{
19572012
"shape":"TrustDirection",
@@ -1993,6 +2048,16 @@
19932048
"min":1,
19942049
"pattern":"^(?!.*\\\\|.*\"|.*\\/|.*\\[|.*\\]|.*:|.*;|.*\\||.*=|.*,|.*\\+|.*\\*|.*\\?|.*<|.*>|.*@).*$"
19952050
},
2051+
"DataAccessStatus":{
2052+
"type":"string",
2053+
"enum":[
2054+
"Disabled",
2055+
"Disabling",
2056+
"Enabled",
2057+
"Enabling",
2058+
"Failed"
2059+
]
2060+
},
19962061
"DeleteAssociatedConditionalForwarder":{"type":"boolean"},
19972062
"DeleteConditionalForwarderRequest":{
19982063
"type":"structure",
@@ -2264,6 +2329,25 @@
22642329
},
22652330
"documentation":"<p>Contains the results of the <a>DescribeDirectories</a> operation.</p>"
22662331
},
2332+
"DescribeDirectoryDataAccessRequest":{
2333+
"type":"structure",
2334+
"required":["DirectoryId"],
2335+
"members":{
2336+
"DirectoryId":{
2337+
"shape":"DirectoryId",
2338+
"documentation":"<p>The directory identifier.</p>"
2339+
}
2340+
}
2341+
},
2342+
"DescribeDirectoryDataAccessResult":{
2343+
"type":"structure",
2344+
"members":{
2345+
"DataAccessStatus":{
2346+
"shape":"DataAccessStatus",
2347+
"documentation":"<p>The current status of data access through the Directory Service Data API.</p>"
2348+
}
2349+
}
2350+
},
22672351
"DescribeDomainControllersRequest":{
22682352
"type":"structure",
22692353
"required":["DirectoryId"],
@@ -2753,7 +2837,7 @@
27532837
},
27542838
"Type":{
27552839
"shape":"DirectoryType",
2756-
"documentation":"<p>The directory size.</p>"
2840+
"documentation":"<p>The directory type.</p>"
27572841
},
27582842
"VpcSettings":{
27592843
"shape":"DirectoryVpcSettingsDescription",
@@ -2925,7 +3009,8 @@
29253009
"RestoreFailed",
29263010
"Deleting",
29273011
"Deleted",
2928-
"Failed"
3012+
"Failed",
3013+
"Updating"
29293014
]
29303015
},
29313016
"DirectoryType":{
@@ -2943,7 +3028,7 @@
29433028
"Message":{"shape":"ExceptionMessage"},
29443029
"RequestId":{"shape":"RequestId"}
29453030
},
2946-
"documentation":"<p>The specified directory is unavailable or could not be found.</p>",
3031+
"documentation":"<p>The specified directory is unavailable.</p>",
29473032
"exception":true
29483033
},
29493034
"DirectoryVpcSettings":{
@@ -2999,7 +3084,7 @@
29993084
},
30003085
"Type":{
30013086
"shape":"ClientAuthenticationType",
3002-
"documentation":"<p>The type of client authentication to disable. Currently, only the parameter, <code>SmartCard</code> is supported.</p>"
3087+
"documentation":"<p>The type of client authentication to disable. Currently the only parameter <code>\"SmartCard\"</code> is supported.</p>"
30033088
}
30043089
}
30053090
},
@@ -3008,6 +3093,21 @@
30083093
"members":{
30093094
}
30103095
},
3096+
"DisableDirectoryDataAccessRequest":{
3097+
"type":"structure",
3098+
"required":["DirectoryId"],
3099+
"members":{
3100+
"DirectoryId":{
3101+
"shape":"DirectoryId",
3102+
"documentation":"<p>The directory identifier.</p>"
3103+
}
3104+
}
3105+
},
3106+
"DisableDirectoryDataAccessResult":{
3107+
"type":"structure",
3108+
"members":{
3109+
}
3110+
},
30113111
"DisableLDAPSRequest":{
30123112
"type":"structure",
30133113
"required":[
@@ -3148,7 +3248,8 @@
31483248
"Restoring",
31493249
"Deleting",
31503250
"Deleted",
3151-
"Failed"
3251+
"Failed",
3252+
"Updating"
31523253
]
31533254
},
31543255
"DomainControllerStatusReason":{"type":"string"},
@@ -3178,6 +3279,21 @@
31783279
"members":{
31793280
}
31803281
},
3282+
"EnableDirectoryDataAccessRequest":{
3283+
"type":"structure",
3284+
"required":["DirectoryId"],
3285+
"members":{
3286+
"DirectoryId":{
3287+
"shape":"DirectoryId",
3288+
"documentation":"<p>The directory identifier.</p>"
3289+
}
3290+
}
3291+
},
3292+
"EnableDirectoryDataAccessResult":{
3293+
"type":"structure",
3294+
"members":{
3295+
}
3296+
},
31813297
"EnableLDAPSRequest":{
31823298
"type":"structure",
31833299
"required":[
@@ -3865,7 +3981,7 @@
38653981
},
38663982
"RadiusRetries":{
38673983
"shape":"RadiusRetries",
3868-
"documentation":"<p>The maximum number of times that communication with the RADIUS server is attempted.</p>"
3984+
"documentation":"<p>The maximum number of times that communication with the RADIUS server is retried after the initial attempt.</p>"
38693985
},
38703986
"SharedSecret":{
38713987
"shape":"RadiusSharedSecret",
@@ -3903,7 +4019,7 @@
39034019
},
39044020
"RadiusTimeout":{
39054021
"type":"integer",
3906-
"max":20,
4022+
"max":50,
39074023
"min":1
39084024
},
39094025
"RegionDescription":{
@@ -4635,11 +4751,11 @@
46354751
"members":{
46364752
"Key":{
46374753
"shape":"TagKey",
4638-
"documentation":"<p>Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
4754+
"documentation":"<p>Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-', ':', '@'(Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
46394755
},
46404756
"Value":{
46414757
"shape":"TagValue",
4642-
"documentation":"<p>The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
4758+
"documentation":"<p>The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-', ':', '@' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>"
46434759
}
46444760
},
46454761
"documentation":"<p>Metadata assigned to a directory consisting of a key-value pair.</p>"

0 commit comments

Comments
 (0)