aws-sdk-voiceid 1.11.0 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -24,6 +24,41 @@ module Aws::VoiceID
24
24
  include Aws::Structure
25
25
  end
26
26
 
27
+ # @!attribute [rw] domain_id
28
+ # The identifier of the domain that contains the fraudster.
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] fraudster_id
32
+ # The identifier of the fraudster to be associated with the watchlist.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] watchlist_id
36
+ # The identifier of the watchlist you want to associate with the
37
+ # fraudster.
38
+ # @return [String]
39
+ #
40
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudsterRequest AWS API Documentation
41
+ #
42
+ class AssociateFraudsterRequest < Struct.new(
43
+ :domain_id,
44
+ :fraudster_id,
45
+ :watchlist_id)
46
+ SENSITIVE = [:fraudster_id]
47
+ include Aws::Structure
48
+ end
49
+
50
+ # @!attribute [rw] fraudster
51
+ # Contains all the information about a fraudster.
52
+ # @return [Types::Fraudster]
53
+ #
54
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudsterResponse AWS API Documentation
55
+ #
56
+ class AssociateFraudsterResponse < Struct.new(
57
+ :fraudster)
58
+ SENSITIVE = []
59
+ include Aws::Structure
60
+ end
61
+
27
62
  # The configuration used to authenticate a speaker during a session.
28
63
  #
29
64
  # @!attribute [rw] acceptance_threshold
@@ -42,12 +77,12 @@ module Aws::VoiceID
42
77
  # current session state and streamed audio of the speaker.
43
78
  #
44
79
  # @!attribute [rw] audio_aggregation_ended_at
45
- # A timestamp indicating when audio aggregation ended for this
46
- # authentication result.
80
+ # A timestamp of when audio aggregation ended for this authentication
81
+ # result.
47
82
  # @return [Time]
48
83
  #
49
84
  # @!attribute [rw] audio_aggregation_started_at
50
- # A timestamp indicating when audio aggregation started for this
85
+ # A timestamp of when audio aggregation started for this
51
86
  # authentication result.
52
87
  # @return [Time]
53
88
  #
@@ -110,21 +145,21 @@ module Aws::VoiceID
110
145
  # The type of conflict which caused a ConflictException. Possible
111
146
  # types and the corresponding error messages are as follows:
112
147
  #
113
- # * `DOMAIN_NOT_ACTIVE`\: The domain is not active.
148
+ # * `DOMAIN_NOT_ACTIVE`: The domain is not active.
114
149
  #
115
- # * `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`\: You cannot change the
150
+ # * `CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT`: You cannot change the
116
151
  # speaker ID after an enrollment has been requested.
117
152
  #
118
- # * `ENROLLMENT_ALREADY_EXISTS`\: There is already an enrollment for
153
+ # * `ENROLLMENT_ALREADY_EXISTS`: There is already an enrollment for
119
154
  # this session.
120
155
  #
121
- # * `SPEAKER_NOT_SET`\: You must set the speaker ID before requesting
156
+ # * `SPEAKER_NOT_SET`: You must set the speaker ID before requesting
122
157
  # an enrollment.
123
158
  #
124
- # * `SPEAKER_OPTED_OUT`\: You cannot request an enrollment for an
125
- # opted out speaker.
159
+ # * `SPEAKER_OPTED_OUT`: You cannot request an enrollment for an opted
160
+ # out speaker.
126
161
  #
127
- # * `CONCURRENT_CHANGES`\: The request could not be processed as the
162
+ # * `CONCURRENT_CHANGES`: The request could not be processed as the
128
163
  # resource was modified by another request during execution.
129
164
  # @return [String]
130
165
  #
@@ -141,15 +176,21 @@ module Aws::VoiceID
141
176
  end
142
177
 
143
178
  # @!attribute [rw] client_token
144
- # The idempotency token for creating a new domain. If not provided,
145
- # Amazon Web Services SDK populates this field.
179
+ # A unique, case-sensitive identifier that you provide to ensure the
180
+ # idempotency of the request. If not provided, the Amazon Web Services
181
+ # SDK populates this field. For more information about idempotency,
182
+ # see [Making retries safe with idempotent APIs][1].
146
183
  #
147
184
  # **A suitable default value is auto-generated.** You should normally
148
185
  # not need to pass this option.
186
+ #
187
+ #
188
+ #
189
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
149
190
  # @return [String]
150
191
  #
151
192
  # @!attribute [rw] description
152
- # A brief description of the domain.
193
+ # A brief description of this domain.
153
194
  # @return [String]
154
195
  #
155
196
  # @!attribute [rw] name
@@ -195,6 +236,55 @@ module Aws::VoiceID
195
236
  include Aws::Structure
196
237
  end
197
238
 
239
+ # @!attribute [rw] client_token
240
+ # A unique, case-sensitive identifier that you provide to ensure the
241
+ # idempotency of the request. If not provided, the Amazon Web Services
242
+ # SDK populates this field. For more information about idempotency,
243
+ # see [Making retries safe with idempotent APIs][1].
244
+ #
245
+ # **A suitable default value is auto-generated.** You should normally
246
+ # not need to pass this option.
247
+ #
248
+ #
249
+ #
250
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] description
254
+ # A brief description of this watchlist.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] domain_id
258
+ # The identifier of the domain that contains the watchlist.
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] name
262
+ # The name of the watchlist.
263
+ # @return [String]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlistRequest AWS API Documentation
266
+ #
267
+ class CreateWatchlistRequest < Struct.new(
268
+ :client_token,
269
+ :description,
270
+ :domain_id,
271
+ :name)
272
+ SENSITIVE = [:description, :name]
273
+ include Aws::Structure
274
+ end
275
+
276
+ # @!attribute [rw] watchlist
277
+ # Information about the newly created watchlist.
278
+ # @return [Types::Watchlist]
279
+ #
280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlistResponse AWS API Documentation
281
+ #
282
+ class CreateWatchlistResponse < Struct.new(
283
+ :watchlist)
284
+ SENSITIVE = []
285
+ include Aws::Structure
286
+ end
287
+
198
288
  # @!attribute [rw] domain_id
