@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 risk detection, which make voice interactions in contact centers more secure and efficient.
ENDPOINT_PREFIXassociateFraudster, createDomain, createWatchlist, deleteDomain, deleteFraudster, deleteSpeaker, deleteWatchlist, describeDomain, describeFraudster, describeFraudsterRegistrationJob, describeSpeaker, describeSpeakerEnrollmentJob, describeWatchlist, disassociateFraudster, evaluateSession, getCachedResponseMetadata, listDomains, listFraudsterRegistrationJobs, listFraudsters, listSpeakerEnrollmentJobs, listSpeakers, listTagsForResource, listWatchlists, optOutSpeaker, shutdown, startFraudsterRegistrationJob, startSpeakerEnrollmentJob, tagResource, untagResource, updateDomain, updateWatchlistFuture<AssociateFraudsterResult> associateFraudsterAsync(AssociateFraudsterRequest associateFraudsterRequest)
Associates the fraudsters with the watchlist specified in the same domain.
associateFraudsterRequest - Future<AssociateFraudsterResult> associateFraudsterAsync(AssociateFraudsterRequest associateFraudsterRequest, AsyncHandler<AssociateFraudsterRequest,AssociateFraudsterResult> asyncHandler)
Associates the fraudsters with the watchlist specified in the same domain.
associateFraudsterRequest - 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<CreateDomainResult> createDomainAsync(CreateDomainRequest createDomainRequest)
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.
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. Every domain is created with a default watchlist that fraudsters can be a part of.
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<CreateWatchlistResult> createWatchlistAsync(CreateWatchlistRequest createWatchlistRequest)
Creates a watchlist that fraudsters can be a part of.
createWatchlistRequest - Future<CreateWatchlistResult> createWatchlistAsync(CreateWatchlistRequest createWatchlistRequest, AsyncHandler<CreateWatchlistRequest,CreateWatchlistResult> asyncHandler)
Creates a watchlist that fraudsters can be a part of.
createWatchlistRequest - 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 Voice ID.
deleteDomainRequest - Future<DeleteDomainResult> deleteDomainAsync(DeleteDomainRequest deleteDomainRequest, AsyncHandler<DeleteDomainRequest,DeleteDomainResult> asyncHandler)
Deletes the specified domain from Voice ID.
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 Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
deleteFraudsterRequest - Future<DeleteFraudsterResult> deleteFraudsterAsync(DeleteFraudsterRequest deleteFraudsterRequest, AsyncHandler<DeleteFraudsterRequest,DeleteFraudsterResult> asyncHandler)
Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
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 Voice ID.
deleteSpeakerRequest - Future<DeleteSpeakerResult> deleteSpeakerAsync(DeleteSpeakerRequest deleteSpeakerRequest, AsyncHandler<DeleteSpeakerRequest,DeleteSpeakerResult> asyncHandler)
Deletes the specified speaker from Voice ID.
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<DeleteWatchlistResult> deleteWatchlistAsync(DeleteWatchlistRequest deleteWatchlistRequest)
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.
deleteWatchlistRequest - Future<DeleteWatchlistResult> deleteWatchlistAsync(DeleteWatchlistRequest deleteWatchlistRequest, AsyncHandler<DeleteWatchlistRequest,DeleteWatchlistResult> asyncHandler)
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.
deleteWatchlistRequest - 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<DescribeWatchlistResult> describeWatchlistAsync(DescribeWatchlistRequest describeWatchlistRequest)
Describes the specified watchlist.
describeWatchlistRequest - Future<DescribeWatchlistResult> describeWatchlistAsync(DescribeWatchlistRequest describeWatchlistRequest, AsyncHandler<DescribeWatchlistRequest,DescribeWatchlistResult> asyncHandler)
Describes the specified watchlist.
describeWatchlistRequest - 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<DisassociateFraudsterResult> disassociateFraudsterAsync(DisassociateFraudsterRequest disassociateFraudsterRequest)
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.
disassociateFraudsterRequest - Future<DisassociateFraudsterResult> disassociateFraudsterAsync(DisassociateFraudsterRequest disassociateFraudsterRequest, AsyncHandler<DisassociateFraudsterRequest,DisassociateFraudsterResult> asyncHandler)
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.
disassociateFraudsterRequest - 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<ListFraudstersResult> listFraudstersAsync(ListFraudstersRequest listFraudstersRequest)
Lists all fraudsters in a specified watchlist or domain.
listFraudstersRequest - Future<ListFraudstersResult> listFraudstersAsync(ListFraudstersRequest listFraudstersRequest, AsyncHandler<ListFraudstersRequest,ListFraudstersResult> asyncHandler)
Lists all fraudsters in a specified watchlist or domain.
listFraudstersRequest - 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<ListWatchlistsResult> listWatchlistsAsync(ListWatchlistsRequest listWatchlistsRequest)
Lists all watchlists in a specified domain.
listWatchlistsRequest - Future<ListWatchlistsResult> listWatchlistsAsync(ListWatchlistsRequest listWatchlistsRequest, AsyncHandler<ListWatchlistsRequest,ListWatchlistsResult> asyncHandler)
Lists all watchlists in a specified domain.
listWatchlistsRequest - 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. 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.
optOutSpeakerRequest - Future<OptOutSpeakerResult> optOutSpeakerAsync(OptOutSpeakerRequest optOutSpeakerRequest, AsyncHandler<OptOutSpeakerRequest,OptOutSpeakerResult> asyncHandler)
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.
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 a Voice ID resource with the provided list of tags.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Tags a 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.Future<UpdateWatchlistResult> updateWatchlistAsync(UpdateWatchlistRequest updateWatchlistRequest)
Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
updateWatchlistRequest - Future<UpdateWatchlistResult> updateWatchlistAsync(UpdateWatchlistRequest updateWatchlistRequest, AsyncHandler<UpdateWatchlistRequest,UpdateWatchlistResult> asyncHandler)
Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
updateWatchlistRequest - 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.