AWS directoryservice documentation change

Service: directoryservice · 2025-08-01 · Documentation low

File: directoryservice/latest/devguide/API_Assessment.md

Summary

Added new API documentation for Assessment object detailing configuration parameters, status fields, validation patterns, and associated resource identifiers

Security assessment

The change documents API parameters related to directory assessments but does not indicate any security vulnerability remediation. While it includes security-adjacent fields like SecurityGroupIds and validation patterns, these appear to be standard API documentation rather than addressing a specific security issue or introducing new security features.

Diff

diff --git a/directoryservice/latest/devguide/API_Assessment.md b/directoryservice/latest/devguide/API_Assessment.md
index 8b1378917..3b5b46540 100644
--- a//directoryservice/latest/devguide/API_Assessment.md
+++ b//directoryservice/latest/devguide/API_Assessment.md
@@ -0,0 +1 @@
+[](/pdfs/directoryservice/latest/devguide/directoryservice-api.pdf#API_Assessment "Open PDF")
@@ -1,0 +3,201 @@
+[Documentation](/index.html)[AWS Directory Service](/directory-service/index.html)[API Reference](welcome.html)
+
+ContentsSee Also
+
+# Assessment
+
+Contains detailed information about a directory assessment, including configuration parameters, status, and 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 are `CUSTOMER` and `SYSTEM`.
+
+Type: String
+
+Required: No
+
+**SecurityGroupIds**
+    
+
+The security groups identifiers attached to the network interfaces.
+
+Type: Array of strings
+
+Array Members: Fixed number of 1 item.
+
+Pattern: `^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$`
+
+Required: No
+
+**SelfManagedInstanceIds**
+    
+
+The identifiers of the self-managed AD instances used to perform the assessment.
+
+Type: Array of strings
+
+Array Members: Fixed number of 2 items.
+
+Pattern: `^(i-[0-9a-f]{8}|i-[0-9a-f]{17}|mi-[0-9a-f]{8}|mi-[0-9a-f]{17})$`
+
+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
+
+**StatusCode**
+    
+
+A detailed status code providing additional information about the assessment state.
+
+Type: String
+
+Required: No
+
+**StatusReason**
+    
+
+A human-readable description of the current assessment status, including any error details or progress information.
+
+Type: String
+
+Required: No
+
+**SubnetIds**
+    
+
+A list of subnet identifiers in the Amazon VPC in which the hybrid directory is created.
+
+Type: Array of strings
+
+Pattern: `^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$`
+
+Required: No
+
+**Version**
+    
+
+The version of the assessment framework used to evaluate your self-managed AD environment.
+
+Type: String
+
+Required: No
+
+**VpcId**
+    
+
+Contains Amazon VPC information for the `StartADAssessment` operation. 
+
+Type: String
+
+Pattern: `^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$`
+
+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/Assessment)
+
+  * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/Assessment)
+
+  * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/Assessment)
+
+
+
+
+![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)
+
+Data Types
+
+AssessmentConfiguration
+
+Did this page help you? - Yes
+
+Thanks for letting us know we're doing a good job!