models

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

Overview

Name	models
Type	Resource
Id	aws.frauddetector.models

Fields

The following fields are returned by SELECT queries:

get_models

Name	Datatype	Description
models	array	The array of models.
next_token	string	The next page token to be used in subsequent requests.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_models	select	region		Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.
create_model	insert	region, modelId, modelType, eventTypeName		Creates a model using the specified model type.
update_model	update	region, modelId, modelType		Updates model description.
delete_model	delete	region		Deletes a model. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model, Amazon Fraud Detector permanently deletes that model 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_models

Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified. This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

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

INSERT examples

create_model

Creates a model using the specified model type.

INSERT INTO aws.frauddetector.models (
modelId,
modelType,
description,
eventTypeName,
tags,
region
)
SELECT 
'{{ modelId }}' /* required */,
'{{ modelType }}' /* required */,
'{{ description }}',
'{{ eventTypeName }}' /* required */,
'{{ tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: models
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the models resource.
  - name: modelId
    value: "{{ modelId }}"
    description: |
      The model ID.
  - name: modelType
    value: "{{ modelType }}"
    description: |
      The model type.
    valid_values: ['ONLINE_FRAUD_INSIGHTS', 'TRANSACTION_FRAUD_INSIGHTS', 'ACCOUNT_TAKEOVER_INSIGHTS']
  - name: description
    value: "{{ description }}"
    description: |
      The model description.
  - name: eventTypeName
    value: "{{ eventTypeName }}"
    description: |
      The name of the event type.
  - name: tags
    description: |
      A collection of key and value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_model

Updates model description.

UPDATE aws.frauddetector.models
SET 
modelId = '{{ modelId }}',
modelType = '{{ modelType }}',
description = '{{ description }}'
WHERE 
region = '{{ region }}' --required
AND modelId = '{{ modelId }}' --required
AND modelType = '{{ modelType }}' --required;

DELETE examples

delete_model

Deletes a model. You can delete models and model versions in Amazon Fraud Detector, provided that they are not associated with a detector version. When you delete a model, Amazon Fraud Detector permanently deletes that model and the data is no longer stored in Amazon Fraud Detector.

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