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
-
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
-
#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.
-
#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.
-
#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_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.
-
#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.
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.
375 376 377 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#create_domain(params = {}) ⇒ Types::CreateDomainResponse
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
449 450 451 452 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 449 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Struct
Deletes the specified domain from Voice ID.
471 472 473 474 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 471 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.
497 498 499 500 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 497 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.
523 524 525 526 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 523 def delete_speaker(params = {}, = {}) req = build_request(:delete_speaker, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
561 562 563 564 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 561 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
595 596 597 598 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 595 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.
642 643 644 645 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 642 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.
680 681 682 683 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 680 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.
727 728 729 730 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 727 def describe_speaker_enrollment_job(params = {}, = {}) req = build_request(:describe_speaker_enrollment_job, 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.
787 788 789 790 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 787 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.
838 839 840 841 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 838 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.
900 901 902 903 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 900 def list_fraudster_registration_jobs(params = {}, = {}) req = build_request(:list_fraudster_registration_jobs, 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.
961 962 963 964 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 961 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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1014 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.
1045 1046 1047 1048 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1045 def (params = {}, = {}) req = build_request(:list_tags_for_resource, 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.
1089 1090 1091 1092 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1089 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.
1181 1182 1183 1184 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1181 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.
1277 1278 1279 1280 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1277 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1309 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.
1337 1338 1339 1340 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1337 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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1397 def update_domain(params = {}, = {}) req = build_request(:update_domain, params) req.send_request() end |