199
289
  # The identifier of the domain you want to delete.
200
290
  # @return [String]
@@ -208,7 +298,7 @@ module Aws::VoiceID
208
298
  end
209
299
 
210
300
  # @!attribute [rw] domain_id
211
- # The identifier of the domain containing the fraudster.
301
+ # The identifier of the domain that contains the fraudster.
212
302
  # @return [String]
213
303
  #
214
304
  # @!attribute [rw] fraudster_id
@@ -225,7 +315,7 @@ module Aws::VoiceID
225
315
  end
226
316
 
227
317
  # @!attribute [rw] domain_id
228
- # The identifier of the domain containing the speaker.
318
+ # The identifier of the domain that contains the speaker.
229
319
  # @return [String]
230
320
  #
231
321
  # @!attribute [rw] speaker_id
@@ -242,7 +332,24 @@ module Aws::VoiceID
242
332
  end
243
333
 
244
334
  # @!attribute [rw] domain_id
245
- # The identifier of the domain you are describing.
335
+ # The identifier of the domain that contains the watchlist.
336
+ # @return [String]
337
+ #
338
+ # @!attribute [rw] watchlist_id
339
+ # The identifier of the watchlist to be deleted.
340
+ # @return [String]
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlistRequest AWS API Documentation
343
+ #
344
+ class DeleteWatchlistRequest < Struct.new(
345
+ :domain_id,
346
+ :watchlist_id)
347
+ SENSITIVE = []
348
+ include Aws::Structure
349
+ end
350
+
351
+ # @!attribute [rw] domain_id
352
+ # The identifier of the domain that you are describing.
246
353
  # @return [String]
247
354
  #
248
355
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomainRequest AWS API Documentation
@@ -266,13 +373,12 @@ module Aws::VoiceID
266
373
  end
267
374
 
268
375
  # @!attribute [rw] domain_id
269
- # The identifier for the domain containing the fraudster registration
270
- # job.
376
+ # The identifier of the domain that contains the fraudster
377
+ # registration job.
271
378
  # @return [String]
272
379
  #
273
380
  # @!attribute [rw] job_id
274
- # The identifier for the fraudster registration job you are
275
- # describing.
381
+ # The identifier of the fraudster registration job you are describing.
276
382
  # @return [String]
277
383
  #
278
384
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJobRequest AWS API Documentation
@@ -297,7 +403,7 @@ module Aws::VoiceID
297
403
  end
298
404
 
299
405
  # @!attribute [rw] domain_id
300
- # The identifier of the domain containing the fraudster.
406
+ # The identifier of the domain that contains the fraudster.
301
407
  # @return [String]
302
408
  #
303
409
  # @!attribute [rw] fraudster_id
@@ -326,7 +432,8 @@ module Aws::VoiceID
326
432
  end
327
433
 
328
434
  # @!attribute [rw] domain_id
329
- # The identifier of the domain containing the speaker enrollment job.
435
+ # The identifier of the domain that contains the speaker enrollment
436
+ # job.
330
437
  # @return [String]
331
438
  #
332
439
  # @!attribute [rw] job_id
@@ -383,6 +490,71 @@ module Aws::VoiceID
383
490
  include Aws::Structure
384
491
  end
385
492
 
493
+ # @!attribute [rw] domain_id
494
+ # The identifier of the domain that contains the watchlist.
495
+ # @return [String]
496
+ #
497
+ # @!attribute [rw] watchlist_id
498
+ # The identifier of the watchlist that you are describing.
499
+ # @return [String]
500
+ #
501
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlistRequest AWS API Documentation
502
+ #
503
+ class DescribeWatchlistRequest < Struct.new(
504
+ :domain_id,
505
+ :watchlist_id)
506
+ SENSITIVE = []
507
+ include Aws::Structure
508
+ end
509
+
510
+ # @!attribute [rw] watchlist
511
+ # Information about the specified watchlist.
512
+ # @return [Types::Watchlist]
513
+ #
514
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlistResponse AWS API Documentation
515
+ #
516
+ class DescribeWatchlistResponse < Struct.new(
517
+ :watchlist)
518
+ SENSITIVE = []
519
+ include Aws::Structure
520
+ end
521
+
522
+ # @!attribute [rw] domain_id
523
+ # The identifier of the domain that contains the fraudster.
524
+ # @return [String]
525
+ #
526
+ # @!attribute [rw] fraudster_id
527
+ # The identifier of the fraudster to be disassociated from the
528
+ # watchlist.
529
+ # @return [String]
530
+ #
531
+ # @!attribute [rw] watchlist_id
532
+ # The identifier of the watchlist that you want to disassociate from
533
+ # the fraudster.
534
+ # @return [String]
535
+ #
536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudsterRequest AWS API Documentation
537
+ #
538
+ class DisassociateFraudsterRequest < Struct.new(
539
+ :domain_id,
540
+ :fraudster_id,
541
+ :watchlist_id)
542
+ SENSITIVE = [:fraudster_id]
543
+ include Aws::Structure
544
+ end
545
+
546
+ # @!attribute [rw] fraudster
547
+ # Contains all the information about a fraudster.
548
+ # @return [Types::Fraudster]
549
+ #
550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudsterResponse AWS API Documentation
551
+ #
552
+ class DisassociateFraudsterResponse < Struct.new(
553
+ :fraudster)
554
+ SENSITIVE = []
555
+ include Aws::Structure
556
+ end
557
+
386
558
  # Contains all the information about a domain.
