Lists all speakers in a specified domain¶

Description¶

Lists all speakers in a specified domain.

Usage¶

voiceid_list_speakers(DomainId, MaxResults, NextToken)

Arguments¶

• DomainId

  [required] The identifier of the domain.

• 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(
  NextToken = "string",
  SpeakerSummaries = list(
    list(
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CustomerSpeakerId = "string",
      DomainId = "string",
      GeneratedSpeakerId = "string",
      LastAccessedAt = as.POSIXct(
        "2015-01-01"
      ),
      Status = "ENROLLED"|"EXPIRED"|"OPTED_OUT"|"PENDING",
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$list_speakers(
  DomainId = "string",
  MaxResults = 123,
  NextToken = "string"
)