Update Domain

voiceid_update_domain

R Documentation

Updates the specified domain

Description

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.

Usage

voiceid_update_domain(Description, DomainId, Name,
  ServerSideEncryptionConfiguration)

Arguments

Description

A brief description about this domain.

DomainId

[required] The identifier of the domain to be updated.

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. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

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$update_domain(
  Description = "string",
  DomainId = "string",
  Name = "string",
  ServerSideEncryptionConfiguration = list(
    KmsKeyId = "string"
  )
)