387
559
  #
388
560
  # @!attribute [rw] arn
@@ -390,15 +562,15 @@ module Aws::VoiceID
390
562
  # @return [String]
391
563
  #
392
564
  # @!attribute [rw] created_at
393
- # The timestamp at which the domain is created.
565
+ # The timestamp of when the domain was created.
394
566
  # @return [Time]
395
567
  #
396
568
  # @!attribute [rw] description
397
- # The client-provided description of the domain.
569
+ # The description of the domain.
398
570
  # @return [String]
399
571
  #
400
572
  # @!attribute [rw] domain_id
401
- # The service-generated identifier for the domain.
573
+ # The identifier of the domain.
402
574
  # @return [String]
403
575
  #
404
576
  # @!attribute [rw] domain_status
@@ -406,7 +578,7 @@ module Aws::VoiceID
406
578
  # @return [String]
407
579
  #
408
580
  # @!attribute [rw] name
409
- # The client-provided name for the domain.
581
+ # The name for the domain.
410
582
  # @return [String]
411
583
  #
412
584
  # @!attribute [rw] server_side_encryption_configuration
@@ -423,9 +595,14 @@ module Aws::VoiceID
423
595
  # @return [Types::ServerSideEncryptionUpdateDetails]
424
596
  #
425
597
  # @!attribute [rw] updated_at
426
- # The timestamp showing the domain's last update.
598
+ # The timestamp of when the domain was last update.
427
599
  # @return [Time]
428
600
  #
601
+ # @!attribute [rw] watchlist_details
602
+ # The watchlist details of a domain. Contains the default watchlist ID
603
+ # of the domain.
604
+ # @return [Types::WatchlistDetails]
605
+ #
429
606
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/Domain AWS API Documentation
430
607
  #
431
608
  class Domain < Struct.new(
@@ -437,7 +614,8 @@ module Aws::VoiceID
437
614
  :name,
438
615
  :server_side_encryption_configuration,
439
616
  :server_side_encryption_update_details,
440
- :updated_at)
617
+ :updated_at,
618
+ :watchlist_details)
441
619
  SENSITIVE = [:description, :name]
442
620
  include Aws::Structure
443
621
  end
@@ -449,15 +627,15 @@ module Aws::VoiceID
449
627
  # @return [String]
450
628
  #
451
629
  # @!attribute [rw] created_at
452
- # The timestamp showing when the domain is created.
630
+ # The timestamp of when the domain was created.
453
631
  # @return [Time]
454
632
  #
455
633
  # @!attribute [rw] description
456
- # The client-provided description of the domain.
634
+ # The description of the domain.
457
635
  # @return [String]
458
636
  #
459
637
  # @!attribute [rw] domain_id
460
- # The service-generated identifier for the domain.
638
+ # The identifier of the domain.
461
639
  # @return [String]
462
640
  #
463
641
  # @!attribute [rw] domain_status
@@ -482,9 +660,14 @@ module Aws::VoiceID
482
660
  # @return [Types::ServerSideEncryptionUpdateDetails]
483
661
  #
484
662
  # @!attribute [rw] updated_at
485
- # The timestamp showing the domain's last update.
663
+ # The timestamp of when the domain was last updated.
486
664
  # @return [Time]
487
665
  #
666
+ # @!attribute [rw] watchlist_details
667
+ # Provides information about `watchlistDetails` and
668
+ # `DefaultWatchlistID`.
669
+ # @return [Types::WatchlistDetails]
670
+ #
488
671
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DomainSummary AWS API Documentation
489
672
  #
490
673
  class DomainSummary < Struct.new(
@@ -496,7 +679,8 @@ module Aws::VoiceID
496
679
  :name,
497
680
  :server_side_encryption_configuration,
498
681
  :server_side_encryption_update_details,
499
- :updated_at)
682
+ :updated_at,
683
+ :watchlist_details)
500
684
  SENSITIVE = [:description, :name]
501
685
  include Aws::Structure
502
686
  end
@@ -527,9 +711,8 @@ module Aws::VoiceID
527
711
  include Aws::Structure
528
712
  end
529
713
 
530
- # The configuration defining the action to take when a speaker is
531
- # flagged by the fraud detection system during a batch speaker
532
- # enrollment job, and the risk threshold to use for identification.
714
+ # The fraud detection configuration to be used during the batch speaker
715
+ # enrollment job.
533
716
  #
534
717
  # @!attribute [rw] fraud_detection_action
535
718
  # The action to take when the given speaker is flagged by the fraud
@@ -546,11 +729,17 @@ module Aws::VoiceID
546
729
  # a fraudster.
547
730
  # @return [Integer]
548
731
  #
732
+ # @!attribute [rw] watchlist_ids
733
+ # The identifier of watchlists against which fraud detection is
734
+ # performed.
735
+ # @return [Array<String>]
736
+ #
549
737
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EnrollmentJobFraudDetectionConfig AWS API Documentation
550
738
  #
