fraudster_registration_jobs

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

Overview

Name	fraudster_registration_jobs
Type	Resource
Id	aws.voice_id.fraudster_registration_jobs

Fields

The following fields are returned by SELECT queries:

describe_fraudster_registration_job

Name	Datatype	Description
created_at	string (date-time)	A timestamp of when the fraudster registration job was created.
data_access_role_arn	string	The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. (pattern: <code>^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$</code>)
domain_id	string	The identifier of the domain that contains the fraudster registration job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
ended_at	string (date-time)	A timestamp of when the fraudster registration job ended.
failure_details	object	Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
input_data_config	object	The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
job_id	string	The service-generated identifier for the fraudster registration job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
job_name	string	The client-provided name for the fraudster registration job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
job_progress	object	Shows the completed percentage of registration requests listed in the input file.
job_status	string	The current status of the fraudster registration job. (SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)
output_data_config	object	The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
registration_config	object	The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

list_fraudster_registration_jobs

Name	Datatype	Description
created_at	string (date-time)	A timestamp of when the fraudster registration job was created.
domain_id	string	The identifier of the domain that contains the fraudster registration job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
ended_at	string (date-time)	A timestamp of when the fraudster registration job ended.
failure_details	object	Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
job_id	string	The service-generated identifier for the fraudster registration job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
job_name	string	The client-provided name for the fraudster registration job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
job_progress	object	Shows the completed percentage of registration requests listed in the input file.
job_status	string	The current status of the fraudster registration job. (SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_fraudster_registration_job	select	region		Describes the specified fraudster registration job.
list_fraudster_registration_jobs	select	region		Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

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_registration_job

Describes the specified fraudster registration job.

SELECT
created_at,
data_access_role_arn,
domain_id,
ended_at,
failure_details,
input_data_config,
job_id,
job_name,
job_progress,
job_status,
output_data_config,
registration_config
FROM aws.voice_id.fraudster_registration_jobs
WHERE region = '{{ region }}' -- required
;

list_fraudster_registration_jobs

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

SELECT
created_at,
domain_id,
ended_at,
failure_details,
job_id,
job_name,
job_progress,
job_status
FROM aws.voice_id.fraudster_registration_jobs
WHERE region = '{{ region }}' -- required
;