update_framework ¶

def update_framework(
    self,
    framework_name: "capo_backup.types.framework_name.FrameworkName",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    framework_description: Optional[
        "capo_backup.types.framework_description.FrameworkDescription"
    ] = None,
    framework_controls: Optional[
        "capo_backup.types.framework_controls.FrameworkControls"
    ] = None,
    idempotency_token: Optional["capo_backup.types.string.string"] = None,
) -> "capo_backup.types.update_framework_output.UpdateFrameworkOutput":
    """<p>Updates the specified framework.</p>

    Args:
        framework_name: <p>The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
        framework_description: <p>An optional description of the framework with a maximum 1,024 characters.</p>
        framework_controls: <p>The controls that make up the framework. Each control in the list has a name, input parameters, and scope.</p>
        idempotency_token: <p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>UpdateFrameworkInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>

    Raises:
        capo_backup.errors.already_exists_exception.AlreadyExistsException: <p>The required resource already exists.</p>
        capo_backup.errors.conflict_exception.ConflictException: <p>Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.</p>
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.limit_exceeded_exception.LimitExceededException: <p>A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.update_framework_input.UpdateFrameworkInput]",
    ) -> OperationResponse[
        "capo_backup.types.update_framework_output.UpdateFrameworkOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.update_framework

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.update_framework.update_framework(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFramework")
    )
    input_: capo_backup.types.update_framework_input.UpdateFrameworkInput = {
        "framework_name": framework_name
    }
    if framework_description is not None:
        input_["framework_description"] = framework_description
    if framework_controls is not None:
        input_["framework_controls"] = framework_controls
    if idempotency_token is None:
        idempotency_token = str(uuid.uuid4())
    input_["idempotency_token"] = idempotency_token

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