551
739
  class EnrollmentJobFraudDetectionConfig < Struct.new(
552
740
  :fraud_detection_action,
553
- :risk_threshold)
741
+ :risk_threshold,
742
+ :watchlist_ids)
554
743
  SENSITIVE = []
555
744
  include Aws::Structure
556
745
  end
@@ -579,7 +768,7 @@ module Aws::VoiceID
579
768
  # @return [Types::AuthenticationResult]
580
769
  #
581
770
  # @!attribute [rw] domain_id
582
- # The identifier of the domain containing the session.
771
+ # The identifier of the domain that contains the session.
583
772
  # @return [String]
584
773
  #
585
774
  # @!attribute [rw] fraud_detection_result
@@ -649,10 +838,16 @@ module Aws::VoiceID
649
838
  # threshold, the speaker is considered a fraudster.
650
839
  # @return [Integer]
651
840
  #
841
+ # @!attribute [rw] watchlist_id
842
+ # The identifier of the watchlist against which fraud detection is
843
+ # performed.
844
+ # @return [String]
845
+ #
652
846
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/FraudDetectionConfiguration AWS API Documentation
653
847
  #
654
848
  class FraudDetectionConfiguration < Struct.new(
655
- :risk_threshold)
849
+ :risk_threshold,
850
+ :watchlist_id)
656
851
  SENSITIVE = []
657
852
  include Aws::Structure
658
853
  end
@@ -661,12 +856,12 @@ module Aws::VoiceID
661
856
  # current session state and streamed audio of the speaker.
662
857
  #
663
858
  # @!attribute [rw] audio_aggregation_ended_at
664
- # A timestamp indicating when audio aggregation ended for this fraud
665
- # detection result.
859
+ # A timestamp of when audio aggregation ended for this fraud detection
860
+ # result.
666
861
  # @return [Time]
667
862
  #
668
863
  # @!attribute [rw] audio_aggregation_started_at
669
- # A timestamp indicating when audio aggregation started for this fraud
864
+ # A timestamp of when audio aggregation started for this fraud
670
865
  # detection result.
671
866
  # @return [Time]
672
867
  #
@@ -740,23 +935,28 @@ module Aws::VoiceID
740
935
  # Contains all the information about a fraudster.
741
936
  #
742
937
  # @!attribute [rw] created_at
743
- # The timestamp when Voice ID identified the fraudster.
938
+ # The timestamp of when Voice ID identified the fraudster.
744
939
  # @return [Time]
745
940
  #
746
941
  # @!attribute [rw] domain_id
747
- # The identifier for the domain containing the fraudster.
942
+ # The identifier of the domain that contains the fraudster.
748
943
  # @return [String]
749
944
  #
750
945
  # @!attribute [rw] generated_fraudster_id
751
946
  # The service-generated identifier for the fraudster.
752
947
  # @return [String]
753
948
  #
949
+ # @!attribute [rw] watchlist_ids
950
+ # The identifier of the watchlists the fraudster is a part of.
951
+ # @return [Array<String>]
952
+ #
754
953
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/Fraudster AWS API Documentation
755
954
  #
756
955
  class Fraudster < Struct.new(
757
956
  :created_at,
758
957
  :domain_id,
759
- :generated_fraudster_id)
958
+ :generated_fraudster_id,
959
+ :watchlist_ids)
760
960
  SENSITIVE = []
761
961
  include Aws::Structure
762
962
  end
@@ -764,8 +964,7 @@ module Aws::VoiceID
764
964
  # Contains all the information about a fraudster registration job.
765
965
  #
766
966
  # @!attribute [rw] created_at
767
- # A timestamp showing the creation time of the fraudster registration
768
- # job.
967
+ # A timestamp of when the fraudster registration job was created.
769
968
  # @return [Time]
770
969
  #
771
970
  # @!attribute [rw] data_access_role_arn
@@ -775,12 +974,12 @@ module Aws::VoiceID
775
974
  # @return [String]
776
975
  #
777
976
  # @!attribute [rw] domain_id
778
- # The identifier of the domain containing the fraudster registration
779
- # job.
977
+ # The identifier of the domain that contains the fraudster
978
+ # registration job.
780
979
  # @return [String]
781
980
  #
782
981
  # @!attribute [rw] ended_at
783
- # A timestamp showing when the fraudster registration job ended.
982
+ # A timestamp of when the fraudster registration job ended.
784
983
  # @return [Time]
785
984
  #
786
985
  # @!attribute [rw] failure_details
@@ -847,16 +1046,16 @@ module Aws::VoiceID
847
1046
  # Contains a summary of information about a fraudster registration job.
848
1047
  #
849
1048
  # @!attribute [rw] created_at
850
- # A timestamp showing when the fraudster registration job is created.
1049
+ # A timestamp of when the fraudster registration job was created.
851
1050
  # @return [Time]
852
1051
  #
853
1052
  # @!attribute [rw] domain_id
854
- # The identifier of the domain containing the fraudster registration
855
- # job.
1053
+ # The identifier of the domain that contains the fraudster
1054
+ # registration job.
856
1055
  # @return [String]
857
1056
  #
858
1057
  # @!attribute [rw] ended_at
859
- # A timestamp showing when the fraudster registration job ended.
1058
+ # A timestamp of when the fraudster registration job ended.
860
1059
  # @return [Time]
861
1060
  #
862
1061
  # @!attribute [rw] failure_details
@@ -899,6 +1098,35 @@ module Aws::VoiceID
899
1098
  include Aws::Structure
