AWS directoryservice medium security documentation change

Service: directoryservice · 2025-08-01 · Security-related medium

File: directoryservice/latest/devguide/API_AssessmentSummary.md

Summary

Added documentation for AssessmentSummary API object with fields describing directory assessment metadata including DNS IP validation patterns and assessment status tracking

Security assessment

Documents assessment capabilities for directory configurations including DNS/IP validation patterns (security hardening) and status tracking of security assessments. The CustomerDnsIps field with IP pattern validation helps prevent misconfigurations that could lead to security vulnerabilities.

Diff

diff --git a/directoryservice/latest/devguide/API_AssessmentSummary.md b/directoryservice/latest/devguide/API_AssessmentSummary.md
index 8b1378917..d50e4efb9 100644
--- a//directoryservice/latest/devguide/API_AssessmentSummary.md
+++ b//directoryservice/latest/devguide/API_AssessmentSummary.md
@@ -0,0 +1 @@
+[](/pdfs/directoryservice/latest/devguide/directoryservice-api.pdf#API_AssessmentSummary "Open PDF")
@@ -1,0 +3,126 @@
+[Documentation](/index.html)[AWS Directory Service](/directory-service/index.html)[API Reference](welcome.html)
+
+ContentsSee Also
+
+# AssessmentSummary
+
+Contains summary information about a directory assessment, providing a high-level overview without detailed validation results.
+
+## Contents
+
+**AssessmentId**
+    
+
+The unique identifier of the directory assessment.
+
+Type: String
+
+Pattern: `^da-[0-9a-f]{18}$`
+
+Required: No
+
+**CustomerDnsIps**
+    
+
+The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
+
+Type: Array of strings
+
+Array Members: Fixed number of 2 items.
+
+Pattern: `^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$`
+
+Required: No
+
+**DirectoryId**
+    
+
+The identifier of the directory associated with this assessment.
+
+Type: String
+
+Pattern: `^d-[0-9a-f]{10}$`
+
+Required: No
+
+**DnsName**
+    
+
+The fully qualified domain name (FQDN) of the Active Directory domain being assessed.
+
+Type: String
+
+Pattern: `^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$`
+
+Required: No
+
+**LastUpdateDateTime**
+    
+
+The date and time when the assessment status was last updated.
+
+Type: Timestamp
+
+Required: No
+
+**ReportType**
+    
+
+The type of assessment report generated. Valid values include `CUSTOMER` and `SYSTEM`.
+
+Type: String
+
+Required: No
+
+**StartTime**
+    
+
+The date and time when the assessment was initiated.
+
+Type: Timestamp
+
+Required: No
+
+**Status**
+    
+
+The current status of the assessment. Valid values include `SUCCESS`, `FAILED`, `PENDING`, and `IN_PROGRESS`.
+
+Type: String
+
+Required: No
+
+## See Also
+
+For more information about using this API in one of the language-specific AWS SDKs, see the following:
+
+  * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/AssessmentSummary)
+
+  * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/AssessmentSummary)
+
+  * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/AssessmentSummary)
+
+
+
+
+![Warning](https://d1ge0kk1l5kms0.cloudfront.net/images/G/01/webservices/console/warning.png) **Javascript is disabled or is unavailable in your browser.**
+
+To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.
+
+[Document Conventions](/general/latest/gr/docconventions.html)
+
+AssessmentReport
+
+AssessmentValidation
+
+Did this page help you? - Yes
+
+Thanks for letting us know we're doing a good job!
+
+If you've got a moment, please tell us what we did right so we can do more of it.
+
+Did this page help you? - No
+
+Thanks for letting us know this page needs work. We're sorry we let you down.
+
+If you've got a moment, please tell us how we can make the documentation better.