Skip to content

Create Domain

voiceid_create_domain R Documentation

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints

Description

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.

Usage

voiceid_create_domain(ClientToken, Description, Name,
  ServerSideEncryptionConfiguration, Tags)

Arguments

ClientToken

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.

Description

A brief description of this domain.

Name

[required] The name of the domain.

ServerSideEncryptionConfiguration

[required] 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.

Tags

A list of tags you want added to the domain.

Value

A list with the following syntax:

list(
  Domain = list(
    Arn = "string",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Description = "string",
    DomainId = "string",
    DomainStatus = "ACTIVE"|"PENDING"|"SUSPENDED",
    Name = "string",
    ServerSideEncryptionConfiguration = list(
      KmsKeyId = "string"
    ),
    ServerSideEncryptionUpdateDetails = list(
      Message = "string",
      OldKmsKeyId = "string",
      UpdateStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"
    ),
    UpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    WatchlistDetails = list(
      DefaultWatchlistId = "string"
    )
  )
)

Request syntax

svc$create_domain(
  ClientToken = "string",
  Description = "string",
  Name = "string",
  ServerSideEncryptionConfiguration = list(
    KmsKeyId = "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)