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.
358 359 360 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 358 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.
432 433 434 435 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 432 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.
454 455 456 457 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 454 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.
480 481 482 483 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 480 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.
506 507 508 509 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 506 def delete_speaker(params = {}, = {}) req = build_request(:delete_speaker, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse
Describes the specified domain.
544 545 546 547 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 544 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse
Describes the specified fraudster.
578 579 580 581 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 578 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.
625 626 627 628 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 625 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.
663 664 665 666 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 663 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.
710 711 712 713 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 710 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.
769 770 771 772 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 769 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.
822 823 824 825 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 822 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.
884 885 886 887 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 884 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.
945 946 947 948 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 945 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.
998 999 1000 1001 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 998 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.
1029 1030 1031 1032 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1029 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.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1073 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.
1165 1166 1167 1168 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1165 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.
1261 1262 1263 1264 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1261 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.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1293 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.
1321 1322 1323 1324 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1321 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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1379 def update_domain(params = {}, = {}) req = build_request(:update_domain, params) req.send_request() end |