variables

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

Overview

Name	variables
Type	Resource
Id	aws.frauddetector.variables

Fields

The following fields are returned by SELECT queries:

batch_get_variable

Name	Datatype	Description
errors	array	The errors from the request.
variables	array	The returned variables.

get_variables

Name	Datatype	Description
next_token	string	The next page token to be used in subsequent requests.
variables	array	The names of the variables returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_variable	select	region		Gets a batch of variables.
get_variables	select	region		Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.
create_variable	insert	region, name, dataType, dataSource, defaultValue		Creates a variable.
update_variable	update	region, name		Updates a variable.
delete_variable	delete	region		Deletes a variable. You can't delete variables that are included in an event type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually. When you delete a variable, Amazon Fraud Detector permanently deletes that variable 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

batch_get_variable

Gets a batch of variables.

SELECT
errors,
variables
FROM aws.frauddetector.variables
WHERE region = '{{ region }}' -- required
;

get_variables

Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage results in retrieving maximum of 100 records per page. If you provide maxSizePerPage the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult as part of your request. Null pagination token fetches the records from the beginning.

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

INSERT examples

create_variable

Creates a variable.

INSERT INTO aws.frauddetector.variables (
name,
dataType,
dataSource,
defaultValue,
description,
variableType,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ dataType }}' /* required */,
'{{ dataSource }}' /* required */,
'{{ defaultValue }}' /* required */,
'{{ description }}',
'{{ variableType }}',
'{{ tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: variables
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the variables resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the variable.
  - name: dataType
    value: "{{ dataType }}"
    description: |
      The data type of the variable.
    valid_values: ['STRING', 'INTEGER', 'FLOAT', 'BOOLEAN', 'DATETIME']
  - name: dataSource
    value: "{{ dataSource }}"
    description: |
      The source of the data.
    valid_values: ['EVENT', 'MODEL_SCORE', 'EXTERNAL_MODEL_SCORE']
  - name: defaultValue
    value: "{{ defaultValue }}"
    description: |
      The default value for the variable when no value is received.
  - name: description
    value: "{{ description }}"
    description: |
      The description.
  - name: variableType
    value: "{{ variableType }}"
    description: |
      The variable type. For more information see Variable types. Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT
  - name: tags
    description: |
      A collection of key and value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_variable

Updates a variable.

UPDATE aws.frauddetector.variables
SET 
name = '{{ name }}',
defaultValue = '{{ defaultValue }}',
description = '{{ description }}',
variableType = '{{ variableType }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required;

DELETE examples

delete_variable

Deletes a variable. You can't delete variables that are included in an event type in Amazon Fraud Detector. Amazon Fraud Detector automatically deletes model output variables and SageMaker model output variables when you delete the model. You can't delete these variables manually. When you delete a variable, Amazon Fraud Detector permanently deletes that variable and the data is no longer stored in Amazon Fraud Detector.

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