/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.voiceid; import javax.annotation.Generated; import com.amazonaws.services.voiceid.model.*; /** * Interface for accessing Amazon Voice ID asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.voiceid.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. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonVoiceIDAsync extends AmazonVoiceID { /** ** Associates the fraudsters with the watchlist specified in the same domain. *
* * @param associateFraudsterRequest * @return A Java Future containing the result of the AssociateFraudster operation returned by the service. * @sample AmazonVoiceIDAsync.AssociateFraudster * @see AWS * API Documentation */ java.util.concurrent.Future* Associates the fraudsters with the watchlist specified in the same domain. *
* * @param associateFraudsterRequest * @param 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. * @return A Java Future containing the result of the AssociateFraudster operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.AssociateFraudster * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param createDomainRequest * @return A Java Future containing the result of the CreateDomain operation returned by the service. * @sample AmazonVoiceIDAsync.CreateDomain * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param createDomainRequest * @param 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. * @return A Java Future containing the result of the CreateDomain operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.CreateDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a watchlist that fraudsters can be a part of. *
* * @param createWatchlistRequest * @return A Java Future containing the result of the CreateWatchlist operation returned by the service. * @sample AmazonVoiceIDAsync.CreateWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a watchlist that fraudsters can be a part of. *
* * @param createWatchlistRequest * @param 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. * @return A Java Future containing the result of the CreateWatchlist operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.CreateWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified domain from Voice ID. *
* * @param deleteDomainRequest * @return A Java Future containing the result of the DeleteDomain operation returned by the service. * @sample AmazonVoiceIDAsync.DeleteDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified domain from Voice ID. *
* * @param deleteDomainRequest * @param 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. * @return A Java Future containing the result of the DeleteDomain operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DeleteDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is * a part of. *
* * @param deleteFraudsterRequest * @return A Java Future containing the result of the DeleteFraudster operation returned by the service. * @sample AmazonVoiceIDAsync.DeleteFraudster * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is * a part of. *
* * @param deleteFraudsterRequest * @param 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. * @return A Java Future containing the result of the DeleteFraudster operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DeleteFraudster * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified speaker from Voice ID. *
* * @param deleteSpeakerRequest * @return A Java Future containing the result of the DeleteSpeaker operation returned by the service. * @sample AmazonVoiceIDAsync.DeleteSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes the specified speaker from Voice ID. *
* * @param deleteSpeakerRequest * @param 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. * @return A Java Future containing the result of the DeleteSpeaker operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DeleteSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteWatchlistRequest * @return A Java Future containing the result of the DeleteWatchlist operation returned by the service. * @sample AmazonVoiceIDAsync.DeleteWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param deleteWatchlistRequest * @param 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. * @return A Java Future containing the result of the DeleteWatchlist operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DeleteWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified domain. *
* * @param describeDomainRequest * @return A Java Future containing the result of the DescribeDomain operation returned by the service. * @sample AmazonVoiceIDAsync.DescribeDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified domain. *
* * @param describeDomainRequest * @param 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. * @return A Java Future containing the result of the DescribeDomain operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DescribeDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified fraudster. *
* * @param describeFraudsterRequest * @return A Java Future containing the result of the DescribeFraudster operation returned by the service. * @sample AmazonVoiceIDAsync.DescribeFraudster * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified fraudster. *
* * @param describeFraudsterRequest * @param 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. * @return A Java Future containing the result of the DescribeFraudster operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DescribeFraudster * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified fraudster registration job. *
* * @param describeFraudsterRegistrationJobRequest * @return A Java Future containing the result of the DescribeFraudsterRegistrationJob operation returned by the * service. * @sample AmazonVoiceIDAsync.DescribeFraudsterRegistrationJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the specified fraudster registration job. *
* * @param describeFraudsterRegistrationJobRequest * @param 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. * @return A Java Future containing the result of the DescribeFraudsterRegistrationJob operation returned by the * service. * @sample AmazonVoiceIDAsyncHandler.DescribeFraudsterRegistrationJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the specified speaker. *
* * @param describeSpeakerRequest * @return A Java Future containing the result of the DescribeSpeaker operation returned by the service. * @sample AmazonVoiceIDAsync.DescribeSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified speaker. *
* * @param describeSpeakerRequest * @param 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. * @return A Java Future containing the result of the DescribeSpeaker operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DescribeSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified speaker enrollment job. *
* * @param describeSpeakerEnrollmentJobRequest * @return A Java Future containing the result of the DescribeSpeakerEnrollmentJob operation returned by the * service. * @sample AmazonVoiceIDAsync.DescribeSpeakerEnrollmentJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the specified speaker enrollment job. *
* * @param describeSpeakerEnrollmentJobRequest * @param 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. * @return A Java Future containing the result of the DescribeSpeakerEnrollmentJob operation returned by the * service. * @sample AmazonVoiceIDAsyncHandler.DescribeSpeakerEnrollmentJob * @see AWS API Documentation */ java.util.concurrent.Future* Describes the specified watchlist. *
* * @param describeWatchlistRequest * @return A Java Future containing the result of the DescribeWatchlist operation returned by the service. * @sample AmazonVoiceIDAsync.DescribeWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* Describes the specified watchlist. *
* * @param describeWatchlistRequest * @param 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. * @return A Java Future containing the result of the DescribeWatchlist operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.DescribeWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call. *
* * @param evaluateSessionRequest * @return A Java Future containing the result of the EvaluateSession operation returned by the service. * @sample AmazonVoiceIDAsync.EvaluateSession * @see AWS API * Documentation */ java.util.concurrent.Future* Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call. *
* * @param evaluateSessionRequest * @param 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. * @return A Java Future containing the result of the EvaluateSession operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.EvaluateSession * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all the domains in the Amazon Web Services account. *
* * @param listDomainsRequest * @return A Java Future containing the result of the ListDomains operation returned by the service. * @sample AmazonVoiceIDAsync.ListDomains * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all the domains in the Amazon Web Services account. *
* * @param listDomainsRequest * @param 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. * @return A Java Future containing the result of the ListDomains operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.ListDomains * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Lists all fraudsters in a specified watchlist or domain. *
* * @param listFraudstersRequest * @return A Java Future containing the result of the ListFraudsters operation returned by the service. * @sample AmazonVoiceIDAsync.ListFraudsters * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all fraudsters in a specified watchlist or domain. *
* * @param listFraudstersRequest * @param 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. * @return A Java Future containing the result of the ListFraudsters operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.ListFraudsters * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Lists all speakers in a specified domain. *
* * @param listSpeakersRequest * @return A Java Future containing the result of the ListSpeakers operation returned by the service. * @sample AmazonVoiceIDAsync.ListSpeakers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all speakers in a specified domain. *
* * @param listSpeakersRequest * @param 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. * @return A Java Future containing the result of the ListSpeakers operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.ListSpeakers * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all tags associated with a specified Voice ID resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonVoiceIDAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Lists all tags associated with a specified Voice ID resource. *
* * @param listTagsForResourceRequest * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Lists all watchlists in a specified domain. *
* * @param listWatchlistsRequest * @return A Java Future containing the result of the ListWatchlists operation returned by the service. * @sample AmazonVoiceIDAsync.ListWatchlists * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all watchlists in a specified domain. *
* * @param listWatchlistsRequest * @param 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. * @return A Java Future containing the result of the ListWatchlists operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.ListWatchlists * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param optOutSpeakerRequest * @return A Java Future containing the result of the OptOutSpeaker operation returned by the service. * @sample AmazonVoiceIDAsync.OptOutSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param optOutSpeakerRequest * @param 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. * @return A Java Future containing the result of the OptOutSpeaker operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.OptOutSpeaker * @see AWS API * Documentation */ java.util.concurrent.Future* Starts a new batch fraudster registration job using provided details. *
* * @param startFraudsterRegistrationJobRequest * @return A Java Future containing the result of the StartFraudsterRegistrationJob operation returned by the * service. * @sample AmazonVoiceIDAsync.StartFraudsterRegistrationJob * @see AWS API Documentation */ java.util.concurrent.Future* Starts a new batch fraudster registration job using provided details. *
* * @param startFraudsterRegistrationJobRequest * @param 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. * @return A Java Future containing the result of the StartFraudsterRegistrationJob operation returned by the * service. * @sample AmazonVoiceIDAsyncHandler.StartFraudsterRegistrationJob * @see AWS API Documentation */ java.util.concurrent.Future* Starts a new batch speaker enrollment job using specified details. *
* * @param startSpeakerEnrollmentJobRequest * @return A Java Future containing the result of the StartSpeakerEnrollmentJob operation returned by the service. * @sample AmazonVoiceIDAsync.StartSpeakerEnrollmentJob * @see AWS API Documentation */ java.util.concurrent.Future* Starts a new batch speaker enrollment job using specified details. *
* * @param startSpeakerEnrollmentJobRequest * @param 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. * @return A Java Future containing the result of the StartSpeakerEnrollmentJob operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.StartSpeakerEnrollmentJob * @see AWS API Documentation */ java.util.concurrent.Future* Tags a Voice ID resource with the provided list of tags. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonVoiceIDAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Tags a Voice ID resource with the provided list of tags. *
* * @param tagResourceRequest * @param 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. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes specified tags from a specified Amazon Connect Voice ID resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonVoiceIDAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes specified tags from a specified Amazon Connect Voice ID resource. *
* * @param untagResourceRequest * @param 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. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param updateDomainRequest * @return A Java Future containing the result of the UpdateDomain operation returned by the service. * @sample AmazonVoiceIDAsync.UpdateDomain * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param updateDomainRequest * @param 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. * @return A Java Future containing the result of the UpdateDomain operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.UpdateDomain * @see AWS API * Documentation */ java.util.concurrent.Future* Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. *
* * @param updateWatchlistRequest * @return A Java Future containing the result of the UpdateWatchlist operation returned by the service. * @sample AmazonVoiceIDAsync.UpdateWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future* Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. *
* * @param updateWatchlistRequest * @param 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. * @return A Java Future containing the result of the UpdateWatchlist operation returned by the service. * @sample AmazonVoiceIDAsyncHandler.UpdateWatchlist * @see AWS API * Documentation */ java.util.concurrent.Future