

# Managing voice profile domains
<a name="manage-voice-profile-domains"></a>

Amazon Chime SDK speaker search creates *voice profiles*, vector maps of a caller's voice. A voice profile domain represents a collection of voice profiles. You must create a voice profile domain before developers can call the [https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_StartSpeakerSearchTask.html](https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_StartSpeakerSearchTask.html) API.

**Important**  
The speaker search feature involves the creation of a voice embedding, which can be used to compare the voice of a caller against previously stored voice data. The collection, use, storage, and retention of biometric identifiers and biometric information in the form of a digital embedding may require 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. Before using the speaker search feature, you must provide all notices, and obtain all consents as required by applicable law, and under the [AWS service terms](https://aws.amazon.com/service-terms/) governing your use of the feature.  
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 analytics service, as required under the terms of your agreement with AWS governing your use of the service.

The following topics explain how to create and manage voice profile domains.

**Topics**
+ [Creating voice profile domains](create-vp-domain.md)
+ [Editing voice profile domains](edit-vp-domain.md)
+ [Deleting voice profile domains](delete-vp-domain.md)
+ [Using tags with voice profile domains](vp-domain-tags.md)
+ [Understanding the voice analytics consent notice](va-consent-notice.md)

# Creating voice profile domains
<a name="create-vp-domain"></a>

The steps in this section explain how to create voice profile domains. Remember the following:
+ Domain names can't exceed 256 characters.
+ Domain descriptions can't exceed 512 characters.

The Amazon Chime SDK console displays an error message if you exceed either limit.

**Note**  
You must use a symmetric KMS key to encrypt all your domains. For more information, see [Using encryption with voice analytics](analytics-encryption.md). Also, your end users must consent to having their voice recorded before you start a voice analytics session. For more information about consent, see [Understanding the voice analytics consent notice](va-consent-notice.md).

**To create a voice profile domain**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains**. 

1. Choose **Create voice profile domain**.

1. Under **Consent Acknowledgement**, choose **Yes, I agree to the Consent Acknowledgement for Amazon Chime Speaker Search**. 

1. Under **Setup**, enter a name and description for the domain, then choose a KMS key.

1. (Optional) Under **Tags**, choose **Add new tag**, then enter a key and optional value. Repeat as needed to add more tags.

1. When finished, choose **Create voice profile domain**.

# Editing voice profile domains
<a name="edit-vp-domain"></a>

You can edit any voice profile domain, regardless of who created it.

**To edit a voice profile domain**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains**. 

1. Select the checkbox next to the domain that you want to edit, then choose **Edit**.

1. As needed, change the domain's name and description, then choose **Save**.

# Deleting voice profile domains
<a name="delete-vp-domain"></a>

You can delete any voice profile domain, regardless of who created it.

**Important**  
When you delete a domain, you also delete all its voice profiles, and you can't undo the deletion.

**To delete a voice profile domain**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains**. 

1. Select the checkbox next to the domain that you want to delete, then choose **Delete**.

1. In the dialog box that appears, choose **I understand that this action cannot be reversed**, then choose **Delete**.

# Using tags with voice profile domains
<a name="vp-domain-tags"></a>

The topics in this section explain how to use tags with your existing Amazon Chime SDK voice profile domains. Tags allow you to assign metadata to your domains. A tag consists of a key and an optional value that stores information about the resource, or the data retained on that resource. You define all keys and values. For example, you can create a tag key named *CostCenter* with a value of *98765* and use the pair for cost allocation purposes. You can add up to 50 tags to a voice profile domain.



## Adding tags to voice profile domains
<a name="domain-add-tags"></a>

Follow these steps to add tags to an existing voice profile domain.

**To add tags**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains**.

1. Choose the domain that you want to add tags to.

1. Choose **Manage tags**, then choose **Add new tag**.

1. Enter a value in the **Key** box and an optional value in the **Value** box.

1. As needed, choose **Add new tag** to create another tag.

1. When finished, choose **Save changes**.

## Editing voice profile domain tags
<a name="domain-edit-tags"></a>

If you have the necessary permissions, you can edit any tags in your AWS account, regardless of who created them. However, IAM policies may prevent you from doing so.

**To edit tags**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains.**.

1. Choose the domain that has the tags you want to edit.

1. Choose **Manage tags**.

1. As needed, change the values in the **Key** and **Value** boxes.

   —OR—

   Choose **Add new tag** and add one or more tags.

1. When finished, choose **Save changes**.

## Removing voice profile domain tags
<a name="domain-remove-tags"></a>

If you have the necessary permissions, you can remove any tags in your AWS account regardless of who created them. However, IAM policies may prevent you from doing so.

**To remove tags**

1. Open the Amazon Chime SDK console at [https://console.aws.amazon.com/chime-sdk/home](https://console.aws.amazon.com/chime-sdk/home).

1. In the navigation pane, choose **Voice profile domains.**.

1. Choose the domain that has the tags you want to edit.

1. Choose **Manage tags**.

1. Choose **Remove** under each of the tags that you want to delete.

1. When finished, choose **Save changes**.

# Understanding the voice analytics consent notice
<a name="va-consent-notice"></a>

When you create a voice profile domain or call analytics configuration that uses voice analytics, you see this consent acknowledgement:

*As a condition of using this feature, you acknowledge that the collection, use, storage, and retention of a speaker’s biometric identifiers and biometric information (“biometric data”) in the form of a digital embedding may require the speaker’s informed consent, including via a written release. Such consent is required under various state laws, including biometrics laws in Illinois, Texas, Washington and other state privacy laws. Before using speaker search, you must provide all necessary notices to and obtain all necessary consents from each speaker as required by applicable law, and as set forth in our Service Terms governing your use of the feature.* 

*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 analytics service, as required under the terms of your agreement with AWS governing your use of the service.*

*For each speaker in Illinois, as required under the Biometric Information Privacy Act (“BIPA”), you must provide the following information in writing as a written release through a process that clearly reflects each caller’s informed consent before using speaker search:*

*“[Your company name (“Company”)] uses Amazon Web Services as a service provider for voice search services. Biometric identifiers and biometric information (“biometric data”) may be collected, stored, and used by Amazon Web Services on behalf of [Company] for the purpose of comparing the voice of a caller against previously stored voice data. Biometric data that is generated as part of this process will be retained for up to three years after your last interaction with [Company], or longer only if allowed or required by applicable law, and thereafter destroyed. Except as required or permitted by applicable law, [Company] will instruct Amazon Web Services to permanently destroy biometric data that is stored on [Company’s] behalf when the initial purpose for collecting or obtaining such data has been satisfied, within three years after your last interaction with the services, or after being informed by you that such data should be destroyed, whichever comes first. Biometric data may be transmitted between [Company] and Amazon Web Services as necessary to provide and receive this service. You hereby provide your express, informed, written release and consent for [Company] and Amazon Web Services to collect, use, and store your biometric data as described herein.”*

*By checking the box below you agree to provide the preceding information in writing to, and obtain an executed written release, from each speaker in Illinois as required by BIPA.*