AWS directoryservice documentation change
Summary
Added new API documentation for DescribeADAssessment, detailing its request/response syntax, parameters, errors, and examples for retrieving directory assessment status and validation results.
Security assessment
The change introduces documentation for an API that retrieves directory assessment details, including security-related validations (e.g., DNS IP checks) and network configurations (security groups, VPC/subnet IDs). While it enables monitoring of security posture, there is no explicit evidence of addressing a specific vulnerability or incident.
Diff
diff --git a/directoryservice/latest/devguide/API_DescribeADAssessment.md b/directoryservice/latest/devguide/API_DescribeADAssessment.md index 8b1378917..148e261bd 100644 --- a//directoryservice/latest/devguide/API_DescribeADAssessment.md +++ b//directoryservice/latest/devguide/API_DescribeADAssessment.md @@ -0,0 +1 @@ +[](/pdfs/directoryservice/latest/devguide/directoryservice-api.pdf#API_DescribeADAssessment "Open PDF") @@ -1,0 +3,266 @@ +[Documentation](/index.html)[AWS Directory Service](/directory-service/index.html)[API Reference](welcome.html) + +Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also + +# DescribeADAssessment + +Retrieves detailed information about a directory assessment, including its current status, validation results, and configuration details. Use this operation to monitor assessment progress and review results. + +## Request Syntax + + + { + "AssessmentId": "string" + } + +## Request Parameters + +The request accepts the following data in JSON format. + +**AssessmentId ** + + +The identifier of the directory assessment to describe. + +Type: String + +Pattern: `^da-[0-9a-f]{18}$` + +Required: Yes + +## Response Syntax + + + { + "Assessment": { + "[AssessmentId](./API_Assessment.html#DirectoryService-Type-Assessment-AssessmentId)": "**_string_** ", + "[CustomerDnsIps](./API_Assessment.html#DirectoryService-Type-Assessment-CustomerDnsIps)": [ "**_string_** " ], + "[DirectoryId](./API_Assessment.html#DirectoryService-Type-Assessment-DirectoryId)": "**_string_** ", + "[DnsName](./API_Assessment.html#DirectoryService-Type-Assessment-DnsName)": "**_string_** ", + "[LastUpdateDateTime](./API_Assessment.html#DirectoryService-Type-Assessment-LastUpdateDateTime)": **_number_** , + "[ReportType](./API_Assessment.html#DirectoryService-Type-Assessment-ReportType)": "**_string_** ", + "[SecurityGroupIds](./API_Assessment.html#DirectoryService-Type-Assessment-SecurityGroupIds)": [ "**_string_** " ], + "[SelfManagedInstanceIds](./API_Assessment.html#DirectoryService-Type-Assessment-SelfManagedInstanceIds)": [ "**_string_** " ], + "[StartTime](./API_Assessment.html#DirectoryService-Type-Assessment-StartTime)": **_number_** , + "[Status](./API_Assessment.html#DirectoryService-Type-Assessment-Status)": "**_string_** ", + "[StatusCode](./API_Assessment.html#DirectoryService-Type-Assessment-StatusCode)": "**_string_** ", + "[StatusReason](./API_Assessment.html#DirectoryService-Type-Assessment-StatusReason)": "**_string_** ", + "[SubnetIds](./API_Assessment.html#DirectoryService-Type-Assessment-SubnetIds)": [ "**_string_** " ], + "[Version](./API_Assessment.html#DirectoryService-Type-Assessment-Version)": "**_string_** ", + "[VpcId](./API_Assessment.html#DirectoryService-Type-Assessment-VpcId)": "**_string_** " + }, + "AssessmentReports": [ + { + "[DomainControllerIp](./API_AssessmentReport.html#DirectoryService-Type-AssessmentReport-DomainControllerIp)": "**_string_** ", + "[Validations](./API_AssessmentReport.html#DirectoryService-Type-AssessmentReport-Validations)": [ + { + "[Category](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-Category)": "**_string_** ", + "[LastUpdateDateTime](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-LastUpdateDateTime)": **_number_** , + "[Name](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-Name)": "**_string_** ", + "[StartTime](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-StartTime)": **_number_** , + "[Status](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-Status)": "**_string_** ", + "[StatusCode](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-StatusCode)": "**_string_** ", + "[StatusReason](./API_AssessmentValidation.html#DirectoryService-Type-AssessmentValidation-StatusReason)": "**_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. + +**Assessment ** + + +Detailed information about the self-managed instance settings (IDs and DNS IPs). + +Type: [Assessment](./API_Assessment.html) object + +**AssessmentReports ** + + +A list of assessment reports containing validation results for each domain controller and test category. Each report includes specific validation details and outcomes. + +Type: Array of [AssessmentReport](./API_AssessmentReport.html) objects + +## Errors + +For information about the errors that are common to all actions, see [Common Errors](./CommonErrors.html). + +**ClientException** + + +A client exception has occurred. + +HTTP Status Code: 400 + +**EntityDoesNotExistException** + + +The specified entity could not be found. + +HTTP Status Code: 400 + +**InvalidParameterException** + + +One or more parameters are not valid. + +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 DescribeADAssessment. + + + POST / HTTP/1.1 + Host: ds.us-west-2.amazonaws.com + Accept-Encoding: identity + Content-Length: 45 + X-Amz-Target: DirectoryService_20150416.DescribeADAssessment + X-Amz-Date: 20231212T212029Z + User-Agent: aws-cli/2.0.0 Python/3.8.0 Linux/5.4.0 botocore/2.0.0 + Content-Type: application/x-amz-json-1.1 + Authorization: AWS4-HMAC-SHA256 + Credential=AKIAIOSFODNN7EXAMPLE/20231212/us-west-2/ds/aws4_request, + SignedHeaders=content-type;host;x-amz-date;x-amz-target, + Signature=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 + + { + "AssessmentId": "da-1234567890example1" + } + +### Example Response + +This example illustrates one usage of DescribeADAssessment. + + + HTTP/1.1 200 OK + x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463 + Content-Type: application/x-amz-json-1.1 + Content-Length: 892 + Date: Mon, 12 Dec 2023 21:20:31 GMT + + { + "Assessment": { + "AssessmentId": "da-1234567890example1", + "DnsName": "ad.example.com", + "StartTime": "2025-06-10T14:28:54.934000-04:00", + "LastUpdateDateTime": "2025-06-10T14:55:52.197000-04:00", + "Status": "SUCCESS", + "CustomerDnsIps": [ + "10.24.34.100", + "10.24.34.200" + ] + "VpcId": "vpc-0e1051example5f2a", + "SubnetIds": [ + "subnet-0fee0examplee9604", + "subnet-076dbexample5ed88" + ], + "SelfManagedInstanceIds": [ + "i-10243410", + "i-10243420" + ], + "ReportType": "CUSTOMER", + "Version": "v1" + }, + "AssessmentReports": [ + { + "DomainControllerIp": "10.24.34.100", + "Validations": [ + {