lists

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

Overview

Name	lists
Type	Resource
Id	aws.frauddetector.lists

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_list	insert	region, name		Creates a list. List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.
update_list	update	region, name		Updates a list.
delete_list	delete	region		Deletes the list, provided it is not used in a rule. When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.

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)

INSERT examples

create_list

Creates a list. List is a set of input data for a variable in your event dataset. You use the input data in a rule that's associated with your detector. For more information, see Lists.

INSERT INTO aws.frauddetector.lists (
name,
elements,
variableType,
description,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ elements }}',
'{{ variableType }}',
'{{ description }}',
'{{ tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: lists
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the lists resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the list.
  - name: elements
    value:
      - "{{ elements }}"
    description: |
      The names of the elements, if providing. You can also create an empty list and add elements later using the UpdateList API.
  - name: variableType
    value: "{{ variableType }}"
    description: |
      The variable type of the list. You can only assign the variable type with String data type. For more information, see Variable types.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the list.
  - name: tags
    description: |
      A collection of the key and value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_list

Updates a list.

UPDATE aws.frauddetector.lists
SET 
name = '{{ name }}',
elements = '{{ elements }}',
description = '{{ description }}',
updateMode = '{{ updateMode }}',
variableType = '{{ variableType }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required;

DELETE examples

delete_list

Deletes the list, provided it is not used in a rule. When you delete a list, Amazon Fraud Detector permanently deletes that list and the elements in the list.

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