delete_rule ¶

delete_rule(
    rule: Rule, *, config_overrides: Optional[FraudDetectorClientConfig] = None
) -> DeleteRuleResult

Deletes the rule. You cannot delete a rule if it is used by an ACTIVE or INACTIVE detector version.

When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.

Raises:

AccessDeniedException –

An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as PutExternalModel, that specifies a role that is not in your account.
ConflictException –

An exception indicating there was a conflict during a delete operation.
InternalServerException –

An exception indicating an internal server error.
ThrottlingException –

An exception indicating a throttling error.
ValidationException –

An exception indicating a specified value is not allowed.
UnknownServiceError –

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

Source code in docs_src/capo_frauddetector/_services/fraud_detector.py

def delete_rule(
    self,
    rule: "capo_frauddetector.types.rule.Rule",
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
) -> "capo_frauddetector.types.delete_rule_result.DeleteRuleResult":
    """<p>Deletes the rule. You cannot delete a rule if it is used by an <code>ACTIVE</code> or <code>INACTIVE</code> detector version.</p> <p>When you delete a rule, Amazon Fraud Detector permanently deletes that rule and the data is no longer stored in Amazon Fraud Detector.</p>

    Raises:
        capo_frauddetector.errors.access_denied_exception.AccessDeniedException: <p>An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as <code>PutExternalModel</code>, that specifies a role that is not in your account.</p>
        capo_frauddetector.errors.conflict_exception.ConflictException: <p>An exception indicating there was a conflict during a delete operation.</p>
        capo_frauddetector.errors.internal_server_exception.InternalServerException: <p>An exception indicating an internal server error.</p>
        capo_frauddetector.errors.throttling_exception.ThrottlingException: <p>An exception indicating a throttling error.</p>
        capo_frauddetector.errors.validation_exception.ValidationException: <p>An exception indicating a specified value is not allowed.</p>
        capo_frauddetector.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_frauddetector.types.delete_rule_request.DeleteRuleRequest]",
    ) -> OperationResponse[
        "capo_frauddetector.types.delete_rule_result.DeleteRuleResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.delete_rule

        output, http_response = (
            capo_frauddetector._operations.aws_hawks_nest_service_facade.delete_rule.delete_rule(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRule")
    )
    input_: capo_frauddetector.types.delete_rule_request.DeleteRuleRequest = {
        "rule": rule
    }

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