List Speaker Enrollment Jobs

voiceid_list_speaker_enrollment_jobs

R Documentation

Lists all the speaker enrollment jobs in the domain with the specified JobStatus

Description

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

Usage

voiceid_list_speaker_enrollment_jobs(DomainId, JobStatus, MaxResults,
  NextToken)

Arguments

DomainId

[required] The identifier of the domain that contains the speaker enrollment jobs.

JobStatus

Provides the status of your speaker enrollment Job.

MaxResults

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Value

A list with the following syntax:

list(
  JobSummaries = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      DomainId = "string",
      EndedAt = as.POSIXct(
        "2015-01-01"
      ),
      FailureDetails = list(
        Message = "string",
        StatusCode = 123
      ),
      JobId = "string",
      JobName = "string",
      JobProgress = list(
        PercentComplete = 123
      ),
      JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"FAILED"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_speaker_enrollment_jobs(
  DomainId = "string",
  JobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"FAILED",
  MaxResults = 123,
  NextToken = "string"
)