AWS directoryservice documentation change
Summary
Added documentation for DeleteADAssessment API operation, including request/response syntax, parameters, errors, examples, and SDK references
Security assessment
Documents a security-related feature (directory assessment deletion) but does not indicate remediation of a specific vulnerability. The operation allows permanent deletion of assessment data which could impact audit trails, but this is standard functionality documentation rather than addressing a disclosed security issue.
Diff
diff --git a/directoryservice/latest/devguide/API_DeleteADAssessment.md b/directoryservice/latest/devguide/API_DeleteADAssessment.md index 8b1378917..155188e5c 100644 --- a//directoryservice/latest/devguide/API_DeleteADAssessment.md +++ b//directoryservice/latest/devguide/API_DeleteADAssessment.md @@ -0,0 +1 @@ +[](/pdfs/directoryservice/latest/devguide/directoryservice-api.pdf#API_DeleteADAssessment "Open PDF") @@ -1,0 +3,182 @@ +[Documentation](/index.html)[AWS Directory Service](/directory-service/index.html)[API Reference](welcome.html) + +Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also + +# DeleteADAssessment + +Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information. + +You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress. + +## Request Syntax + + + { + "AssessmentId": "string" + } + +## Request Parameters + +The request accepts the following data in JSON format. + +**AssessmentId ** + + +The unique identifier of the directory assessment to delete. + +Type: String + +Pattern: `^da-[0-9a-f]{18}$` + +Required: Yes + +## Response Syntax + + + { + "AssessmentId": "**_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. + +**AssessmentId ** + + +The unique identifier of the deleted directory assessment. + +Type: String + +Pattern: `^da-[0-9a-f]{18}$` + +## 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 DeleteADAssessment. + + + POST / HTTP/1.1 + Host: ds.us-west-2.amazonaws.com + Accept-Encoding: identity + Content-Length: 45 + X-Amz-Target: DirectoryService_20150416.DeleteADAssessment + 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 DeleteADAssessment. + + + HTTP/1.1 200 OK + x-amzn-RequestId: cfc1cbc8-c0b0-11e6-aa44-41d91ee57463 + Content-Type: application/x-amz-json-1.1 + Content-Length: 45 + Date: Mon, 12 Dec 2023 21:20:31 GMT + + { + "AssessmentId": "da-1234567890example1" + } + +## See Also + +For more information about using this API in one of the language-specific AWS SDKs, see the following: + + * [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for C++](https://docs.aws.amazon.com/goto/SdkForCpp/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ds-2015-04-16/DeleteADAssessment) + + * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ds-2015-04-16/DeleteADAssessment) + + + + + **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) + +CreateTrust + +DeleteConditionalForwarder + +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.