Skip to content

update_assessment_framework

update_assessment_framework(
    framework_id: UUID,
    name: FrameworkName,
    control_sets: UpdateAssessmentFrameworkControlSets,
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    description: Optional[FrameworkDescription] = None,
    compliance_type: Optional[ComplianceType] = None,
) -> UpdateAssessmentFrameworkResponse

Updates a custom framework in Audit Manager.

Parameters:

  • framework_id (UUID) –

    The unique identifier for the framework.

  • name (FrameworkName) –

    The name of the framework to be updated.

  • description (Optional[FrameworkDescription], default: None ) –

    The description of the updated framework.

  • compliance_type (Optional[ComplianceType], default: None ) –

    The compliance type that the new custom framework supports, such as CIS or HIPAA.

  • control_sets (UpdateAssessmentFrameworkControlSets) –

    The control sets that are associated with the framework.

    The Controls object returns a partial response when called through Framework APIs. For a complete Controls object, use GetControl.

Raises:

Source code in docs_src/capo_auditmanager/_services/audit_manager.py
def update_assessment_framework(
    self,
    framework_id: "capo_auditmanager.types.uuid.UUID",
    name: "capo_auditmanager.types.framework_name.FrameworkName",
    control_sets: "capo_auditmanager.types.update_assessment_framework_control_sets.UpdateAssessmentFrameworkControlSets",
    *,
    config_overrides: Optional[AuditManagerClientConfig] = None,
    description: Optional[
        "capo_auditmanager.types.framework_description.FrameworkDescription"
    ] = None,
    compliance_type: Optional[
        "capo_auditmanager.types.compliance_type.ComplianceType"
    ] = None,
) -> "capo_auditmanager.types.update_assessment_framework_response.UpdateAssessmentFrameworkResponse":
    """<p> Updates a custom framework in Audit Manager. </p>

    Args:
        framework_id: <p> The unique identifier for the framework. </p>
        name: <p> The name of the framework to be updated. </p>
        description: <p> The description of the updated framework. </p>
        compliance_type: <p> The compliance type that the new custom framework supports, such as CIS or HIPAA. </p>
        control_sets: <p> The control sets that are associated with the framework. </p> <note> <p>The <code>Controls</code> object returns a partial response when called through Framework APIs. For a complete <code>Controls</code> object, use <code>GetControl</code>.</p> </note>

    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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>You've reached your account quota for this resource type. To perform the requested action, delete some existing resources or <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html">request a quota increase</a> from the Service Quotas console. For a list of Audit Manager service quotas, see <a href="https://docs.aws.amazon.com/audit-manager/latest/userguide/service-quotas.html">Quotas and restrictions for Audit Manager</a>.</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_framework_request.UpdateAssessmentFrameworkRequest]",
    ) -> OperationResponse[
        "capo_auditmanager.types.update_assessment_framework_response.UpdateAssessmentFrameworkResponse"
    ]:
        import capo_auditmanager._operations.bedrock_assessment_manager_lambda.update_assessment_framework

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

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

        return capo_auditmanager.types.update_assessment_framework_request.redact_sensitive(
            input_
        )

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

        return capo_auditmanager.types.update_assessment_framework_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateAssessmentFramework",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_auditmanager.types.update_assessment_framework_request.UpdateAssessmentFrameworkRequest = {
        "framework_id": framework_id,
        "name": name,
        "control_sets": control_sets,
    }
    if description is not None:
        input_["description"] = description
    if compliance_type is not None:
        input_["compliance_type"] = compliance_type

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