Skip to content

update_assessment_control

update_assessment_control(
    assessment_id: UUID,
    control_set_id: ControlSetId,
    control_id: UUID,
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    control_status: Optional[ControlStatus] = None,
    comment_body: Optional[ControlCommentBody] = None,
) -> UpdateAssessmentControlResponse

Updates a control within an assessment in Audit Manager.

Parameters:

  • assessment_id (UUID) –

    The unique identifier for the assessment.

  • control_set_id (ControlSetId) –

    The unique identifier for the control set.

  • control_id (UUID) –

    The unique identifier for the control.

  • control_status (Optional[ControlStatus], default: None ) –

    The status of the control.

  • comment_body (Optional[ControlCommentBody], default: None ) –

    The comment body text for the control.

Raises:

  • AccessDeniedException –

    Your account isn't registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.

  • InternalServerException –

    An internal service error occurred during the processing of your request. Try again later.

  • ResourceNotFoundException –

    The resource that's specified in the request can't be found.

  • ValidationException –

    The request has invalid or missing parameters.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_auditmanager/_services/audit_manager.py
def update_assessment_control(
    self,
    assessment_id: "capo_auditmanager.types.uuid.UUID",
    control_set_id: "capo_auditmanager.types.control_set_id.ControlSetId",
    control_id: "capo_auditmanager.types.uuid.UUID",
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    control_status: Optional[
        "capo_auditmanager.types.control_status.ControlStatus"
    ] = None,
    comment_body: Optional[
        "capo_auditmanager.types.control_comment_body.ControlCommentBody"
    ] = None,
) -> "capo_auditmanager.types.update_assessment_control_response.UpdateAssessmentControlResponse":
    """<p> Updates a control within an assessment in Audit Manager. </p>

    Args:
        assessment_id: <p> The unique identifier for the assessment. </p>
        control_set_id: <p> The unique identifier for the control set. </p>
        control_id: <p> The unique identifier for the control. </p>
        control_status: <p> The status of the control. </p>
        comment_body: <p> The comment body text for the control. </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.update_assessment_control_request.UpdateAssessmentControlRequest]",
    ) -> OperationResponse[
        "capo_auditmanager.types.update_assessment_control_response.UpdateAssessmentControlResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.update_assessment_control

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

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

        return capo_auditmanager.types.update_assessment_control_request.redact_sensitive(
            input_
        )

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

        return capo_auditmanager.types.update_assessment_control_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAssessmentControl",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_auditmanager.types.update_assessment_control_request.UpdateAssessmentControlRequest = {
        "assessment_id": assessment_id,
        "control_set_id": control_set_id,
        "control_id": control_id,
    }
    if control_status is not None:
        input_["control_status"] = control_status
    if comment_body is not None:
        input_["comment_body"] = comment_body

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