aws-sdk-voiceid 1.11.0 → 1.13.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-voiceid/client.rb +443 -30
- data/lib/aws-sdk-voiceid/client_api.rb +259 -1
- data/lib/aws-sdk-voiceid/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-voiceid/endpoints.rb +112 -0
- data/lib/aws-sdk-voiceid/plugins/endpoints.rb +16 -0
- data/lib/aws-sdk-voiceid/types.rb +582 -84
- data/lib/aws-sdk-voiceid.rb +2 -2
- metadata +4 -4
@@ -275,6 +275,11 @@ module Aws::VoiceID
|
|
275
275
|
# in the future.
|
276
276
|
#
|
277
277
|
#
|
278
|
+
# @option options [String] :sdk_ua_app_id
|
279
|
+
# A unique and opaque application ID that is appended to the
|
280
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
281
|
+
# maximum length of 50.
|
282
|
+
#
|
278
283
|
# @option options [String] :secret_access_key
|
279
284
|
#
|
280
285
|
# @option options [String] :session_token
|
@@ -378,18 +383,67 @@ module Aws::VoiceID
|
|
378
383
|
|
379
384
|
# @!group API Operations
|
380
385
|
|
386
|
+
# Associates the fraudsters with the watchlist specified in the same
|
387
|
+
# domain.
|
388
|
+
#
|
389
|
+
# @option params [required, String] :domain_id
|
390
|
+
# The identifier of the domain that contains the fraudster.
|
391
|
+
#
|
392
|
+
# @option params [required, String] :fraudster_id
|
393
|
+
# The identifier of the fraudster to be associated with the watchlist.
|
394
|
+
#
|
395
|
+
# @option params [required, String] :watchlist_id
|
396
|
+
# The identifier of the watchlist you want to associate with the
|
397
|
+
# fraudster.
|
398
|
+
#
|
399
|
+
# @return [Types::AssociateFraudsterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
400
|
+
#
|
401
|
+
# * {Types::AssociateFraudsterResponse#fraudster #fraudster} => Types::Fraudster
|
402
|
+
#
|
403
|
+
# @example Request syntax with placeholder values
|
404
|
+
#
|
405
|
+
# resp = client.associate_fraudster({
|
406
|
+
# domain_id: "DomainId", # required
|
407
|
+
# fraudster_id: "FraudsterId", # required
|
408
|
+
# watchlist_id: "WatchlistId", # required
|
409
|
+
# })
|
410
|
+
#
|
411
|
+
# @example Response structure
|
412
|
+
#
|
413
|
+
# resp.fraudster.created_at #=> Time
|
414
|
+
# resp.fraudster.domain_id #=> String
|
415
|
+
# resp.fraudster.generated_fraudster_id #=> String
|
416
|
+
# resp.fraudster.watchlist_ids #=> Array
|
417
|
+
# resp.fraudster.watchlist_ids[0] #=> String
|
418
|
+
#
|
419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/AssociateFraudster AWS API Documentation
|
420
|
+
#
|
421
|
+
# @overload associate_fraudster(params = {})
|
422
|
+
# @param [Hash] params ({})
|
423
|
+
def associate_fraudster(params = {}, options = {})
|
424
|
+
req = build_request(:associate_fraudster, params)
|
425
|
+
req.send_request(options)
|
426
|
+
end
|
427
|
+
|
381
428
|
# Creates a domain that contains all Amazon Connect Voice ID data, such
|
382
|
-
# as speakers, fraudsters, customer audio, and voiceprints.
|
429
|
+
# as speakers, fraudsters, customer audio, and voiceprints. Every domain
|
430
|
+
# is created with a default watchlist that fraudsters can be a part of.
|
383
431
|
#
|
384
432
|
# @option params [String] :client_token
|
385
|
-
#
|
386
|
-
#
|
433
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
434
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
435
|
+
# SDK populates this field. For more information about idempotency, see
|
436
|
+
# [Making retries safe with idempotent APIs][1].
|
387
437
|
#
|
388
438
|
# **A suitable default value is auto-generated.** You should normally
|
389
439
|
# not need to pass this option.**
|
390
440
|
#
|
441
|
+
#
|
442
|
+
#
|
443
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
444
|
+
#
|
391
445
|
# @option params [String] :description
|
392
|
-
# A brief description of
|
446
|
+
# A brief description of this domain.
|
393
447
|
#
|
394
448
|
# @option params [required, String] :name
|
395
449
|
# The name of the domain.
|
@@ -441,6 +495,7 @@ module Aws::VoiceID
|
|
441
495
|
# resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
|
442
496
|
# resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
443
497
|
# resp.domain.updated_at #=> Time
|
498
|
+
# resp.domain.watchlist_details.default_watchlist_id #=> String
|
444
499
|
#
|
445
500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain AWS API Documentation
|
446
501
|
#
|
@@ -451,6 +506,62 @@ module Aws::VoiceID
|
|
451
506
|
req.send_request(options)
|
452
507
|
end
|
453
508
|
|
509
|
+
# Creates a watchlist that fraudsters can be a part of.
|
510
|
+
#
|
511
|
+
# @option params [String] :client_token
|
512
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
513
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
514
|
+
# SDK populates this field. For more information about idempotency, see
|
515
|
+
# [Making retries safe with idempotent APIs][1].
|
516
|
+
#
|
517
|
+
# **A suitable default value is auto-generated.** You should normally
|
518
|
+
# not need to pass this option.**
|
519
|
+
#
|
520
|
+
#
|
521
|
+
#
|
522
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
523
|
+
#
|
524
|
+
# @option params [String] :description
|
525
|
+
# A brief description of this watchlist.
|
526
|
+
#
|
527
|
+
# @option params [required, String] :domain_id
|
528
|
+
# The identifier of the domain that contains the watchlist.
|
529
|
+
#
|
530
|
+
# @option params [required, String] :name
|
531
|
+
# The name of the watchlist.
|
532
|
+
#
|
533
|
+
# @return [Types::CreateWatchlistResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
534
|
+
#
|
535
|
+
# * {Types::CreateWatchlistResponse#watchlist #watchlist} => Types::Watchlist
|
536
|
+
#
|
537
|
+
# @example Request syntax with placeholder values
|
538
|
+
#
|
539
|
+
# resp = client.create_watchlist({
|
540
|
+
# client_token: "ClientTokenString",
|
541
|
+
# description: "WatchlistDescription",
|
542
|
+
# domain_id: "DomainId", # required
|
543
|
+
# name: "WatchlistName", # required
|
544
|
+
# })
|
545
|
+
#
|
546
|
+
# @example Response structure
|
547
|
+
#
|
548
|
+
# resp.watchlist.created_at #=> Time
|
549
|
+
# resp.watchlist.default_watchlist #=> Boolean
|
550
|
+
# resp.watchlist.description #=> String
|
551
|
+
# resp.watchlist.domain_id #=> String
|
552
|
+
# resp.watchlist.name #=> String
|
553
|
+
# resp.watchlist.updated_at #=> Time
|
554
|
+
# resp.watchlist.watchlist_id #=> String
|
555
|
+
#
|
556
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateWatchlist AWS API Documentation
|
557
|
+
#
|
558
|
+
# @overload create_watchlist(params = {})
|
559
|
+
# @param [Hash] params ({})
|
560
|
+
def create_watchlist(params = {}, options = {})
|
561
|
+
req = build_request(:create_watchlist, params)
|
562
|
+
req.send_request(options)
|
563
|
+
end
|
564
|
+
|
454
565
|
# Deletes the specified domain from Voice ID.
|
455
566
|
#
|
456
567
|
# @option params [required, String] :domain_id
|
@@ -473,10 +584,11 @@ module Aws::VoiceID
|
|
473
584
|
req.send_request(options)
|
474
585
|
end
|
475
586
|
|
476
|
-
# Deletes the specified fraudster from Voice ID.
|
587
|
+
# Deletes the specified fraudster from Voice ID. This action
|
588
|
+
# disassociates the fraudster from any watchlists it is a part of.
|
477
589
|
#
|
478
590
|
# @option params [required, String] :domain_id
|
479
|
-
# The identifier of the domain
|
591
|
+
# The identifier of the domain that contains the fraudster.
|
480
592
|
#
|
481
593
|
# @option params [required, String] :fraudster_id
|
482
594
|
# The identifier of the fraudster you want to delete.
|
@@ -502,7 +614,7 @@ module Aws::VoiceID
|
|
502
614
|
# Deletes the specified speaker from Voice ID.
|
503
615
|
#
|
504
616
|
# @option params [required, String] :domain_id
|
505
|
-
# The identifier of the domain
|
617
|
+
# The identifier of the domain that contains the speaker.
|
506
618
|
#
|
507
619
|
# @option params [required, String] :speaker_id
|
508
620
|
# The identifier of the speaker you want to delete.
|
@@ -525,10 +637,40 @@ module Aws::VoiceID
|
|
525
637
|
req.send_request(options)
|
526
638
|
end
|
527
639
|
|
640
|
+
# Deletes the specified watchlist from Voice ID. This API throws an
|
641
|
+
# exception when there are fraudsters in the watchlist that you are
|
642
|
+
# trying to delete. You must delete the fraudsters, and then delete the
|
643
|
+
# watchlist. Every domain has a default watchlist which cannot be
|
644
|
+
# deleted.
|
645
|
+
#
|
646
|
+
# @option params [required, String] :domain_id
|
647
|
+
# The identifier of the domain that contains the watchlist.
|
648
|
+
#
|
649
|
+
# @option params [required, String] :watchlist_id
|
650
|
+
# The identifier of the watchlist to be deleted.
|
651
|
+
#
|
652
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
653
|
+
#
|
654
|
+
# @example Request syntax with placeholder values
|
655
|
+
#
|
656
|
+
# resp = client.delete_watchlist({
|
657
|
+
# domain_id: "DomainId", # required
|
658
|
+
# watchlist_id: "WatchlistId", # required
|
659
|
+
# })
|
660
|
+
#
|
661
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteWatchlist AWS API Documentation
|
662
|
+
#
|
663
|
+
# @overload delete_watchlist(params = {})
|
664
|
+
# @param [Hash] params ({})
|
665
|
+
def delete_watchlist(params = {}, options = {})
|
666
|
+
req = build_request(:delete_watchlist, params)
|
667
|
+
req.send_request(options)
|
668
|
+
end
|
669
|
+
|
528
670
|
# Describes the specified domain.
|
529
671
|
#
|
530
672
|
# @option params [required, String] :domain_id
|
531
|
-
# The identifier of the domain you are describing.
|
673
|
+
# The identifier of the domain that you are describing.
|
532
674
|
#
|
533
675
|
# @return [Types::DescribeDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
534
676
|
#
|
@@ -553,6 +695,7 @@ module Aws::VoiceID
|
|
553
695
|
# resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
|
554
696
|
# resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
555
697
|
# resp.domain.updated_at #=> Time
|
698
|
+
# resp.domain.watchlist_details.default_watchlist_id #=> String
|
556
699
|
#
|
557
700
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain AWS API Documentation
|
558
701
|
#
|
@@ -566,7 +709,7 @@ module Aws::VoiceID
|
|
566
709
|
# Describes the specified fraudster.
|
567
710
|
#
|
568
711
|
# @option params [required, String] :domain_id
|
569
|
-
# The identifier of the domain
|
712
|
+
# The identifier of the domain that contains the fraudster.
|
570
713
|
#
|
571
714
|
# @option params [required, String] :fraudster_id
|
572
715
|
# The identifier of the fraudster you are describing.
|
@@ -587,6 +730,8 @@ module Aws::VoiceID
|
|
587
730
|
# resp.fraudster.created_at #=> Time
|
588
731
|
# resp.fraudster.domain_id #=> String
|
589
732
|
# resp.fraudster.generated_fraudster_id #=> String
|
733
|
+
# resp.fraudster.watchlist_ids #=> Array
|
734
|
+
# resp.fraudster.watchlist_ids[0] #=> String
|
590
735
|
#
|
591
736
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudster AWS API Documentation
|
592
737
|
#
|
@@ -600,11 +745,11 @@ module Aws::VoiceID
|
|
600
745
|
# Describes the specified fraudster registration job.
|
601
746
|
#
|
602
747
|
# @option params [required, String] :domain_id
|
603
|
-
# The identifier
|
748
|
+
# The identifier of the domain that contains the fraudster registration
|
604
749
|
# job.
|
605
750
|
#
|
606
751
|
# @option params [required, String] :job_id
|
607
|
-
# The identifier
|
752
|
+
# The identifier of the fraudster registration job you are describing.
|
608
753
|
#
|
609
754
|
# @return [Types::DescribeFraudsterRegistrationJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
610
755
|
#
|
@@ -634,6 +779,8 @@ module Aws::VoiceID
|
|
634
779
|
# resp.job.output_data_config.s3_uri #=> String
|
635
780
|
# resp.job.registration_config.duplicate_registration_action #=> String, one of "SKIP", "REGISTER_AS_NEW"
|
636
781
|
# resp.job.registration_config.fraudster_similarity_threshold #=> Integer
|
782
|
+
# resp.job.registration_config.watchlist_ids #=> Array
|
783
|
+
# resp.job.registration_config.watchlist_ids[0] #=> String
|
637
784
|
#
|
638
785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJob AWS API Documentation
|
639
786
|
#
|
@@ -685,7 +832,7 @@ module Aws::VoiceID
|
|
685
832
|
# Describes the specified speaker enrollment job.
|
686
833
|
#
|
687
834
|
# @option params [required, String] :domain_id
|
688
|
-
# The identifier of the domain
|
835
|
+
# The identifier of the domain that contains the speaker enrollment job.
|
689
836
|
#
|
690
837
|
# @option params [required, String] :job_id
|
691
838
|
# The identifier of the speaker enrollment job you are describing.
|
@@ -710,6 +857,8 @@ module Aws::VoiceID
|
|
710
857
|
# resp.job.enrollment_config.existing_enrollment_action #=> String, one of "SKIP", "OVERWRITE"
|
711
858
|
# resp.job.enrollment_config.fraud_detection_config.fraud_detection_action #=> String, one of "IGNORE", "FAIL"
|
712
859
|
# resp.job.enrollment_config.fraud_detection_config.risk_threshold #=> Integer
|
860
|
+
# resp.job.enrollment_config.fraud_detection_config.watchlist_ids #=> Array
|
861
|
+
# resp.job.enrollment_config.fraud_detection_config.watchlist_ids[0] #=> String
|
713
862
|
# resp.job.failure_details.message #=> String
|
714
863
|
# resp.job.failure_details.status_code #=> Integer
|
715
864
|
# resp.job.input_data_config.s3_uri #=> String
|
@@ -729,6 +878,89 @@ module Aws::VoiceID
|
|
729
878
|
req.send_request(options)
|
730
879
|
end
|
731
880
|
|
881
|
+
# Describes the specified watchlist.
|
882
|
+
#
|
883
|
+
# @option params [required, String] :domain_id
|
884
|
+
# The identifier of the domain that contains the watchlist.
|
885
|
+
#
|
886
|
+
# @option params [required, String] :watchlist_id
|
887
|
+
# The identifier of the watchlist that you are describing.
|
888
|
+
#
|
889
|
+
# @return [Types::DescribeWatchlistResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
890
|
+
#
|
891
|
+
# * {Types::DescribeWatchlistResponse#watchlist #watchlist} => Types::Watchlist
|
892
|
+
#
|
893
|
+
# @example Request syntax with placeholder values
|
894
|
+
#
|
895
|
+
# resp = client.describe_watchlist({
|
896
|
+
# domain_id: "DomainId", # required
|
897
|
+
# watchlist_id: "WatchlistId", # required
|
898
|
+
# })
|
899
|
+
#
|
900
|
+
# @example Response structure
|
901
|
+
#
|
902
|
+
# resp.watchlist.created_at #=> Time
|
903
|
+
# resp.watchlist.default_watchlist #=> Boolean
|
904
|
+
# resp.watchlist.description #=> String
|
905
|
+
# resp.watchlist.domain_id #=> String
|
906
|
+
# resp.watchlist.name #=> String
|
907
|
+
# resp.watchlist.updated_at #=> Time
|
908
|
+
# resp.watchlist.watchlist_id #=> String
|
909
|
+
#
|
910
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeWatchlist AWS API Documentation
|
911
|
+
#
|
912
|
+
# @overload describe_watchlist(params = {})
|
913
|
+
# @param [Hash] params ({})
|
914
|
+
def describe_watchlist(params = {}, options = {})
|
915
|
+
req = build_request(:describe_watchlist, params)
|
916
|
+
req.send_request(options)
|
917
|
+
end
|
918
|
+
|
919
|
+
# Disassociates the fraudsters from the watchlist specified. Voice ID
|
920
|
+
# always expects a fraudster to be a part of at least one watchlist. If
|
921
|
+
# you try to disassociate a fraudster from its only watchlist, a
|
922
|
+
# `ValidationException` is thrown.
|
923
|
+
#
|
924
|
+
# @option params [required, String] :domain_id
|
925
|
+
# The identifier of the domain that contains the fraudster.
|
926
|
+
#
|
927
|
+
# @option params [required, String] :fraudster_id
|
928
|
+
# The identifier of the fraudster to be disassociated from the
|
929
|
+
# watchlist.
|
930
|
+
#
|
931
|
+
# @option params [required, String] :watchlist_id
|
932
|
+
# The identifier of the watchlist that you want to disassociate from the
|
933
|
+
# fraudster.
|
934
|
+
#
|
935
|
+
# @return [Types::DisassociateFraudsterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
936
|
+
#
|
937
|
+
# * {Types::DisassociateFraudsterResponse#fraudster #fraudster} => Types::Fraudster
|
938
|
+
#
|
939
|
+
# @example Request syntax with placeholder values
|
940
|
+
#
|
941
|
+
# resp = client.disassociate_fraudster({
|
942
|
+
# domain_id: "DomainId", # required
|
943
|
+
# fraudster_id: "FraudsterId", # required
|
944
|
+
# watchlist_id: "WatchlistId", # required
|
945
|
+
# })
|
946
|
+
#
|
947
|
+
# @example Response structure
|
948
|
+
#
|
949
|
+
# resp.fraudster.created_at #=> Time
|
950
|
+
# resp.fraudster.domain_id #=> String
|
951
|
+
# resp.fraudster.generated_fraudster_id #=> String
|
952
|
+
# resp.fraudster.watchlist_ids #=> Array
|
953
|
+
# resp.fraudster.watchlist_ids[0] #=> String
|
954
|
+
#
|
955
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DisassociateFraudster AWS API Documentation
|
956
|
+
#
|
957
|
+
# @overload disassociate_fraudster(params = {})
|
958
|
+
# @param [Hash] params ({})
|
959
|
+
def disassociate_fraudster(params = {}, options = {})
|
960
|
+
req = build_request(:disassociate_fraudster, params)
|
961
|
+
req.send_request(options)
|
962
|
+
end
|
963
|
+
|
732
964
|
# Evaluates a specified session based on audio data accumulated during a
|
733
965
|
# streaming Amazon Connect Voice ID call.
|
734
966
|
#
|
@@ -769,6 +1001,7 @@ module Aws::VoiceID
|
|
769
1001
|
# resp.fraud_detection_result.audio_aggregation_ended_at #=> Time
|
770
1002
|
# resp.fraud_detection_result.audio_aggregation_started_at #=> Time
|
771
1003
|
# resp.fraud_detection_result.configuration.risk_threshold #=> Integer
|
1004
|
+
# resp.fraud_detection_result.configuration.watchlist_id #=> String
|
772
1005
|
# resp.fraud_detection_result.decision #=> String, one of "HIGH_RISK", "LOW_RISK", "NOT_ENOUGH_SPEECH"
|
773
1006
|
# resp.fraud_detection_result.fraud_detection_result_id #=> String
|
774
1007
|
# resp.fraud_detection_result.reasons #=> Array
|
@@ -792,7 +1025,9 @@ module Aws::VoiceID
|
|
792
1025
|
# Lists all the domains in the Amazon Web Services account.
|
793
1026
|
#
|
794
1027
|
# @option params [Integer] :max_results
|
795
|
-
# The maximum number of
|
1028
|
+
# The maximum number of results that are returned per call. You can use
|
1029
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1030
|
+
# maximum allowed page size is also 100.
|
796
1031
|
#
|
797
1032
|
# @option params [String] :next_token
|
798
1033
|
# If `NextToken` is returned, there are more results available. The
|
@@ -829,6 +1064,7 @@ module Aws::VoiceID
|
|
829
1064
|
# resp.domain_summaries[0].server_side_encryption_update_details.old_kms_key_id #=> String
|
830
1065
|
# resp.domain_summaries[0].server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
831
1066
|
# resp.domain_summaries[0].updated_at #=> Time
|
1067
|
+
# resp.domain_summaries[0].watchlist_details.default_watchlist_id #=> String
|
832
1068
|
# resp.next_token #=> String
|
833
1069
|
#
|
834
1070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListDomains AWS API Documentation
|
@@ -845,7 +1081,7 @@ module Aws::VoiceID
|
|
845
1081
|
# registration jobs in the given domain.
|
846
1082
|
#
|
847
1083
|
# @option params [required, String] :domain_id
|
848
|
-
# The identifier of the domain
|
1084
|
+
# The identifier of the domain that contains the fraudster registration
|
849
1085
|
# Jobs.
|
850
1086
|
#
|
851
1087
|
# @option params [String] :job_status
|
@@ -853,8 +1089,8 @@ module Aws::VoiceID
|
|
853
1089
|
#
|
854
1090
|
# @option params [Integer] :max_results
|
855
1091
|
# The maximum number of results that are returned per call. You can use
|
856
|
-
# `NextToken` to obtain
|
857
|
-
#
|
1092
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1093
|
+
# maximum allowed page size is also 100.
|
858
1094
|
#
|
859
1095
|
# @option params [String] :next_token
|
860
1096
|
# If `NextToken` is returned, there are more results available. The
|
@@ -902,20 +1138,78 @@ module Aws::VoiceID
|
|
902
1138
|
req.send_request(options)
|
903
1139
|
end
|
904
1140
|
|
1141
|
+
# Lists all fraudsters in a specified watchlist or domain.
|
1142
|
+
#
|
1143
|
+
# @option params [required, String] :domain_id
|
1144
|
+
# The identifier of the domain.
|
1145
|
+
#
|
1146
|
+
# @option params [Integer] :max_results
|
1147
|
+
# The maximum number of results that are returned per call. You can use
|
1148
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1149
|
+
# maximum allowed page size is also 100.
|
1150
|
+
#
|
1151
|
+
# @option params [String] :next_token
|
1152
|
+
# If `NextToken` is returned, there are more results available. The
|
1153
|
+
# value of `NextToken` is a unique pagination token for each page. Make
|
1154
|
+
# the call again using the returned token to retrieve the next page.
|
1155
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1156
|
+
# after 24 hours.
|
1157
|
+
#
|
1158
|
+
# @option params [String] :watchlist_id
|
1159
|
+
# The identifier of the watchlist. If provided, all fraudsters in the
|
1160
|
+
# watchlist are listed. If not provided, all fraudsters in the domain
|
1161
|
+
# are listed.
|
1162
|
+
#
|
1163
|
+
# @return [Types::ListFraudstersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1164
|
+
#
|
1165
|
+
# * {Types::ListFraudstersResponse#fraudster_summaries #fraudster_summaries} => Array<Types::FraudsterSummary>
|
1166
|
+
# * {Types::ListFraudstersResponse#next_token #next_token} => String
|
1167
|
+
#
|
1168
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1169
|
+
#
|
1170
|
+
# @example Request syntax with placeholder values
|
1171
|
+
#
|
1172
|
+
# resp = client.list_fraudsters({
|
1173
|
+
# domain_id: "DomainId", # required
|
1174
|
+
# max_results: 1,
|
1175
|
+
# next_token: "NextToken",
|
1176
|
+
# watchlist_id: "WatchlistId",
|
1177
|
+
# })
|
1178
|
+
#
|
1179
|
+
# @example Response structure
|
1180
|
+
#
|
1181
|
+
# resp.fraudster_summaries #=> Array
|
1182
|
+
# resp.fraudster_summaries[0].created_at #=> Time
|
1183
|
+
# resp.fraudster_summaries[0].domain_id #=> String
|
1184
|
+
# resp.fraudster_summaries[0].generated_fraudster_id #=> String
|
1185
|
+
# resp.fraudster_summaries[0].watchlist_ids #=> Array
|
1186
|
+
# resp.fraudster_summaries[0].watchlist_ids[0] #=> String
|
1187
|
+
# resp.next_token #=> String
|
1188
|
+
#
|
1189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsters AWS API Documentation
|
1190
|
+
#
|
1191
|
+
# @overload list_fraudsters(params = {})
|
1192
|
+
# @param [Hash] params ({})
|
1193
|
+
def list_fraudsters(params = {}, options = {})
|
1194
|
+
req = build_request(:list_fraudsters, params)
|
1195
|
+
req.send_request(options)
|
1196
|
+
end
|
1197
|
+
|
905
1198
|
# Lists all the speaker enrollment jobs in the domain with the specified
|
906
1199
|
# `JobStatus`. If `JobStatus` is not provided, this lists all jobs with
|
907
1200
|
# all possible speaker enrollment job statuses.
|
908
1201
|
#
|
909
1202
|
# @option params [required, String] :domain_id
|
910
|
-
# The identifier of the domain
|
1203
|
+
# The identifier of the domain that contains the speaker enrollment
|
1204
|
+
# jobs.
|
911
1205
|
#
|
912
1206
|
# @option params [String] :job_status
|
913
1207
|
# Provides the status of your speaker enrollment Job.
|
914
1208
|
#
|
915
1209
|
# @option params [Integer] :max_results
|
916
1210
|
# The maximum number of results that are returned per call. You can use
|
917
|
-
# `NextToken` to obtain
|
918
|
-
#
|
1211
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1212
|
+
# maximum allowed page size is also 100.
|
919
1213
|
#
|
920
1214
|
# @option params [String] :next_token
|
921
1215
|
# If `NextToken` is returned, there are more results available. The
|
@@ -970,8 +1264,8 @@ module Aws::VoiceID
|
|
970
1264
|
#
|
971
1265
|
# @option params [Integer] :max_results
|
972
1266
|
# The maximum number of results that are returned per call. You can use
|
973
|
-
# `NextToken` to obtain
|
974
|
-
#
|
1267
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1268
|
+
# maximum allowed page size is also 100.
|
975
1269
|
#
|
976
1270
|
# @option params [String] :next_token
|
977
1271
|
# If `NextToken` is returned, there are more results available. The
|
@@ -1047,6 +1341,59 @@ module Aws::VoiceID
|
|
1047
1341
|
req.send_request(options)
|
1048
1342
|
end
|
1049
1343
|
|
1344
|
+
# Lists all watchlists in a specified domain.
|
1345
|
+
#
|
1346
|
+
# @option params [required, String] :domain_id
|
1347
|
+
# The identifier of the domain.
|
1348
|
+
#
|
1349
|
+
# @option params [Integer] :max_results
|
1350
|
+
# The maximum number of results that are returned per call. You can use
|
1351
|
+
# `NextToken` to obtain more pages of results. The default is 100; the
|
1352
|
+
# maximum allowed page size is also 100.
|
1353
|
+
#
|
1354
|
+
# @option params [String] :next_token
|
1355
|
+
# If `NextToken` is returned, there are more results available. The
|
1356
|
+
# value of `NextToken` is a unique pagination token for each page. Make
|
1357
|
+
# the call again using the returned token to retrieve the next page.
|
1358
|
+
# Keep all other arguments unchanged. Each pagination token expires
|
1359
|
+
# after 24 hours.
|
1360
|
+
#
|
1361
|
+
# @return [Types::ListWatchlistsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1362
|
+
#
|
1363
|
+
# * {Types::ListWatchlistsResponse#next_token #next_token} => String
|
1364
|
+
# * {Types::ListWatchlistsResponse#watchlist_summaries #watchlist_summaries} => Array<Types::WatchlistSummary>
|
1365
|
+
#
|
1366
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1367
|
+
#
|
1368
|
+
# @example Request syntax with placeholder values
|
1369
|
+
#
|
1370
|
+
# resp = client.list_watchlists({
|
1371
|
+
# domain_id: "DomainId", # required
|
1372
|
+
# max_results: 1,
|
1373
|
+
# next_token: "NextToken",
|
1374
|
+
# })
|
1375
|
+
#
|
1376
|
+
# @example Response structure
|
1377
|
+
#
|
1378
|
+
# resp.next_token #=> String
|
1379
|
+
# resp.watchlist_summaries #=> Array
|
1380
|
+
# resp.watchlist_summaries[0].created_at #=> Time
|
1381
|
+
# resp.watchlist_summaries[0].default_watchlist #=> Boolean
|
1382
|
+
# resp.watchlist_summaries[0].description #=> String
|
1383
|
+
# resp.watchlist_summaries[0].domain_id #=> String
|
1384
|
+
# resp.watchlist_summaries[0].name #=> String
|
1385
|
+
# resp.watchlist_summaries[0].updated_at #=> Time
|
1386
|
+
# resp.watchlist_summaries[0].watchlist_id #=> String
|
1387
|
+
#
|
1388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListWatchlists AWS API Documentation
|
1389
|
+
#
|
1390
|
+
# @overload list_watchlists(params = {})
|
1391
|
+
# @param [Hash] params ({})
|
1392
|
+
def list_watchlists(params = {}, options = {})
|
1393
|
+
req = build_request(:list_watchlists, params)
|
1394
|
+
req.send_request(options)
|
1395
|
+
end
|
1396
|
+
|
1050
1397
|
# Opts out a speaker from Voice ID. A speaker can be opted out
|
1051
1398
|
# regardless of whether or not they already exist in Voice ID. If they
|
1052
1399
|
# don't yet exist, a new speaker is created in an opted out state. If
|
@@ -1056,7 +1403,7 @@ module Aws::VoiceID
|
|
1056
1403
|
# embeddings stored in Voice ID.
|
1057
1404
|
#
|
1058
1405
|
# @option params [required, String] :domain_id
|
1059
|
-
# The identifier of the domain
|
1406
|
+
# The identifier of the domain that contains the speaker.
|
1060
1407
|
#
|
1061
1408
|
# @option params [required, String] :speaker_id
|
1062
1409
|
# The identifier of the speaker you want opted-out.
|
@@ -1094,12 +1441,18 @@ module Aws::VoiceID
|
|
1094
1441
|
# Starts a new batch fraudster registration job using provided details.
|
1095
1442
|
#
|
1096
1443
|
# @option params [String] :client_token
|
1097
|
-
#
|
1098
|
-
# If not provided, Amazon Web Services
|
1444
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1445
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1446
|
+
# SDK populates this field. For more information about idempotency, see
|
1447
|
+
# [Making retries safe with idempotent APIs][1].
|
1099
1448
|
#
|
1100
1449
|
# **A suitable default value is auto-generated.** You should normally
|
1101
1450
|
# not need to pass this option.**
|
1102
1451
|
#
|
1452
|
+
#
|
1453
|
+
#
|
1454
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1455
|
+
#
|
1103
1456
|
# @option params [required, String] :data_access_role_arn
|
1104
1457
|
# The IAM role Amazon Resource Name (ARN) that grants Voice ID
|
1105
1458
|
# permissions to access customer's buckets to read the input manifest
|
@@ -1112,8 +1465,8 @@ module Aws::VoiceID
|
|
1112
1465
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html
|
1113
1466
|
#
|
1114
1467
|
# @option params [required, String] :domain_id
|
1115
|
-
# The identifier of the domain
|
1116
|
-
# and in which the fraudsters are registered.
|
1468
|
+
# The identifier of the domain that contains the fraudster registration
|
1469
|
+
# job and in which the fraudsters are registered.
|
1117
1470
|
#
|
1118
1471
|
# @option params [required, Types::InputDataConfig] :input_data_config
|
1119
1472
|
# The input data config containing an S3 URI for the input manifest file
|
@@ -1153,6 +1506,7 @@ module Aws::VoiceID
|
|
1153
1506
|
# registration_config: {
|
1154
1507
|
# duplicate_registration_action: "SKIP", # accepts SKIP, REGISTER_AS_NEW
|
1155
1508
|
# fraudster_similarity_threshold: 1,
|
1509
|
+
# watchlist_ids: ["WatchlistId"],
|
1156
1510
|
# },
|
1157
1511
|
# })
|
1158
1512
|
#
|
@@ -1173,6 +1527,8 @@ module Aws::VoiceID
|
|
1173
1527
|
# resp.job.output_data_config.s3_uri #=> String
|
1174
1528
|
# resp.job.registration_config.duplicate_registration_action #=> String, one of "SKIP", "REGISTER_AS_NEW"
|
1175
1529
|
# resp.job.registration_config.fraudster_similarity_threshold #=> Integer
|
1530
|
+
# resp.job.registration_config.watchlist_ids #=> Array
|
1531
|
+
# resp.job.registration_config.watchlist_ids[0] #=> String
|
1176
1532
|
#
|
1177
1533
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartFraudsterRegistrationJob AWS API Documentation
|
1178
1534
|
#
|
@@ -1186,12 +1542,18 @@ module Aws::VoiceID
|
|
1186
1542
|
# Starts a new batch speaker enrollment job using specified details.
|
1187
1543
|
#
|
1188
1544
|
# @option params [String] :client_token
|
1189
|
-
#
|
1190
|
-
# not provided, Amazon Web Services
|
1545
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1546
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1547
|
+
# SDK populates this field. For more information about idempotency, see
|
1548
|
+
# [Making retries safe with idempotent APIs][1].
|
1191
1549
|
#
|
1192
1550
|
# **A suitable default value is auto-generated.** You should normally
|
1193
1551
|
# not need to pass this option.**
|
1194
1552
|
#
|
1553
|
+
#
|
1554
|
+
#
|
1555
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1556
|
+
#
|
1195
1557
|
# @option params [required, String] :data_access_role_arn
|
1196
1558
|
# The IAM role Amazon Resource Name (ARN) that grants Voice ID
|
1197
1559
|
# permissions to access customer's buckets to read the input manifest
|
@@ -1239,6 +1601,7 @@ module Aws::VoiceID
|
|
1239
1601
|
# fraud_detection_config: {
|
1240
1602
|
# fraud_detection_action: "IGNORE", # accepts IGNORE, FAIL
|
1241
1603
|
# risk_threshold: 1,
|
1604
|
+
# watchlist_ids: ["WatchlistId"],
|
1242
1605
|
# },
|
1243
1606
|
# },
|
1244
1607
|
# input_data_config: { # required
|
@@ -1260,6 +1623,8 @@ module Aws::VoiceID
|
|
1260
1623
|
# resp.job.enrollment_config.existing_enrollment_action #=> String, one of "SKIP", "OVERWRITE"
|
1261
1624
|
# resp.job.enrollment_config.fraud_detection_config.fraud_detection_action #=> String, one of "IGNORE", "FAIL"
|
1262
1625
|
# resp.job.enrollment_config.fraud_detection_config.risk_threshold #=> Integer
|
1626
|
+
# resp.job.enrollment_config.fraud_detection_config.watchlist_ids #=> Array
|
1627
|
+
# resp.job.enrollment_config.fraud_detection_config.watchlist_ids[0] #=> String
|
1263
1628
|
# resp.job.failure_details.message #=> String
|
1264
1629
|
# resp.job.failure_details.status_code #=> Integer
|
1265
1630
|
# resp.job.input_data_config.s3_uri #=> String
|
@@ -1344,7 +1709,7 @@ module Aws::VoiceID
|
|
1344
1709
|
# 'Description' is not provided, it is removed from the domain.
|
1345
1710
|
#
|
1346
1711
|
# @option params [String] :description
|
1347
|
-
# A brief description
|
1712
|
+
# A brief description about this domain.
|
1348
1713
|
#
|
1349
1714
|
# @option params [required, String] :domain_id
|
1350
1715
|
# The identifier of the domain to be updated.
|
@@ -1389,6 +1754,7 @@ module Aws::VoiceID
|
|
1389
1754
|
# resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
|
1390
1755
|
# resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
1391
1756
|
# resp.domain.updated_at #=> Time
|
1757
|
+
# resp.domain.watchlist_details.default_watchlist_id #=> String
|
1392
1758
|
#
|
1393
1759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain AWS API Documentation
|
1394
1760
|
#
|
@@ -1399,6 +1765,53 @@ module Aws::VoiceID
|
|
1399
1765
|
req.send_request(options)
|
1400
1766
|
end
|
1401
1767
|
|
1768
|
+
# Updates the specified watchlist. Every domain has a default watchlist
|
1769
|
+
# which cannot be updated.
|
1770
|
+
#
|
1771
|
+
# @option params [String] :description
|
1772
|
+
# A brief description about this watchlist.
|
1773
|
+
#
|
1774
|
+
# @option params [required, String] :domain_id
|
1775
|
+
# The identifier of the domain that contains the watchlist.
|
1776
|
+
#
|
1777
|
+
# @option params [String] :name
|
1778
|
+
# The name of the watchlist.
|
1779
|
+
#
|
1780
|
+
# @option params [required, String] :watchlist_id
|
1781
|
+
# The identifier of the watchlist to be updated.
|
1782
|
+
#
|
1783
|
+
# @return [Types::UpdateWatchlistResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1784
|
+
#
|
1785
|
+
# * {Types::UpdateWatchlistResponse#watchlist #watchlist} => Types::Watchlist
|
1786
|
+
#
|
1787
|
+
# @example Request syntax with placeholder values
|
1788
|
+
#
|
1789
|
+
# resp = client.update_watchlist({
|
1790
|
+
# description: "WatchlistDescription",
|
1791
|
+
# domain_id: "DomainId", # required
|
1792
|
+
# name: "WatchlistName",
|
1793
|
+
# watchlist_id: "WatchlistId", # required
|
1794
|
+
# })
|
1795
|
+
#
|
1796
|
+
# @example Response structure
|
1797
|
+
#
|
1798
|
+
# resp.watchlist.created_at #=> Time
|
1799
|
+
# resp.watchlist.default_watchlist #=> Boolean
|
1800
|
+
# resp.watchlist.description #=> String
|
1801
|
+
# resp.watchlist.domain_id #=> String
|
1802
|
+
# resp.watchlist.name #=> String
|
1803
|
+
# resp.watchlist.updated_at #=> Time
|
1804
|
+
# resp.watchlist.watchlist_id #=> String
|
1805
|
+
#
|
1806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateWatchlist AWS API Documentation
|
1807
|
+
#
|
1808
|
+
# @overload update_watchlist(params = {})
|
1809
|
+
# @param [Hash] params ({})
|
1810
|
+
def update_watchlist(params = {}, options = {})
|
1811
|
+
req = build_request(:update_watchlist, params)
|
1812
|
+
req.send_request(options)
|
1813
|
+
end
|
1814
|
+
|
1402
1815
|
# @!endgroup
|
1403
1816
|
|
1404
1817
|
# @param params ({})
|
@@ -1412,7 +1825,7 @@ module Aws::VoiceID
|
|
1412
1825
|
params: params,
|
1413
1826
|
config: config)
|
1414
1827
|
context[:gem_name] = 'aws-sdk-voiceid'
|
1415
|
-
context[:gem_version] = '1.
|
1828
|
+
context[:gem_version] = '1.13.0'
|
1416
1829
|
Seahorse::Client::Request.new(handlers, context)
|
1417
1830
|
end
|
1418
1831
|
|