feat(client-voice-id): Amazon Connect Voice ID now detects voice spoo…

…fing. When a prospective fraudster tries to spoof caller audio using audio playback or synthesized speech, Voice ID will return a risk score and outcome to indicate the how likely it is that the voice is spoofed.
aws · Aug 29, 2022 · bf82531 · bf82531
1 parent 4b78fb1
commit bf82531
Show file tree

Hide file tree

Showing 13 changed files with 675 additions and 666 deletions.
diff --git a/clients/client-voice-id/README.md b/clients/client-voice-id/README.md
@@ -10,8 +10,7 @@
 AWS SDK for JavaScript VoiceID Client for Node.js, Browser and React Native.
 
 <p>Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide
-describes the APIs used for this service.
-</p>
+describes the APIs used for this service. </p>
 
 ## Installing
 

diff --git a/clients/client-voice-id/src/VoiceID.ts b/clients/client-voice-id/src/VoiceID.ts
@@ -102,14 +102,12 @@ import { VoiceIDClient } from "./VoiceIDClient";
 
 /**
  * <p>Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide
- *             describes the APIs used for this service.
- *         </p>
+ *             describes the APIs used for this service. </p>
  */
 export class VoiceID extends VoiceIDClient {
   /**
-   * <p>Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer
-   *             audio, and voiceprints.
-   *         </p>
+   * <p>Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters,
+   *             customer audio, and voiceprints. </p>
    */
   public createDomain(
     args: CreateDomainCommandInput,
@@ -391,8 +389,8 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice
-   *             ID call.</p>
+   * <p>Evaluates a specified session based on audio data accumulated during a streaming
+   *             Amazon Connect Voice ID call.</p>
    */
   public evaluateSession(
     args: EvaluateSessionCommandInput,
@@ -424,8 +422,7 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>Lists all the domains in the Amazon Web Services account.
-   *         </p>
+   * <p>Lists all the domains in the Amazon Web Services account. </p>
    */
   public listDomains(args: ListDomainsCommandInput, options?: __HttpHandlerOptions): Promise<ListDomainsCommandOutput>;
   public listDomains(args: ListDomainsCommandInput, cb: (err: any, data?: ListDomainsCommandOutput) => void): void;
@@ -451,10 +448,9 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>Lists all the fraudster registration jobs in the domain with the given <code>JobStatus</code>.
-   *             If <code>JobStatus</code> is not provided, this lists all fraudster registration jobs in the given
-   *             domain.
-   *         </p>
+   * <p>Lists all the fraudster registration jobs in the domain with the given
+   *                 <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all
+   *             fraudster registration jobs in the given domain. </p>
    */
   public listFraudsterRegistrationJobs(
     args: ListFraudsterRegistrationJobsCommandInput,
@@ -486,9 +482,9 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>Lists all the speaker enrollment jobs in the domain with the specified <code>JobStatus</code>. If
-   *             <code>JobStatus</code> is not provided, this lists all jobs with all possible speaker enrollment job
-   *             statuses.</p>
+   * <p>Lists all the speaker enrollment jobs in the domain with the specified
+   *                 <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all
+   *             jobs with all possible speaker enrollment job statuses.</p>
    */
   public listSpeakerEnrollmentJobs(
     args: ListSpeakerEnrollmentJobsCommandInput,
@@ -581,11 +577,12 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    */
   public optOutSpeaker(
     args: OptOutSpeakerCommandInput,
@@ -739,8 +736,9 @@ export class VoiceID extends VoiceIDClient {
   }
 
   /**
-   * <p>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.</p>
+   * <p>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.</p>
    */
   public updateDomain(
     args: UpdateDomainCommandInput,

diff --git a/clients/client-voice-id/src/VoiceIDClient.ts b/clients/client-voice-id/src/VoiceIDClient.ts
@@ -298,8 +298,7 @@ export interface VoiceIDClientResolvedConfig extends VoiceIDClientResolvedConfig
 
 /**
  * <p>Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide
- *             describes the APIs used for this service.
- *         </p>
+ *             describes the APIs used for this service. </p>
  */
 export class VoiceIDClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-voice-id/src/commands/CreateDomainCommand.ts b/clients/client-voice-id/src/commands/CreateDomainCommand.ts
@@ -28,9 +28,8 @@ export interface CreateDomainCommandInput extends CreateDomainRequest {}
 export interface CreateDomainCommandOutput extends CreateDomainResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer
- *             audio, and voiceprints.
- *         </p>
+ * <p>Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters,
+ *             customer audio, and voiceprints. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/EvaluateSessionCommand.ts b/clients/client-voice-id/src/commands/EvaluateSessionCommand.ts
@@ -28,8 +28,8 @@ export interface EvaluateSessionCommandInput extends EvaluateSessionRequest {}
 export interface EvaluateSessionCommandOutput extends EvaluateSessionResponse, __MetadataBearer {}
 
 /**
- * <p>Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice
- *             ID call.</p>
+ * <p>Evaluates a specified session based on audio data accumulated during a streaming
+ *             Amazon Connect Voice ID call.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/ListDomainsCommand.ts b/clients/client-voice-id/src/commands/ListDomainsCommand.ts
@@ -28,8 +28,7 @@ export interface ListDomainsCommandInput extends ListDomainsRequest {}
 export interface ListDomainsCommandOutput extends ListDomainsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists all the domains in the Amazon Web Services account.
- *         </p>
+ * <p>Lists all the domains in the Amazon Web Services account. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/ListFraudsterRegistrationJobsCommand.ts b/clients/client-voice-id/src/commands/ListFraudsterRegistrationJobsCommand.ts
@@ -30,10 +30,9 @@ export interface ListFraudsterRegistrationJobsCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Lists all the fraudster registration jobs in the domain with the given <code>JobStatus</code>.
- *             If <code>JobStatus</code> is not provided, this lists all fraudster registration jobs in the given
- *             domain.
- *         </p>
+ * <p>Lists all the fraudster registration jobs in the domain with the given
+ *                 <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all
+ *             fraudster registration jobs in the given domain. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/ListSpeakerEnrollmentJobsCommand.ts b/clients/client-voice-id/src/commands/ListSpeakerEnrollmentJobsCommand.ts
@@ -28,9 +28,9 @@ export interface ListSpeakerEnrollmentJobsCommandInput extends ListSpeakerEnroll
 export interface ListSpeakerEnrollmentJobsCommandOutput extends ListSpeakerEnrollmentJobsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists all the speaker enrollment jobs in the domain with the specified <code>JobStatus</code>. If
- *             <code>JobStatus</code> is not provided, this lists all jobs with all possible speaker enrollment job
- *             statuses.</p>
+ * <p>Lists all the speaker enrollment jobs in the domain with the specified
+ *                 <code>JobStatus</code>. If <code>JobStatus</code> is not provided, this lists all
+ *             jobs with all possible speaker enrollment job statuses.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/OptOutSpeakerCommand.ts b/clients/client-voice-id/src/commands/OptOutSpeakerCommand.ts
@@ -28,11 +28,12 @@ export interface OptOutSpeakerCommandInput extends OptOutSpeakerRequest {}
 export interface OptOutSpeakerCommandOutput extends OptOutSpeakerResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-voice-id/src/commands/UpdateDomainCommand.ts b/clients/client-voice-id/src/commands/UpdateDomainCommand.ts
@@ -28,8 +28,9 @@ export interface UpdateDomainCommandInput extends UpdateDomainRequest {}
 export interface UpdateDomainCommandOutput extends UpdateDomainResponse, __MetadataBearer {}
 
 /**
- * <p>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.</p>
+ * <p>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.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript