voiceid/aws.sdk.kotlin.services.voiceid

Package-level declarations

Types

Link copied to clipboard
interface VoiceIdClient : SdkClient

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun VoiceIdClient.associateFraudster(crossinline block: AssociateFraudsterRequest.Builder.() -> Unit): AssociateFraudsterResponse

Associates the fraudsters with the watchlist specified in the same domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.createDomain(crossinline block: CreateDomainRequest.Builder.() -> Unit): CreateDomainResponse

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.

Link copied to clipboard
inline suspend fun VoiceIdClient.createWatchlist(crossinline block: CreateWatchlistRequest.Builder.() -> Unit): CreateWatchlistResponse

Creates a watchlist that fraudsters can be a part of.

Link copied to clipboard
inline suspend fun VoiceIdClient.deleteDomain(crossinline block: DeleteDomainRequest.Builder.() -> Unit): DeleteDomainResponse

Deletes the specified domain from Voice ID.

Link copied to clipboard
inline suspend fun VoiceIdClient.deleteFraudster(crossinline block: DeleteFraudsterRequest.Builder.() -> Unit): DeleteFraudsterResponse

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

Link copied to clipboard
inline suspend fun VoiceIdClient.deleteSpeaker(crossinline block: DeleteSpeakerRequest.Builder.() -> Unit): DeleteSpeakerResponse

Deletes the specified speaker from Voice ID.

Link copied to clipboard
inline suspend fun VoiceIdClient.deleteWatchlist(crossinline block: DeleteWatchlistRequest.Builder.() -> Unit): DeleteWatchlistResponse

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeDomain(crossinline block: DescribeDomainRequest.Builder.() -> Unit): DescribeDomainResponse

Describes the specified domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeFraudster(crossinline block: DescribeFraudsterRequest.Builder.() -> Unit): DescribeFraudsterResponse

Describes the specified fraudster.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeFraudsterRegistrationJob(crossinline block: DescribeFraudsterRegistrationJobRequest.Builder.() -> Unit): DescribeFraudsterRegistrationJobResponse

Describes the specified fraudster registration job.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeSpeaker(crossinline block: DescribeSpeakerRequest.Builder.() -> Unit): DescribeSpeakerResponse

Describes the specified speaker.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeSpeakerEnrollmentJob(crossinline block: DescribeSpeakerEnrollmentJobRequest.Builder.() -> Unit): DescribeSpeakerEnrollmentJobResponse

Describes the specified speaker enrollment job.

Link copied to clipboard
inline suspend fun VoiceIdClient.describeWatchlist(crossinline block: DescribeWatchlistRequest.Builder.() -> Unit): DescribeWatchlistResponse

Describes the specified watchlist.

Link copied to clipboard
inline suspend fun VoiceIdClient.disassociateFraudster(crossinline block: DisassociateFraudsterRequest.Builder.() -> Unit): DisassociateFraudsterResponse

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

Link copied to clipboard
inline suspend fun VoiceIdClient.evaluateSession(crossinline block: EvaluateSessionRequest.Builder.() -> Unit): EvaluateSessionResponse

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Link copied to clipboard
inline suspend fun VoiceIdClient.listDomains(crossinline block: ListDomainsRequest.Builder.() -> Unit): ListDomainsResponse

Lists all the domains in the Amazon Web Services account.

Link copied to clipboard
inline suspend fun VoiceIdClient.listFraudsterRegistrationJobs(crossinline block: ListFraudsterRegistrationJobsRequest.Builder.() -> Unit): ListFraudsterRegistrationJobsResponse

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.listFraudsters(crossinline block: ListFraudstersRequest.Builder.() -> Unit): ListFraudstersResponse

Lists all fraudsters in a specified watchlist or domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.listSpeakerEnrollmentJobs(crossinline block: ListSpeakerEnrollmentJobsRequest.Builder.() -> Unit): ListSpeakerEnrollmentJobsResponse

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.

Link copied to clipboard
inline suspend fun VoiceIdClient.listSpeakers(crossinline block: ListSpeakersRequest.Builder.() -> Unit): ListSpeakersResponse

Lists all speakers in a specified domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists all tags associated with a specified Voice ID resource.

Link copied to clipboard
inline suspend fun VoiceIdClient.listWatchlists(crossinline block: ListWatchlistsRequest.Builder.() -> Unit): ListWatchlistsResponse

Lists all watchlists in a specified domain.

Link copied to clipboard
inline suspend fun VoiceIdClient.optOutSpeaker(crossinline block: OptOutSpeakerRequest.Builder.() -> Unit): OptOutSpeakerResponse

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

Link copied to clipboard
inline suspend fun VoiceIdClient.startFraudsterRegistrationJob(crossinline block: StartFraudsterRegistrationJobRequest.Builder.() -> Unit): StartFraudsterRegistrationJobResponse

Starts a new batch fraudster registration job using provided details.

Link copied to clipboard
inline suspend fun VoiceIdClient.startSpeakerEnrollmentJob(crossinline block: StartSpeakerEnrollmentJobRequest.Builder.() -> Unit): StartSpeakerEnrollmentJobResponse

Starts a new batch speaker enrollment job using specified details.

Link copied to clipboard
inline suspend fun VoiceIdClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Tags a Voice ID resource with the provided list of tags.

Link copied to clipboard
inline suspend fun VoiceIdClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes specified tags from a specified Amazon Connect Voice ID resource.

Link copied to clipboard
inline suspend fun VoiceIdClient.updateDomain(crossinline block: UpdateDomainRequest.Builder.() -> Unit): UpdateDomainResponse

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.

Link copied to clipboard
inline suspend fun VoiceIdClient.updateWatchlist(crossinline block: UpdateWatchlistRequest.Builder.() -> Unit): UpdateWatchlistResponse

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.

Link copied to clipboard
fun VoiceIdClient.withConfig(block: VoiceIdClient.Config.Builder.() -> Unit): VoiceIdClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.