rules

Creates, updates, deletes, gets or lists a rules resource.

Overview

Name	rules
Type	Resource
Id	aws.frauddetector.rules

Fields

The following fields are returned by SELECT queries:

get_rules

Name	Datatype	Description
next_token	string	The next page token to be used in subsequent requests.
rule_details	array	The details of the requested rule.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_rules	select	region		Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.
create_rule	insert	region, ruleId, detectorId, expression, language, outcomes		Creates a rule for use with the specified detector.
update_rule_version	update	region, rule, expression, language, outcomes		Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).
update_rule_metadata	update	region, rule, description		Updates a rule's metadata. The description attribute can be updated.
delete_rule	delete	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_rules

Get all rules for a detector (paginated) if ruleId and ruleVersion are not specified. Gets all rules for the detector and the ruleId if present (paginated). Gets a specific rule if both the ruleId and the ruleVersion are specified. This is a paginated API. Providing null maxResults results in retrieving maximum of 100 records per page. If you provide maxResults the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetRulesResult as part of your request. Null pagination token fetches the records from the beginning.

SELECT
next_token,
rule_details
FROM aws.frauddetector.rules
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_rule

Creates a rule for use with the specified detector.

INSERT INTO aws.frauddetector.rules (
ruleId,
detectorId,
description,
expression,
language,
outcomes,
tags,
region
)
SELECT 
'{{ ruleId }}' /* required */,
'{{ detectorId }}' /* required */,
'{{ description }}',
'{{ expression }}' /* required */,
'{{ language }}' /* required */,
'{{ outcomes }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
rule
;

Manifest

# Description fields are for documentation purposes
- name: rules
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rules resource.
  - name: ruleId
    value: "{{ ruleId }}"
    description: |
      The rule ID.
  - name: detectorId
    value: "{{ detectorId }}"
    description: |
      The detector ID for the rule's parent detector.
  - name: description
    value: "{{ description }}"
    description: |
      The rule description.
  - name: expression
    value: "{{ expression }}"
    description: |
      The rule expression.
  - name: language
    value: "{{ language }}"
    description: |
      The language of the rule.
    valid_values: ['DETECTORPL']
  - name: outcomes
    value:
      - "{{ outcomes }}"
    description: |
      The outcome or outcomes returned when the rule expression matches.
  - name: tags
    description: |
      A collection of key and value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_rule_version

Updates a rule version resulting in a new rule version. Updates a rule version resulting in a new rule version (version 1, 2, 3 ...).

UPDATE aws.frauddetector.rules
SET 
rule = '{{ rule }}',
description = '{{ description }}',
expression = '{{ expression }}',
language = '{{ language }}',
outcomes = '{{ outcomes }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND rule = '{{ rule }}' --required
AND expression = '{{ expression }}' --required
AND language = '{{ language }}' --required
AND outcomes = '{{ outcomes }}' --required
RETURNING
rule;

update_rule_metadata

Updates a rule's metadata. The description attribute can be updated.

UPDATE aws.frauddetector.rules
SET 
rule = '{{ rule }}',
description = '{{ description }}'
WHERE 
region = '{{ region }}' --required
AND rule = '{{ rule }}' --required
AND description = '{{ description }}' --required;

DELETE examples

delete_rule

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.

DELETE FROM aws.frauddetector.rules
WHERE region = '{{ region }}' --required
;