900
1099
  end
901
1100
 
1101
+ # Contains a summary of information about a fraudster.
1102
+ #
1103
+ # @!attribute [rw] created_at
1104
+ # The timestamp of when the fraudster summary was created.
1105
+ # @return [Time]
1106
+ #
1107
+ # @!attribute [rw] domain_id
1108
+ # The identifier of the domain that contains the fraudster summary.
1109
+ # @return [String]
1110
+ #
1111
+ # @!attribute [rw] generated_fraudster_id
1112
+ # The service-generated identifier for the fraudster.
1113
+ # @return [String]
1114
+ #
1115
+ # @!attribute [rw] watchlist_ids
1116
+ # The identifier of the watchlists the fraudster is a part of.
1117
+ # @return [Array<String>]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/FraudsterSummary AWS API Documentation
1120
+ #
1121
+ class FraudsterSummary < Struct.new(
1122
+ :created_at,
1123
+ :domain_id,
1124
+ :generated_fraudster_id,
1125
+ :watchlist_ids)
1126
+ SENSITIVE = []
1127
+ include Aws::Structure
1128
+ end
1129
+
902
1130
  # The configuration containing input file information for a batch job.
903
1131
  #
904
1132
  # @!attribute [rw] s3_uri
@@ -967,7 +1195,9 @@ module Aws::VoiceID
967
1195
  end
968
1196
 
969
1197
  # @!attribute [rw] max_results
970
- # The maximum number of domains to list per API call.
1198
+ # The maximum number of results that are returned per call. You can
1199
+ # use `NextToken` to obtain more pages of results. The default is 100;
1200
+ # the maximum allowed page size is also 100.
971
1201
  # @return [Integer]
972
1202
  #
973
1203
  # @!attribute [rw] next_token
@@ -1010,8 +1240,8 @@ module Aws::VoiceID
1010
1240
  end
1011
1241
 
1012
1242
  # @!attribute [rw] domain_id
1013
- # The identifier of the domain containing the fraudster registration
1014
- # Jobs.
1243
+ # The identifier of the domain that contains the fraudster
1244
+ # registration Jobs.
1015
1245
  # @return [String]
1016
1246
  #
1017
1247
  # @!attribute [rw] job_status
@@ -1020,8 +1250,8 @@ module Aws::VoiceID
1020
1250
  #
1021
1251
  # @!attribute [rw] max_results
1022
1252
  # The maximum number of results that are returned per call. You can
1023
- # use `NextToken` to obtain further pages of results. The default is
1024
- # 100; the maximum allowed page size is also 100.
1253
+ # use `NextToken` to obtain more pages of results. The default is 100;
1254
+ # the maximum allowed page size is also 100.
1025
1255
  # @return [Integer]
1026
1256
  #
1027
1257
  # @!attribute [rw] next_token
@@ -1066,7 +1296,65 @@ module Aws::VoiceID
1066
1296
  end
1067
1297
 
1068
1298
  # @!attribute [rw] domain_id
1069
- # The identifier of the domain containing the speaker enrollment jobs.
1299
+ # The identifier of the domain.
1300
+ # @return [String]
1301
+ #
1302
+ # @!attribute [rw] max_results
1303
+ # The maximum number of results that are returned per call. You can
1304
+ # use `NextToken` to obtain more pages of results. The default is 100;
1305
+ # the maximum allowed page size is also 100.
1306
+ # @return [Integer]
1307
+ #
1308
+ # @!attribute [rw] next_token
1309
+ # If `NextToken` is returned, there are more results available. The
1310
+ # value of `NextToken` is a unique pagination token for each page.
1311
+ # Make the call again using the returned token to retrieve the next
1312
+ # page. Keep all other arguments unchanged. Each pagination token
1313
+ # expires after 24 hours.
1314
+ # @return [String]
1315
+ #
1316
+ # @!attribute [rw] watchlist_id
1317
+ # The identifier of the watchlist. If provided, all fraudsters in the
1318
+ # watchlist are listed. If not provided, all fraudsters in the domain
1319
+ # are listed.
1320
+ # @return [String]
1321
+ #
1322
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudstersRequest AWS API Documentation
1323
+ #
1324
+ class ListFraudstersRequest < Struct.new(
1325
+ :domain_id,
1326
+ :max_results,
1327
+ :next_token,
1328
+ :watchlist_id)
1329
+ SENSITIVE = []
1330
+ include Aws::Structure
1331
+ end
1332
+
1333
+ # @!attribute [rw] fraudster_summaries
1334
+ # A list that contains details about each fraudster in the Amazon Web
1335
+ # Services account.
1336
+ # @return [Array<Types::FraudsterSummary>]
1337
+ #
1338
+ # @!attribute [rw] next_token
1339
+ # If `NextToken` is returned, there are more results available. The
1340
+ # value of `NextToken` is a unique pagination token for each page.
1341
+ # Make the call again using the returned token to retrieve the next
1342
+ # page. Keep all other arguments unchanged. Each pagination token
1343
+ # expires after 24 hours.
1344
+ # @return [String]
1345
+ #
1346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudstersResponse AWS API Documentation
1347
+ #
1348
+ class ListFraudstersResponse < Struct.new(
1349
+ :fraudster_summaries,
1350
+ :next_token)
1351
+ SENSITIVE = []
1352
+ include Aws::Structure
1353
+ end
1354
+
1355
+ # @!attribute [rw] domain_id
1356
+ # The identifier of the domain that contains the speaker enrollment
1357
+ # jobs.
1070
1358
  # @return [String]
