Skip to content

delete_ad_assessment

delete_ad_assessment(
    assessment_id: AssessmentId,
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> DeleteADAssessmentResult

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.

Parameters:

  • assessment_id (AssessmentId) –

    The unique identifier of the directory assessment to delete.

Raises:

Source code in docs_src/capo_directory_service/_services/directory_service.py
def delete_ad_assessment(
    self,
    assessment_id: "capo_directory_service.types.assessment_id.AssessmentId",
    *,
    config_overrides: Optional[DirectoryServiceClientConfig] = None,
) -> "capo_directory_service.types.delete_ad_assessment_result.DeleteADAssessmentResult":
    """<p>Deletes a directory assessment and all associated data. This operation permanently removes the assessment results, validation reports, and configuration information.</p> <p>You cannot delete system-initiated assessments. You can delete customer-created assessments even if they are in progress.</p>

    Args:
        assessment_id: <p>The unique identifier of the directory assessment to delete.</p>

    Raises:
        capo_directory_service.errors.client_exception.ClientException: <p>A client exception has occurred.</p>
        capo_directory_service.errors.entity_does_not_exist_exception.EntityDoesNotExistException: <p>The specified entity could not be found.</p>
        capo_directory_service.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more parameters are not valid.</p>
        capo_directory_service.errors.service_exception.ServiceException: <p>An exception has occurred in Directory Service.</p>
        capo_directory_service.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The operation is not supported.</p>
        capo_directory_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_directory_service.types.delete_ad_assessment_request.DeleteADAssessmentRequest]",
    ) -> OperationResponse[
        "capo_directory_service.types.delete_ad_assessment_result.DeleteADAssessmentResult"
    ]:
        import capo_directory_service._operations.directory_service_20150416.delete_ad_assessment

        output, http_response = (
            capo_directory_service._operations.directory_service_20150416.delete_ad_assessment.delete_ad_assessment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteADAssessment")
    )
    input_: capo_directory_service.types.delete_ad_assessment_request.DeleteADAssessmentRequest = {
        "assessment_id": assessment_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output