fraudsters

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

Overview

Name	fraudsters
Type	Resource
Id	aws.voice_id.fraudsters

Fields

The following fields are returned by SELECT queries:

describe_fraudster

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when Voice ID identified the fraudster.
domain_id	string	The identifier of the domain that contains the fraudster. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
generated_fraudster_id	string	The service-generated identifier for the fraudster. (pattern: <code>^id#[a-zA-Z0-9]{22}$</code>)
watchlist_ids	array	The identifier of the watchlists the fraudster is a part of.

list_fraudsters

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the fraudster summary was created.
domain_id	string	The identifier of the domain that contains the fraudster summary. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
generated_fraudster_id	string	The service-generated identifier for the fraudster. (pattern: <code>^id#[a-zA-Z0-9]{22}$</code>)
watchlist_ids	array	The identifier of the watchlists the fraudster is a part of.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fraudster	select	region		Describes the specified fraudster.
list_fraudsters	select	region		Lists all fraudsters in a specified watchlist or domain.
associate_fraudster	update	region, DomainId, FraudsterId, WatchlistId		Associates the fraudsters with the watchlist specified in the same domain.
delete_fraudster	delete	region		Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
disassociate_fraudster	exec	region, DomainId, FraudsterId, WatchlistId		Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.
start_fraudster_registration_job	exec	region, DataAccessRoleArn, DomainId, InputDataConfig, OutputDataConfig		Starts a new batch fraudster registration job using provided details.

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_fraudster

Describes the specified fraudster.

SELECT
created_at,
domain_id,
generated_fraudster_id,
watchlist_ids
FROM aws.voice_id.fraudsters
WHERE region = '{{ region }}' -- required
;

list_fraudsters

Lists all fraudsters in a specified watchlist or domain.

SELECT
created_at,
domain_id,
generated_fraudster_id,
watchlist_ids
FROM aws.voice_id.fraudsters
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_fraudster

Associates the fraudsters with the watchlist specified in the same domain.

UPDATE aws.voice_id.fraudsters
SET 
DomainId = '{{ DomainId }}',
FraudsterId = '{{ FraudsterId }}',
WatchlistId = '{{ WatchlistId }}'
WHERE 
region = '{{ region }}' --required
AND DomainId = '{{ DomainId }}' --required
AND FraudsterId = '{{ FraudsterId }}' --required
AND WatchlistId = '{{ WatchlistId }}' --required
RETURNING
fraudster;

DELETE examples

delete_fraudster

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

DELETE FROM aws.voice_id.fraudsters
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

disassociate_fraudster

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

EXEC aws.voice_id.fraudsters.disassociate_fraudster 
@region='{{ region }}' --required 
@@json=
'{
"DomainId": "{{ DomainId }}", 
"FraudsterId": "{{ FraudsterId }}", 
"WatchlistId": "{{ WatchlistId }}"
}'
;

start_fraudster_registration_job

Starts a new batch fraudster registration job using provided details.

EXEC aws.voice_id.fraudsters.start_fraudster_registration_job 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"DataAccessRoleArn": "{{ DataAccessRoleArn }}", 
"DomainId": "{{ DomainId }}", 
"InputDataConfig": "{{ InputDataConfig }}", 
"JobName": "{{ JobName }}", 
"OutputDataConfig": "{{ OutputDataConfig }}", 
"RegistrationConfig": "{{ RegistrationConfig }}"
}'
;