voice_profiles

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

Overview

Name	voice_profiles
Type	Resource
Id	aws.chime_sdk_voice.voice_profiles

Fields

The following fields are returned by SELECT queries:

list_voice_profiles

Name	Datatype	Description
next_token	string	The token used to retrieve the next page of results.
voice_profiles	array	The list of voice profiles.

get_voice_profile

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the voice profile was created and enrolled.
expiration_timestamp	string (date-time)	The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile API.
updated_timestamp	string (date-time)	The time at which the voice profile was last updated.
voice_profile_arn	string	The ARN of the voice profile. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
voice_profile_domain_id	string	The ID of the domain that contains the voice profile. (pattern: <code>.\S.</code>)
voice_profile_id	string	The ID of the voice profile. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_voice_profiles	select	voice-profile-domain-id, region	next-token, max-results	Lists the voice profiles in a voice profile domain.
get_voice_profile	select	voice_profile_id, region		Retrieves the details of the specified voice profile.
create_voice_profile	insert	region, SpeakerSearchTaskId		Creates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.
update_voice_profile	update	voice_profile_id, region, SpeakerSearchTaskId		Updates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws. You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.
delete_voice_profile	delete	voice_profile_id, region		Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

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)
voice-profile-domain-id	string	The ID of the voice profile domain.
voice_profile_id	string	The voice profile ID.
max-results	integer	The maximum number of results in the request.
next-token	string	The token used to retrieve the next page of results.

SELECT examples

list_voice_profiles

Lists the voice profiles in a voice profile domain.

SELECT
next_token,
voice_profiles
FROM aws.chime_sdk_voice.voice_profiles
WHERE `voice-profile-domain-id` = '{{ voice-profile-domain-id }}' -- required
AND region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

get_voice_profile

Retrieves the details of the specified voice profile.

SELECT
created_timestamp,
expiration_timestamp,
updated_timestamp,
voice_profile_arn,
voice_profile_domain_id,
voice_profile_id
FROM aws.chime_sdk_voice.voice_profiles
WHERE voice_profile_id = '{{ voice_profile_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_voice_profile

Creates a voice profile, which consists of an enrolled user and their latest voice print. Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK. For more information about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

INSERT INTO aws.chime_sdk_voice.voice_profiles (
SpeakerSearchTaskId,
region
)
SELECT 
'{{ SpeakerSearchTaskId }}' /* required */,
'{{ region }}'
RETURNING
voice_profile
;

Manifest

# Description fields are for documentation purposes
- name: voice_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the voice_profiles resource.
  - name: SpeakerSearchTaskId
    value: "{{ SpeakerSearchTaskId }}"

UPDATE examples

update_voice_profile

Updates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s informed consent via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws. You must provide a written release to each caller through a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service, as required under the terms of your agreement with AWS governing your use of the service.

UPDATE aws.chime_sdk_voice.voice_profiles
SET 
SpeakerSearchTaskId = '{{ SpeakerSearchTaskId }}'
WHERE 
voice_profile_id = '{{ voice_profile_id }}' --required
AND region = '{{ region }}' --required
AND SpeakerSearchTaskId = '{{ SpeakerSearchTaskId }}' --required
RETURNING
voice_profile;

DELETE examples

delete_voice_profile

Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.

DELETE FROM aws.chime_sdk_voice.voice_profiles
WHERE voice_profile_id = '{{ voice_profile_id }}' --required
AND region = '{{ region }}' --required
;