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.
419 420 421 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#associate_fraudster(params = {}) ⇒ Types::AssociateFraudsterResponse
Associates the fraudsters with the watchlist specified in the same domain.
462 463 464 465 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 462 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.
543 544 545 546 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 543 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.
599 600 601 602 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 599 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.
621 622 623 624 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 621 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.
648 649 650 651 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 648 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.
674 675 676 677 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 674 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.
704 705 706 707 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 704 def delete_watchlist(params = {}, = {}) req = build_request(:delete_watchlist, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
743 744 745 746 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 743 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
779 780 781 782 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 779 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.
828 829 830 831 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 828 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.
866 867 868 869 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 866 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.
915 916 917 918 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 915 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.
953 954 955 956 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 953 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.
998 999 1000 1001 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 998 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.
1059 1060 1061 1062 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1059 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1113 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1175 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.
1232 1233 1234 1235 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1232 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.
1294 1295 1296 1297 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1294 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.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1347 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.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1378 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.
1431 1432 1433 1434 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1431 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1475 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.
1576 1577 1578 1579 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1576 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.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1681 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.
1713 1714 1715 1716 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1713 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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1741 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.
1802 1803 1804 1805 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1802 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.
1849 1850 1851 1852 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1849 def update_watchlist(params = {}, = {}) req = build_request(:update_watchlist, params) req.send_request() end |