Skip to content

aws.voice_id.describe_speaker_enrollment_job

Example SQL Queries

SELECT * FROM
aws.voice_id.describe_speaker_enrollment_job
WHERE
"domain_id" = 'VALUE'
AND "job_id" = 'VALUE';

Description

Describes the specified speaker enrollment job.

Table Definition

Column NameColumn Data Type
domain_id Required Input Column

The identifier of the domain that contains the speaker enrollment job.

VARCHAR
job_id Required Input Column

The identifier of the speaker enrollment job you are describing.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

job

Contains details about the specified speaker enrollment job.

STRUCT(
"created_at" TIMESTAMP_S,
"data_access_role_arn" VARCHAR,
"domain_id" VARCHAR,
"ended_at" TIMESTAMP_S,
"enrollment_config" STRUCT(
"existing_enrollment_action" VARCHAR,
"fraud_detection_config" STRUCT(
"fraud_detection_action" VARCHAR,
"risk_threshold" BIGINT,
"watchlist_ids" VARCHAR[]
)
),
"failure_details" STRUCT(
"message" VARCHAR,
"status_code" BIGINT
),
"input_data_config" STRUCT(
"s3_uri" VARCHAR
),
"job_id" VARCHAR,
"job_name" VARCHAR,
"job_progress" STRUCT(
"percent_complete" BIGINT
),
"job_status" VARCHAR,
"output_data_config" STRUCT(
"kms_key_id" VARCHAR,
"s3_uri" VARCHAR
)
)
Show child fields
job.created_at

A timestamp of when the speaker enrollment job was created.

job.data_access_role_arn

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.

job.domain_id

The identifier of the domain that contains the speaker enrollment job.

job.ended_at

A timestamp of when the speaker enrollment job ended.

job.enrollment_config

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

Show child fields
job.enrollment_config.existing_enrollment_action

The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP, which skips the enrollment for the existing speaker. Setting the value to OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.

job.enrollment_config.fraud_detection_config

The fraud detection configuration to use for the speaker enrollment job.

Show child fields
job.enrollment_config.fraud_detection_config.fraud_detection_action

The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.

job.enrollment_config.fraud_detection_config.risk_threshold

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

job.enrollment_config.fraud_detection_config.watchlist_ids[]
job.failure_details

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.

Show child fields
job.failure_details.message

A description of the error that caused the batch job failure.

job.failure_details.status_code

An HTTP status code representing the nature of the error.

job.input_data_config

The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

Show child fields
job.input_data_config.s3_uri

The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

job.job_id

The service-generated identifier for the speaker enrollment job.

job.job_name

The client-provided name for the speaker enrollment job.

job.job_progress

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

Show child fields
job.job_progress.percent_complete

Shows the completed percentage of enrollment or registration requests listed in the input file.

job.job_status

The current status of the speaker enrollment job.

job.output_data_config

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.

Show child fields
job.output_data_config.kms_key_id

The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.

job.output_data_config.s3_uri

The S3 path of the folder where Voice ID writes the job output file. It has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out.