@aws-sdk/client-voice-id 3.379.1 → 3.382.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.
- package/dist-types/models/models_0.d.ts +260 -0
- package/package.json +5 -5
|
@@ -19,14 +19,17 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
*/
|
|
20
20
|
export interface AssociateFraudsterRequest {
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
23
24
|
*/
|
|
24
25
|
DomainId: string | undefined;
|
|
25
26
|
/**
|
|
27
|
+
* @public
|
|
26
28
|
* <p>The identifier of the watchlist you want to associate with the fraudster.</p>
|
|
27
29
|
*/
|
|
28
30
|
WatchlistId: string | undefined;
|
|
29
31
|
/**
|
|
32
|
+
* @public
|
|
30
33
|
* <p>The identifier of the fraudster to be associated with the watchlist.</p>
|
|
31
34
|
*/
|
|
32
35
|
FraudsterId: string | undefined;
|
|
@@ -37,18 +40,22 @@ export interface AssociateFraudsterRequest {
|
|
|
37
40
|
*/
|
|
38
41
|
export interface Fraudster {
|
|
39
42
|
/**
|
|
43
|
+
* @public
|
|
40
44
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
41
45
|
*/
|
|
42
46
|
DomainId?: string;
|
|
43
47
|
/**
|
|
48
|
+
* @public
|
|
44
49
|
* <p>The service-generated identifier for the fraudster.</p>
|
|
45
50
|
*/
|
|
46
51
|
GeneratedFraudsterId?: string;
|
|
47
52
|
/**
|
|
53
|
+
* @public
|
|
48
54
|
* <p>The timestamp of when Voice ID identified the fraudster.</p>
|
|
49
55
|
*/
|
|
50
56
|
CreatedAt?: Date;
|
|
51
57
|
/**
|
|
58
|
+
* @public
|
|
52
59
|
* <p>The identifier of the watchlists the fraudster is a part of.</p>
|
|
53
60
|
*/
|
|
54
61
|
WatchlistIds?: string[];
|
|
@@ -58,6 +65,7 @@ export interface Fraudster {
|
|
|
58
65
|
*/
|
|
59
66
|
export interface AssociateFraudsterResponse {
|
|
60
67
|
/**
|
|
68
|
+
* @public
|
|
61
69
|
* <p>Contains all the information about a fraudster.</p>
|
|
62
70
|
*/
|
|
63
71
|
Fraudster?: Fraudster;
|
|
@@ -92,6 +100,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
92
100
|
readonly $fault: "client";
|
|
93
101
|
Message?: string;
|
|
94
102
|
/**
|
|
103
|
+
* @public
|
|
95
104
|
* <p>The type of conflict which caused a ConflictException. Possible types and the
|
|
96
105
|
* corresponding error messages are as follows:</p>
|
|
97
106
|
* <ul>
|
|
@@ -172,6 +181,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
172
181
|
readonly $fault: "client";
|
|
173
182
|
Message?: string;
|
|
174
183
|
/**
|
|
184
|
+
* @public
|
|
175
185
|
* <p>The type of resource which cannot not be found. Possible types are
|
|
176
186
|
* <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>, <code>DOMAIN</code>,
|
|
177
187
|
* <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
|
|
@@ -231,6 +241,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
231
241
|
*/
|
|
232
242
|
export interface AuthenticationConfiguration {
|
|
233
243
|
/**
|
|
244
|
+
* @public
|
|
234
245
|
* <p>The minimum threshold needed to successfully authenticate a speaker.</p>
|
|
235
246
|
*/
|
|
236
247
|
AcceptanceThreshold: number | undefined;
|
|
@@ -259,6 +270,7 @@ export type AuthenticationDecision = (typeof AuthenticationDecision)[keyof typeo
|
|
|
259
270
|
*/
|
|
260
271
|
export interface AuthenticationResult {
|
|
261
272
|
/**
|
|
273
|
+
* @public
|
|
262
274
|
* <p>The unique identifier for this authentication result. Because there can be multiple
|
|
263
275
|
* authentications for a given session, this field helps to identify if the returned result
|
|
264
276
|
* is from a previous streaming activity or a new result. Note that in absence of any new
|
|
@@ -267,37 +279,44 @@ export interface AuthenticationResult {
|
|
|
267
279
|
*/
|
|
268
280
|
AuthenticationResultId?: string;
|
|
269
281
|
/**
|
|
282
|
+
* @public
|
|
270
283
|
* <p>A timestamp of when audio aggregation started for this authentication
|
|
271
284
|
* result.</p>
|
|
272
285
|
*/
|
|
273
286
|
AudioAggregationStartedAt?: Date;
|
|
274
287
|
/**
|
|
288
|
+
* @public
|
|
275
289
|
* <p>A timestamp of when audio aggregation ended for this authentication
|
|
276
290
|
* result.</p>
|
|
277
291
|
*/
|
|
278
292
|
AudioAggregationEndedAt?: Date;
|
|
279
293
|
/**
|
|
294
|
+
* @public
|
|
280
295
|
* <p>The client-provided identifier for the speaker whose authentication result is
|
|
281
296
|
* produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>
|
|
282
297
|
*/
|
|
283
298
|
CustomerSpeakerId?: string;
|
|
284
299
|
/**
|
|
300
|
+
* @public
|
|
285
301
|
* <p>The service-generated identifier for the speaker whose authentication result is
|
|
286
302
|
* produced.</p>
|
|
287
303
|
*/
|
|
288
304
|
GeneratedSpeakerId?: string;
|
|
289
305
|
/**
|
|
306
|
+
* @public
|
|
290
307
|
* <p>The authentication decision produced by Voice ID, processed against the current
|
|
291
308
|
* session state and streamed audio of the speaker.</p>
|
|
292
309
|
*/
|
|
293
310
|
Decision?: AuthenticationDecision | string;
|
|
294
311
|
/**
|
|
312
|
+
* @public
|
|
295
313
|
* <p>The authentication score for the speaker whose authentication result is produced. This
|
|
296
314
|
* value is only present if the authentication decision is either <code>ACCEPT</code> or
|
|
297
315
|
* <code>REJECT</code>.</p>
|
|
298
316
|
*/
|
|
299
317
|
Score?: number;
|
|
300
318
|
/**
|
|
319
|
+
* @public
|
|
301
320
|
* <p>The <code>AuthenticationConfiguration</code> used to generate this authentication
|
|
302
321
|
* result.</p>
|
|
303
322
|
*/
|
|
@@ -310,6 +329,7 @@ export interface AuthenticationResult {
|
|
|
310
329
|
*/
|
|
311
330
|
export interface ServerSideEncryptionConfiguration {
|
|
312
331
|
/**
|
|
332
|
+
* @public
|
|
313
333
|
* <p>The identifier of the KMS key to use to encrypt data stored by
|
|
314
334
|
* Voice ID. Voice ID doesn't support asymmetric customer managed keys. </p>
|
|
315
335
|
*/
|
|
@@ -322,11 +342,13 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
322
342
|
*/
|
|
323
343
|
export interface Tag {
|
|
324
344
|
/**
|
|
345
|
+
* @public
|
|
325
346
|
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
|
|
326
347
|
* For example, in the tag 'Department':'Sales', the key is 'Department'. </p>
|
|
327
348
|
*/
|
|
328
349
|
Key: string | undefined;
|
|
329
350
|
/**
|
|
351
|
+
* @public
|
|
330
352
|
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
331
353
|
* For example, in the tag 'Department':'Sales', the value is 'Sales'. </p>
|
|
332
354
|
*/
|
|
@@ -337,20 +359,24 @@ export interface Tag {
|
|
|
337
359
|
*/
|
|
338
360
|
export interface CreateDomainRequest {
|
|
339
361
|
/**
|
|
362
|
+
* @public
|
|
340
363
|
* <p>The name of the domain.</p>
|
|
341
364
|
*/
|
|
342
365
|
Name: string | undefined;
|
|
343
366
|
/**
|
|
367
|
+
* @public
|
|
344
368
|
* <p>A brief description of this domain.</p>
|
|
345
369
|
*/
|
|
346
370
|
Description?: string;
|
|
347
371
|
/**
|
|
372
|
+
* @public
|
|
348
373
|
* <p>The configuration, containing the KMS key identifier, to be used by
|
|
349
374
|
* Voice ID for the server-side encryption of your data. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid">
|
|
350
375
|
* Amazon Connect Voice ID encryption at rest</a> for more details on how the KMS key is used. </p>
|
|
351
376
|
*/
|
|
352
377
|
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
|
|
353
378
|
/**
|
|
379
|
+
* @public
|
|
354
380
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
355
381
|
* request. If not provided, the Amazon Web Services
|
|
356
382
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -358,6 +384,7 @@ export interface CreateDomainRequest {
|
|
|
358
384
|
*/
|
|
359
385
|
ClientToken?: string;
|
|
360
386
|
/**
|
|
387
|
+
* @public
|
|
361
388
|
* <p>A list of tags you want added to the domain.</p>
|
|
362
389
|
*/
|
|
363
390
|
Tags?: Tag[];
|
|
@@ -396,11 +423,13 @@ export type ServerSideEncryptionUpdateStatus = (typeof ServerSideEncryptionUpdat
|
|
|
396
423
|
*/
|
|
397
424
|
export interface ServerSideEncryptionUpdateDetails {
|
|
398
425
|
/**
|
|
426
|
+
* @public
|
|
399
427
|
* <p>The previous KMS key ID the domain was encrypted with, before
|
|
400
428
|
* ServerSideEncryptionConfiguration was updated to a new KMS key ID.</p>
|
|
401
429
|
*/
|
|
402
430
|
OldKmsKeyId?: string;
|
|
403
431
|
/**
|
|
432
|
+
* @public
|
|
404
433
|
* <p>Status of the server-side encryption update. During an update, if there is an issue
|
|
405
434
|
* with the domain's current or old KMS key ID, such as an inaccessible or
|
|
406
435
|
* disabled key, then the status is FAILED. In order to resolve this, the key needs to be
|
|
@@ -409,6 +438,7 @@ export interface ServerSideEncryptionUpdateDetails {
|
|
|
409
438
|
*/
|
|
410
439
|
UpdateStatus?: ServerSideEncryptionUpdateStatus | string;
|
|
411
440
|
/**
|
|
441
|
+
* @public
|
|
412
442
|
* <p>Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this
|
|
413
443
|
* message explains the cause of the failure.</p>
|
|
414
444
|
*/
|
|
@@ -420,6 +450,7 @@ export interface ServerSideEncryptionUpdateDetails {
|
|
|
420
450
|
*/
|
|
421
451
|
export interface WatchlistDetails {
|
|
422
452
|
/**
|
|
453
|
+
* @public
|
|
423
454
|
* <p>The identifier of the default watchlist.</p>
|
|
424
455
|
*/
|
|
425
456
|
DefaultWatchlistId: string | undefined;
|
|
@@ -430,45 +461,55 @@ export interface WatchlistDetails {
|
|
|
430
461
|
*/
|
|
431
462
|
export interface Domain {
|
|
432
463
|
/**
|
|
464
|
+
* @public
|
|
433
465
|
* <p>The identifier of the domain.</p>
|
|
434
466
|
*/
|
|
435
467
|
DomainId?: string;
|
|
436
468
|
/**
|
|
469
|
+
* @public
|
|
437
470
|
* <p>The Amazon Resource Name (ARN) for the domain.</p>
|
|
438
471
|
*/
|
|
439
472
|
Arn?: string;
|
|
440
473
|
/**
|
|
474
|
+
* @public
|
|
441
475
|
* <p>The name for the domain.</p>
|
|
442
476
|
*/
|
|
443
477
|
Name?: string;
|
|
444
478
|
/**
|
|
479
|
+
* @public
|
|
445
480
|
* <p>The description of the domain.</p>
|
|
446
481
|
*/
|
|
447
482
|
Description?: string;
|
|
448
483
|
/**
|
|
484
|
+
* @public
|
|
449
485
|
* <p>The current status of the domain.</p>
|
|
450
486
|
*/
|
|
451
487
|
DomainStatus?: DomainStatus | string;
|
|
452
488
|
/**
|
|
489
|
+
* @public
|
|
453
490
|
* <p>The server-side encryption configuration containing the KMS key
|
|
454
491
|
* identifier you want Voice ID to use to encrypt your data.</p>
|
|
455
492
|
*/
|
|
456
493
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
457
494
|
/**
|
|
495
|
+
* @public
|
|
458
496
|
* <p>The timestamp of when the domain was created.</p>
|
|
459
497
|
*/
|
|
460
498
|
CreatedAt?: Date;
|
|
461
499
|
/**
|
|
500
|
+
* @public
|
|
462
501
|
* <p>The timestamp of when the domain was last update.</p>
|
|
463
502
|
*/
|
|
464
503
|
UpdatedAt?: Date;
|
|
465
504
|
/**
|
|
505
|
+
* @public
|
|
466
506
|
* <p>Details about the most recent server-side encryption configuration update. When the
|
|
467
507
|
* server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
|
|
468
508
|
* complete, the domain's data can only be accessed using the new KMS key.</p>
|
|
469
509
|
*/
|
|
470
510
|
ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
|
|
471
511
|
/**
|
|
512
|
+
* @public
|
|
472
513
|
* <p>The watchlist details of a domain. Contains the default watchlist ID of the domain.</p>
|
|
473
514
|
*/
|
|
474
515
|
WatchlistDetails?: WatchlistDetails;
|
|
@@ -478,6 +519,7 @@ export interface Domain {
|
|
|
478
519
|
*/
|
|
479
520
|
export interface CreateDomainResponse {
|
|
480
521
|
/**
|
|
522
|
+
* @public
|
|
481
523
|
* <p>Information about the newly created domain.</p>
|
|
482
524
|
*/
|
|
483
525
|
Domain?: Domain;
|
|
@@ -487,18 +529,22 @@ export interface CreateDomainResponse {
|
|
|
487
529
|
*/
|
|
488
530
|
export interface CreateWatchlistRequest {
|
|
489
531
|
/**
|
|
532
|
+
* @public
|
|
490
533
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
491
534
|
*/
|
|
492
535
|
DomainId: string | undefined;
|
|
493
536
|
/**
|
|
537
|
+
* @public
|
|
494
538
|
* <p>The name of the watchlist.</p>
|
|
495
539
|
*/
|
|
496
540
|
Name: string | undefined;
|
|
497
541
|
/**
|
|
542
|
+
* @public
|
|
498
543
|
* <p>A brief description of this watchlist.</p>
|
|
499
544
|
*/
|
|
500
545
|
Description?: string;
|
|
501
546
|
/**
|
|
547
|
+
* @public
|
|
502
548
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
503
549
|
* request. If not provided, the Amazon Web Services
|
|
504
550
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -512,30 +558,37 @@ export interface CreateWatchlistRequest {
|
|
|
512
558
|
*/
|
|
513
559
|
export interface Watchlist {
|
|
514
560
|
/**
|
|
561
|
+
* @public
|
|
515
562
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
516
563
|
*/
|
|
517
564
|
DomainId?: string;
|
|
518
565
|
/**
|
|
566
|
+
* @public
|
|
519
567
|
* <p>The identifier of the watchlist.</p>
|
|
520
568
|
*/
|
|
521
569
|
WatchlistId?: string;
|
|
522
570
|
/**
|
|
571
|
+
* @public
|
|
523
572
|
* <p>The name for the watchlist.</p>
|
|
524
573
|
*/
|
|
525
574
|
Name?: string;
|
|
526
575
|
/**
|
|
576
|
+
* @public
|
|
527
577
|
* <p>The description of the watchlist.</p>
|
|
528
578
|
*/
|
|
529
579
|
Description?: string;
|
|
530
580
|
/**
|
|
581
|
+
* @public
|
|
531
582
|
* <p>Whether the specified watchlist is the default watchlist of a domain.</p>
|
|
532
583
|
*/
|
|
533
584
|
DefaultWatchlist?: boolean;
|
|
534
585
|
/**
|
|
586
|
+
* @public
|
|
535
587
|
* <p>The timestamp of when the watchlist was created.</p>
|
|
536
588
|
*/
|
|
537
589
|
CreatedAt?: Date;
|
|
538
590
|
/**
|
|
591
|
+
* @public
|
|
539
592
|
* <p>The timestamp of when the watchlist was updated.</p>
|
|
540
593
|
*/
|
|
541
594
|
UpdatedAt?: Date;
|
|
@@ -545,6 +598,7 @@ export interface Watchlist {
|
|
|
545
598
|
*/
|
|
546
599
|
export interface CreateWatchlistResponse {
|
|
547
600
|
/**
|
|
601
|
+
* @public
|
|
548
602
|
* <p>Information about the newly created watchlist.</p>
|
|
549
603
|
*/
|
|
550
604
|
Watchlist?: Watchlist;
|
|
@@ -554,6 +608,7 @@ export interface CreateWatchlistResponse {
|
|
|
554
608
|
*/
|
|
555
609
|
export interface DeleteDomainRequest {
|
|
556
610
|
/**
|
|
611
|
+
* @public
|
|
557
612
|
* <p>The identifier of the domain you want to delete.</p>
|
|
558
613
|
*/
|
|
559
614
|
DomainId: string | undefined;
|
|
@@ -563,10 +618,12 @@ export interface DeleteDomainRequest {
|
|
|
563
618
|
*/
|
|
564
619
|
export interface DeleteFraudsterRequest {
|
|
565
620
|
/**
|
|
621
|
+
* @public
|
|
566
622
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
567
623
|
*/
|
|
568
624
|
DomainId: string | undefined;
|
|
569
625
|
/**
|
|
626
|
+
* @public
|
|
570
627
|
* <p>The identifier of the fraudster you want to delete.</p>
|
|
571
628
|
*/
|
|
572
629
|
FraudsterId: string | undefined;
|
|
@@ -576,10 +633,12 @@ export interface DeleteFraudsterRequest {
|
|
|
576
633
|
*/
|
|
577
634
|
export interface DeleteSpeakerRequest {
|
|
578
635
|
/**
|
|
636
|
+
* @public
|
|
579
637
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
580
638
|
*/
|
|
581
639
|
DomainId: string | undefined;
|
|
582
640
|
/**
|
|
641
|
+
* @public
|
|
583
642
|
* <p>The identifier of the speaker you want to delete.</p>
|
|
584
643
|
*/
|
|
585
644
|
SpeakerId: string | undefined;
|
|
@@ -589,10 +648,12 @@ export interface DeleteSpeakerRequest {
|
|
|
589
648
|
*/
|
|
590
649
|
export interface DeleteWatchlistRequest {
|
|
591
650
|
/**
|
|
651
|
+
* @public
|
|
592
652
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
593
653
|
*/
|
|
594
654
|
DomainId: string | undefined;
|
|
595
655
|
/**
|
|
656
|
+
* @public
|
|
596
657
|
* <p>The identifier of the watchlist to be deleted.</p>
|
|
597
658
|
*/
|
|
598
659
|
WatchlistId: string | undefined;
|
|
@@ -602,6 +663,7 @@ export interface DeleteWatchlistRequest {
|
|
|
602
663
|
*/
|
|
603
664
|
export interface DescribeDomainRequest {
|
|
604
665
|
/**
|
|
666
|
+
* @public
|
|
605
667
|
* <p>The identifier of the domain that you are describing.</p>
|
|
606
668
|
*/
|
|
607
669
|
DomainId: string | undefined;
|
|
@@ -611,6 +673,7 @@ export interface DescribeDomainRequest {
|
|
|
611
673
|
*/
|
|
612
674
|
export interface DescribeDomainResponse {
|
|
613
675
|
/**
|
|
676
|
+
* @public
|
|
614
677
|
* <p>Information about the specified domain.</p>
|
|
615
678
|
*/
|
|
616
679
|
Domain?: Domain;
|
|
@@ -620,10 +683,12 @@ export interface DescribeDomainResponse {
|
|
|
620
683
|
*/
|
|
621
684
|
export interface DescribeFraudsterRequest {
|
|
622
685
|
/**
|
|
686
|
+
* @public
|
|
623
687
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
624
688
|
*/
|
|
625
689
|
DomainId: string | undefined;
|
|
626
690
|
/**
|
|
691
|
+
* @public
|
|
627
692
|
* <p>The identifier of the fraudster you are describing.</p>
|
|
628
693
|
*/
|
|
629
694
|
FraudsterId: string | undefined;
|
|
@@ -633,6 +698,7 @@ export interface DescribeFraudsterRequest {
|
|
|
633
698
|
*/
|
|
634
699
|
export interface DescribeFraudsterResponse {
|
|
635
700
|
/**
|
|
701
|
+
* @public
|
|
636
702
|
* <p>Information about the specified fraudster.</p>
|
|
637
703
|
*/
|
|
638
704
|
Fraudster?: Fraudster;
|
|
@@ -642,10 +708,12 @@ export interface DescribeFraudsterResponse {
|
|
|
642
708
|
*/
|
|
643
709
|
export interface DescribeFraudsterRegistrationJobRequest {
|
|
644
710
|
/**
|
|
711
|
+
* @public
|
|
645
712
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
646
713
|
*/
|
|
647
714
|
DomainId: string | undefined;
|
|
648
715
|
/**
|
|
716
|
+
* @public
|
|
649
717
|
* <p>The identifier of the fraudster registration job you are describing.</p>
|
|
650
718
|
*/
|
|
651
719
|
JobId: string | undefined;
|
|
@@ -656,10 +724,12 @@ export interface DescribeFraudsterRegistrationJobRequest {
|
|
|
656
724
|
*/
|
|
657
725
|
export interface FailureDetails {
|
|
658
726
|
/**
|
|
727
|
+
* @public
|
|
659
728
|
* <p>An HTTP status code representing the nature of the error.</p>
|
|
660
729
|
*/
|
|
661
730
|
StatusCode?: number;
|
|
662
731
|
/**
|
|
732
|
+
* @public
|
|
663
733
|
* <p>A description of the error that caused the batch job failure.</p>
|
|
664
734
|
*/
|
|
665
735
|
Message?: string;
|
|
@@ -670,6 +740,7 @@ export interface FailureDetails {
|
|
|
670
740
|
*/
|
|
671
741
|
export interface InputDataConfig {
|
|
672
742
|
/**
|
|
743
|
+
* @public
|
|
673
744
|
* <p>The S3 location for the input manifest file that contains the list of individual
|
|
674
745
|
* enrollment or registration job requests.</p>
|
|
675
746
|
*/
|
|
@@ -681,6 +752,7 @@ export interface InputDataConfig {
|
|
|
681
752
|
*/
|
|
682
753
|
export interface JobProgress {
|
|
683
754
|
/**
|
|
755
|
+
* @public
|
|
684
756
|
* <p>Shows the completed percentage of enrollment or registration requests listed in the
|
|
685
757
|
* input file.</p>
|
|
686
758
|
*/
|
|
@@ -707,6 +779,7 @@ export type FraudsterRegistrationJobStatus = (typeof FraudsterRegistrationJobSta
|
|
|
707
779
|
*/
|
|
708
780
|
export interface OutputDataConfig {
|
|
709
781
|
/**
|
|
782
|
+
* @public
|
|
710
783
|
* <p>The S3 path of the folder where Voice ID writes the job output file. It has a
|
|
711
784
|
* <code>*.out</code> extension. For example, if the input file name is
|
|
712
785
|
* <code>input-file.json</code> and the output folder path is
|
|
@@ -715,6 +788,7 @@ export interface OutputDataConfig {
|
|
|
715
788
|
*/
|
|
716
789
|
S3Uri: string | undefined;
|
|
717
790
|
/**
|
|
791
|
+
* @public
|
|
718
792
|
* <p>The identifier of the KMS key you want Voice ID to use to encrypt the
|
|
719
793
|
* output file of a speaker enrollment job/fraudster registration job.
|
|
720
794
|
* </p>
|
|
@@ -739,6 +813,7 @@ export type DuplicateRegistrationAction = (typeof DuplicateRegistrationAction)[k
|
|
|
739
813
|
*/
|
|
740
814
|
export interface RegistrationConfig {
|
|
741
815
|
/**
|
|
816
|
+
* @public
|
|
742
817
|
* <p>The action to take when a fraudster is identified as a duplicate. The default action
|
|
743
818
|
* is <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value
|
|
744
819
|
* to <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified
|
|
@@ -746,11 +821,13 @@ export interface RegistrationConfig {
|
|
|
746
821
|
*/
|
|
747
822
|
DuplicateRegistrationAction?: DuplicateRegistrationAction | string;
|
|
748
823
|
/**
|
|
824
|
+
* @public
|
|
749
825
|
* <p>The minimum similarity score between the new and old fraudsters in order to consider
|
|
750
826
|
* the new fraudster a duplicate.</p>
|
|
751
827
|
*/
|
|
752
828
|
FraudsterSimilarityThreshold?: number;
|
|
753
829
|
/**
|
|
830
|
+
* @public
|
|
754
831
|
* <p>The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.
|
|
755
832
|
* </p>
|
|
756
833
|
*/
|
|
@@ -762,52 +839,63 @@ export interface RegistrationConfig {
|
|
|
762
839
|
*/
|
|
763
840
|
export interface FraudsterRegistrationJob {
|
|
764
841
|
/**
|
|
842
|
+
* @public
|
|
765
843
|
* <p>The client-provided name for the fraudster registration job.</p>
|
|
766
844
|
*/
|
|
767
845
|
JobName?: string;
|
|
768
846
|
/**
|
|
847
|
+
* @public
|
|
769
848
|
* <p>The service-generated identifier for the fraudster registration job.</p>
|
|
770
849
|
*/
|
|
771
850
|
JobId?: string;
|
|
772
851
|
/**
|
|
852
|
+
* @public
|
|
773
853
|
* <p>The current status of the fraudster registration job.</p>
|
|
774
854
|
*/
|
|
775
855
|
JobStatus?: FraudsterRegistrationJobStatus | string;
|
|
776
856
|
/**
|
|
857
|
+
* @public
|
|
777
858
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
778
859
|
*/
|
|
779
860
|
DomainId?: string;
|
|
780
861
|
/**
|
|
862
|
+
* @public
|
|
781
863
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
782
864
|
* customer's buckets to read the input manifest file and write the job output file.</p>
|
|
783
865
|
*/
|
|
784
866
|
DataAccessRoleArn?: string;
|
|
785
867
|
/**
|
|
868
|
+
* @public
|
|
786
869
|
* <p>The registration config containing details such as the action to take when a duplicate
|
|
787
870
|
* fraudster is detected, and the similarity threshold to use for detecting a duplicate
|
|
788
871
|
* fraudster.</p>
|
|
789
872
|
*/
|
|
790
873
|
RegistrationConfig?: RegistrationConfig;
|
|
791
874
|
/**
|
|
875
|
+
* @public
|
|
792
876
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
793
877
|
* the list of fraudster registration job requests.</p>
|
|
794
878
|
*/
|
|
795
879
|
InputDataConfig?: InputDataConfig;
|
|
796
880
|
/**
|
|
881
|
+
* @public
|
|
797
882
|
* <p>The output data config containing the S3 location where you want Voice ID to write
|
|
798
883
|
* your job output file; you must also include a KMS key ID in order to
|
|
799
884
|
* encrypt the file.</p>
|
|
800
885
|
*/
|
|
801
886
|
OutputDataConfig?: OutputDataConfig;
|
|
802
887
|
/**
|
|
888
|
+
* @public
|
|
803
889
|
* <p>A timestamp of when the fraudster registration job was created.</p>
|
|
804
890
|
*/
|
|
805
891
|
CreatedAt?: Date;
|
|
806
892
|
/**
|
|
893
|
+
* @public
|
|
807
894
|
* <p>A timestamp of when the fraudster registration job ended.</p>
|
|
808
895
|
*/
|
|
809
896
|
EndedAt?: Date;
|
|
810
897
|
/**
|
|
898
|
+
* @public
|
|
811
899
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
812
900
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
813
901
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
@@ -816,6 +904,7 @@ export interface FraudsterRegistrationJob {
|
|
|
816
904
|
*/
|
|
817
905
|
FailureDetails?: FailureDetails;
|
|
818
906
|
/**
|
|
907
|
+
* @public
|
|
819
908
|
* <p>Shows the completed percentage of registration requests listed in the input
|
|
820
909
|
* file.</p>
|
|
821
910
|
*/
|
|
@@ -826,6 +915,7 @@ export interface FraudsterRegistrationJob {
|
|
|
826
915
|
*/
|
|
827
916
|
export interface DescribeFraudsterRegistrationJobResponse {
|
|
828
917
|
/**
|
|
918
|
+
* @public
|
|
829
919
|
* <p>Contains details about the specified fraudster registration job.</p>
|
|
830
920
|
*/
|
|
831
921
|
Job?: FraudsterRegistrationJob;
|
|
@@ -835,10 +925,12 @@ export interface DescribeFraudsterRegistrationJobResponse {
|
|
|
835
925
|
*/
|
|
836
926
|
export interface DescribeSpeakerRequest {
|
|
837
927
|
/**
|
|
928
|
+
* @public
|
|
838
929
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
839
930
|
*/
|
|
840
931
|
DomainId: string | undefined;
|
|
841
932
|
/**
|
|
933
|
+
* @public
|
|
842
934
|
* <p>The identifier of the speaker you are describing.</p>
|
|
843
935
|
*/
|
|
844
936
|
SpeakerId: string | undefined;
|
|
@@ -863,30 +955,37 @@ export type SpeakerStatus = (typeof SpeakerStatus)[keyof typeof SpeakerStatus];
|
|
|
863
955
|
*/
|
|
864
956
|
export interface Speaker {
|
|
865
957
|
/**
|
|
958
|
+
* @public
|
|
866
959
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
867
960
|
*/
|
|
868
961
|
DomainId?: string;
|
|
869
962
|
/**
|
|
963
|
+
* @public
|
|
870
964
|
* <p>The client-provided identifier for the speaker.</p>
|
|
871
965
|
*/
|
|
872
966
|
CustomerSpeakerId?: string;
|
|
873
967
|
/**
|
|
968
|
+
* @public
|
|
874
969
|
* <p>The service-generated identifier for the speaker.</p>
|
|
875
970
|
*/
|
|
876
971
|
GeneratedSpeakerId?: string;
|
|
877
972
|
/**
|
|
973
|
+
* @public
|
|
878
974
|
* <p>The current status of the speaker.</p>
|
|
879
975
|
*/
|
|
880
976
|
Status?: SpeakerStatus | string;
|
|
881
977
|
/**
|
|
978
|
+
* @public
|
|
882
979
|
* <p>A timestamp of when the speaker was created. </p>
|
|
883
980
|
*/
|
|
884
981
|
CreatedAt?: Date;
|
|
885
982
|
/**
|
|
983
|
+
* @public
|
|
886
984
|
* <p>A timestamp of the speaker's last update.</p>
|
|
887
985
|
*/
|
|
888
986
|
UpdatedAt?: Date;
|
|
889
987
|
/**
|
|
988
|
+
* @public
|
|
890
989
|
* <p>The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a
|
|
891
990
|
* successful authentication. This timestamp is accurate to one hour.</p>
|
|
892
991
|
*/
|
|
@@ -897,6 +996,7 @@ export interface Speaker {
|
|
|
897
996
|
*/
|
|
898
997
|
export interface DescribeSpeakerResponse {
|
|
899
998
|
/**
|
|
999
|
+
* @public
|
|
900
1000
|
* <p>Information about the specified speaker.</p>
|
|
901
1001
|
*/
|
|
902
1002
|
Speaker?: Speaker;
|
|
@@ -906,10 +1006,12 @@ export interface DescribeSpeakerResponse {
|
|
|
906
1006
|
*/
|
|
907
1007
|
export interface DescribeSpeakerEnrollmentJobRequest {
|
|
908
1008
|
/**
|
|
1009
|
+
* @public
|
|
909
1010
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
910
1011
|
*/
|
|
911
1012
|
DomainId: string | undefined;
|
|
912
1013
|
/**
|
|
1014
|
+
* @public
|
|
913
1015
|
* <p>The identifier of the speaker enrollment job you are describing.</p>
|
|
914
1016
|
*/
|
|
915
1017
|
JobId: string | undefined;
|
|
@@ -944,6 +1046,7 @@ export type FraudDetectionAction = (typeof FraudDetectionAction)[keyof typeof Fr
|
|
|
944
1046
|
*/
|
|
945
1047
|
export interface EnrollmentJobFraudDetectionConfig {
|
|
946
1048
|
/**
|
|
1049
|
+
* @public
|
|
947
1050
|
* <p>The action to take when the given speaker is flagged by the fraud detection system.
|
|
948
1051
|
* The default value is <code>FAIL</code>, which fails the speaker enrollment. Changing
|
|
949
1052
|
* this value to <code>IGNORE</code> results in the speaker being enrolled even if they are
|
|
@@ -951,12 +1054,14 @@ export interface EnrollmentJobFraudDetectionConfig {
|
|
|
951
1054
|
*/
|
|
952
1055
|
FraudDetectionAction?: FraudDetectionAction | string;
|
|
953
1056
|
/**
|
|
1057
|
+
* @public
|
|
954
1058
|
* <p>Threshold value for determining whether the speaker is a high risk to be fraudulent.
|
|
955
1059
|
* If the detected risk score calculated by Voice ID is greater than or equal to the
|
|
956
1060
|
* threshold, the speaker is considered a fraudster.</p>
|
|
957
1061
|
*/
|
|
958
1062
|
RiskThreshold?: number;
|
|
959
1063
|
/**
|
|
1064
|
+
* @public
|
|
960
1065
|
* <p>The identifier of watchlists against which fraud detection is performed.
|
|
961
1066
|
* </p>
|
|
962
1067
|
*/
|
|
@@ -968,6 +1073,7 @@ export interface EnrollmentJobFraudDetectionConfig {
|
|
|
968
1073
|
*/
|
|
969
1074
|
export interface EnrollmentConfig {
|
|
970
1075
|
/**
|
|
1076
|
+
* @public
|
|
971
1077
|
* <p> The action to take when the specified speaker is already enrolled in the specified
|
|
972
1078
|
* domain. The default value is <code>SKIP</code>, which skips the enrollment for the
|
|
973
1079
|
* existing speaker. Setting the value to <code>OVERWRITE</code> replaces the existing
|
|
@@ -976,6 +1082,7 @@ export interface EnrollmentConfig {
|
|
|
976
1082
|
*/
|
|
977
1083
|
ExistingEnrollmentAction?: ExistingEnrollmentAction | string;
|
|
978
1084
|
/**
|
|
1085
|
+
* @public
|
|
979
1086
|
* <p>The fraud detection configuration to use for the speaker enrollment job.</p>
|
|
980
1087
|
*/
|
|
981
1088
|
FraudDetectionConfig?: EnrollmentJobFraudDetectionConfig;
|
|
@@ -1001,51 +1108,62 @@ export type SpeakerEnrollmentJobStatus = (typeof SpeakerEnrollmentJobStatus)[key
|
|
|
1001
1108
|
*/
|
|
1002
1109
|
export interface SpeakerEnrollmentJob {
|
|
1003
1110
|
/**
|
|
1111
|
+
* @public
|
|
1004
1112
|
* <p>The client-provided name for the speaker enrollment job.</p>
|
|
1005
1113
|
*/
|
|
1006
1114
|
JobName?: string;
|
|
1007
1115
|
/**
|
|
1116
|
+
* @public
|
|
1008
1117
|
* <p>The service-generated identifier for the speaker enrollment job.</p>
|
|
1009
1118
|
*/
|
|
1010
1119
|
JobId?: string;
|
|
1011
1120
|
/**
|
|
1121
|
+
* @public
|
|
1012
1122
|
* <p>The current status of the speaker enrollment job.</p>
|
|
1013
1123
|
*/
|
|
1014
1124
|
JobStatus?: SpeakerEnrollmentJobStatus | string;
|
|
1015
1125
|
/**
|
|
1126
|
+
* @public
|
|
1016
1127
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
1017
1128
|
*/
|
|
1018
1129
|
DomainId?: string;
|
|
1019
1130
|
/**
|
|
1131
|
+
* @public
|
|
1020
1132
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
1021
1133
|
* customer's buckets to read the input manifest file and write the job output file.</p>
|
|
1022
1134
|
*/
|
|
1023
1135
|
DataAccessRoleArn?: string;
|
|
1024
1136
|
/**
|
|
1137
|
+
* @public
|
|
1025
1138
|
* <p>The configuration that defines the action to take when the speaker is already enrolled
|
|
1026
1139
|
* in Voice ID, and the <code>FraudDetectionConfig</code> to use.</p>
|
|
1027
1140
|
*/
|
|
1028
1141
|
EnrollmentConfig?: EnrollmentConfig;
|
|
1029
1142
|
/**
|
|
1143
|
+
* @public
|
|
1030
1144
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
1031
1145
|
* the list of speaker enrollment job requests.</p>
|
|
1032
1146
|
*/
|
|
1033
1147
|
InputDataConfig?: InputDataConfig;
|
|
1034
1148
|
/**
|
|
1149
|
+
* @public
|
|
1035
1150
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
1036
1151
|
* output file; you must also include a KMS key ID to encrypt the
|
|
1037
1152
|
* file.</p>
|
|
1038
1153
|
*/
|
|
1039
1154
|
OutputDataConfig?: OutputDataConfig;
|
|
1040
1155
|
/**
|
|
1156
|
+
* @public
|
|
1041
1157
|
* <p>A timestamp of when the speaker enrollment job was created.</p>
|
|
1042
1158
|
*/
|
|
1043
1159
|
CreatedAt?: Date;
|
|
1044
1160
|
/**
|
|
1161
|
+
* @public
|
|
1045
1162
|
* <p>A timestamp of when the speaker enrollment job ended. </p>
|
|
1046
1163
|
*/
|
|
1047
1164
|
EndedAt?: Date;
|
|
1048
1165
|
/**
|
|
1166
|
+
* @public
|
|
1049
1167
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1050
1168
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1051
1169
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
@@ -1054,6 +1172,7 @@ export interface SpeakerEnrollmentJob {
|
|
|
1054
1172
|
*/
|
|
1055
1173
|
FailureDetails?: FailureDetails;
|
|
1056
1174
|
/**
|
|
1175
|
+
* @public
|
|
1057
1176
|
* <p>Provides details on job progress. This field shows the completed percentage of
|
|
1058
1177
|
* registration requests listed in the input file.</p>
|
|
1059
1178
|
*/
|
|
@@ -1064,6 +1183,7 @@ export interface SpeakerEnrollmentJob {
|
|
|
1064
1183
|
*/
|
|
1065
1184
|
export interface DescribeSpeakerEnrollmentJobResponse {
|
|
1066
1185
|
/**
|
|
1186
|
+
* @public
|
|
1067
1187
|
* <p>Contains details about the specified speaker enrollment job.</p>
|
|
1068
1188
|
*/
|
|
1069
1189
|
Job?: SpeakerEnrollmentJob;
|
|
@@ -1073,10 +1193,12 @@ export interface DescribeSpeakerEnrollmentJobResponse {
|
|
|
1073
1193
|
*/
|
|
1074
1194
|
export interface DescribeWatchlistRequest {
|
|
1075
1195
|
/**
|
|
1196
|
+
* @public
|
|
1076
1197
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
1077
1198
|
*/
|
|
1078
1199
|
DomainId: string | undefined;
|
|
1079
1200
|
/**
|
|
1201
|
+
* @public
|
|
1080
1202
|
* <p>The identifier of the watchlist that you are describing.</p>
|
|
1081
1203
|
*/
|
|
1082
1204
|
WatchlistId: string | undefined;
|
|
@@ -1086,6 +1208,7 @@ export interface DescribeWatchlistRequest {
|
|
|
1086
1208
|
*/
|
|
1087
1209
|
export interface DescribeWatchlistResponse {
|
|
1088
1210
|
/**
|
|
1211
|
+
* @public
|
|
1089
1212
|
* <p>Information about the specified watchlist.</p>
|
|
1090
1213
|
*/
|
|
1091
1214
|
Watchlist?: Watchlist;
|
|
@@ -1095,14 +1218,17 @@ export interface DescribeWatchlistResponse {
|
|
|
1095
1218
|
*/
|
|
1096
1219
|
export interface DisassociateFraudsterRequest {
|
|
1097
1220
|
/**
|
|
1221
|
+
* @public
|
|
1098
1222
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
1099
1223
|
*/
|
|
1100
1224
|
DomainId: string | undefined;
|
|
1101
1225
|
/**
|
|
1226
|
+
* @public
|
|
1102
1227
|
* <p>The identifier of the watchlist that you want to disassociate from the fraudster.</p>
|
|
1103
1228
|
*/
|
|
1104
1229
|
WatchlistId: string | undefined;
|
|
1105
1230
|
/**
|
|
1231
|
+
* @public
|
|
1106
1232
|
* <p>The identifier of the fraudster to be disassociated from the watchlist.</p>
|
|
1107
1233
|
*/
|
|
1108
1234
|
FraudsterId: string | undefined;
|
|
@@ -1112,6 +1238,7 @@ export interface DisassociateFraudsterRequest {
|
|
|
1112
1238
|
*/
|
|
1113
1239
|
export interface DisassociateFraudsterResponse {
|
|
1114
1240
|
/**
|
|
1241
|
+
* @public
|
|
1115
1242
|
* <p>Contains all the information about a fraudster.</p>
|
|
1116
1243
|
*/
|
|
1117
1244
|
Fraudster?: Fraudster;
|
|
@@ -1121,11 +1248,13 @@ export interface DisassociateFraudsterResponse {
|
|
|
1121
1248
|
*/
|
|
1122
1249
|
export interface ListDomainsRequest {
|
|
1123
1250
|
/**
|
|
1251
|
+
* @public
|
|
1124
1252
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1125
1253
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
|
|
1126
1254
|
*/
|
|
1127
1255
|
MaxResults?: number;
|
|
1128
1256
|
/**
|
|
1257
|
+
* @public
|
|
1129
1258
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1130
1259
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1131
1260
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1139,45 +1268,55 @@ export interface ListDomainsRequest {
|
|
|
1139
1268
|
*/
|
|
1140
1269
|
export interface DomainSummary {
|
|
1141
1270
|
/**
|
|
1271
|
+
* @public
|
|
1142
1272
|
* <p>The identifier of the domain.</p>
|
|
1143
1273
|
*/
|
|
1144
1274
|
DomainId?: string;
|
|
1145
1275
|
/**
|
|
1276
|
+
* @public
|
|
1146
1277
|
* <p>The Amazon Resource Name (ARN) for the domain.</p>
|
|
1147
1278
|
*/
|
|
1148
1279
|
Arn?: string;
|
|
1149
1280
|
/**
|
|
1281
|
+
* @public
|
|
1150
1282
|
* <p>The client-provided name for the domain.</p>
|
|
1151
1283
|
*/
|
|
1152
1284
|
Name?: string;
|
|
1153
1285
|
/**
|
|
1286
|
+
* @public
|
|
1154
1287
|
* <p>The description of the domain.</p>
|
|
1155
1288
|
*/
|
|
1156
1289
|
Description?: string;
|
|
1157
1290
|
/**
|
|
1291
|
+
* @public
|
|
1158
1292
|
* <p>The current status of the domain.</p>
|
|
1159
1293
|
*/
|
|
1160
1294
|
DomainStatus?: DomainStatus | string;
|
|
1161
1295
|
/**
|
|
1296
|
+
* @public
|
|
1162
1297
|
* <p>The server-side encryption configuration containing the KMS key
|
|
1163
1298
|
* identifier you want Voice ID to use to encrypt your data.</p>
|
|
1164
1299
|
*/
|
|
1165
1300
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1166
1301
|
/**
|
|
1302
|
+
* @public
|
|
1167
1303
|
* <p>The timestamp of when the domain was created.</p>
|
|
1168
1304
|
*/
|
|
1169
1305
|
CreatedAt?: Date;
|
|
1170
1306
|
/**
|
|
1307
|
+
* @public
|
|
1171
1308
|
* <p>The timestamp of when the domain was last updated.</p>
|
|
1172
1309
|
*/
|
|
1173
1310
|
UpdatedAt?: Date;
|
|
1174
1311
|
/**
|
|
1312
|
+
* @public
|
|
1175
1313
|
* <p>Details about the most recent server-side encryption configuration update. When the
|
|
1176
1314
|
* server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
|
|
1177
1315
|
* complete, the domain's data can only be accessed using the new KMS key.</p>
|
|
1178
1316
|
*/
|
|
1179
1317
|
ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
|
|
1180
1318
|
/**
|
|
1319
|
+
* @public
|
|
1181
1320
|
* <p>Provides information about <code>watchlistDetails</code> and <code>DefaultWatchlistID</code>. </p>
|
|
1182
1321
|
*/
|
|
1183
1322
|
WatchlistDetails?: WatchlistDetails;
|
|
@@ -1187,10 +1326,12 @@ export interface DomainSummary {
|
|
|
1187
1326
|
*/
|
|
1188
1327
|
export interface ListDomainsResponse {
|
|
1189
1328
|
/**
|
|
1329
|
+
* @public
|
|
1190
1330
|
* <p>A list containing details about each domain in the Amazon Web Services account.</p>
|
|
1191
1331
|
*/
|
|
1192
1332
|
DomainSummaries?: DomainSummary[];
|
|
1193
1333
|
/**
|
|
1334
|
+
* @public
|
|
1194
1335
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1195
1336
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1196
1337
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1203,18 +1344,22 @@ export interface ListDomainsResponse {
|
|
|
1203
1344
|
*/
|
|
1204
1345
|
export interface UpdateDomainRequest {
|
|
1205
1346
|
/**
|
|
1347
|
+
* @public
|
|
1206
1348
|
* <p>The identifier of the domain to be updated.</p>
|
|
1207
1349
|
*/
|
|
1208
1350
|
DomainId: string | undefined;
|
|
1209
1351
|
/**
|
|
1352
|
+
* @public
|
|
1210
1353
|
* <p>The name of the domain.</p>
|
|
1211
1354
|
*/
|
|
1212
1355
|
Name: string | undefined;
|
|
1213
1356
|
/**
|
|
1357
|
+
* @public
|
|
1214
1358
|
* <p>A brief description about this domain.</p>
|
|
1215
1359
|
*/
|
|
1216
1360
|
Description?: string;
|
|
1217
1361
|
/**
|
|
1362
|
+
* @public
|
|
1218
1363
|
* <p>The configuration, containing the KMS key identifier, to be used by
|
|
1219
1364
|
* Voice ID for the server-side encryption of your data. Changing the domain's associated
|
|
1220
1365
|
* KMS key immediately triggers an asynchronous process to remove
|
|
@@ -1230,6 +1375,7 @@ export interface UpdateDomainRequest {
|
|
|
1230
1375
|
*/
|
|
1231
1376
|
export interface UpdateDomainResponse {
|
|
1232
1377
|
/**
|
|
1378
|
+
* @public
|
|
1233
1379
|
* <p>Details about the updated domain</p>
|
|
1234
1380
|
*/
|
|
1235
1381
|
Domain?: Domain;
|
|
@@ -1239,10 +1385,12 @@ export interface UpdateDomainResponse {
|
|
|
1239
1385
|
*/
|
|
1240
1386
|
export interface EvaluateSessionRequest {
|
|
1241
1387
|
/**
|
|
1388
|
+
* @public
|
|
1242
1389
|
* <p>The identifier of the domain where the session started.</p>
|
|
1243
1390
|
*/
|
|
1244
1391
|
DomainId: string | undefined;
|
|
1245
1392
|
/**
|
|
1393
|
+
* @public
|
|
1246
1394
|
* <p>The session identifier, or name of the session, that you want to evaluate. In
|
|
1247
1395
|
* Voice ID integration, this is the Contact-Id.</p>
|
|
1248
1396
|
*/
|
|
@@ -1255,12 +1403,14 @@ export interface EvaluateSessionRequest {
|
|
|
1255
1403
|
*/
|
|
1256
1404
|
export interface FraudDetectionConfiguration {
|
|
1257
1405
|
/**
|
|
1406
|
+
* @public
|
|
1258
1407
|
* <p>Threshold value for determining whether the speaker is a fraudster. If the detected
|
|
1259
1408
|
* risk score calculated by Voice ID is higher than the threshold, the speaker is
|
|
1260
1409
|
* considered a fraudster.</p>
|
|
1261
1410
|
*/
|
|
1262
1411
|
RiskThreshold?: number;
|
|
1263
1412
|
/**
|
|
1413
|
+
* @public
|
|
1264
1414
|
* <p>The identifier of the watchlist against which fraud detection is performed.
|
|
1265
1415
|
* </p>
|
|
1266
1416
|
*/
|
|
@@ -1298,10 +1448,12 @@ export type FraudDetectionReason = (typeof FraudDetectionReason)[keyof typeof Fr
|
|
|
1298
1448
|
*/
|
|
1299
1449
|
export interface KnownFraudsterRisk {
|
|
1300
1450
|
/**
|
|
1451
|
+
* @public
|
|
1301
1452
|
* <p>The score indicating the likelihood the speaker is a known fraudster.</p>
|
|
1302
1453
|
*/
|
|
1303
1454
|
RiskScore: number | undefined;
|
|
1304
1455
|
/**
|
|
1456
|
+
* @public
|
|
1305
1457
|
* <p>The identifier of the fraudster that is the closest match to the speaker. If there are
|
|
1306
1458
|
* no fraudsters registered in a given domain, or if there are no fraudsters with a
|
|
1307
1459
|
* non-zero RiskScore, this value is <code>null</code>.</p>
|
|
@@ -1314,6 +1466,7 @@ export interface KnownFraudsterRisk {
|
|
|
1314
1466
|
*/
|
|
1315
1467
|
export interface VoiceSpoofingRisk {
|
|
1316
1468
|
/**
|
|
1469
|
+
* @public
|
|
1317
1470
|
* <p>The score indicating the likelihood of speaker’s voice being spoofed.</p>
|
|
1318
1471
|
*/
|
|
1319
1472
|
RiskScore: number | undefined;
|
|
@@ -1325,10 +1478,12 @@ export interface VoiceSpoofingRisk {
|
|
|
1325
1478
|
*/
|
|
1326
1479
|
export interface FraudRiskDetails {
|
|
1327
1480
|
/**
|
|
1481
|
+
* @public
|
|
1328
1482
|
* <p>The details resulting from 'Known Fraudster Risk' analysis of the speaker.</p>
|
|
1329
1483
|
*/
|
|
1330
1484
|
KnownFraudsterRisk: KnownFraudsterRisk | undefined;
|
|
1331
1485
|
/**
|
|
1486
|
+
* @public
|
|
1332
1487
|
* <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
|
|
1333
1488
|
*/
|
|
1334
1489
|
VoiceSpoofingRisk: VoiceSpoofingRisk | undefined;
|
|
@@ -1340,6 +1495,7 @@ export interface FraudRiskDetails {
|
|
|
1340
1495
|
*/
|
|
1341
1496
|
export interface FraudDetectionResult {
|
|
1342
1497
|
/**
|
|
1498
|
+
* @public
|
|
1343
1499
|
* <p>The unique identifier for this fraud detection result. Given there can be multiple
|
|
1344
1500
|
* fraud detections for a given session, this field helps in identifying if the returned
|
|
1345
1501
|
* result is from previous streaming activity or a new result. Note that in the absence of
|
|
@@ -1348,32 +1504,38 @@ export interface FraudDetectionResult {
|
|
|
1348
1504
|
*/
|
|
1349
1505
|
FraudDetectionResultId?: string;
|
|
1350
1506
|
/**
|
|
1507
|
+
* @public
|
|
1351
1508
|
* <p>A timestamp of when audio aggregation started for this fraud detection
|
|
1352
1509
|
* result.</p>
|
|
1353
1510
|
*/
|
|
1354
1511
|
AudioAggregationStartedAt?: Date;
|
|
1355
1512
|
/**
|
|
1513
|
+
* @public
|
|
1356
1514
|
* <p>A timestamp of when audio aggregation ended for this fraud detection
|
|
1357
1515
|
* result.</p>
|
|
1358
1516
|
*/
|
|
1359
1517
|
AudioAggregationEndedAt?: Date;
|
|
1360
1518
|
/**
|
|
1519
|
+
* @public
|
|
1361
1520
|
* <p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection
|
|
1362
1521
|
* result.</p>
|
|
1363
1522
|
*/
|
|
1364
1523
|
Configuration?: FraudDetectionConfiguration;
|
|
1365
1524
|
/**
|
|
1525
|
+
* @public
|
|
1366
1526
|
* <p>The fraud detection decision produced by Voice ID, processed against the current
|
|
1367
1527
|
* session state and streamed audio of the speaker.</p>
|
|
1368
1528
|
*/
|
|
1369
1529
|
Decision?: FraudDetectionDecision | string;
|
|
1370
1530
|
/**
|
|
1531
|
+
* @public
|
|
1371
1532
|
* <p>The reason speaker was flagged by the fraud detection system. This is only be
|
|
1372
1533
|
* populated if fraud detection Decision is <code>HIGH_RISK</code>, and the following
|
|
1373
1534
|
* possible values: <code>KNOWN_FRAUDSTER</code> and <code>VOICE_SPOOFING</code>.</p>
|
|
1374
1535
|
*/
|
|
1375
1536
|
Reasons?: (FraudDetectionReason | string)[];
|
|
1376
1537
|
/**
|
|
1538
|
+
* @public
|
|
1377
1539
|
* <p>Details about each risk analyzed for this speaker. Currently, this contains
|
|
1378
1540
|
* KnownFraudsterRisk and VoiceSpoofingRisk details.</p>
|
|
1379
1541
|
*/
|
|
@@ -1397,18 +1559,22 @@ export type StreamingStatus = (typeof StreamingStatus)[keyof typeof StreamingSta
|
|
|
1397
1559
|
*/
|
|
1398
1560
|
export interface EvaluateSessionResponse {
|
|
1399
1561
|
/**
|
|
1562
|
+
* @public
|
|
1400
1563
|
* <p>The identifier of the domain that contains the session.</p>
|
|
1401
1564
|
*/
|
|
1402
1565
|
DomainId?: string;
|
|
1403
1566
|
/**
|
|
1567
|
+
* @public
|
|
1404
1568
|
* <p>The service-generated identifier of the session.</p>
|
|
1405
1569
|
*/
|
|
1406
1570
|
SessionId?: string;
|
|
1407
1571
|
/**
|
|
1572
|
+
* @public
|
|
1408
1573
|
* <p>The client-provided name of the session.</p>
|
|
1409
1574
|
*/
|
|
1410
1575
|
SessionName?: string;
|
|
1411
1576
|
/**
|
|
1577
|
+
* @public
|
|
1412
1578
|
* <p>The current status of audio streaming for this session. This field is useful to infer
|
|
1413
1579
|
* next steps when the Authentication or Fraud Detection results are empty or the decision
|
|
1414
1580
|
* is <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the
|
|
@@ -1421,11 +1587,13 @@ export interface EvaluateSessionResponse {
|
|
|
1421
1587
|
*/
|
|
1422
1588
|
StreamingStatus?: StreamingStatus | string;
|
|
1423
1589
|
/**
|
|
1590
|
+
* @public
|
|
1424
1591
|
* <p>Details resulting from the authentication process, such as authentication decision and
|
|
1425
1592
|
* authentication score.</p>
|
|
1426
1593
|
*/
|
|
1427
1594
|
AuthenticationResult?: AuthenticationResult;
|
|
1428
1595
|
/**
|
|
1596
|
+
* @public
|
|
1429
1597
|
* <p>Details resulting from the fraud detection process, such as fraud detection decision
|
|
1430
1598
|
* and risk score.</p>
|
|
1431
1599
|
*/
|
|
@@ -1437,30 +1605,37 @@ export interface EvaluateSessionResponse {
|
|
|
1437
1605
|
*/
|
|
1438
1606
|
export interface FraudsterRegistrationJobSummary {
|
|
1439
1607
|
/**
|
|
1608
|
+
* @public
|
|
1440
1609
|
* <p>The client-provided name for the fraudster registration job.</p>
|
|
1441
1610
|
*/
|
|
1442
1611
|
JobName?: string;
|
|
1443
1612
|
/**
|
|
1613
|
+
* @public
|
|
1444
1614
|
* <p>The service-generated identifier for the fraudster registration job.</p>
|
|
1445
1615
|
*/
|
|
1446
1616
|
JobId?: string;
|
|
1447
1617
|
/**
|
|
1618
|
+
* @public
|
|
1448
1619
|
* <p>The current status of the fraudster registration job.</p>
|
|
1449
1620
|
*/
|
|
1450
1621
|
JobStatus?: FraudsterRegistrationJobStatus | string;
|
|
1451
1622
|
/**
|
|
1623
|
+
* @public
|
|
1452
1624
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
1453
1625
|
*/
|
|
1454
1626
|
DomainId?: string;
|
|
1455
1627
|
/**
|
|
1628
|
+
* @public
|
|
1456
1629
|
* <p>A timestamp of when the fraudster registration job was created. </p>
|
|
1457
1630
|
*/
|
|
1458
1631
|
CreatedAt?: Date;
|
|
1459
1632
|
/**
|
|
1633
|
+
* @public
|
|
1460
1634
|
* <p>A timestamp of when the fraudster registration job ended.</p>
|
|
1461
1635
|
*/
|
|
1462
1636
|
EndedAt?: Date;
|
|
1463
1637
|
/**
|
|
1638
|
+
* @public
|
|
1464
1639
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1465
1640
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1466
1641
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
@@ -1469,6 +1644,7 @@ export interface FraudsterRegistrationJobSummary {
|
|
|
1469
1644
|
*/
|
|
1470
1645
|
FailureDetails?: FailureDetails;
|
|
1471
1646
|
/**
|
|
1647
|
+
* @public
|
|
1472
1648
|
* <p>Shows the completed percentage of registration requests listed in the input
|
|
1473
1649
|
* file.</p>
|
|
1474
1650
|
*/
|
|
@@ -1481,18 +1657,22 @@ export interface FraudsterRegistrationJobSummary {
|
|
|
1481
1657
|
*/
|
|
1482
1658
|
export interface FraudsterSummary {
|
|
1483
1659
|
/**
|
|
1660
|
+
* @public
|
|
1484
1661
|
* <p>The identifier of the domain that contains the fraudster summary.</p>
|
|
1485
1662
|
*/
|
|
1486
1663
|
DomainId?: string;
|
|
1487
1664
|
/**
|
|
1665
|
+
* @public
|
|
1488
1666
|
* <p>The service-generated identifier for the fraudster.</p>
|
|
1489
1667
|
*/
|
|
1490
1668
|
GeneratedFraudsterId?: string;
|
|
1491
1669
|
/**
|
|
1670
|
+
* @public
|
|
1492
1671
|
* <p>The timestamp of when the fraudster summary was created.</p>
|
|
1493
1672
|
*/
|
|
1494
1673
|
CreatedAt?: Date;
|
|
1495
1674
|
/**
|
|
1675
|
+
* @public
|
|
1496
1676
|
* <p>The identifier of the watchlists the fraudster is a part of.</p>
|
|
1497
1677
|
*/
|
|
1498
1678
|
WatchlistIds?: string[];
|
|
@@ -1502,19 +1682,23 @@ export interface FraudsterSummary {
|
|
|
1502
1682
|
*/
|
|
1503
1683
|
export interface ListFraudsterRegistrationJobsRequest {
|
|
1504
1684
|
/**
|
|
1685
|
+
* @public
|
|
1505
1686
|
* <p>The identifier of the domain that contains the fraudster registration Jobs.</p>
|
|
1506
1687
|
*/
|
|
1507
1688
|
DomainId: string | undefined;
|
|
1508
1689
|
/**
|
|
1690
|
+
* @public
|
|
1509
1691
|
* <p>Provides the status of your fraudster registration job.</p>
|
|
1510
1692
|
*/
|
|
1511
1693
|
JobStatus?: FraudsterRegistrationJobStatus | string;
|
|
1512
1694
|
/**
|
|
1695
|
+
* @public
|
|
1513
1696
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1514
1697
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1515
1698
|
*/
|
|
1516
1699
|
MaxResults?: number;
|
|
1517
1700
|
/**
|
|
1701
|
+
* @public
|
|
1518
1702
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1519
1703
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1520
1704
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1527,10 +1711,12 @@ export interface ListFraudsterRegistrationJobsRequest {
|
|
|
1527
1711
|
*/
|
|
1528
1712
|
export interface ListFraudsterRegistrationJobsResponse {
|
|
1529
1713
|
/**
|
|
1714
|
+
* @public
|
|
1530
1715
|
* <p>A list containing details about each specified fraudster registration job.</p>
|
|
1531
1716
|
*/
|
|
1532
1717
|
JobSummaries?: FraudsterRegistrationJobSummary[];
|
|
1533
1718
|
/**
|
|
1719
|
+
* @public
|
|
1534
1720
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1535
1721
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1536
1722
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1543,19 +1729,23 @@ export interface ListFraudsterRegistrationJobsResponse {
|
|
|
1543
1729
|
*/
|
|
1544
1730
|
export interface ListFraudstersRequest {
|
|
1545
1731
|
/**
|
|
1732
|
+
* @public
|
|
1546
1733
|
* <p>The identifier of the domain. </p>
|
|
1547
1734
|
*/
|
|
1548
1735
|
DomainId: string | undefined;
|
|
1549
1736
|
/**
|
|
1737
|
+
* @public
|
|
1550
1738
|
* <p>The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.</p>
|
|
1551
1739
|
*/
|
|
1552
1740
|
WatchlistId?: string;
|
|
1553
1741
|
/**
|
|
1742
|
+
* @public
|
|
1554
1743
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1555
1744
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1556
1745
|
*/
|
|
1557
1746
|
MaxResults?: number;
|
|
1558
1747
|
/**
|
|
1748
|
+
* @public
|
|
1559
1749
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1560
1750
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1561
1751
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1569,11 +1759,13 @@ export interface ListFraudstersRequest {
|
|
|
1569
1759
|
*/
|
|
1570
1760
|
export interface ListFraudstersResponse {
|
|
1571
1761
|
/**
|
|
1762
|
+
* @public
|
|
1572
1763
|
* <p>A list that contains details about each fraudster in the Amazon Web Services account.
|
|
1573
1764
|
* </p>
|
|
1574
1765
|
*/
|
|
1575
1766
|
FraudsterSummaries?: FraudsterSummary[];
|
|
1576
1767
|
/**
|
|
1768
|
+
* @public
|
|
1577
1769
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1578
1770
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1579
1771
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1587,19 +1779,23 @@ export interface ListFraudstersResponse {
|
|
|
1587
1779
|
*/
|
|
1588
1780
|
export interface ListSpeakerEnrollmentJobsRequest {
|
|
1589
1781
|
/**
|
|
1782
|
+
* @public
|
|
1590
1783
|
* <p>The identifier of the domain that contains the speaker enrollment jobs.</p>
|
|
1591
1784
|
*/
|
|
1592
1785
|
DomainId: string | undefined;
|
|
1593
1786
|
/**
|
|
1787
|
+
* @public
|
|
1594
1788
|
* <p>Provides the status of your speaker enrollment Job.</p>
|
|
1595
1789
|
*/
|
|
1596
1790
|
JobStatus?: SpeakerEnrollmentJobStatus | string;
|
|
1597
1791
|
/**
|
|
1792
|
+
* @public
|
|
1598
1793
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1599
1794
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
|
|
1600
1795
|
*/
|
|
1601
1796
|
MaxResults?: number;
|
|
1602
1797
|
/**
|
|
1798
|
+
* @public
|
|
1603
1799
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1604
1800
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1605
1801
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1613,30 +1809,37 @@ export interface ListSpeakerEnrollmentJobsRequest {
|
|
|
1613
1809
|
*/
|
|
1614
1810
|
export interface SpeakerEnrollmentJobSummary {
|
|
1615
1811
|
/**
|
|
1812
|
+
* @public
|
|
1616
1813
|
* <p>The client-provided name for the speaker enrollment job.</p>
|
|
1617
1814
|
*/
|
|
1618
1815
|
JobName?: string;
|
|
1619
1816
|
/**
|
|
1817
|
+
* @public
|
|
1620
1818
|
* <p>The service-generated identifier for the speaker enrollment job.</p>
|
|
1621
1819
|
*/
|
|
1622
1820
|
JobId?: string;
|
|
1623
1821
|
/**
|
|
1822
|
+
* @public
|
|
1624
1823
|
* <p>The current status of the speaker enrollment job.</p>
|
|
1625
1824
|
*/
|
|
1626
1825
|
JobStatus?: SpeakerEnrollmentJobStatus | string;
|
|
1627
1826
|
/**
|
|
1827
|
+
* @public
|
|
1628
1828
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
1629
1829
|
*/
|
|
1630
1830
|
DomainId?: string;
|
|
1631
1831
|
/**
|
|
1832
|
+
* @public
|
|
1632
1833
|
* <p>A timestamp of when of the speaker enrollment job was created.</p>
|
|
1633
1834
|
*/
|
|
1634
1835
|
CreatedAt?: Date;
|
|
1635
1836
|
/**
|
|
1837
|
+
* @public
|
|
1636
1838
|
* <p>A timestamp of when the speaker enrollment job ended.</p>
|
|
1637
1839
|
*/
|
|
1638
1840
|
EndedAt?: Date;
|
|
1639
1841
|
/**
|
|
1842
|
+
* @public
|
|
1640
1843
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1641
1844
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1642
1845
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
@@ -1645,6 +1848,7 @@ export interface SpeakerEnrollmentJobSummary {
|
|
|
1645
1848
|
*/
|
|
1646
1849
|
FailureDetails?: FailureDetails;
|
|
1647
1850
|
/**
|
|
1851
|
+
* @public
|
|
1648
1852
|
* <p>Provides details regarding job progress. This field shows the completed percentage of
|
|
1649
1853
|
* enrollment requests listed in the input file.</p>
|
|
1650
1854
|
*/
|
|
@@ -1655,10 +1859,12 @@ export interface SpeakerEnrollmentJobSummary {
|
|
|
1655
1859
|
*/
|
|
1656
1860
|
export interface ListSpeakerEnrollmentJobsResponse {
|
|
1657
1861
|
/**
|
|
1862
|
+
* @public
|
|
1658
1863
|
* <p>A list containing details about each specified speaker enrollment job.</p>
|
|
1659
1864
|
*/
|
|
1660
1865
|
JobSummaries?: SpeakerEnrollmentJobSummary[];
|
|
1661
1866
|
/**
|
|
1867
|
+
* @public
|
|
1662
1868
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1663
1869
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1664
1870
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1671,15 +1877,18 @@ export interface ListSpeakerEnrollmentJobsResponse {
|
|
|
1671
1877
|
*/
|
|
1672
1878
|
export interface ListSpeakersRequest {
|
|
1673
1879
|
/**
|
|
1880
|
+
* @public
|
|
1674
1881
|
* <p>The identifier of the domain.</p>
|
|
1675
1882
|
*/
|
|
1676
1883
|
DomainId: string | undefined;
|
|
1677
1884
|
/**
|
|
1885
|
+
* @public
|
|
1678
1886
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1679
1887
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1680
1888
|
*/
|
|
1681
1889
|
MaxResults?: number;
|
|
1682
1890
|
/**
|
|
1891
|
+
* @public
|
|
1683
1892
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1684
1893
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1685
1894
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1693,30 +1902,37 @@ export interface ListSpeakersRequest {
|
|
|
1693
1902
|
*/
|
|
1694
1903
|
export interface SpeakerSummary {
|
|
1695
1904
|
/**
|
|
1905
|
+
* @public
|
|
1696
1906
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
1697
1907
|
*/
|
|
1698
1908
|
DomainId?: string;
|
|
1699
1909
|
/**
|
|
1910
|
+
* @public
|
|
1700
1911
|
* <p>The client-provided identifier for the speaker.</p>
|
|
1701
1912
|
*/
|
|
1702
1913
|
CustomerSpeakerId?: string;
|
|
1703
1914
|
/**
|
|
1915
|
+
* @public
|
|
1704
1916
|
* <p>The service-generated identifier for the speaker. </p>
|
|
1705
1917
|
*/
|
|
1706
1918
|
GeneratedSpeakerId?: string;
|
|
1707
1919
|
/**
|
|
1920
|
+
* @public
|
|
1708
1921
|
* <p>The current status of the speaker.</p>
|
|
1709
1922
|
*/
|
|
1710
1923
|
Status?: SpeakerStatus | string;
|
|
1711
1924
|
/**
|
|
1925
|
+
* @public
|
|
1712
1926
|
* <p>A timestamp showing the speaker's creation time. </p>
|
|
1713
1927
|
*/
|
|
1714
1928
|
CreatedAt?: Date;
|
|
1715
1929
|
/**
|
|
1930
|
+
* @public
|
|
1716
1931
|
* <p>A timestamp showing the speaker's last update.</p>
|
|
1717
1932
|
*/
|
|
1718
1933
|
UpdatedAt?: Date;
|
|
1719
1934
|
/**
|
|
1935
|
+
* @public
|
|
1720
1936
|
* <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a
|
|
1721
1937
|
* successful authentication. This timestamp is accurate to one hour.</p>
|
|
1722
1938
|
*/
|
|
@@ -1727,11 +1943,13 @@ export interface SpeakerSummary {
|
|
|
1727
1943
|
*/
|
|
1728
1944
|
export interface ListSpeakersResponse {
|
|
1729
1945
|
/**
|
|
1946
|
+
* @public
|
|
1730
1947
|
* <p>A list containing details about each speaker in the Amazon Web Services account.
|
|
1731
1948
|
* </p>
|
|
1732
1949
|
*/
|
|
1733
1950
|
SpeakerSummaries?: SpeakerSummary[];
|
|
1734
1951
|
/**
|
|
1952
|
+
* @public
|
|
1735
1953
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1736
1954
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1737
1955
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1744,6 +1962,7 @@ export interface ListSpeakersResponse {
|
|
|
1744
1962
|
*/
|
|
1745
1963
|
export interface ListTagsForResourceRequest {
|
|
1746
1964
|
/**
|
|
1965
|
+
* @public
|
|
1747
1966
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list
|
|
1748
1967
|
* the tags.</p>
|
|
1749
1968
|
*/
|
|
@@ -1754,6 +1973,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1754
1973
|
*/
|
|
1755
1974
|
export interface ListTagsForResourceResponse {
|
|
1756
1975
|
/**
|
|
1976
|
+
* @public
|
|
1757
1977
|
* <p>The list of tags associated with the specified resource.</p>
|
|
1758
1978
|
*/
|
|
1759
1979
|
Tags?: Tag[];
|
|
@@ -1763,16 +1983,19 @@ export interface ListTagsForResourceResponse {
|
|
|
1763
1983
|
*/
|
|
1764
1984
|
export interface ListWatchlistsRequest {
|
|
1765
1985
|
/**
|
|
1986
|
+
* @public
|
|
1766
1987
|
* <p>The identifier of the domain.</p>
|
|
1767
1988
|
*/
|
|
1768
1989
|
DomainId: string | undefined;
|
|
1769
1990
|
/**
|
|
1991
|
+
* @public
|
|
1770
1992
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1771
1993
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
|
|
1772
1994
|
* </p>
|
|
1773
1995
|
*/
|
|
1774
1996
|
MaxResults?: number;
|
|
1775
1997
|
/**
|
|
1998
|
+
* @public
|
|
1776
1999
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1777
2000
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1778
2001
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1787,30 +2010,37 @@ export interface ListWatchlistsRequest {
|
|
|
1787
2010
|
*/
|
|
1788
2011
|
export interface WatchlistSummary {
|
|
1789
2012
|
/**
|
|
2013
|
+
* @public
|
|
1790
2014
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
1791
2015
|
*/
|
|
1792
2016
|
DomainId?: string;
|
|
1793
2017
|
/**
|
|
2018
|
+
* @public
|
|
1794
2019
|
* <p>The identifier of the watchlist.</p>
|
|
1795
2020
|
*/
|
|
1796
2021
|
WatchlistId?: string;
|
|
1797
2022
|
/**
|
|
2023
|
+
* @public
|
|
1798
2024
|
* <p>The name for the watchlist.</p>
|
|
1799
2025
|
*/
|
|
1800
2026
|
Name?: string;
|
|
1801
2027
|
/**
|
|
2028
|
+
* @public
|
|
1802
2029
|
* <p>The description of the watchlist.</p>
|
|
1803
2030
|
*/
|
|
1804
2031
|
Description?: string;
|
|
1805
2032
|
/**
|
|
2033
|
+
* @public
|
|
1806
2034
|
* <p>Whether the specified watchlist is the default watchlist of a domain.</p>
|
|
1807
2035
|
*/
|
|
1808
2036
|
DefaultWatchlist?: boolean;
|
|
1809
2037
|
/**
|
|
2038
|
+
* @public
|
|
1810
2039
|
* <p>The timestamp of when the watchlist was created.</p>
|
|
1811
2040
|
*/
|
|
1812
2041
|
CreatedAt?: Date;
|
|
1813
2042
|
/**
|
|
2043
|
+
* @public
|
|
1814
2044
|
* <p>The timestamp of when the watchlist was last updated.</p>
|
|
1815
2045
|
*/
|
|
1816
2046
|
UpdatedAt?: Date;
|
|
@@ -1820,11 +2050,13 @@ export interface WatchlistSummary {
|
|
|
1820
2050
|
*/
|
|
1821
2051
|
export interface ListWatchlistsResponse {
|
|
1822
2052
|
/**
|
|
2053
|
+
* @public
|
|
1823
2054
|
* <p>A list that contains details about each watchlist in the Amazon Web Services account.
|
|
1824
2055
|
* </p>
|
|
1825
2056
|
*/
|
|
1826
2057
|
WatchlistSummaries?: WatchlistSummary[];
|
|
1827
2058
|
/**
|
|
2059
|
+
* @public
|
|
1828
2060
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1829
2061
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1830
2062
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
@@ -1838,10 +2070,12 @@ export interface ListWatchlistsResponse {
|
|
|
1838
2070
|
*/
|
|
1839
2071
|
export interface OptOutSpeakerRequest {
|
|
1840
2072
|
/**
|
|
2073
|
+
* @public
|
|
1841
2074
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
1842
2075
|
*/
|
|
1843
2076
|
DomainId: string | undefined;
|
|
1844
2077
|
/**
|
|
2078
|
+
* @public
|
|
1845
2079
|
* <p>The identifier of the speaker you want opted-out.</p>
|
|
1846
2080
|
*/
|
|
1847
2081
|
SpeakerId: string | undefined;
|
|
@@ -1851,6 +2085,7 @@ export interface OptOutSpeakerRequest {
|
|
|
1851
2085
|
*/
|
|
1852
2086
|
export interface OptOutSpeakerResponse {
|
|
1853
2087
|
/**
|
|
2088
|
+
* @public
|
|
1854
2089
|
* <p>Details about the opted-out speaker.</p>
|
|
1855
2090
|
*/
|
|
1856
2091
|
Speaker?: Speaker;
|
|
@@ -1860,6 +2095,7 @@ export interface OptOutSpeakerResponse {
|
|
|
1860
2095
|
*/
|
|
1861
2096
|
export interface StartFraudsterRegistrationJobRequest {
|
|
1862
2097
|
/**
|
|
2098
|
+
* @public
|
|
1863
2099
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1864
2100
|
* request. If not provided, the Amazon Web Services
|
|
1865
2101
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -1867,15 +2103,18 @@ export interface StartFraudsterRegistrationJobRequest {
|
|
|
1867
2103
|
*/
|
|
1868
2104
|
ClientToken?: string;
|
|
1869
2105
|
/**
|
|
2106
|
+
* @public
|
|
1870
2107
|
* <p>The name of the new fraudster registration job.</p>
|
|
1871
2108
|
*/
|
|
1872
2109
|
JobName?: string;
|
|
1873
2110
|
/**
|
|
2111
|
+
* @public
|
|
1874
2112
|
* <p>The identifier of the domain that contains the fraudster registration job and in which
|
|
1875
2113
|
* the fraudsters are registered.</p>
|
|
1876
2114
|
*/
|
|
1877
2115
|
DomainId: string | undefined;
|
|
1878
2116
|
/**
|
|
2117
|
+
* @public
|
|
1879
2118
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
1880
2119
|
* customer's buckets to read the input manifest file and write the Job output file. Refer
|
|
1881
2120
|
* to the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and edit a
|
|
@@ -1884,17 +2123,20 @@ export interface StartFraudsterRegistrationJobRequest {
|
|
|
1884
2123
|
*/
|
|
1885
2124
|
DataAccessRoleArn: string | undefined;
|
|
1886
2125
|
/**
|
|
2126
|
+
* @public
|
|
1887
2127
|
* <p>The registration config containing details such as the action to take when a duplicate
|
|
1888
2128
|
* fraudster is detected, and the similarity threshold to use for detecting a duplicate
|
|
1889
2129
|
* fraudster. </p>
|
|
1890
2130
|
*/
|
|
1891
2131
|
RegistrationConfig?: RegistrationConfig;
|
|
1892
2132
|
/**
|
|
2133
|
+
* @public
|
|
1893
2134
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
1894
2135
|
* the list of fraudster registration requests.</p>
|
|
1895
2136
|
*/
|
|
1896
2137
|
InputDataConfig: InputDataConfig | undefined;
|
|
1897
2138
|
/**
|
|
2139
|
+
* @public
|
|
1898
2140
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
1899
2141
|
* output file; you must also include a KMS key ID to encrypt the
|
|
1900
2142
|
* file.</p>
|
|
@@ -1906,6 +2148,7 @@ export interface StartFraudsterRegistrationJobRequest {
|
|
|
1906
2148
|
*/
|
|
1907
2149
|
export interface StartFraudsterRegistrationJobResponse {
|
|
1908
2150
|
/**
|
|
2151
|
+
* @public
|
|
1909
2152
|
* <p>Details about the started fraudster registration job.</p>
|
|
1910
2153
|
*/
|
|
1911
2154
|
Job?: FraudsterRegistrationJob;
|
|
@@ -1915,6 +2158,7 @@ export interface StartFraudsterRegistrationJobResponse {
|
|
|
1915
2158
|
*/
|
|
1916
2159
|
export interface StartSpeakerEnrollmentJobRequest {
|
|
1917
2160
|
/**
|
|
2161
|
+
* @public
|
|
1918
2162
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1919
2163
|
* request. If not provided, the Amazon Web Services
|
|
1920
2164
|
* SDK populates this field. For more information about idempotency, see
|
|
@@ -1922,15 +2166,18 @@ export interface StartSpeakerEnrollmentJobRequest {
|
|
|
1922
2166
|
*/
|
|
1923
2167
|
ClientToken?: string;
|
|
1924
2168
|
/**
|
|
2169
|
+
* @public
|
|
1925
2170
|
* <p>A name for your speaker enrollment job.</p>
|
|
1926
2171
|
*/
|
|
1927
2172
|
JobName?: string;
|
|
1928
2173
|
/**
|
|
2174
|
+
* @public
|
|
1929
2175
|
* <p>The identifier of the domain that contains the speaker enrollment job and in which the
|
|
1930
2176
|
* speakers are enrolled. </p>
|
|
1931
2177
|
*/
|
|
1932
2178
|
DomainId: string | undefined;
|
|
1933
2179
|
/**
|
|
2180
|
+
* @public
|
|
1934
2181
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
1935
2182
|
* customer's buckets to read the input manifest file and write the job output file. Refer
|
|
1936
2183
|
* to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using
|
|
@@ -1938,16 +2185,19 @@ export interface StartSpeakerEnrollmentJobRequest {
|
|
|
1938
2185
|
*/
|
|
1939
2186
|
DataAccessRoleArn: string | undefined;
|
|
1940
2187
|
/**
|
|
2188
|
+
* @public
|
|
1941
2189
|
* <p>The enrollment config that contains details such as the action to take when a speaker
|
|
1942
2190
|
* is already enrolled in Voice ID or when a speaker is identified as a fraudster.</p>
|
|
1943
2191
|
*/
|
|
1944
2192
|
EnrollmentConfig?: EnrollmentConfig;
|
|
1945
2193
|
/**
|
|
2194
|
+
* @public
|
|
1946
2195
|
* <p>The input data config containing the S3 location for the input manifest file that
|
|
1947
2196
|
* contains the list of speaker enrollment requests.</p>
|
|
1948
2197
|
*/
|
|
1949
2198
|
InputDataConfig: InputDataConfig | undefined;
|
|
1950
2199
|
/**
|
|
2200
|
+
* @public
|
|
1951
2201
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
1952
2202
|
* output file; you must also include a KMS key ID to encrypt the
|
|
1953
2203
|
* file.</p>
|
|
@@ -1959,6 +2209,7 @@ export interface StartSpeakerEnrollmentJobRequest {
|
|
|
1959
2209
|
*/
|
|
1960
2210
|
export interface StartSpeakerEnrollmentJobResponse {
|
|
1961
2211
|
/**
|
|
2212
|
+
* @public
|
|
1962
2213
|
* <p>Details about the started speaker enrollment job.</p>
|
|
1963
2214
|
*/
|
|
1964
2215
|
Job?: SpeakerEnrollmentJob;
|
|
@@ -1968,10 +2219,12 @@ export interface StartSpeakerEnrollmentJobResponse {
|
|
|
1968
2219
|
*/
|
|
1969
2220
|
export interface TagResourceRequest {
|
|
1970
2221
|
/**
|
|
2222
|
+
* @public
|
|
1971
2223
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.</p>
|
|
1972
2224
|
*/
|
|
1973
2225
|
ResourceArn: string | undefined;
|
|
1974
2226
|
/**
|
|
2227
|
+
* @public
|
|
1975
2228
|
* <p>The list of tags to assign to the specified resource.</p>
|
|
1976
2229
|
*/
|
|
1977
2230
|
Tags: Tag[] | undefined;
|
|
@@ -1986,11 +2239,13 @@ export interface TagResourceResponse {
|
|
|
1986
2239
|
*/
|
|
1987
2240
|
export interface UntagResourceRequest {
|
|
1988
2241
|
/**
|
|
2242
|
+
* @public
|
|
1989
2243
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags
|
|
1990
2244
|
* from.</p>
|
|
1991
2245
|
*/
|
|
1992
2246
|
ResourceArn: string | undefined;
|
|
1993
2247
|
/**
|
|
2248
|
+
* @public
|
|
1994
2249
|
* <p>The list of tag keys you want to remove from the specified resource.</p>
|
|
1995
2250
|
*/
|
|
1996
2251
|
TagKeys: string[] | undefined;
|
|
@@ -2005,18 +2260,22 @@ export interface UntagResourceResponse {
|
|
|
2005
2260
|
*/
|
|
2006
2261
|
export interface UpdateWatchlistRequest {
|
|
2007
2262
|
/**
|
|
2263
|
+
* @public
|
|
2008
2264
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
2009
2265
|
*/
|
|
2010
2266
|
DomainId: string | undefined;
|
|
2011
2267
|
/**
|
|
2268
|
+
* @public
|
|
2012
2269
|
* <p>The identifier of the watchlist to be updated.</p>
|
|
2013
2270
|
*/
|
|
2014
2271
|
WatchlistId: string | undefined;
|
|
2015
2272
|
/**
|
|
2273
|
+
* @public
|
|
2016
2274
|
* <p>The name of the watchlist.</p>
|
|
2017
2275
|
*/
|
|
2018
2276
|
Name?: string;
|
|
2019
2277
|
/**
|
|
2278
|
+
* @public
|
|
2020
2279
|
* <p>A brief description about this watchlist.</p>
|
|
2021
2280
|
*/
|
|
2022
2281
|
Description?: string;
|
|
@@ -2026,6 +2285,7 @@ export interface UpdateWatchlistRequest {
|
|
|
2026
2285
|
*/
|
|
2027
2286
|
export interface UpdateWatchlistResponse {
|
|
2028
2287
|
/**
|
|
2288
|
+
* @public
|
|
2029
2289
|
* <p>Details about the updated watchlist.</p>
|
|
2030
2290
|
*/
|
|
2031
2291
|
Watchlist?: Watchlist;
|