speaker_enrollment_jobs

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

Overview

Name	speaker_enrollment_jobs
Type	Resource
Id	aws.voice_id.speaker_enrollment_jobs

Fields

The following fields are returned by SELECT queries:

describe_speaker_enrollment_job

Name	Datatype	Description
created_at	string (date-time)	A timestamp of when the speaker enrollment 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 speaker enrollment job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
ended_at	string (date-time)	A timestamp of when the speaker enrollment job ended.
enrollment_config	object	The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
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 speaker enrollment job requests.
job_id	string	The service-generated identifier for the speaker enrollment job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
job_name	string	The client-provided name for the speaker enrollment job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
job_progress	object	Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
job_status	string	The current status of the speaker enrollment job. (SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)
output_data_config	object	The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

list_speaker_enrollment_jobs

Name	Datatype	Description
created_at	string (date-time)	A timestamp of when of the speaker enrollment job was created.
domain_id	string	The identifier of the domain that contains the speaker enrollment job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
ended_at	string (date-time)	A timestamp of when the speaker enrollment 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 speaker enrollment job. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
job_name	string	The client-provided name for the speaker enrollment job. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
job_progress	object	Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
job_status	string	The current status of the speaker enrollment 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_speaker_enrollment_job	select	region		Describes the specified speaker enrollment job.
list_speaker_enrollment_jobs	select	region		Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

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_speaker_enrollment_job

Describes the specified speaker enrollment job.

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

list_speaker_enrollment_jobs

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

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