Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See 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.

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 Amazon 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"
}