create_assessment_report ¶

def create_assessment_report(
    self,
    name: "capo_auditmanager.types.assessment_report_name.AssessmentReportName",
    assessment_id: "capo_auditmanager.types.uuid.UUID",
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    description: Optional[
        "capo_auditmanager.types.assessment_report_description.AssessmentReportDescription"
    ] = None,
    query_statement: Optional[
        "capo_auditmanager.types.query_statement.QueryStatement"
    ] = None,
) -> "capo_auditmanager.types.create_assessment_report_response.CreateAssessmentReportResponse":
    """<p> Creates an assessment report for the specified assessment. </p>

    Args:
        name: <p> The name of the new assessment report. </p>
        description: <p> The description of the assessment report. </p>
        assessment_id: <p> The identifier for the assessment. </p>
        query_statement: <p>A SQL statement that represents an evidence finder query.</p> <p>Provide this parameter when you want to generate an assessment report from the results of an evidence finder search query. When you use this parameter, Audit Manager generates a one-time report using only the evidence from the query output. This report does not include any assessment evidence that was manually <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/generate-assessment-report.html#generate-assessment-report-include-evidence">added to a report using the console</a>, or <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_BatchAssociateAssessmentReportEvidence.html">associated with a report using the API</a>. </p> <p>To use this parameter, the <a href="https://docs.aws.amazon.com/audit-manager/latest/APIReference/API_EvidenceFinderEnablement.html#auditmanager-Type-EvidenceFinderEnablement-enablementStatus">enablementStatus</a> of evidence finder must be <code>ENABLED</code>. </p> <p> For examples and help resolving <code>queryStatement</code> validation exceptions, see <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/evidence-finder-issues.html#querystatement-exceptions">Troubleshooting evidence finder issues</a> in the <i>Audit Manager User Guide.</i> </p>

    Raises:
        capo_auditmanager.errors.access_denied_exception.AccessDeniedException: <p> Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again. </p>
        capo_auditmanager.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
        capo_auditmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource that's specified in the request can't be found. </p>
        capo_auditmanager.errors.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </p>
        capo_auditmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_auditmanager.types.create_assessment_report_request.CreateAssessmentReportRequest]",
    ) -> OperationResponse[
        "capo_auditmanager.types.create_assessment_report_response.CreateAssessmentReportResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.create_assessment_report

        output, http_response = (
            capo_auditmanager._operations.bedrock_assessment_manager_lambda.create_assessment_report.create_assessment_report(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_auditmanager.types.create_assessment_report_request.CreateAssessmentReportRequest",
    ) -> dict[str, Any]:
        import capo_auditmanager.types.create_assessment_report_request

        return capo_auditmanager.types.create_assessment_report_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_auditmanager.types.create_assessment_report_response.CreateAssessmentReportResponse",
    ) -> dict[str, Any]:
        import capo_auditmanager.types.create_assessment_report_response

        return capo_auditmanager.types.create_assessment_report_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateAssessmentReport",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_auditmanager.types.create_assessment_report_request.CreateAssessmentReportRequest = {
        "name": name,
        "assessment_id": assessment_id,
    }
    if description is not None:
        input_["description"] = description
    if query_statement is not None:
        input_["query_statement"] = query_statement

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