domains

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

Overview

Name	domains
Type	Resource
Id	aws.voice_id.domains

Fields

The following fields are returned by SELECT queries:

describe_domain

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the domain. (pattern: <code>^arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}$</code>)
created_at	string (date-time)	The timestamp of when the domain was created.
description	string	The description of the domain. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
domain_id	string	The identifier of the domain. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
domain_status	string	The current status of the domain. (ACTIVE, PENDING, SUSPENDED)
name	string	The name for the domain. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
server_side_encryption_configuration	object	The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
server_side_encryption_update_details	object	Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
updated_at	string (date-time)	The timestamp of when the domain was last update.
watchlist_details	object	The watchlist details of a domain. Contains the default watchlist ID of the domain.

list_domains

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) for the domain. (pattern: <code>^arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}$</code>)
created_at	string (date-time)	The timestamp of when the domain was created.
description	string	The description of the domain. (pattern: <code>^([\p{L}\p{Z}\p{N}_.:/=+-%@]*)$</code>)
domain_id	string	The identifier of the domain. (pattern: <code>^[a-zA-Z0-9]{22}$</code>)
domain_status	string	The current status of the domain. (ACTIVE, PENDING, SUSPENDED)
name	string	The client-provided name for the domain. (pattern: <code>^[a-zA-Z0-9][a-zA-Z0-9_-]*$</code>)
server_side_encryption_configuration	object	The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
server_side_encryption_update_details	object	Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
updated_at	string (date-time)	The timestamp of when the domain was last updated.
watchlist_details	object	Provides information about watchlistDetails and DefaultWatchlistID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain	select	region		Describes the specified domain.
list_domains	select	region		Lists all the domains in the Amazon Web Services account.
create_domain	insert	region, ServerSideEncryptionConfiguration		Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.
update_domain	update	region, DomainId, ServerSideEncryptionConfiguration		Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.
delete_domain	delete	region		Deletes the specified domain from Voice ID.
evaluate_session	exec	region, DomainId, SessionNameOrId		Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

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_domain

Describes the specified domain.

SELECT
arn,
created_at,
description,
domain_id,
domain_status,
name,
server_side_encryption_configuration,
server_side_encryption_update_details,
updated_at,
watchlist_details
FROM aws.voice_id.domains
WHERE region = '{{ region }}' -- required
;

list_domains

Lists all the domains in the Amazon Web Services account.

SELECT
arn,
created_at,
description,
domain_id,
domain_status,
name,
server_side_encryption_configuration,
server_side_encryption_update_details,
updated_at,
watchlist_details
FROM aws.voice_id.domains
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_domain

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

INSERT INTO aws.voice_id.domains (
ClientToken,
Description,
Name,
ServerSideEncryptionConfiguration,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ Description }}',
'{{ Name }}',
'{{ ServerSideEncryptionConfiguration }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
domain
;

Manifest

# Description fields are for documentation purposes
- name: domains
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the domains resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
  - name: Description
    value: "{{ Description }}"
    description: |
      A brief description of this domain.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the domain.
  - name: ServerSideEncryptionConfiguration
    description: |
      The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.
    value:
      KmsKeyId: "{{ KmsKeyId }}"
  - name: Tags
    description: |
      A list of tags you want added to the domain.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_domain

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

UPDATE aws.voice_id.domains
SET 
Description = '{{ Description }}',
DomainId = '{{ DomainId }}',
Name = '{{ Name }}',
ServerSideEncryptionConfiguration = '{{ ServerSideEncryptionConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND DomainId = '{{ DomainId }}' --required
AND ServerSideEncryptionConfiguration = '{{ ServerSideEncryptionConfiguration }}' --required
RETURNING
domain;

DELETE examples

delete_domain

Deletes the specified domain from Voice ID.

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

Lifecycle Methods

evaluate_session

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

EXEC aws.voice_id.domains.evaluate_session 
@region='{{ region }}' --required 
@@json=
'{
"DomainId": "{{ DomainId }}", 
"SessionNameOrId": "{{ SessionNameOrId }}"
}'
;