Start Speaker Enrollment Job

voiceid_start_speaker_enrollment_job

R Documentation

Starts a new batch speaker enrollment job using specified details

Description

Starts a new batch speaker enrollment job using specified details.

Usage

voiceid_start_speaker_enrollment_job(ClientToken, DataAccessRoleArn,
  DomainId, EnrollmentConfig, InputDataConfig, JobName, OutputDataConfig)

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.

DataAccessRoleArn

[required] The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

DomainId

[required] The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

EnrollmentConfig

The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.

InputDataConfig

[required] The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

JobName

A name for your speaker enrollment job.

OutputDataConfig

[required] The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS key ID to encrypt the file.

Value

A list with the following syntax:

list(
  Job = list(
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    DataAccessRoleArn = "string",
    DomainId = "string",
    EndedAt = as.POSIXct(
      "2015-01-01"
    ),
    EnrollmentConfig = list(
      ExistingEnrollmentAction = "SKIP"|"OVERWRITE",
      FraudDetectionConfig = list(
        FraudDetectionAction = "IGNORE"|"FAIL",
        RiskThreshold = 123,
        WatchlistIds = list(
          "string"
        )
      )
    ),
    FailureDetails = list(
      Message = "string",
      StatusCode = 123
    ),
    InputDataConfig = list(
      S3Uri = "string"
    ),
    JobId = "string",
    JobName = "string",
    JobProgress = list(
      PercentComplete = 123
    ),
    JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"FAILED",
    OutputDataConfig = list(
      KmsKeyId = "string",
      S3Uri = "string"
    )
  )
)

Request syntax

svc$start_speaker_enrollment_job(
  ClientToken = "string",
  DataAccessRoleArn = "string",
  DomainId = "string",
  EnrollmentConfig = list(
    ExistingEnrollmentAction = "SKIP"|"OVERWRITE",
    FraudDetectionConfig = list(
      FraudDetectionAction = "IGNORE"|"FAIL",
      RiskThreshold = 123,
      WatchlistIds = list(
        "string"
      )
    )
  ),
  InputDataConfig = list(
    S3Uri = "string"
  ),
  JobName = "string",
  OutputDataConfig = list(
    KmsKeyId = "string",
    S3Uri = "string"
  )
)