AWS.VoiceID — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.VoiceID

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

Sending a Request Using VoiceID

var voiceid = new AWS.VoiceID();
voiceid.createWatchlist(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the VoiceID object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var voiceid = new AWS.VoiceID({apiVersion: '2021-09-27'});

You can also set the API version globally in AWS.config.apiVersions using the voiceid service identifier:

AWS.config.apiVersions = {
  voiceid: '2021-09-27',
  // other service API versions
};

var voiceid = new AWS.VoiceID();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.VoiceID(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

associateFraudster(params = {}, callback) ⇒ AWS.Request

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

createDomain(params = {}, callback) ⇒ AWS.Request

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.

createWatchlist(params = {}, callback) ⇒ AWS.Request

Creates a watchlist that fraudsters can be a part of.

deleteDomain(params = {}, callback) ⇒ AWS.Request

Deletes the specified domain from Voice ID.

deleteFraudster(params = {}, callback) ⇒ AWS.Request

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

deleteSpeaker(params = {}, callback) ⇒ AWS.Request

Deletes the specified speaker from Voice ID.

deleteWatchlist(params = {}, callback) ⇒ AWS.Request

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.

describeDomain(params = {}, callback) ⇒ AWS.Request

Describes the specified domain.

describeFraudster(params = {}, callback) ⇒ AWS.Request

Describes the specified fraudster.

describeFraudsterRegistrationJob(params = {}, callback) ⇒ AWS.Request

Describes the specified fraudster registration job.

describeSpeaker(params = {}, callback) ⇒ AWS.Request

Describes the specified speaker.

describeSpeakerEnrollmentJob(params = {}, callback) ⇒ AWS.Request

Describes the specified speaker enrollment job.

describeWatchlist(params = {}, callback) ⇒ AWS.Request

Describes the specified watchlist.

disassociateFraudster(params = {}, callback) ⇒ AWS.Request

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.

evaluateSession(params = {}, callback) ⇒ AWS.Request

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

listDomains(params = {}, callback) ⇒ AWS.Request

Lists all the domains in the Amazon Web Services account.

listFraudsterRegistrationJobs(params = {}, callback) ⇒ AWS.Request

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.

listFraudsters(params = {}, callback) ⇒ AWS.Request

Lists all fraudsters in a specified watchlist or domain.

listSpeakerEnrollmentJobs(params = {}, callback) ⇒ AWS.Request

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.

listSpeakers(params = {}, callback) ⇒ AWS.Request

Lists all speakers in a specified domain.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists all tags associated with a specified Voice ID resource.

listWatchlists(params = {}, callback) ⇒ AWS.Request

Lists all watchlists in a specified domain.

optOutSpeaker(params = {}, callback) ⇒ AWS.Request

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.

startFraudsterRegistrationJob(params = {}, callback) ⇒ AWS.Request

Starts a new batch fraudster registration job using provided details.

startSpeakerEnrollmentJob(params = {}, callback) ⇒ AWS.Request

Starts a new batch speaker enrollment job using specified details.

tagResource(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

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

updateDomain(params = {}, callback) ⇒ AWS.Request

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.

updateWatchlist(params = {}, callback) ⇒ AWS.Request

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