1071
1359
  #
1072
1360
  # @!attribute [rw] job_status
@@ -1075,8 +1363,8 @@ module Aws::VoiceID
1075
1363
  #
1076
1364
  # @!attribute [rw] max_results
1077
1365
  # The maximum number of results that are returned per call. You can
1078
- # use `NextToken` to obtain further pages of results. The default is
1079
- # 100; the maximum allowed page size is also 100.
1366
+ # use `NextToken` to obtain more pages of results. The default is 100;
1367
+ # the maximum allowed page size is also 100.
1080
1368
  # @return [Integer]
1081
1369
  #
1082
1370
  # @!attribute [rw] next_token
@@ -1126,8 +1414,8 @@ module Aws::VoiceID
1126
1414
  #
1127
1415
  # @!attribute [rw] max_results
1128
1416
  # The maximum number of results that are returned per call. You can
1129
- # use `NextToken` to obtain further pages of results. The default is
1130
- # 100; the maximum allowed page size is also 100.
1417
+ # use `NextToken` to obtain more pages of results. The default is 100;
1418
+ # the maximum allowed page size is also 100.
1131
1419
  # @return [Integer]
1132
1420
  #
1133
1421
  # @!attribute [rw] next_token
@@ -1196,7 +1484,57 @@ module Aws::VoiceID
1196
1484
  end
1197
1485
 
1198
1486
  # @!attribute [rw] domain_id
1199
- # The identifier of the domain containing the speaker.
1487
+ # The identifier of the domain.
1488
+ # @return [String]
1489
+ #
1490
+ # @!attribute [rw] max_results
1491
+ # The maximum number of results that are returned per call. You can
1492
+ # use `NextToken` to obtain more pages of results. The default is 100;
1493
+ # the maximum allowed page size is also 100.
1494
+ # @return [Integer]
1495
+ #
1496
+ # @!attribute [rw] next_token
1497
+ # If `NextToken` is returned, there are more results available. The
1498
+ # value of `NextToken` is a unique pagination token for each page.
1499
+ # Make the call again using the returned token to retrieve the next
1500
+ # page. Keep all other arguments unchanged. Each pagination token
1501
+ # expires after 24 hours.
1502
+ # @return [String]
1503
+ #
1504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlistsRequest AWS API Documentation
1505
+ #
1506
+ class ListWatchlistsRequest < Struct.new(
1507
+ :domain_id,
1508
+ :max_results,
1509
+ :next_token)
1510
+ SENSITIVE = []
1511
+ include Aws::Structure
1512
+ end
1513
+
1514
+ # @!attribute [rw] next_token
1515
+ # If `NextToken` is returned, there are more results available. The
1516
+ # value of `NextToken` is a unique pagination token for each page.
1517
+ # Make the call again using the returned token to retrieve the next
1518
+ # page. Keep all other arguments unchanged. Each pagination token
1519
+ # expires after 24 hours.
1520
+ # @return [String]
1521
+ #
1522
+ # @!attribute [rw] watchlist_summaries
1523
+ # A list that contains details about each watchlist in the Amazon Web
1524
+ # Services account.
1525
+ # @return [Array<Types::WatchlistSummary>]
1526
+ #
1527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlistsResponse AWS API Documentation
1528
+ #
1529
+ class ListWatchlistsResponse < Struct.new(
1530
+ :next_token,
1531
+ :watchlist_summaries)
1532
+ SENSITIVE = []
1533
+ include Aws::Structure
1534
+ end
1535
+
1536
+ # @!attribute [rw] domain_id
1537
+ # The identifier of the domain that contains the speaker.
1200
1538
  # @return [String]
1201
1539
  #
1202
1540
  # @!attribute [rw] speaker_id
@@ -1249,10 +1587,8 @@ module Aws::VoiceID
1249
1587
  include Aws::Structure
1250
1588
  end
1251
1589
 
1252
- # The configuration defining the action to take when a duplicate
1253
- # fraudster is detected, and the similarity threshold to use for
1254
- # detecting a duplicate fraudster during a batch fraudster registration
1255
- # job.
1590
+ # The registration configuration to be used during the batch fraudster
1591
+ # registration job.
1256
1592
  #
1257
1593
  # @!attribute [rw] duplicate_registration_action
1258
1594
  # The action to take when a fraudster is identified as a duplicate.
@@ -1266,11 +1602,18 @@ module Aws::VoiceID
1266
1602
  # order to consider the new fraudster a duplicate.
1267
1603
  # @return [Integer]
1268
1604
  #
1605
+ # @!attribute [rw] watchlist_ids
1606
+ # The identifiers of watchlists that a fraudster is registered to. If
1607
+ # a watchlist isn't provided, the fraudsters are registered to the
1608
+ # default watchlist.
1609
+ # @return [Array<String>]
1610
+ #
1269
1611
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/RegistrationConfig AWS API Documentation
1270
1612
  #
1271
1613
  class RegistrationConfig < Struct.new(
1272
1614
  :duplicate_registration_action,
1273
- :fraudster_similarity_threshold)
1615
+ :fraudster_similarity_threshold,
1616
+ :watchlist_ids)
1274
1617
  SENSITIVE = []
1275
1618
  include Aws::Structure
1276
1619
  end
@@ -1368,7 +1711,7 @@ module Aws::VoiceID
1368
1711
  # Contains all the information about a speaker.
1369
1712
  #
1370
1713
  # @!attribute [rw] created_at
