Class: Aws::VoiceID::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::VoiceID::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb
Overview
An API client for VoiceID. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::VoiceID::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_fraudster(params = {}) ⇒ Types::AssociateFraudsterResponse
Associates the fraudsters with the watchlist specified in the same domain.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
-
#create_watchlist(params = {}) ⇒ Types::CreateWatchlistResponse
Creates a watchlist that fraudsters can be a part of.
-
#delete_domain(params = {}) ⇒ Struct
Deletes the specified domain from Voice ID.
-
#delete_fraudster(params = {}) ⇒ Struct
Deletes the specified fraudster from Voice ID.
-
#delete_speaker(params = {}) ⇒ Struct
Deletes the specified speaker from Voice ID.
-
#delete_watchlist(params = {}) ⇒ Struct
Deletes the specified watchlist from Voice ID.
-
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
-
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
-
#describe_fraudster_registration_job(params = {}) ⇒ Types::DescribeFraudsterRegistrationJobResponse
Describes the specified fraudster registration job.
-
#describe_speaker(params = {}) ⇒ Types::DescribeSpeakerResponse
Describes the specified speaker.
-
#describe_speaker_enrollment_job(params = {}) ⇒ Types::DescribeSpeakerEnrollmentJobResponse
Describes the specified speaker enrollment job.
-
#describe_watchlist(params = {}) ⇒ Types::DescribeWatchlistResponse
Describes the specified watchlist.
-
#disassociate_fraudster(params = {}) ⇒ Types::DisassociateFraudsterResponse
Disassociates the fraudsters from the watchlist specified.
-
#evaluate_session(params = {}) ⇒ Types::EvaluateSessionResponse
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists all the domains in the Amazon Web Services account.
-
#list_fraudster_registration_jobs(params = {}) ⇒ Types::ListFraudsterRegistrationJobsResponse
Lists all the fraudster registration jobs in the domain with the given
JobStatus
. -
#list_fraudsters(params = {}) ⇒ Types::ListFraudstersResponse
Lists all fraudsters in a specified watchlist or domain.
-
#list_speaker_enrollment_jobs(params = {}) ⇒ Types::ListSpeakerEnrollmentJobsResponse
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus
. -
#list_speakers(params = {}) ⇒ Types::ListSpeakersResponse
Lists all speakers in a specified domain.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a specified Voice ID resource.
-
#list_watchlists(params = {}) ⇒ Types::ListWatchlistsResponse
Lists all watchlists in a specified domain.
-
#opt_out_speaker(params = {}) ⇒ Types::OptOutSpeakerResponse
Opts out a speaker from Voice ID.
-
#start_fraudster_registration_job(params = {}) ⇒ Types::StartFraudsterRegistrationJobResponse
Starts a new batch fraudster registration job using provided details.
-
#start_speaker_enrollment_job(params = {}) ⇒ Types::StartSpeakerEnrollmentJobResponse
Starts a new batch speaker enrollment job using specified details.
-
#tag_resource(params = {}) ⇒ Struct
Tags a Voice ID resource with the provided list of tags.
-
#untag_resource(params = {}) ⇒ Struct
Removes specified tags from a specified Amazon Connect Voice ID resource.
-
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
Updates the specified domain.
-
#update_watchlist(params = {}) ⇒ Types::UpdateWatchlistResponse
Updates the specified watchlist.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 395 def initialize(*args) super end |
Instance Method Details
#associate_fraudster(params = {}) ⇒ Types::AssociateFraudsterResponse
Associates the fraudsters with the watchlist specified in the same domain.
438 439 440 441 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 438 def associate_fraudster(params = {}, = {}) req = build_request(:associate_fraudster, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.
519 520 521 522 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 519 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_watchlist(params = {}) ⇒ Types::CreateWatchlistResponse
Creates a watchlist that fraudsters can be a part of.
575 576 577 578 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 575 def create_watchlist(params = {}, = {}) req = build_request(:create_watchlist, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Deletes the specified domain from Voice ID.
597 598 599 600 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 597 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_fraudster(params = {}) ⇒ Struct
Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
624 625 626 627 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 624 def delete_fraudster(params = {}, = {}) req = build_request(:delete_fraudster, params) req.send_request() end |
#delete_speaker(params = {}) ⇒ Struct
Deletes the specified speaker from Voice ID.
650 651 652 653 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 650 def delete_speaker(params = {}, = {}) req = build_request(:delete_speaker, params) req.send_request() end |
#delete_watchlist(params = {}) ⇒ Struct
Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.
680 681 682 683 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 680 def delete_watchlist(params = {}, = {}) req = build_request(:delete_watchlist, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
719 720 721 722 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 719 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
755 756 757 758 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 755 def describe_fraudster(params = {}, = {}) req = build_request(:describe_fraudster, params) req.send_request() end |
#describe_fraudster_registration_job(params = {}) ⇒ Types::DescribeFraudsterRegistrationJobResponse
Describes the specified fraudster registration job.
804 805 806 807 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 804 def describe_fraudster_registration_job(params = {}, = {}) req = build_request(:describe_fraudster_registration_job, params) req.send_request() end |
#describe_speaker(params = {}) ⇒ Types::DescribeSpeakerResponse
Describes the specified speaker.
842 843 844 845 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 842 def describe_speaker(params = {}, = {}) req = build_request(:describe_speaker, params) req.send_request() end |
#describe_speaker_enrollment_job(params = {}) ⇒ Types::DescribeSpeakerEnrollmentJobResponse
Describes the specified speaker enrollment job.
891 892 893 894 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 891 def describe_speaker_enrollment_job(params = {}, = {}) req = build_request(:describe_speaker_enrollment_job, params) req.send_request() end |
#describe_watchlist(params = {}) ⇒ Types::DescribeWatchlistResponse
Describes the specified watchlist.
929 930 931 932 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 929 def describe_watchlist(params = {}, = {}) req = build_request(:describe_watchlist, params) req.send_request() end |
#disassociate_fraudster(params = {}) ⇒ Types::DisassociateFraudsterResponse
Disassociates the fraudsters from the watchlist specified. Voice ID
always expects a fraudster to be a part of at least one watchlist. If
you try to disassociate a fraudster from its only watchlist, a
ValidationException
is thrown.
974 975 976 977 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 974 def disassociate_fraudster(params = {}, = {}) req = build_request(:disassociate_fraudster, params) req.send_request() end |
#evaluate_session(params = {}) ⇒ Types::EvaluateSessionResponse
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
1035 1036 1037 1038 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1035 def evaluate_session(params = {}, = {}) req = build_request(:evaluate_session, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
Lists all the domains in the Amazon Web Services account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1089 1090 1091 1092 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1089 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_fraudster_registration_jobs(params = {}) ⇒ Types::ListFraudsterRegistrationJobsResponse
Lists all the fraudster registration jobs in the domain with the given
JobStatus
. If JobStatus
is not provided, this lists all fraudster
registration jobs in the given domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1151 def list_fraudster_registration_jobs(params = {}, = {}) req = build_request(:list_fraudster_registration_jobs, params) req.send_request() end |
#list_fraudsters(params = {}) ⇒ Types::ListFraudstersResponse
Lists all fraudsters in a specified watchlist or domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1208 1209 1210 1211 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1208 def list_fraudsters(params = {}, = {}) req = build_request(:list_fraudsters, params) req.send_request() end |
#list_speaker_enrollment_jobs(params = {}) ⇒ Types::ListSpeakerEnrollmentJobsResponse
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus
. If JobStatus
is not provided, this lists all jobs with
all possible speaker enrollment job statuses.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1270 1271 1272 1273 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1270 def list_speaker_enrollment_jobs(params = {}, = {}) req = build_request(:list_speaker_enrollment_jobs, params) req.send_request() end |
#list_speakers(params = {}) ⇒ Types::ListSpeakersResponse
Lists all speakers in a specified domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1323 1324 1325 1326 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1323 def list_speakers(params = {}, = {}) req = build_request(:list_speakers, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists all tags associated with a specified Voice ID resource.
1354 1355 1356 1357 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1354 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_watchlists(params = {}) ⇒ Types::ListWatchlistsResponse
Lists all watchlists in a specified domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1407 1408 1409 1410 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1407 def list_watchlists(params = {}, = {}) req = build_request(:list_watchlists, params) req.send_request() end |
#opt_out_speaker(params = {}) ⇒ Types::OptOutSpeakerResponse
Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.
1451 1452 1453 1454 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1451 def opt_out_speaker(params = {}, = {}) req = build_request(:opt_out_speaker, params) req.send_request() end |
#start_fraudster_registration_job(params = {}) ⇒ Types::StartFraudsterRegistrationJobResponse
Starts a new batch fraudster registration job using provided details.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1552 def start_fraudster_registration_job(params = {}, = {}) req = build_request(:start_fraudster_registration_job, params) req.send_request() end |
#start_speaker_enrollment_job(params = {}) ⇒ Types::StartSpeakerEnrollmentJobResponse
Starts a new batch speaker enrollment job using specified details.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1657 def start_speaker_enrollment_job(params = {}, = {}) req = build_request(:start_speaker_enrollment_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Tags a Voice ID resource with the provided list of tags.
1689 1690 1691 1692 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1689 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes specified tags from a specified Amazon Connect Voice ID resource.
1717 1718 1719 1720 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1717 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_domain(params = {}) ⇒ Types::UpdateDomainResponse
Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1778 def update_domain(params = {}, = {}) req = build_request(:update_domain, params) req.send_request() end |
#update_watchlist(params = {}) ⇒ Types::UpdateWatchlistResponse
Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
1825 1826 1827 1828 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1825 def update_watchlist(params = {}, = {}) req = build_request(:update_watchlist, params) req.send_request() end |