@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonVoiceIDAsync extends AmazonVoiceID
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonVoiceIDAsync
instead.
Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
ENDPOINT_PREFIX
createDomain, deleteDomain, deleteFraudster, deleteSpeaker, describeDomain, describeFraudster, describeFraudsterRegistrationJob, describeSpeaker, describeSpeakerEnrollmentJob, evaluateSession, getCachedResponseMetadata, listDomains, listFraudsterRegistrationJobs, listSpeakerEnrollmentJobs, listSpeakers, listTagsForResource, optOutSpeaker, shutdown, startFraudsterRegistrationJob, startSpeakerEnrollmentJob, tagResource, untagResource, updateDomain
Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
createDomainRequest
- Future<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest, AsyncHandler<CreateDomainRequest,CreateDomainResult> asyncHandler)
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
createDomainRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain from the Amazon Connect Voice ID system.
deleteDomainRequest
- Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
Deletes the specified domain from the Amazon Connect Voice ID system.
deleteDomainRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteFraudsterResult> deleteFraudsterAsync(DeleteFraudsterRequest deleteFraudsterRequest)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
deleteFraudsterRequest
- Future<DeleteFraudsterResult> deleteFraudsterAsync(DeleteFraudsterRequest deleteFraudsterRequest, AsyncHandler<DeleteFraudsterRequest,DeleteFraudsterResult> asyncHandler)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
deleteFraudsterRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteSpeakerResult> deleteSpeakerAsync(DeleteSpeakerRequest deleteSpeakerRequest)
Deletes the specified speaker from the Amazon Connect Voice ID system.
deleteSpeakerRequest
- Future<DeleteSpeakerResult> deleteSpeakerAsync(DeleteSpeakerRequest deleteSpeakerRequest, AsyncHandler<DeleteSpeakerRequest,DeleteSpeakerResult> asyncHandler)
Deletes the specified speaker from the Amazon Connect Voice ID system.
deleteSpeakerRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeDomainResult> describeDomainAsync(DescribeDomainRequest describeDomainRequest)
Describes the specified domain.
describeDomainRequest
- Future<DescribeDomainResult> describeDomainAsync(DescribeDomainRequest describeDomainRequest, AsyncHandler<DescribeDomainRequest,DescribeDomainResult> asyncHandler)
Describes the specified domain.
describeDomainRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFraudsterResult> describeFraudsterAsync(DescribeFraudsterRequest describeFraudsterRequest)
Describes the specified fraudster.
describeFraudsterRequest
- Future<DescribeFraudsterResult> describeFraudsterAsync(DescribeFraudsterRequest describeFraudsterRequest, AsyncHandler<DescribeFraudsterRequest,DescribeFraudsterResult> asyncHandler)
Describes the specified fraudster.
describeFraudsterRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeFraudsterRegistrationJobResult> describeFraudsterRegistrationJobAsync(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest)
Describes the specified fraudster registration job.
describeFraudsterRegistrationJobRequest
- Future<DescribeFraudsterRegistrationJobResult> describeFraudsterRegistrationJobAsync(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest, AsyncHandler<DescribeFraudsterRegistrationJobRequest,DescribeFraudsterRegistrationJobResult> asyncHandler)
Describes the specified fraudster registration job.
describeFraudsterRegistrationJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeSpeakerResult> describeSpeakerAsync(DescribeSpeakerRequest describeSpeakerRequest)
Describes the specified speaker.
describeSpeakerRequest
- Future<DescribeSpeakerResult> describeSpeakerAsync(DescribeSpeakerRequest describeSpeakerRequest, AsyncHandler<DescribeSpeakerRequest,DescribeSpeakerResult> asyncHandler)
Describes the specified speaker.
describeSpeakerRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeSpeakerEnrollmentJobResult> describeSpeakerEnrollmentJobAsync(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest)
Describes the specified speaker enrollment job.
describeSpeakerEnrollmentJobRequest
- Future<DescribeSpeakerEnrollmentJobResult> describeSpeakerEnrollmentJobAsync(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest, AsyncHandler<DescribeSpeakerEnrollmentJobRequest,DescribeSpeakerEnrollmentJobResult> asyncHandler)
Describes the specified speaker enrollment job.
describeSpeakerEnrollmentJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<EvaluateSessionResult> evaluateSessionAsync(EvaluateSessionRequest evaluateSessionRequest)
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
evaluateSessionRequest
- Future<EvaluateSessionResult> evaluateSessionAsync(EvaluateSessionRequest evaluateSessionRequest, AsyncHandler<EvaluateSessionRequest,EvaluateSessionResult> asyncHandler)
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
evaluateSessionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest)
Lists all the domains in the Amazon Web Services account.
listDomainsRequest
- Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest listDomainsRequest, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)
Lists all the domains in the Amazon Web Services account.
listDomainsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListFraudsterRegistrationJobsResult> listFraudsterRegistrationJobsAsync(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest)
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.
listFraudsterRegistrationJobsRequest
- Future<ListFraudsterRegistrationJobsResult> listFraudsterRegistrationJobsAsync(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest, AsyncHandler<ListFraudsterRegistrationJobsRequest,ListFraudsterRegistrationJobsResult> asyncHandler)
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.
listFraudsterRegistrationJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSpeakerEnrollmentJobsResult> listSpeakerEnrollmentJobsAsync(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest)
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.
listSpeakerEnrollmentJobsRequest
- Future<ListSpeakerEnrollmentJobsResult> listSpeakerEnrollmentJobsAsync(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest, AsyncHandler<ListSpeakerEnrollmentJobsRequest,ListSpeakerEnrollmentJobsResult> asyncHandler)
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.
listSpeakerEnrollmentJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListSpeakersResult> listSpeakersAsync(ListSpeakersRequest listSpeakersRequest)
Lists all speakers in a specified domain.
listSpeakersRequest
- Future<ListSpeakersResult> listSpeakersAsync(ListSpeakersRequest listSpeakersRequest, AsyncHandler<ListSpeakersRequest,ListSpeakersResult> asyncHandler)
Lists all speakers in a specified domain.
listSpeakersRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a specified Voice ID resource.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags associated with a specified Voice ID resource.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<OptOutSpeakerResult> optOutSpeakerAsync(OptOutSpeakerRequest optOutSpeakerRequest)
Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. 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 the system.
optOutSpeakerRequest
- Future<OptOutSpeakerResult> optOutSpeakerAsync(OptOutSpeakerRequest optOutSpeakerRequest, AsyncHandler<OptOutSpeakerRequest,OptOutSpeakerResult> asyncHandler)
Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. 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 the system.
optOutSpeakerRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartFraudsterRegistrationJobResult> startFraudsterRegistrationJobAsync(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest)
Starts a new batch fraudster registration job using provided details.
startFraudsterRegistrationJobRequest
- Future<StartFraudsterRegistrationJobResult> startFraudsterRegistrationJobAsync(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest, AsyncHandler<StartFraudsterRegistrationJobRequest,StartFraudsterRegistrationJobResult> asyncHandler)
Starts a new batch fraudster registration job using provided details.
startFraudsterRegistrationJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartSpeakerEnrollmentJobResult> startSpeakerEnrollmentJobAsync(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest)
Starts a new batch speaker enrollment job using specified details.
startSpeakerEnrollmentJobRequest
- Future<StartSpeakerEnrollmentJobResult> startSpeakerEnrollmentJobAsync(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest, AsyncHandler<StartSpeakerEnrollmentJobRequest,StartSpeakerEnrollmentJobResult> asyncHandler)
Starts a new batch speaker enrollment job using specified details.
startSpeakerEnrollmentJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Tags an Amazon Connect Voice ID resource with the provided list of tags.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags an Amazon Connect Voice ID resource with the provided list of tags.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes specified tags from a specified Amazon Connect Voice ID resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes specified tags from a specified Amazon Connect Voice ID resource.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest updateDomainRequest)
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.
updateDomainRequest
- Future<UpdateDomainResult> updateDomainAsync(UpdateDomainRequest updateDomainRequest, AsyncHandler<UpdateDomainRequest,UpdateDomainResult> asyncHandler)
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.
updateDomainRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.