1371
- # A timestamp showing when the speaker is created.
1714
+ # A timestamp of when the speaker was created.
1372
1715
  # @return [Time]
1373
1716
  #
1374
1717
  # @!attribute [rw] customer_speaker_id
@@ -1384,7 +1727,7 @@ module Aws::VoiceID
1384
1727
  # @return [String]
1385
1728
  #
1386
1729
  # @!attribute [rw] last_accessed_at
1387
- # The timestamp when the speaker was last accessed for enrollment,
1730
+ # The timestamp of when the speaker was last accessed for enrollment,
1388
1731
  # re-enrollment or a successful authentication. This timestamp is
1389
1732
  # accurate to one hour.
1390
1733
  # @return [Time]
@@ -1394,7 +1737,7 @@ module Aws::VoiceID
1394
1737
  # @return [String]
1395
1738
  #
1396
1739
  # @!attribute [rw] updated_at
1397
- # A timestamp showing the speaker's last update.
1740
+ # A timestamp of the speaker's last update.
1398
1741
  # @return [Time]
1399
1742
  #
1400
1743
  # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/Speaker AWS API Documentation
@@ -1414,7 +1757,7 @@ module Aws::VoiceID
1414
1757
  # Contains all the information about a speaker enrollment job.
1415
1758
  #
1416
1759
  # @!attribute [rw] created_at
1417
- # A timestamp showing the creation of the speaker enrollment job.
1760
+ # A timestamp of when the speaker enrollment job was created.
1418
1761
  # @return [Time]
1419
1762
  #
1420
1763
  # @!attribute [rw] data_access_role_arn
@@ -1429,7 +1772,7 @@ module Aws::VoiceID
1429
1772
  # @return [String]
1430
1773
  #
1431
1774
  # @!attribute [rw] ended_at
1432
- # A timestamp showing when the speaker enrollment job ended.
1775
+ # A timestamp of when the speaker enrollment job ended.
1433
1776
  # @return [Time]
1434
1777
  #
1435
1778
  # @!attribute [rw] enrollment_config
@@ -1496,7 +1839,7 @@ module Aws::VoiceID
1496
1839
  # Contains a summary of information about a speaker enrollment job.
1497
1840
  #
1498
1841
  # @!attribute [rw] created_at
1499
- # A timestamp showing the creation time of the speaker enrollment job.
1842
+ # A timestamp of when of the speaker enrollment job was created.
1500
1843
  # @return [Time]
1501
1844
  #
1502
1845
  # @!attribute [rw] domain_id
@@ -1505,7 +1848,7 @@ module Aws::VoiceID
1505
1848
  # @return [String]
1506
1849
  #
1507
1850
  # @!attribute [rw] ended_at
1508
- # A timestamp showing when the speaker enrollment job ended.
1851
+ # A timestamp of when the speaker enrollment job ended.
1509
1852
  # @return [Time]
1510
1853
  #
1511
1854
  # @!attribute [rw] failure_details
@@ -1596,11 +1939,17 @@ module Aws::VoiceID
1596
1939
  end
1597
1940
 
1598
1941
  # @!attribute [rw] client_token
1599
- # The idempotency token for starting a new fraudster registration job.
1600
- # If not provided, Amazon Web Services SDK populates this field.
1942
+ # A unique, case-sensitive identifier that you provide to ensure the
1943
+ # idempotency of the request. If not provided, the Amazon Web Services
1944
+ # SDK populates this field. For more information about idempotency,
1945
+ # see [Making retries safe with idempotent APIs][1].
1601
1946
  #
1602
1947
  # **A suitable default value is auto-generated.** You should normally
1603
1948
  # not need to pass this option.
1949
+ #
1950
+ #
1951
+ #
1952
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1604
1953
  # @return [String]
1605
1954
  #
1606
1955
  # @!attribute [rw] data_access_role_arn
@@ -1616,8 +1965,8 @@ module Aws::VoiceID
1616
1965
  # @return [String]
1617
1966
  #
1618
1967
  # @!attribute [rw] domain_id
1619
- # The identifier of the domain containing the fraudster registration
1620
- # job and in which the fraudsters are registered.
1968
+ # The identifier of the domain that contains the fraudster
1969
+ # registration job and in which the fraudsters are registered.
1621
1970
  # @return [String]
1622
1971
  #
1623
1972
  # @!attribute [rw] input_data_config
@@ -1668,11 +2017,17 @@ module Aws::VoiceID
1668
2017
  end
1669
2018
 
1670
2019
  # @!attribute [rw] client_token
1671
- # The idempotency token for starting a new speaker enrollment Job. If
1672
- # not provided, Amazon Web Services SDK populates this field.
2020
+ # A unique, case-sensitive identifier that you provide to ensure the
2021
+ # idempotency of the request. If not provided, the Amazon Web Services
2022
+ # SDK populates this field. For more information about idempotency,
2023
+ # see [Making retries safe with idempotent APIs][1].
1673
2024
  #
1674
2025
  # **A suitable default value is auto-generated.** You should normally
1675
2026
  # not need to pass this option.
2027
+ #
2028
+ #
2029
+ #
2030
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
1676
2031
  # @return [String]
1677
2032
  #
1678
2033
  # @!attribute [rw] data_access_role_arn
@@ -1828,7 +2183,7 @@ module Aws::VoiceID
1828
2183
  class UntagResourceResponse < Aws::EmptyStructure; end
1829
2184
 
1830
2185
  # @!attribute [rw] description
1831
- # A brief description of the domain.
2186
+ # A brief description about this domain.
1832
2187
  # @return [String]
