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.
447 448 449 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 447 def initialize(*args) super end |
Instance Method Details
#associate_fraudster(params = {}) ⇒ Types::AssociateFraudsterResponse
Associates the fraudsters with the watchlist specified in the same domain.
490 491 492 493 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 490 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.
571 572 573 574 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 571 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.
627 628 629 630 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 627 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.
649 650 651 652 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 649 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.
676 677 678 679 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 676 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.
702 703 704 705 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 702 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.
732 733 734 735 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 732 def delete_watchlist(params = {}, = {}) req = build_request(:delete_watchlist, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
771 772 773 774 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 771 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
807 808 809 810 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 807 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.
856 857 858 859 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 856 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.
894 895 896 897 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 894 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.
943 944 945 946 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 943 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.
981 982 983 984 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 981 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.
1026 1027 1028 1029 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1026 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.
1087 1088 1089 1090 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1087 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.
1141 1142 1143 1144 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1141 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.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1203 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.
1260 1261 1262 1263 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1260 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.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1322 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.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1375 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.
1406 1407 1408 1409 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1406 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1459 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1503 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.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1604 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.
1709 1710 1711 1712 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1709 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.
1741 1742 1743 1744 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1741 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.
1769 1770 1771 1772 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1769 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1830 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.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1877 def update_watchlist(params = {}, = {}) req = build_request(:update_watchlist, params) req.send_request() end |