event_predictions

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

Overview

Name	event_predictions
Type	Resource
Id	aws.frauddetector.event_predictions

Fields

The following fields are returned by SELECT queries:

get_event_prediction

Name	Datatype	Description
external_model_outputs	array	The model scores for Amazon SageMaker models.
model_scores	array	The model scores. Amazon Fraud Detector generates model scores between 0 and 1000, where 0 is low fraud risk and 1000 is high fraud risk. Model scores are directly related to the false positive rate (FPR). For example, a score of 600 corresponds to an estimated 10% false positive rate whereas a score of 900 corresponds to an estimated 2% false positive rate.
rule_results	array	The results from the rules.

list_event_predictions

Name	Datatype	Description
event_prediction_summaries	array	The summary of the past predictions.
next_token	string	Identifies the next page of results to return. Use the token to make the call again to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_event_prediction	select	region		Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.
list_event_predictions	select	region		Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned. For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.

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_prediction

Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE) version is used.

SELECT
external_model_outputs,
model_scores,
rule_results
FROM aws.frauddetector.event_predictions
WHERE region = '{{ region }}' -- required
;

list_event_predictions

Gets a list of past predictions. The list can be filtered by detector ID, detector version ID, event ID, event type, or by specifying a time period. If filter is not specified, the most recent prediction is returned. For example, the following filter lists all past predictions for xyz event type - { "eventType":{ "value": "xyz" }” } This is a paginated API. If you provide a null maxResults, this action will retrieve a maximum of 10 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the nextToken from the response as part of your request. A null nextToken fetches the records from the beginning.

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