1833
2188
  #
1834
2189
  # @!attribute [rw] domain_id
@@ -1872,6 +2227,45 @@ module Aws::VoiceID
1872
2227
  include Aws::Structure
1873
2228
  end
1874
2229
 
2230
+ # @!attribute [rw] description
2231
+ # A brief description about this watchlist.
2232
+ # @return [String]
2233
+ #
2234
+ # @!attribute [rw] domain_id
2235
+ # The identifier of the domain that contains the watchlist.
2236
+ # @return [String]
2237
+ #
2238
+ # @!attribute [rw] name
2239
+ # The name of the watchlist.
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] watchlist_id
2243
+ # The identifier of the watchlist to be updated.
2244
+ # @return [String]
2245
+ #
2246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlistRequest AWS API Documentation
2247
+ #
2248
+ class UpdateWatchlistRequest < Struct.new(
2249
+ :description,
2250
+ :domain_id,
2251
+ :name,
2252
+ :watchlist_id)
2253
+ SENSITIVE = [:description, :name]
2254
+ include Aws::Structure
2255
+ end
2256
+
2257
+ # @!attribute [rw] watchlist
2258
+ # Details about the updated watchlist.
2259
+ # @return [Types::Watchlist]
2260
+ #
2261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlistResponse AWS API Documentation
2262
+ #
2263
+ class UpdateWatchlistResponse < Struct.new(
2264
+ :watchlist)
2265
+ SENSITIVE = []
2266
+ include Aws::Structure
2267
+ end
2268
+
1875
2269
  # The request failed one or more validations; check the error message
1876
2270
  # for more details.
1877
2271
  #
@@ -1902,5 +2296,109 @@ module Aws::VoiceID
1902
2296
  include Aws::Structure
1903
2297
  end
1904
2298
 
2299
+ # Contains all the information about a watchlist.
2300
+ #
2301
+ # @!attribute [rw] created_at
2302
+ # The timestamp of when the watchlist was created.
2303
+ # @return [Time]
2304
+ #
2305
+ # @!attribute [rw] default_watchlist
2306
+ # Whether the specified watchlist is the default watchlist of a
2307
+ # domain.
2308
+ # @return [Boolean]
2309
+ #
2310
+ # @!attribute [rw] description
2311
+ # The description of the watchlist.
2312
+ # @return [String]
2313
+ #
2314
+ # @!attribute [rw] domain_id
2315
+ # The identifier of the domain that contains the watchlist.
2316
+ # @return [String]
2317
+ #
2318
+ # @!attribute [rw] name
2319
+ # The name for the watchlist.
2320
+ # @return [String]
2321
+ #
2322
+ # @!attribute [rw] updated_at
2323
+ # The timestamp of when the watchlist was updated.
2324
+ # @return [Time]
2325
+ #
2326
+ # @!attribute [rw] watchlist_id
2327
+ # The identifier of the watchlist.
2328
+ # @return [String]
2329
+ #
2330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/Watchlist AWS API Documentation
2331
+ #
2332
+ class Watchlist < Struct.new(
2333
+ :created_at,
2334
+ :default_watchlist,
2335
+ :description,
2336
+ :domain_id,
2337
+ :name,
2338
+ :updated_at,
2339
+ :watchlist_id)
2340
+ SENSITIVE = [:description, :name]
2341
+ include Aws::Structure
2342
+ end
2343
+
2344
+ # Details of the watchlists in a domain.
2345
+ #
2346
+ # @!attribute [rw] default_watchlist_id
2347
+ # The identifier of the default watchlist.
2348
+ # @return [String]
2349
+ #
2350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/WatchlistDetails AWS API Documentation
2351
+ #
2352
+ class WatchlistDetails < Struct.new(
2353
+ :default_watchlist_id)
2354
+ SENSITIVE = []
2355
+ include Aws::Structure
2356
+ end
2357
+
2358
+ # Contains a summary of information about a watchlist.
2359
+ #
2360
+ # @!attribute [rw] created_at
2361
+ # The timestamp of when the watchlist was created.
2362
+ # @return [Time]
2363
+ #
2364
+ # @!attribute [rw] default_watchlist
2365
+ # Whether the specified watchlist is the default watchlist of a
2366
+ # domain.
2367
+ # @return [Boolean]
2368
+ #
2369
+ # @!attribute [rw] description
2370
+ # The description of the watchlist.
2371
+ # @return [String]
2372
+ #
2373
+ # @!attribute [rw] domain_id
2374
+ # The identifier of the domain that contains the watchlist.
2375
+ # @return [String]
2376
+ #
2377
+ # @!attribute [rw] name
2378
+ # The name for the watchlist.
2379
+ # @return [String]
2380
+ #
2381
+ # @!attribute [rw] updated_at
2382
+ # The timestamp of when the watchlist was last updated.
2383
+ # @return [Time]
2384
+ #
2385
+ # @!attribute [rw] watchlist_id
2386
+ # The identifier of the watchlist.
2387
+ # @return [String]
2388
+ #
2389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/WatchlistSummary AWS API Documentation
2390
+ #
2391
+ class WatchlistSummary < Struct.new(
2392
+ :created_at,
2393
+ :default_watchlist,
2394
+ :description,
2395
+ :domain_id,
2396
+ :name,
2397
+ :updated_at,
2398
+ :watchlist_id)
2399
+ SENSITIVE = [:description, :name]
2400
+ include Aws::Structure
2401
+ end
2402
+
1905
2403
  end
1906
2404
  end