speakers

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

Overview

Name	speakers
Type	Resource
Id	aws.voice_id.speakers

Fields

The following fields are returned by SELECT queries:

describe_speaker

Name	Datatype	Description
created_at	string (date-time)	A timestamp of when the speaker was created.
customer_speaker_id	string	The client-provided identifier for the speaker. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
domain_id	string	The identifier of the domain that contains the speaker. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
generated_speaker_id	string	The service-generated identifier for the speaker. (pattern: <code>^id#[a-zA-Z0-9]{22}$</code>)
last_accessed_at	string (date-time)	The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
status	string	The current status of the speaker. (ENROLLED, EXPIRED, OPTED_OUT, PENDING)
updated_at	string (date-time)	A timestamp of the speaker's last update.

list_speakers

Name	Datatype	Description
created_at	string (date-time)	A timestamp showing the speaker's creation time.
customer_speaker_id	string	The client-provided identifier for the speaker. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
domain_id	string	The identifier of the domain that contains the speaker. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
generated_speaker_id	string	The service-generated identifier for the speaker. (pattern: <code>^id#[a-zA-Z0-9]{22}$</code>)
last_accessed_at	string (date-time)	The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
status	string	The current status of the speaker. (ENROLLED, EXPIRED, OPTED_OUT, PENDING)
updated_at	string (date-time)	A timestamp showing the speaker's last update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_speaker	select	region		Describes the specified speaker.
list_speakers	select	region		Lists all speakers in a specified domain.
delete_speaker	delete	region		Deletes the specified speaker from Voice ID.
opt_out_speaker	exec	region, DomainId, SpeakerId		Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.
start_speaker_enrollment_job	exec	region, DataAccessRoleArn, DomainId, InputDataConfig, OutputDataConfig		Starts a new batch speaker enrollment job using specified 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_speaker

Describes the specified speaker.

SELECT
created_at,
customer_speaker_id,
domain_id,
generated_speaker_id,
last_accessed_at,
status,
updated_at
FROM aws.voice_id.speakers
WHERE region = '{{ region }}' -- required
;

list_speakers

Lists all speakers in a specified domain.

SELECT
created_at,
customer_speaker_id,
domain_id,
generated_speaker_id,
last_accessed_at,
status,
updated_at
FROM aws.voice_id.speakers
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_speaker

Deletes the specified speaker from Voice ID.

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

Lifecycle Methods

opt_out_speaker

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

EXEC aws.voice_id.speakers.opt_out_speaker 
@region='{{ region }}' --required 
@@json=
'{
"DomainId": "{{ DomainId }}", 
"SpeakerId": "{{ SpeakerId }}"
}'
;

start_speaker_enrollment_job

Starts a new batch speaker enrollment job using specified details.

EXEC aws.voice_id.speakers.start_speaker_enrollment_job 
@region='{{ region }}' --required 
@@json=
'{
"ClientToken": "{{ ClientToken }}", 
"DataAccessRoleArn": "{{ DataAccessRoleArn }}", 
"DomainId": "{{ DomainId }}", 
"EnrollmentConfig": "{{ EnrollmentConfig }}", 
"InputDataConfig": "{{ InputDataConfig }}", 
"JobName": "{{ JobName }}", 
"OutputDataConfig": "{{ OutputDataConfig }}"
}'
;