voice_profile_domains

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

Overview

Name	voice_profile_domains
Type	Resource
Id	aws.chime_sdk_voice.voice_profile_domains

Fields

The following fields are returned by SELECT queries:

get_voice_profile_domain

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the voice profile domain was created.
description	string	The description of the voice profile domain.
name	string	The name of the voice profile domain. (pattern: <code>[a-zA-Z0-9 _.-]+</code>)
server_side_encryption_configuration	object	A structure that contains the configuration settings for server-side encryption. We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.
updated_timestamp	string (date-time)	The time at which the voice profile was last updated.
voice_profile_domain_arn	string	The voice profile domain's Amazon Resource Number (ARN). (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
voice_profile_domain_id	string	The ID of the voice profile domain. (pattern: <code>.\S.</code>)

list_voice_profile_domains

Name	Datatype	Description
next_token	string	The token used to return the next page of results.
voice_profile_domains	array	The list of voice profile domains.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_voice_profile_domain	select	voice_profile_domain_id, region		Retrieves the details of the specified voice profile domain.
list_voice_profile_domains	select	region	next-token, max-results	Lists the specified voice profile domains in the administrator's AWS account.
create_voice_profile_domain	insert	region, Name, ServerSideEncryptionConfiguration		Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. 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 profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.
update_voice_profile_domain	update	voice_profile_domain_id, region		Updates the settings for the specified voice profile domain.
delete_voice_profile_domain	delete	voice_profile_domain_id, region		Deletes all voice profiles in the domain. 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 voice profile domain ID.
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token used to return the next page of results.

SELECT examples

get_voice_profile_domain

Retrieves the details of the specified voice profile domain.

SELECT
created_timestamp,
description,
name,
server_side_encryption_configuration,
updated_timestamp,
voice_profile_domain_arn,
voice_profile_domain_id
FROM aws.chime_sdk_voice.voice_profile_domains
WHERE voice_profile_domain_id = '{{ voice_profile_domain_id }}' -- required
AND region = '{{ region }}' -- required
;

list_voice_profile_domains

Lists the specified voice profile domains in the administrator's AWS account.

SELECT
next_token,
voice_profile_domains
FROM aws.chime_sdk_voice.voice_profile_domains
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_voice_profile_domain

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio. 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 profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

INSERT INTO aws.chime_sdk_voice.voice_profile_domains (
Name,
Description,
ServerSideEncryptionConfiguration,
ClientRequestToken,
Tags,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ Description }}',
'{{ ServerSideEncryptionConfiguration }}' /* required */,
'{{ ClientRequestToken }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
voice_profile_domain
;

Manifest

# Description fields are for documentation purposes
- name: voice_profile_domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the voice_profile_domains resource.
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
  - name: ServerSideEncryptionConfiguration
    description: |
      A structure that contains the configuration settings for server-side encryption. We only support symmetric keys. Do not use asymmetric or HMAC keys, or KMS aliases.
    value:
      KmsKeyArn: "{{ KmsKeyArn }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_voice_profile_domain

Updates the settings for the specified voice profile domain.

UPDATE aws.chime_sdk_voice.voice_profile_domains
SET 
Name = '{{ Name }}',
Description = '{{ Description }}'
WHERE 
voice_profile_domain_id = '{{ voice_profile_domain_id }}' --required
AND region = '{{ region }}' --required
RETURNING
voice_profile_domain;

DELETE examples

delete_voice_profile_domain

Deletes all voice profiles in the domain. WARNING: This action is not reversible.

DELETE FROM aws.chime_sdk_voice.voice_profile_domains
WHERE voice_profile_domain_id = '{{ voice_profile_domain_id }}' --required
AND region = '{{ region }}' --required
;