Skip to content

create_rule

create_rule(
    rule_id: identifier,
    detector_id: identifier,
    expression: ruleExpression,
    language: Language,
    outcomes: NonEmptyListOfStrings,
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    description: Optional[description] = None,
    tags: Optional[tagList] = None,
) -> CreateRuleResult

Creates a rule for use with the specified detector.

Parameters:

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.

  • 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 create_rule(
    self,
    rule_id: "capo_frauddetector.types.identifier.identifier",
    detector_id: "capo_frauddetector.types.identifier.identifier",
    expression: "capo_frauddetector.types.rule_expression.ruleExpression",
    language: "capo_frauddetector.types.language.Language",
    outcomes: "capo_frauddetector.types.non_empty_list_of_strings.NonEmptyListOfStrings",
    *,
    config_overrides: Optional[FraudDetectorClientConfig] = None,
    description: Optional[
        "capo_frauddetector.types.description.description"
    ] = None,
    tags: Optional["capo_frauddetector.types.tag_list.tagList"] = None,
) -> "capo_frauddetector.types.create_rule_result.CreateRuleResult":
    """<p>Creates a rule for use with the specified detector. </p>

    Args:
        rule_id: <p>The rule ID.</p>
        detector_id: <p>The detector ID for the rule's parent detector.</p>
        description: <p>The rule description.</p>
        expression: <p>The rule expression.</p>
        language: <p>The language of the rule.</p>
        outcomes: <p>The outcome or outcomes returned when the rule expression matches.</p>
        tags: <p>A collection of key and value pairs.</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.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.create_rule_request.CreateRuleRequest]",
    ) -> OperationResponse[
        "capo_frauddetector.types.create_rule_result.CreateRuleResult"
    ]:
        import capo_frauddetector._operations.aws_hawks_nest_service_facade.create_rule

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

    def _redact_input(
        input_: "capo_frauddetector.types.create_rule_request.CreateRuleRequest",
    ) -> dict[str, Any]:
        import capo_frauddetector.types.create_rule_request

        return capo_frauddetector.types.create_rule_request.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateRule", redact_input=_redact_input)
    )
    input_: capo_frauddetector.types.create_rule_request.CreateRuleRequest = {
        "rule_id": rule_id,
        "detector_id": detector_id,
        "expression": expression,
        "language": language,
        "outcomes": outcomes,
    }
    if description is not None:
        input_["description"] = description
    if tags is not None:
        input_["tags"] = tags

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