Obtains status of directory data access enablement through the AWS Directory Service Data API for the specified directory.
Request Syntax
{
"DirectoryId": "string"
}Request Parameters
The request accepts the following data in JSON format.
- DirectoryId
-
The directory identifier.
Type: String
Pattern:
^d-[0-9a-f]{10}$Required: Yes
Response Syntax
{
"DataAccessStatus": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- DataAccessStatus
-
The current status of data access through the AWS Directory Service Data API.
Type: String
Valid Values:
Disabled | Disabling | Enabled | Enabling | Failed
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- ClientException
-
A client exception has occurred.
HTTP Status Code: 400
- DirectoryDoesNotExistException
-
The specified directory does not exist in the system.
HTTP Status Code: 400
- ServiceException
-
An exception has occurred in AWS Directory Service.
HTTP Status Code: 500
- UnsupportedOperationException
-
The operation is not supported.
HTTP Status Code: 400
Examples
The following examples are formatted for legibility.
Example Request
This example illustrates one usage of DescribeDirectoryDataAccess.
POST / HTTP/1.1
Host: ds.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 98
X-Amz-Target: DirectoryService_20150416.DescribeDirectoryDataAccess
X-Amz-Date: 20161212T212029Z
User-Agent: aws-cli/1.11.24 Python/2.7.9 Windows/7 botocore/1.4.81
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAI7E3BYXS3example/20161212/us-west-2/ds/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=477f3a2802dcc303f69499723eb2e29a455fe3d1b646df0dacfd7c005a3a9509
{
"DirectoryId":"d-926example"
}Example Response
This example illustrates one usage of DescribeDirectoryDataAccess.
HTTP/1.1 200 OK
x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463
Content-Type: application/x-amz-json-1.1
Content-Length: 2
Date: Mon, 12 Dec 2016 21:20:31 GMT
{
"DataAccessStatus": "Enabled"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
