outcomes

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

Overview

Name	outcomes
Type	Resource
Id	aws.frauddetector.outcomes

Fields

The following fields are returned by SELECT queries:

get_outcomes

Name	Datatype	Description
next_token	string	The next page token for subsequent requests.
outcomes	array	The outcomes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_outcomes	select	region		Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.
put_outcome	replace	region, name		Creates or updates an outcome.
delete_outcome	delete	region		Deletes an outcome. You cannot delete an outcome that is used in a rule version. When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome 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_outcomes

Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.

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

REPLACE examples

put_outcome

Creates or updates an outcome.

REPLACE aws.frauddetector.outcomes
SET 
name = '{{ name }}',
description = '{{ description }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND name = '{{ name }}' --required;

DELETE examples

delete_outcome

Deletes an outcome. You cannot delete an outcome that is used in a rule version. When you delete an outcome, Amazon Fraud Detector permanently deletes that outcome and the data is no longer stored in Amazon Fraud Detector.

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