- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
VoiceIDClient
Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.
Installation
npm install @aws-sdk/client-voice-id
yarn add @aws-sdk/client-voice-id
pnpm add @aws-sdk/client-voice-id
VoiceIDClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AssociateFraudsterCommand | Associates the fraudsters with the watchlist specified in the same domain. |
CreateDomainCommand | 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. |
CreateWatchlistCommand | Creates a watchlist that fraudsters can be a part of. |
DeleteDomainCommand | Deletes the specified domain from Voice ID. |
DeleteFraudsterCommand | Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of. |
DeleteSpeakerCommand | Deletes the specified speaker from Voice ID. |
DeleteWatchlistCommand | 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. |
DescribeDomainCommand | Describes the specified domain. |
DescribeFraudsterCommand | Describes the specified fraudster. |
DescribeFraudsterRegistrationJobCommand | Describes the specified fraudster registration job. |
DescribeSpeakerCommand | Describes the specified speaker. |
DescribeSpeakerEnrollmentJobCommand | Describes the specified speaker enrollment job. |
DescribeWatchlistCommand | Describes the specified watchlist. |
DisassociateFraudsterCommand | 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 |
EvaluateSessionCommand | Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call. |
ListDomainsCommand | Lists all the domains in the Amazon Web Services account. |
ListFraudsterRegistrationJobsCommand | Lists all the fraudster registration jobs in the domain with the given |
ListFraudstersCommand | Lists all fraudsters in a specified watchlist or domain. |
ListSpeakerEnrollmentJobsCommand | Lists all the speaker enrollment jobs in the domain with the specified |
ListSpeakersCommand | Lists all speakers in a specified domain. |
ListTagsForResourceCommand | Lists all tags associated with a specified Voice ID resource. |
ListWatchlistsCommand | Lists all watchlists in a specified domain. |
OptOutSpeakerCommand | 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. |
StartFraudsterRegistrationJobCommand | Starts a new batch fraudster registration job using provided details. |
StartSpeakerEnrollmentJobCommand | Starts a new batch speaker enrollment job using specified details. |
TagResourceCommand | Tags a Voice ID resource with the provided list of tags. |
UntagResourceCommand | Removes specified tags from a specified Amazon Connect Voice ID resource. |
UpdateDomainCommand | 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. |
UpdateWatchlistCommand | Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. |
VoiceIDClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: VoiceIDClientConfig