aws-sdk 2.1343.0 → 2.1344.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,13 +12,29 @@ declare class VoiceID extends Service {
12
12
  constructor(options?: VoiceID.Types.ClientConfiguration)
13
13
  config: Config & VoiceID.Types.ClientConfiguration;
14
14
  /**
15
- * Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
15
+ * Associates the fraudsters with the watchlist specified in the same domain.
16
+ */
17
+ associateFraudster(params: VoiceID.Types.AssociateFraudsterRequest, callback?: (err: AWSError, data: VoiceID.Types.AssociateFraudsterResponse) => void): Request<VoiceID.Types.AssociateFraudsterResponse, AWSError>;
18
+ /**
19
+ * Associates the fraudsters with the watchlist specified in the same domain.
20
+ */
21
+ associateFraudster(callback?: (err: AWSError, data: VoiceID.Types.AssociateFraudsterResponse) => void): Request<VoiceID.Types.AssociateFraudsterResponse, AWSError>;
22
+ /**
23
+ * 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.
16
24
  */
17
25
  createDomain(params: VoiceID.Types.CreateDomainRequest, callback?: (err: AWSError, data: VoiceID.Types.CreateDomainResponse) => void): Request<VoiceID.Types.CreateDomainResponse, AWSError>;
18
26
  /**
19
- * Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
27
+ * 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.
20
28
  */
21
29
  createDomain(callback?: (err: AWSError, data: VoiceID.Types.CreateDomainResponse) => void): Request<VoiceID.Types.CreateDomainResponse, AWSError>;
30
+ /**
31
+ * Creates a watchlist that fraudsters can be a part of.
32
+ */
33
+ createWatchlist(params: VoiceID.Types.CreateWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.CreateWatchlistResponse) => void): Request<VoiceID.Types.CreateWatchlistResponse, AWSError>;
34
+ /**
35
+ * Creates a watchlist that fraudsters can be a part of.
36
+ */
37
+ createWatchlist(callback?: (err: AWSError, data: VoiceID.Types.CreateWatchlistResponse) => void): Request<VoiceID.Types.CreateWatchlistResponse, AWSError>;
22
38
  /**
23
39
  * Deletes the specified domain from Voice ID.
24
40
  */
