events

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

Overview

Name	events
Type	Resource
Id	aws.frauddetector.events

Fields

The following fields are returned by SELECT queries:

get_event

Name	Datatype	Description
current_label	string	The label associated with the event.
entities	array	The event entities.
event_id	string	The event ID.
event_timestamp	string	The timestamp that defines when the event under evaluation occurred. The timestamp must be specified using ISO 8601 standard in UTC.
event_type_name	string	The event type.
event_variables	object	Names of the event type's variables you defined in Amazon Fraud Detector to represent data elements and their corresponding values for the event you are sending for evaluation.
label_timestamp	string	The timestamp associated with the label to update. The timestamp must be specified using ISO 8601 standard in UTC.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event	select	region		Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.
delete_event	delete	region		Deletes the specified event. When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.

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

Retrieves details of events stored with Amazon Fraud Detector. This action does not retrieve prediction results.

SELECT
current_label,
entities,
event_id,
event_timestamp,
event_type_name,
event_variables,
label_timestamp
FROM aws.frauddetector.events
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_event

Deletes the specified event. When you delete an event, Amazon Fraud Detector permanently deletes that event and the event data is no longer stored in Amazon Fraud Detector. If deleteAuditHistory is True, event data is available through search for up to 30 seconds after the delete operation is completed.

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