Voice ID domain operations - Amazon Connect

Voice ID domain operations

Amazon Connect Voice ID provides APIs for you manage Voice ID domains. You can find equivalents for Create, Describe, List, and Update in the AWS Console.

  1. CreateDomain: To create a new Voice ID domain, use the CreateDomain Voice ID API. When the Voice ID domain is created, a default fraudster watchlist to hold your fraudsters is created at the same time.

    Note the following guidelines when using the CreateDomain API:

    • You can only invoke this for your account after you have acknowledged the BIPA Consent in the AWS console.

    • You must also specify the KMS key for the Voice ID domain at the time of creation.

    • After creating a Voice ID domain, use the Amazon Connect association APIs to associate it with an Amazon Connect instance.

  2. DeleteDomain: To delete a Voice ID domain, you must invoke the DeleteDomain Voice ID API and provide the domain ID. If this domain was associated with an Amazon Connect instance, Voice ID API calls, and Voice ID flow blocks will return runtime error. Deleting a Voice ID domain deletes all stored customer data such as audio recordings, voiceprints and speaker identifiers, as well as fraudster lists that you managed.

  3. DescribeDomain: Use this API to return the name, description and encryption configuration of an existing domain identified by its DomainID.

  4. ListDomains: Use this API to list all your Voice ID domains owned by your account in the Region.

  5. UpdateDomain: To update the name and encryption configuration for a domain, you can use the UpdateDomain Voice ID API. This API clobbers existing attributes, and you must provide both these fields.

    When you change the KMS key associated with the Voice ID domain, following the UpdateDomain call your domain's existing data will be asynchronously re-encrypted under the new KMS key. You can check status of this process from your domain's ServerSideEncryptionUpdateDetails attribute using the DescribeDomain API. While this update process is in progress, you must retain your old KMS key in an accessible state, otherwise this process may fail. After this process completes, the old KMS key may be safely retired.