detectors

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

Overview

Name	detectors
Type	Resource
Id	aws.frauddetector.detectors

Fields

The following fields are returned by SELECT queries:

describe_detector

Name	Datatype	Description
arn	string	The detector ARN. (pattern: <code>^arn:aws[a-z-]{0,15}:frauddetector:[a-z0-9-]{3,20}:[0-9]{12}:[^\s]{2,128}$</code>)
detector_id	string	The detector ID. (pattern: <code>^[0-9a-z_-]+$</code>)
detector_version_summaries	array	The status and description for each detector version.
next_token	string	The next token to be used for subsequent requests.

get_detectors

Name	Datatype	Description
detectors	array	The detectors.
next_token	string	The next page token.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_detector	select	region		Gets all versions for a specified detector.
get_detectors	select	region		Gets all detectors or a single detector if a detectorId 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 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.
put_detector	replace	region, detectorId, eventTypeName		Creates or updates a detector.
delete_detector	delete	region		Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete a detector, Amazon Fraud Detector permanently deletes the detector 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

describe_detector

Gets all versions for a specified detector.

SELECT
arn,
detector_id,
detector_version_summaries,
next_token
FROM aws.frauddetector.detectors
WHERE region = '{{ region }}' -- required
;

get_detectors

Gets all detectors or a single detector if a detectorId 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 5 and 10. To get the next page results, provide the pagination token from the GetDetectorsResponse as part of your request. A null pagination token fetches the records from the beginning.

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

REPLACE examples

put_detector

Creates or updates a detector.

REPLACE aws.frauddetector.detectors
SET 
detectorId = '{{ detectorId }}',
description = '{{ description }}',
eventTypeName = '{{ eventTypeName }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND detectorId = '{{ detectorId }}' --required
AND eventTypeName = '{{ eventTypeName }}' --required;

DELETE examples

delete_detector

Deletes the detector. Before deleting a detector, you must first delete all detector versions and rule versions associated with the detector. When you delete a detector, Amazon Fraud Detector permanently deletes the detector and the data is no longer stored in Amazon Fraud Detector.

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