@@ -28,11 +44,11 @@ declare class VoiceID extends Service {
28
44
  */
29
45
  deleteDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
30
46
  /**
31
- * Deletes the specified fraudster from Voice ID.
47
+ * Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
32
48
  */
33
49
  deleteFraudster(params: VoiceID.Types.DeleteFraudsterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
34
50
  /**
35
- * Deletes the specified fraudster from Voice ID.
51
+ * Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
36
52
  */
37
53
  deleteFraudster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
38
54
  /**
@@ -43,6 +59,14 @@ declare class VoiceID extends Service {
43
59
  * Deletes the specified speaker from Voice ID.
44
60
  */
45
61
  deleteSpeaker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62
+ /**
63
+ * 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.
64
+ */
65
+ deleteWatchlist(params: VoiceID.Types.DeleteWatchlistRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66
+ /**
67
+ * 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.
68
+ */
69
+ deleteWatchlist(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
46
70
  /**
47
71
  * Describes the specified domain.
48
72
  */
@@ -83,6 +107,22 @@ declare class VoiceID extends Service {
83
107
  * Describes the specified speaker enrollment job.
84
108
  */
85
109
  describeSpeakerEnrollmentJob(callback?: (err: AWSError, data: VoiceID.Types.DescribeSpeakerEnrollmentJobResponse) => void): Request<VoiceID.Types.DescribeSpeakerEnrollmentJobResponse, AWSError>;
110
+ /**
111
+ * Describes the specified watchlist.
112
+ */
113
+ describeWatchlist(params: VoiceID.Types.DescribeWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeWatchlistResponse) => void): Request<VoiceID.Types.DescribeWatchlistResponse, AWSError>;
114
+ /**
115
+ * Describes the specified watchlist.
116
+ */
117
+ describeWatchlist(callback?: (err: AWSError, data: VoiceID.Types.DescribeWatchlistResponse) => void): Request<VoiceID.Types.DescribeWatchlistResponse, AWSError>;
118
+ /**
119
+ * 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.
120
+ */
121
+ disassociateFraudster(params: VoiceID.Types.DisassociateFraudsterRequest, callback?: (err: AWSError, data: VoiceID.Types.DisassociateFraudsterResponse) => void): Request<VoiceID.Types.DisassociateFraudsterResponse, AWSError>;
122
+ /**
123
+ * 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.
124
+ */
125
+ disassociateFraudster(callback?: (err: AWSError, data: VoiceID.Types.DisassociateFraudsterResponse) => void): Request<VoiceID.Types.DisassociateFraudsterResponse, AWSError>;
86
126
  /**
87
127
  * Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
88
128
  */
@@ -107,6 +147,14 @@ declare class VoiceID extends Service {
107
147
  * 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.
108
148
  */
109
149
  listFraudsterRegistrationJobs(callback?: (err: AWSError, data: VoiceID.Types.ListFraudsterRegistrationJobsResponse) => void): Request<VoiceID.Types.ListFraudsterRegistrationJobsResponse, AWSError>;
150
+ /**
151
+ * Lists all fraudsters in a specified watchlist or domain.
152
+ */
153
+ listFraudsters(params: VoiceID.Types.ListFraudstersRequest, callback?: (err: AWSError, data: VoiceID.Types.ListFraudstersResponse) => void): Request<VoiceID.Types.ListFraudstersResponse, AWSError>;
154
+ /**
155
+ * Lists all fraudsters in a specified watchlist or domain.
156
+ */
157
+ listFraudsters(callback?: (err: AWSError, data: VoiceID.Types.ListFraudstersResponse) => void): Request<VoiceID.Types.ListFraudstersResponse, AWSError>;
110
158
  /**
111
159
  * 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.
112
160
  */
@@ -131,6 +179,14 @@ declare class VoiceID extends Service {
131
179
  * Lists all tags associated with a specified Voice ID resource.
132
180
  */
133
181
  listTagsForResource(callback?: (err: AWSError, data: VoiceID.Types.ListTagsForResourceResponse) => void): Request<VoiceID.Types.ListTagsForResourceResponse, AWSError>;
182
+ /**
183
+ * Lists all watchlists in a specified domain.
184
+ */
185
+ listWatchlists(params: VoiceID.Types.ListWatchlistsRequest, callback?: (err: AWSError, data: VoiceID.Types.ListWatchlistsResponse) => void): Request<VoiceID.Types.ListWatchlistsResponse, AWSError>;
186
+ /**
187
+ * Lists all watchlists in a specified domain.
188
+ */
189
+ listWatchlists(callback?: (err: AWSError, data: VoiceID.Types.ListWatchlistsResponse) => void): Request<VoiceID.Types.ListWatchlistsResponse, AWSError>;
134
190
  /**
135
191
  * 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.
136
192
  */
@@ -179,10 +235,35 @@ declare class VoiceID extends Service {
179
235
  * 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.
180
236
  */
181
237
  updateDomain(callback?: (err: AWSError, data: VoiceID.Types.UpdateDomainResponse) => void): Request<VoiceID.Types.UpdateDomainResponse, AWSError>;
238
+ /**
239
+ * Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
240
+ */
241
+ updateWatchlist(params: VoiceID.Types.UpdateWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.UpdateWatchlistResponse) => void): Request<VoiceID.Types.UpdateWatchlistResponse, AWSError>;
242
+ /**
243
+ * Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
244
+ */
245
+ updateWatchlist(callback?: (err: AWSError, data: VoiceID.Types.UpdateWatchlistResponse) => void): Request<VoiceID.Types.UpdateWatchlistResponse, AWSError>;
182
246
  }
183
247
  declare namespace VoiceID {
184
248
  export type AmazonResourceName = string;
185
249
  export type Arn = string;
250
+ export interface AssociateFraudsterRequest {
251
+ /**
252
+ * The identifier of the domain that contains the fraudster.
253
+ */
254
+ DomainId: DomainId;
255
+ /**
256
+ * The identifier of the fraudster to be associated with the watchlist.
257
+ */
258
+ FraudsterId: FraudsterId;
259
+ /**
260
+ * The identifier of the watchlist you want to associate with the fraudster.
261
+ */
262
+ WatchlistId: WatchlistId;
263
+ }
264
+ export interface AssociateFraudsterResponse {
265
+ Fraudster?: Fraudster;
266
+ }
186
267
  export interface AuthenticationConfiguration {
187
268
  /**
188
269
  * The minimum threshold needed to successfully authenticate a speaker.
@@ -192,11 +273,11 @@ declare namespace VoiceID {
192
273
  export type AuthenticationDecision = "ACCEPT"|"REJECT"|"NOT_ENOUGH_SPEECH"|"SPEAKER_NOT_ENROLLED"|"SPEAKER_OPTED_OUT"|"SPEAKER_ID_NOT_PROVIDED"|"SPEAKER_EXPIRED"|string;
193
274
  export interface AuthenticationResult {
194
275
  /**
195
- * A timestamp indicating when audio aggregation ended for this authentication result.
276
+ * A timestamp of when audio aggregation ended for this authentication result.
196
277
  */
197
278
  AudioAggregationEndedAt?: Timestamp;
198
279
  /**
199
- * A timestamp indicating when audio aggregation started for this authentication result.
280
+ * A timestamp of when audio aggregation started for this authentication result.
200
281
  */
201
282
  AudioAggregationStartedAt?: Timestamp;
202
283
  /**
@@ -224,14 +305,15 @@ declare namespace VoiceID {
224
305
  */
225
306
  Score?: Score;
226
307
  }
308
+ export type Boolean = boolean;
227
309
  export type ClientTokenString = string;
228
310
  export interface CreateDomainRequest {
229
311
  /**
230
- * The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
312
+ * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
231
313
  */
232
314
  ClientToken?: ClientTokenString;
233
315
  /**
234
- * A brief description of the domain.
316
+ * A brief description of this domain.
235
317
  */
236
318
  Description?: Description;
237
319
  /**
@@ -253,6 +335,30 @@ declare namespace VoiceID {
253
335
  */
254
336
  Domain?: Domain;
255
337
  }
338
+ export interface CreateWatchlistRequest {
339
+ /**
340
+ * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
341
+ */
342
+ ClientToken?: ClientTokenString;
343
+ /**
344
+ * A brief description of this watchlist.
345
+ */
346
+ Description?: WatchlistDescription;
347
+ /**
348
+ * The identifier of the domain that contains the watchlist.
349
+ */
350
+ DomainId: DomainId;
351
+ /**
352
+ * The name of the watchlist.
353
+ */
354
+ Name: WatchlistName;
355
+ }
356
+ export interface CreateWatchlistResponse {
357
+ /**
358
+ * Information about the newly created watchlist.
359
+ */
360
+ Watchlist?: Watchlist;
361
+ }
256
362
  export type CustomerSpeakerId = string;
257
363
  export interface DeleteDomainRequest {
258
364
  /**
@@ -262,7 +368,7 @@ declare namespace VoiceID {
262
368
  }
263
369
  export interface DeleteFraudsterRequest {
264
370
  /**
265
- * The identifier of the domain containing the fraudster.
371
+ * The identifier of the domain that contains the fraudster.
266
372
  */
267
373
  DomainId: DomainId;
268
374
  /**
@@ -272,7 +378,7 @@ declare namespace VoiceID {
272
378
  }
273
379
  export interface DeleteSpeakerRequest {
274
380
  /**
275
- * The identifier of the domain containing the speaker.
381
+ * The identifier of the domain that contains the speaker.
276
382
  */
277
383
  DomainId: DomainId;
278
384
  /**
@@ -280,9 +386,19 @@ declare namespace VoiceID {
280
386
  */
281
387
  SpeakerId: SpeakerId;
282
388
  }
389
+ export interface DeleteWatchlistRequest {
390
+ /**
391
+ * The identifier of the domain that contains the watchlist.
392
+ */
393
+ DomainId: DomainId;
394
+ /**
395
+ * The identifier of the watchlist to be deleted.
396
+ */
397
+ WatchlistId: WatchlistId;
398
+ }
283
399
  export interface DescribeDomainRequest {
284
400
  /**
285
- * The identifier of the domain you are describing.
401
+ * The identifier of the domain that you are describing.
286
402
  */
287
403
  DomainId: DomainId;
288
404
  }
@@ -294,11 +410,11 @@ declare namespace VoiceID {
294
410
  }
295
411
  export interface DescribeFraudsterRegistrationJobRequest {
296
412
  /**
297
- * The identifier for the domain containing the fraudster registration job.
413
+ * The identifier of the domain that contains the fraudster registration job.
298
414
  */
299
415
  DomainId: DomainId;
300
416
  /**
301
- * The identifier for the fraudster registration job you are describing.
417
+ * The identifier of the fraudster registration job you are describing.
302
418
  */
303
419
  JobId: JobId;
304
420
  }
@@ -310,7 +426,7 @@ declare namespace VoiceID {
310
426
  }
311
427
  export interface DescribeFraudsterRequest {
312
428
  /**
313
- * The identifier of the domain containing the fraudster.
429
+ * The identifier of the domain that contains the fraudster.
314
430
  */
315
431
  DomainId: DomainId;
316
432
  /**
@@ -326,7 +442,7 @@ declare namespace VoiceID {
326
442
  }
327
443
  export interface DescribeSpeakerEnrollmentJobRequest {
328
444
  /**
329
- * The identifier of the domain containing the speaker enrollment job.
445
+ * The identifier of the domain that contains the speaker enrollment job.
330
446
  */
331
447
  DomainId: DomainId;
332
448
  /**
@@ -356,22 +472,55 @@ declare namespace VoiceID {
356
472
  */
357
473
  Speaker?: Speaker;
358
474
  }
475
+ export interface DescribeWatchlistRequest {
476
+ /**
477
+ * The identifier of the domain that contains the watchlist.
478
+ */
479
+ DomainId: DomainId;
480
+ /**
481
+ * The identifier of the watchlist that you are describing.
482
+ */
483
+ WatchlistId: WatchlistId;
484
+ }
485
+ export interface DescribeWatchlistResponse {
486
+ /**
487
+ * Information about the specified watchlist.
488
+ */
489
+ Watchlist?: Watchlist;
490
+ }
359
491
  export type Description = string;
492
+ export interface DisassociateFraudsterRequest {
493
+ /**
494
+ * The identifier of the domain that contains the fraudster.
495
+ */
496
+ DomainId: DomainId;
497
+ /**
498
+ * The identifier of the fraudster to be disassociated from the watchlist.
499
+ */
500
+ FraudsterId: FraudsterId;
501
+ /**
502
+ * The identifier of the watchlist that you want to disassociate from the fraudster.
503
+ */
504
+ WatchlistId: WatchlistId;
505
+ }
506
+ export interface DisassociateFraudsterResponse {
507
+ Fraudster?: Fraudster;
508
+ }
360
509
  export interface Domain {
361
510
  /**
362
511
  * The Amazon Resource Name (ARN) for the domain.
363
512
  */
364
513
  Arn?: Arn;
365
514
  /**
366
- * The timestamp at which the domain is created.
515
+ * The timestamp of when the domain was created.
367
516
  */
368
517
  CreatedAt?: Timestamp;
369
518
  /**
370
- * The client-provided description of the domain.
519
+ * The description of the domain.
371
520
  */
372
521
  Description?: Description;
373
522
  /**
374
- * The service-generated identifier for the domain.
523
+ * The identifier of the domain.
375
524
  */
376
525
  DomainId?: DomainId;
377
526
  /**
@@ -379,7 +528,7 @@ declare namespace VoiceID {
379
528
  */
380
529
  DomainStatus?: DomainStatus;
381
530
  /**
382
- * The client-provided name for the domain.
531
+ * The name for the domain.
383
532
  */
384
533
  Name?: DomainName;
385
534
  /**
@@ -391,9 +540,13 @@ declare namespace VoiceID {
391
540
  */
392
541
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
393
542
  /**
394
- * The timestamp showing the domain's last update.
543
+ * The timestamp of when the domain was last update.
395
544
  */
396
545
  UpdatedAt?: Timestamp;
546
+ /**
547
+ * The watchlist details of a domain. Contains the default watchlist ID of the domain.
548
+ */
549
+ WatchlistDetails?: WatchlistDetails;
397
550
  }
398
551
  export type DomainId = string;
399
552
  export type DomainName = string;
@@ -405,15 +558,15 @@ declare namespace VoiceID {
405
558
  */
406
559
  Arn?: Arn;
407
560
  /**
408
- * The timestamp showing when the domain is created.
561
+ * The timestamp of when the domain was created.
409
562
  */
410
563
  CreatedAt?: Timestamp;
411
564
  /**
412
- * The client-provided description of the domain.
565
+ * The description of the domain.
413
566
  */
414
567
  Description?: Description;
415
568
  /**
416
- * The service-generated identifier for the domain.
569
+ * The identifier of the domain.
417
570
  */
418
571
  DomainId?: DomainId;
419
572
  /**
@@ -433,9 +586,13 @@ declare namespace VoiceID {
433
586
  */
434
587
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
435
588
  /**
436
- * The timestamp showing the domain's last update.
589
+ * The timestamp of when the domain was last updated.
437
590
  */
438
591
  UpdatedAt?: Timestamp;
592
+ /**
593
+ * Provides information about watchlistDetails and DefaultWatchlistID.
594
+ */
595
+ WatchlistDetails?: WatchlistDetails;
439
596
  }
440
597
  export type DuplicateRegistrationAction = "SKIP"|"REGISTER_AS_NEW"|string;
441
598
  export interface EnrollmentConfig {
@@ -457,7 +614,12 @@ declare namespace VoiceID {
457
614
  * Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
458
615
  */
459
616
  RiskThreshold?: Score;
617
+ /**
618
+ * The identifier of watchlists against which fraud detection is performed.
619
+ */
620
+ WatchlistIds?: EnrollmentJobFraudDetectionConfigWatchlistIds;
460
621
  }
622
+ export type EnrollmentJobFraudDetectionConfigWatchlistIds = WatchlistId[];
461
623
  export interface EvaluateSessionRequest {
462
624
  /**
463
625
  * The identifier of the domain where the session started.
@@ -474,7 +636,7 @@ declare namespace VoiceID {
474
636
  */
475
637
  AuthenticationResult?: AuthenticationResult;
476
638
  /**
477
- * The identifier of the domain containing the session.
639
+ * The identifier of the domain that contains the session.
478
640
  */
479
641
  DomainId?: DomainId;
480
642
  /**
@@ -510,18 +672,22 @@ declare namespace VoiceID {
510
672
  /**
511
673
  * Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
512
674
  */
513
- RiskThreshold: Score;
675
+ RiskThreshold?: Score;
676
+ /**
677
+ * The identifier of the watchlist against which fraud detection is performed.
678
+ */
679
+ WatchlistId?: WatchlistId;
514
680
  }
515
681
  export type FraudDetectionDecision = "HIGH_RISK"|"LOW_RISK"|"NOT_ENOUGH_SPEECH"|string;
516
682
  export type FraudDetectionReason = "KNOWN_FRAUDSTER"|"VOICE_SPOOFING"|string;
517
683
  export type FraudDetectionReasons = FraudDetectionReason[];
518
684
  export interface FraudDetectionResult {
519
685
  /**
520
- * A timestamp indicating when audio aggregation ended for this fraud detection result.
686
+ * A timestamp of when audio aggregation ended for this fraud detection result.
521
687
  */
522
688
  AudioAggregationEndedAt?: Timestamp;
523
689
  /**
524
- * A timestamp indicating when audio aggregation started for this fraud detection result.
690
+ * A timestamp of when audio aggregation started for this fraud detection result.
525
691
  */
526
692
  AudioAggregationStartedAt?: Timestamp;
527
693
  /**
@@ -557,22 +723,26 @@ declare namespace VoiceID {
557
723
  }
558
724
  export interface Fraudster {
559
725
  /**
560
- * The timestamp when Voice ID identified the fraudster.
726
+ * The timestamp of when Voice ID identified the fraudster.
561
727
  */
562
728
  CreatedAt?: Timestamp;
563
729
  /**
564
- * The identifier for the domain containing the fraudster.
730
+ * The identifier of the domain that contains the fraudster.
565
731
  */
566
732
  DomainId?: DomainId;
567
733
  /**
568
734
  * The service-generated identifier for the fraudster.
569
735
  */
570
736
  GeneratedFraudsterId?: GeneratedFraudsterId;
737
+ /**
738
+ * The identifier of the watchlists the fraudster is a part of.
739
+ */
740
+ WatchlistIds?: ResponseWatchlistIds;
571
741
  }
572
742
  export type FraudsterId = string;
573
743
  export interface FraudsterRegistrationJob {
574
744
  /**
575
- * A timestamp showing the creation time of the fraudster registration job.
745
+ * A timestamp of when the fraudster registration job was created.
576
746
  */
577
747
  CreatedAt?: Timestamp;
578
748
  /**
@@ -580,11 +750,11 @@ declare namespace VoiceID {
580
750
  */
581
751
  DataAccessRoleArn?: IamRoleArn;
582
752
  /**
583
- * The identifier of the domain containing the fraudster registration job.
753
+ * The identifier of the domain that contains the fraudster registration job.
584
754
  */
585
755
  DomainId?: DomainId;
586
756
  /**
587
- * A timestamp showing when the fraudster registration job ended.
757
+ * A timestamp of when the fraudster registration job ended.
588
758
  */
589
759
  EndedAt?: Timestamp;
590
760
  /**
@@ -624,15 +794,15 @@ declare namespace VoiceID {
624
794
  export type FraudsterRegistrationJobSummaries = FraudsterRegistrationJobSummary[];
625
795
  export interface FraudsterRegistrationJobSummary {
626
796
  /**
627
- * A timestamp showing when the fraudster registration job is created.
797
+ * A timestamp of when the fraudster registration job was created.
628
798
  */
629
799
  CreatedAt?: Timestamp;
630
800
  /**
631
- * The identifier of the domain containing the fraudster registration job.
801
+ * The identifier of the domain that contains the fraudster registration job.
632
802
  */
633
803
  DomainId?: DomainId;
634
804
  /**
635
- * A timestamp showing when the fraudster registration job ended.
805
+ * A timestamp of when the fraudster registration job ended.
636
806
  */
637
807
  EndedAt?: Timestamp;
638
808
  /**
@@ -656,6 +826,25 @@ declare namespace VoiceID {
656
826
  */
657
827
  JobStatus?: FraudsterRegistrationJobStatus;
658
828
  }
829
+ export type FraudsterSummaries = FraudsterSummary[];
830
+ export interface FraudsterSummary {
831
+ /**
832
+ * The timestamp of when the fraudster summary was created.
833
+ */
834
+ CreatedAt?: Timestamp;
835
+ /**
836
+ * The identifier of the domain that contains the fraudster summary.
837
+ */
838
+ DomainId?: DomainId;
839
+ /**
840
+ * The service-generated identifier for the fraudster.
841
+ */
842
+ GeneratedFraudsterId?: GeneratedFraudsterId;
843
+ /**
844
+ * The identifier of the watchlists the fraudster is a part of.
845
+ */
846
+ WatchlistIds?: ResponseWatchlistIds;
847
+ }
659
848
  export type GeneratedFraudsterId = string;
660
849
  export type GeneratedSpeakerId = string;
661
850
  export type IamRoleArn = string;
@@ -687,11 +876,11 @@ declare namespace VoiceID {
687
876
  }
688
877
  export interface ListDomainsRequest {
689
878
  /**
690
- * The maximum number of domains to list per API call.
879
+ * 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.
691
880
  */
692
881
  MaxResults?: MaxResultsForListDomainFe;
693
882
  /**
694
- * 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.
883
+ * 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.
695
884
  */
696
885
  NextToken?: NextToken;
697
886
  }
@@ -701,13 +890,13 @@ declare namespace VoiceID {
701
890
  */
702
891
  DomainSummaries?: DomainSummaries;
703
892
  /**
704
- * 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.
893
+ * 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.
705
894
  */
706
895
  NextToken?: String;
707
896
  }
708
897
  export interface ListFraudsterRegistrationJobsRequest {
709
898
  /**
710
- * The identifier of the domain containing the fraudster registration Jobs.
899
+ * The identifier of the domain that contains the fraudster registration Jobs.
711
900
  */
712
901
  DomainId: DomainId;
713
902
  /**
@@ -715,11 +904,11 @@ declare namespace VoiceID {
715
904
  */
716
905
  JobStatus?: FraudsterRegistrationJobStatus;
717
906
  /**
718
- * The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
907
+ * 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.
719
908
  */
720
909
  MaxResults?: MaxResultsForList;
721
910
  /**
722
- * 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.
911
+ * 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.
723
912
  */
724
913
  NextToken?: NextToken;
725
914
  }
@@ -728,6 +917,34 @@ declare namespace VoiceID {
728
917
  * A list containing details about each specified fraudster registration job.
729
918
  */
730
919
  JobSummaries?: FraudsterRegistrationJobSummaries;
920
+ /**
921
+ * 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.
922
+ */
923
+ NextToken?: String;
924
+ }
925
+ export interface ListFraudstersRequest {
926
+ /**
927
+ * The identifier of the domain.
928
+ */
929
+ DomainId: DomainId;
930
+ /**
931
+ * 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.
932
+ */
933
+ MaxResults?: MaxResultsForList;
934
+ /**
935
+ * 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.
936
+ */
937
+ NextToken?: NextToken;
938
+ /**
939
+ * The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.
940
+ */
941
+ WatchlistId?: WatchlistId;
942
+ }
943
+ export interface ListFraudstersResponse {
944
+ /**
945
+ * A list that contains details about each fraudster in the Amazon Web Services account.
946
+ */
947
+ FraudsterSummaries?: FraudsterSummaries;
731
948
  /**
732
949
  * 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.
733
950
  */
@@ -735,7 +952,7 @@ declare namespace VoiceID {
735
952
  }
736
953
  export interface ListSpeakerEnrollmentJobsRequest {
737
954
  /**
738
- * The identifier of the domain containing the speaker enrollment jobs.
955
+ * The identifier of the domain that contains the speaker enrollment jobs.
739
956
  */
740
957
  DomainId: DomainId;
741
958
  /**
@@ -743,11 +960,11 @@ declare namespace VoiceID {
743
960
  */
744
961
  JobStatus?: SpeakerEnrollmentJobStatus;
745
962
  /**
746
- * The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
963
+ * 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.
747
964
  */
748
965
  MaxResults?: MaxResultsForList;
749
966
  /**
750
- * 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.
967
+ * 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.
751
968
  */
752
969
  NextToken?: NextToken;
753
970
  }
@@ -767,11 +984,11 @@ declare namespace VoiceID {
767
984
  */
768
985
  DomainId: DomainId;
769
986
  /**
770
- * The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
987
+ * 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.
771
988
  */
772
989
  MaxResults?: MaxResultsForList;
773
990
  /**
774
- * 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.
991
+ * 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.
775
992
  */
776
993
  NextToken?: NextToken;
777
994
  }
@@ -797,12 +1014,36 @@ declare namespace VoiceID {
797
1014
  */
798
1015
  Tags?: TagList;
799
1016
  }
1017
+ export interface ListWatchlistsRequest {
1018
+ /**
1019
+ * The identifier of the domain.
1020
+ */
1021
+ DomainId: DomainId;
1022
+ /**
1023
+ * 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.
1024
+ */
1025
+ MaxResults?: MaxResultsForList;
1026
+ /**
1027
+ * 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.
1028
+ */
1029
+ NextToken?: NextToken;
1030
+ }
1031
+ export interface ListWatchlistsResponse {
1032
+ /**
1033
+ * 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.
1034
+ */
1035
+ NextToken?: String;
1036
+ /**
1037
+ * A list that contains details about each watchlist in the Amazon Web Services account.
1038
+ */
1039
+ WatchlistSummaries?: WatchlistSummaries;
1040
+ }
800
1041
  export type MaxResultsForList = number;
801
1042
  export type MaxResultsForListDomainFe = number;
802
1043
  export type NextToken = string;
803
1044
  export interface OptOutSpeakerRequest {
804
1045
  /**
805
- * The identifier of the domain containing the speaker.
1046
+ * The identifier of the domain that contains the speaker.
806
1047
  */
807
1048
  DomainId: DomainId;
808
1049
  /**
@@ -835,7 +1076,13 @@ declare namespace VoiceID {
835
1076
  * The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
836
1077
  */
837
1078
  FraudsterSimilarityThreshold?: Score;
1079
+ /**
1080
+ * The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.
1081
+ */
1082
+ WatchlistIds?: RegistrationConfigWatchlistIds;
838
1083
  }
1084
+ export type RegistrationConfigWatchlistIds = WatchlistId[];
1085
+ export type ResponseWatchlistIds = WatchlistId[];
839
1086
  export type S3Uri = string;
840
1087
  export type Score = number;
841
1088
  export interface ServerSideEncryptionConfiguration {
@@ -864,7 +1111,7 @@ declare namespace VoiceID {
864
1111
  export type SessionNameOrId = string;
865
1112
  export interface Speaker {
866
1113
  /**
867
- * A timestamp showing when the speaker is created.
1114
+ * A timestamp of when the speaker was created.
868
1115
  */
869
1116
  CreatedAt?: Timestamp;
870
1117
  /**
@@ -880,7 +1127,7 @@ declare namespace VoiceID {
880
1127
  */
881
1128
  GeneratedSpeakerId?: GeneratedSpeakerId;
882
1129
  /**
883
- * The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
1130
+ * The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
884
1131
  */
885
1132
  LastAccessedAt?: Timestamp;
886
1133
  /**
@@ -888,13 +1135,13 @@ declare namespace VoiceID {
888
1135
  */
889
1136
  Status?: SpeakerStatus;
890
1137
  /**
891
- * A timestamp showing the speaker's last update.
1138
+ * A timestamp of the speaker's last update.
892
1139
  */
893
1140
  UpdatedAt?: Timestamp;
894
1141
  }
895
1142
  export interface SpeakerEnrollmentJob {
896
1143
  /**
897
- * A timestamp showing the creation of the speaker enrollment job.
1144
+ * A timestamp of when the speaker enrollment job was created.
898
1145
  */
899
1146
  CreatedAt?: Timestamp;
900
1147
  /**
@@ -906,7 +1153,7 @@ declare namespace VoiceID {
906
1153
  */
907
1154
  DomainId?: DomainId;
908
1155
  /**
909
- * A timestamp showing when the speaker enrollment job ended.
1156
+ * A timestamp of when the speaker enrollment job ended.
910
1157
  */
911
1158
  EndedAt?: Timestamp;
912
1159
  /**
@@ -946,7 +1193,7 @@ declare namespace VoiceID {
946
1193
  export type SpeakerEnrollmentJobSummaries = SpeakerEnrollmentJobSummary[];
947
1194
  export interface SpeakerEnrollmentJobSummary {
948
1195
  /**
949
- * A timestamp showing the creation time of the speaker enrollment job.
1196
+ * A timestamp of when of the speaker enrollment job was created.
950
1197
  */
951
1198
  CreatedAt?: Timestamp;
952
1199
  /**
@@ -954,7 +1201,7 @@ declare namespace VoiceID {
954
1201
  */
955
1202
  DomainId?: DomainId;
956
1203
  /**
957
- * A timestamp showing when the speaker enrollment job ended.
1204
+ * A timestamp of when the speaker enrollment job ended.
958
1205
  */
959
1206
  EndedAt?: Timestamp;
960
1207
  /**
@@ -1013,7 +1260,7 @@ declare namespace VoiceID {
1013
1260
  }
1014
1261
  export interface StartFraudsterRegistrationJobRequest {
1015
1262
  /**
1016
- * The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.
1263
+ * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
1017
1264
  */
1018
1265
  ClientToken?: ClientTokenString;
1019
1266
  /**
@@ -1021,7 +1268,7 @@ declare namespace VoiceID {
1021
1268
  */
1022
1269
  DataAccessRoleArn: IamRoleArn;
1023
1270
  /**
1024
- * The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.
1271
+ * The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.
1025
1272
  */
1026
1273
  DomainId: DomainId;
1027
1274
  /**
@@ -1049,7 +1296,7 @@ declare namespace VoiceID {
1049
1296
  }
1050
1297
  export interface StartSpeakerEnrollmentJobRequest {
1051
1298
  /**
1052
- * The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.
1299
+ * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
1053
1300
  */
1054
1301
  ClientToken?: ClientTokenString;
1055
1302
  /**
@@ -1127,7 +1374,7 @@ declare namespace VoiceID {
1127
1374
  }
1128
1375
  export interface UpdateDomainRequest {
1129
1376
  /**
1130
- * A brief description of the domain.
1377
+ * A brief description about this domain.
1131
1378
  */
1132
1379
  Description?: Description;
1133
1380
  /**
@@ -1149,12 +1396,106 @@ declare namespace VoiceID {
1149
1396
  */
1150
1397
  Domain?: Domain;
1151
1398
  }
1399
+ export interface UpdateWatchlistRequest {
1400
+ /**
1401
+ * A brief description about this watchlist.
1402
+ */
1403
+ Description?: WatchlistDescription;
1404
+ /**
1405
+ * The identifier of the domain that contains the watchlist.
1406
+ */
1407
+ DomainId: DomainId;
1408
+ /**
1409
+ * The name of the watchlist.
1410
+ */
1411
+ Name?: WatchlistName;
1412
+ /**
1413
+ * The identifier of the watchlist to be updated.
1414
+ */
1415
+ WatchlistId: WatchlistId;
1416
+ }
1417
+ export interface UpdateWatchlistResponse {
1418
+ /**
1419
+ * Details about the updated watchlist.
1420
+ */
1421
+ Watchlist?: Watchlist;
1422
+ }
1152
1423
  export interface VoiceSpoofingRisk {
1153
1424
  /**
1154
1425
  * The score indicating the likelihood of speaker’s voice being spoofed.
1155
1426
  */
1156
1427
  RiskScore: Score;
1157
1428
  }
1429
+ export interface Watchlist {
1430
+ /**
1431
+ * The timestamp of when the watchlist was created.
1432
+ */
1433
+ CreatedAt?: Timestamp;
1434
+ /**
1435
+ * Whether the specified watchlist is the default watchlist of a domain.
1436
+ */
1437
+ DefaultWatchlist?: Boolean;
1438
+ /**
1439
+ * The description of the watchlist.
1440
+ */
1441
+ Description?: WatchlistDescription;
1442
+ /**
1443
+ * The identifier of the domain that contains the watchlist.
1444
+ */
1445
+ DomainId?: DomainId;
1446
+ /**
1447
+ * The name for the watchlist.
1448
+ */
1449
+ Name?: WatchlistName;
1450
+ /**
1451
+ * The timestamp of when the watchlist was updated.
1452
+ */
1453
+ UpdatedAt?: Timestamp;
1454
+ /**
1455
+ * The identifier of the watchlist.
1456
+ */
1457
+ WatchlistId?: WatchlistId;
1458
+ }
1459
+ export type WatchlistDescription = string;
1460
+ export interface WatchlistDetails {
1461
+ /**
1462
+ * The identifier of the default watchlist.
1463
+ */
1464
+ DefaultWatchlistId: WatchlistId;
1465
+ }
1466
+ export type WatchlistId = string;
1467
+ export type WatchlistName = string;
1468
+ export type WatchlistSummaries = WatchlistSummary[];
1469
+ export interface WatchlistSummary {
1470
+ /**
1471
+ * The timestamp of when the watchlist was created.
1472
+ */
1473
+ CreatedAt?: Timestamp;
1474
+ /**
1475
+ * Whether the specified watchlist is the default watchlist of a domain.
1476
+ */
1477
+ DefaultWatchlist?: Boolean;
1478
+ /**
1479
+ * The description of the watchlist.
1480
+ */
1481
+ Description?: WatchlistDescription;
1482
+ /**
1483
+ * The identifier of the domain that contains the watchlist.
1484
+ */
1485
+ DomainId?: DomainId;
1486
+ /**
1487
+ * The name for the watchlist.
1488
+ */
1489
+ Name?: WatchlistName;
1490
+ /**
1491
+ * The timestamp of when the watchlist was last updated.
1492
+ */
1493
+ UpdatedAt?: Timestamp;
1494
+ /**
1495
+ * The identifier of the watchlist.
1496
+ */
1497
+ WatchlistId?: WatchlistId;
1498
+ }
1158
1499
  /**
1159
1500
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1160
1501
  */