event_types

Creates, updates, deletes, gets or lists an event_types resource.

Overview

Name	event_types
Type	Resource
Id	aws.frauddetector.event_types

Fields

The following fields are returned by SELECT queries:

get_event_types

Name	Datatype	Description
event_types	array	An array of event types.
next_token	string	The next page token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_types	select	region		Gets all event types or a specific event type if name is provided. 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 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.
put_event_type	replace	region, name, eventVariables, entityTypes		Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.
delete_event_type	delete	region		Deletes an event type. You cannot delete an event type that is used in a detector or a model. When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.
delete_events_by_event_type	delete	region		Deletes all events of a particular event type.
send_event	exec	region, eventId, eventTypeName, eventTimestamp, eventVariables, entities		Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

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_event_types

Gets all event types or a specific event type if name is provided. 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 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse as part of your request. A null pagination token fetches the records from the beginning.

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

REPLACE examples

put_event_type

Creates or updates an event type. An event is a business activity that is evaluated for fraud risk. With Amazon Fraud Detector, you generate fraud predictions for events. An event type defines the structure for an event sent to Amazon Fraud Detector. This includes the variables sent as part of the event, the entity performing the event (such as a customer), and the labels that classify the event. Example event types include online payment transactions, account registrations, and authentications.

REPLACE aws.frauddetector.event_types
SET 
name = '{{ name }}',
description = '{{ description }}',
eventVariables = '{{ eventVariables }}',
labels = '{{ labels }}',
entityTypes = '{{ entityTypes }}',
eventIngestion = '{{ eventIngestion }}',
tags = '{{ tags }}',
eventOrchestration = '{{ eventOrchestration }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND eventVariables = '{{ eventVariables }}' --required
AND entityTypes = '{{ entityTypes }}' --required;

DELETE examples

delete_event_type

Deletes an event type. You cannot delete an event type that is used in a detector or a model. When you delete an event type, Amazon Fraud Detector permanently deletes that event type and the data is no longer stored in Amazon Fraud Detector.

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

delete_events_by_event_type

Deletes all events of a particular event type.

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

Lifecycle Methods

send_event

Stores events in Amazon Fraud Detector without generating fraud predictions for those events. For example, you can use SendEvent to upload a historical dataset, which you can then later use to train a model.

EXEC aws.frauddetector.event_types.send_event 
@region='{{ region }}' --required 
@@json=
'{
"eventId": "{{ eventId }}", 
"eventTypeName": "{{ eventTypeName }}", 
"eventTimestamp": "{{ eventTimestamp }}", 
"eventVariables": "{{ eventVariables }}", 
"assignedLabel": "{{ assignedLabel }}", 
"labelTimestamp": "{{ labelTimestamp }}", 
"entities": "{{ entities }}"
}'
;