Interface VoiceIdAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateFraudster
(Consumer<AssociateFraudsterRequest.Builder> associateFraudsterRequest) Associates the fraudsters with the watchlist specified in the same domain.associateFraudster
(AssociateFraudsterRequest associateFraudsterRequest) Associates the fraudsters with the watchlist specified in the same domain.static VoiceIdAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aVoiceIdAsyncClient
.static VoiceIdAsyncClient
create()
Create aVoiceIdAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateDomainResponse> createDomain
(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.default CompletableFuture
<CreateDomainResponse> createDomain
(CreateDomainRequest createDomainRequest) Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.default CompletableFuture
<CreateWatchlistResponse> createWatchlist
(Consumer<CreateWatchlistRequest.Builder> createWatchlistRequest) Creates a watchlist that fraudsters can be a part of.default CompletableFuture
<CreateWatchlistResponse> createWatchlist
(CreateWatchlistRequest createWatchlistRequest) Creates a watchlist that fraudsters can be a part of.default CompletableFuture
<DeleteDomainResponse> deleteDomain
(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes the specified domain from Voice ID.default CompletableFuture
<DeleteDomainResponse> deleteDomain
(DeleteDomainRequest deleteDomainRequest) Deletes the specified domain from Voice ID.default CompletableFuture
<DeleteFraudsterResponse> deleteFraudster
(Consumer<DeleteFraudsterRequest.Builder> deleteFraudsterRequest) Deletes the specified fraudster from Voice ID.default CompletableFuture
<DeleteFraudsterResponse> deleteFraudster
(DeleteFraudsterRequest deleteFraudsterRequest) Deletes the specified fraudster from Voice ID.default CompletableFuture
<DeleteSpeakerResponse> deleteSpeaker
(Consumer<DeleteSpeakerRequest.Builder> deleteSpeakerRequest) Deletes the specified speaker from Voice ID.default CompletableFuture
<DeleteSpeakerResponse> deleteSpeaker
(DeleteSpeakerRequest deleteSpeakerRequest) Deletes the specified speaker from Voice ID.default CompletableFuture
<DeleteWatchlistResponse> deleteWatchlist
(Consumer<DeleteWatchlistRequest.Builder> deleteWatchlistRequest) Deletes the specified watchlist from Voice ID.default CompletableFuture
<DeleteWatchlistResponse> deleteWatchlist
(DeleteWatchlistRequest deleteWatchlistRequest) Deletes the specified watchlist from Voice ID.default CompletableFuture
<DescribeDomainResponse> describeDomain
(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) Describes the specified domain.default CompletableFuture
<DescribeDomainResponse> describeDomain
(DescribeDomainRequest describeDomainRequest) Describes the specified domain.describeFraudster
(Consumer<DescribeFraudsterRequest.Builder> describeFraudsterRequest) Describes the specified fraudster.describeFraudster
(DescribeFraudsterRequest describeFraudsterRequest) Describes the specified fraudster.describeFraudsterRegistrationJob
(Consumer<DescribeFraudsterRegistrationJobRequest.Builder> describeFraudsterRegistrationJobRequest) Describes the specified fraudster registration job.describeFraudsterRegistrationJob
(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest) Describes the specified fraudster registration job.default CompletableFuture
<DescribeSpeakerResponse> describeSpeaker
(Consumer<DescribeSpeakerRequest.Builder> describeSpeakerRequest) Describes the specified speaker.default CompletableFuture
<DescribeSpeakerResponse> describeSpeaker
(DescribeSpeakerRequest describeSpeakerRequest) Describes the specified speaker.describeSpeakerEnrollmentJob
(Consumer<DescribeSpeakerEnrollmentJobRequest.Builder> describeSpeakerEnrollmentJobRequest) Describes the specified speaker enrollment job.describeSpeakerEnrollmentJob
(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest) Describes the specified speaker enrollment job.describeWatchlist
(Consumer<DescribeWatchlistRequest.Builder> describeWatchlistRequest) Describes the specified watchlist.describeWatchlist
(DescribeWatchlistRequest describeWatchlistRequest) Describes the specified watchlist.disassociateFraudster
(Consumer<DisassociateFraudsterRequest.Builder> disassociateFraudsterRequest) Disassociates the fraudsters from the watchlist specified.disassociateFraudster
(DisassociateFraudsterRequest disassociateFraudsterRequest) Disassociates the fraudsters from the watchlist specified.default CompletableFuture
<EvaluateSessionResponse> evaluateSession
(Consumer<EvaluateSessionRequest.Builder> evaluateSessionRequest) Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.default CompletableFuture
<EvaluateSessionResponse> evaluateSession
(EvaluateSessionRequest evaluateSessionRequest) Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.default CompletableFuture
<ListDomainsResponse> listDomains
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Lists all the domains in the Amazon Web Services account.default CompletableFuture
<ListDomainsResponse> listDomains
(ListDomainsRequest listDomainsRequest) Lists all the domains in the Amazon Web Services account.default ListDomainsPublisher
listDomainsPaginator
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation.default ListDomainsPublisher
listDomainsPaginator
(ListDomainsRequest listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation.listFraudsterRegistrationJobs
(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) Lists all the fraudster registration jobs in the domain with the givenJobStatus
.listFraudsterRegistrationJobs
(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) Lists all the fraudster registration jobs in the domain with the givenJobStatus
.listFraudsterRegistrationJobsPaginator
(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) This is a variant oflistFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation.listFraudsterRegistrationJobsPaginator
(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) This is a variant oflistFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation.default CompletableFuture
<ListFraudstersResponse> listFraudsters
(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) Lists all fraudsters in a specified watchlist or domain.default CompletableFuture
<ListFraudstersResponse> listFraudsters
(ListFraudstersRequest listFraudstersRequest) Lists all fraudsters in a specified watchlist or domain.default ListFraudstersPublisher
listFraudstersPaginator
(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) This is a variant oflistFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation.default ListFraudstersPublisher
listFraudstersPaginator
(ListFraudstersRequest listFraudstersRequest) This is a variant oflistFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation.listSpeakerEnrollmentJobs
(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) Lists all the speaker enrollment jobs in the domain with the specifiedJobStatus
.listSpeakerEnrollmentJobs
(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) Lists all the speaker enrollment jobs in the domain with the specifiedJobStatus
.listSpeakerEnrollmentJobsPaginator
(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) This is a variant oflistSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation.listSpeakerEnrollmentJobsPaginator
(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) This is a variant oflistSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation.default CompletableFuture
<ListSpeakersResponse> listSpeakers
(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) Lists all speakers in a specified domain.default CompletableFuture
<ListSpeakersResponse> listSpeakers
(ListSpeakersRequest listSpeakersRequest) Lists all speakers in a specified domain.default ListSpeakersPublisher
listSpeakersPaginator
(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) This is a variant oflistSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation.default ListSpeakersPublisher
listSpeakersPaginator
(ListSpeakersRequest listSpeakersRequest) This is a variant oflistSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags associated with a specified Voice ID resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a specified Voice ID resource.default CompletableFuture
<ListWatchlistsResponse> listWatchlists
(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) Lists all watchlists in a specified domain.default CompletableFuture
<ListWatchlistsResponse> listWatchlists
(ListWatchlistsRequest listWatchlistsRequest) Lists all watchlists in a specified domain.default ListWatchlistsPublisher
listWatchlistsPaginator
(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) This is a variant oflistWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation.default ListWatchlistsPublisher
listWatchlistsPaginator
(ListWatchlistsRequest listWatchlistsRequest) This is a variant oflistWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation.default CompletableFuture
<OptOutSpeakerResponse> optOutSpeaker
(Consumer<OptOutSpeakerRequest.Builder> optOutSpeakerRequest) Opts out a speaker from Voice ID.default CompletableFuture
<OptOutSpeakerResponse> optOutSpeaker
(OptOutSpeakerRequest optOutSpeakerRequest) Opts out a speaker from Voice ID.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartFraudsterRegistrationJob
(Consumer<StartFraudsterRegistrationJobRequest.Builder> startFraudsterRegistrationJobRequest) Starts a new batch fraudster registration job using provided details.startFraudsterRegistrationJob
(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest) Starts a new batch fraudster registration job using provided details.startSpeakerEnrollmentJob
(Consumer<StartSpeakerEnrollmentJobRequest.Builder> startSpeakerEnrollmentJobRequest) Starts a new batch speaker enrollment job using specified details.startSpeakerEnrollmentJob
(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest) Starts a new batch speaker enrollment job using specified details.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a Voice ID resource with the provided list of tags.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Tags a Voice ID resource with the provided list of tags.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes specified tags from a specified Amazon Connect Voice ID resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes specified tags from a specified Amazon Connect Voice ID resource.default CompletableFuture
<UpdateDomainResponse> updateDomain
(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) Updates the specified domain.default CompletableFuture
<UpdateDomainResponse> updateDomain
(UpdateDomainRequest updateDomainRequest) Updates the specified domain.default CompletableFuture
<UpdateWatchlistResponse> updateWatchlist
(Consumer<UpdateWatchlistRequest.Builder> updateWatchlistRequest) Updates the specified watchlist.default CompletableFuture
<UpdateWatchlistResponse> updateWatchlist
(UpdateWatchlistRequest updateWatchlistRequest) Updates the specified watchlist.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateFraudster
default CompletableFuture<AssociateFraudsterResponse> associateFraudster(AssociateFraudsterRequest associateFraudsterRequest) Associates the fraudsters with the watchlist specified in the same domain.
- Parameters:
associateFraudsterRequest
-- Returns:
- A Java Future containing the result of the AssociateFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateFraudster
default CompletableFuture<AssociateFraudsterResponse> associateFraudster(Consumer<AssociateFraudsterRequest.Builder> associateFraudsterRequest) Associates the fraudsters with the watchlist specified in the same domain.
This is a convenience which creates an instance of the
AssociateFraudsterRequest.Builder
avoiding the need to create one manually viaAssociateFraudsterRequest.builder()
- Parameters:
associateFraudsterRequest
- AConsumer
that will call methods onAssociateFraudsterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the AssociateFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(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.
- Parameters:
createDomainRequest
-- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateDomainRequest.Builder
avoiding the need to create one manually viaCreateDomainRequest.builder()
- Parameters:
createDomainRequest
- AConsumer
that will call methods onCreateDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWatchlist
default CompletableFuture<CreateWatchlistResponse> createWatchlist(CreateWatchlistRequest createWatchlistRequest) Creates a watchlist that fraudsters can be a part of.
- Parameters:
createWatchlistRequest
-- Returns:
- A Java Future containing the result of the CreateWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createWatchlist
default CompletableFuture<CreateWatchlistResponse> createWatchlist(Consumer<CreateWatchlistRequest.Builder> createWatchlistRequest) Creates a watchlist that fraudsters can be a part of.
This is a convenience which creates an instance of the
CreateWatchlistRequest.Builder
avoiding the need to create one manually viaCreateWatchlistRequest.builder()
- Parameters:
createWatchlistRequest
- AConsumer
that will call methods onCreateWatchlistRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes the specified domain from Voice ID.
- Parameters:
deleteDomainRequest
-- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes the specified domain from Voice ID.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builder
avoiding the need to create one manually viaDeleteDomainRequest.builder()
- Parameters:
deleteDomainRequest
- AConsumer
that will call methods onDeleteDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteFraudster
default CompletableFuture<DeleteFraudsterResponse> deleteFraudster(DeleteFraudsterRequest deleteFraudsterRequest) Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
- Parameters:
deleteFraudsterRequest
-- Returns:
- A Java Future containing the result of the DeleteFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteFraudster
default CompletableFuture<DeleteFraudsterResponse> deleteFraudster(Consumer<DeleteFraudsterRequest.Builder> deleteFraudsterRequest) Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
This is a convenience which creates an instance of the
DeleteFraudsterRequest.Builder
avoiding the need to create one manually viaDeleteFraudsterRequest.builder()
- Parameters:
deleteFraudsterRequest
- AConsumer
that will call methods onDeleteFraudsterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteSpeaker
default CompletableFuture<DeleteSpeakerResponse> deleteSpeaker(DeleteSpeakerRequest deleteSpeakerRequest) Deletes the specified speaker from Voice ID.
- Parameters:
deleteSpeakerRequest
-- Returns:
- A Java Future containing the result of the DeleteSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteSpeaker
default CompletableFuture<DeleteSpeakerResponse> deleteSpeaker(Consumer<DeleteSpeakerRequest.Builder> deleteSpeakerRequest) Deletes the specified speaker from Voice ID.
This is a convenience which creates an instance of the
DeleteSpeakerRequest.Builder
avoiding the need to create one manually viaDeleteSpeakerRequest.builder()
- Parameters:
deleteSpeakerRequest
- AConsumer
that will call methods onDeleteSpeakerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteWatchlist
default CompletableFuture<DeleteWatchlistResponse> deleteWatchlist(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.
- Parameters:
deleteWatchlistRequest
-- Returns:
- A Java Future containing the result of the DeleteWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
deleteWatchlist
default CompletableFuture<DeleteWatchlistResponse> deleteWatchlist(Consumer<DeleteWatchlistRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteWatchlistRequest.Builder
avoiding the need to create one manually viaDeleteWatchlistRequest.builder()
- Parameters:
deleteWatchlistRequest
- AConsumer
that will call methods onDeleteWatchlistRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeDomain
default CompletableFuture<DescribeDomainResponse> describeDomain(DescribeDomainRequest describeDomainRequest) Describes the specified domain.
- Parameters:
describeDomainRequest
-- Returns:
- A Java Future containing the result of the DescribeDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeDomain
default CompletableFuture<DescribeDomainResponse> describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) Describes the specified domain.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builder
avoiding the need to create one manually viaDescribeDomainRequest.builder()
- Parameters:
describeDomainRequest
- AConsumer
that will call methods onDescribeDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeFraudster
default CompletableFuture<DescribeFraudsterResponse> describeFraudster(DescribeFraudsterRequest describeFraudsterRequest) Describes the specified fraudster.
- Parameters:
describeFraudsterRequest
-- Returns:
- A Java Future containing the result of the DescribeFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeFraudster
default CompletableFuture<DescribeFraudsterResponse> describeFraudster(Consumer<DescribeFraudsterRequest.Builder> describeFraudsterRequest) Describes the specified fraudster.
This is a convenience which creates an instance of the
DescribeFraudsterRequest.Builder
avoiding the need to create one manually viaDescribeFraudsterRequest.builder()
- Parameters:
describeFraudsterRequest
- AConsumer
that will call methods onDescribeFraudsterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeFraudsterRegistrationJob
default CompletableFuture<DescribeFraudsterRegistrationJobResponse> describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest) Describes the specified fraudster registration job.
- Parameters:
describeFraudsterRegistrationJobRequest
-- Returns:
- A Java Future containing the result of the DescribeFraudsterRegistrationJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeFraudsterRegistrationJob
default CompletableFuture<DescribeFraudsterRegistrationJobResponse> describeFraudsterRegistrationJob(Consumer<DescribeFraudsterRegistrationJobRequest.Builder> describeFraudsterRegistrationJobRequest) Describes the specified fraudster registration job.
This is a convenience which creates an instance of the
DescribeFraudsterRegistrationJobRequest.Builder
avoiding the need to create one manually viaDescribeFraudsterRegistrationJobRequest.builder()
- Parameters:
describeFraudsterRegistrationJobRequest
- AConsumer
that will call methods onDescribeFraudsterRegistrationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeFraudsterRegistrationJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeSpeaker
default CompletableFuture<DescribeSpeakerResponse> describeSpeaker(DescribeSpeakerRequest describeSpeakerRequest) Describes the specified speaker.
- Parameters:
describeSpeakerRequest
-- Returns:
- A Java Future containing the result of the DescribeSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeSpeaker
default CompletableFuture<DescribeSpeakerResponse> describeSpeaker(Consumer<DescribeSpeakerRequest.Builder> describeSpeakerRequest) Describes the specified speaker.
This is a convenience which creates an instance of the
DescribeSpeakerRequest.Builder
avoiding the need to create one manually viaDescribeSpeakerRequest.builder()
- Parameters:
describeSpeakerRequest
- AConsumer
that will call methods onDescribeSpeakerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeSpeakerEnrollmentJob
default CompletableFuture<DescribeSpeakerEnrollmentJobResponse> describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest) Describes the specified speaker enrollment job.
- Parameters:
describeSpeakerEnrollmentJobRequest
-- Returns:
- A Java Future containing the result of the DescribeSpeakerEnrollmentJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeSpeakerEnrollmentJob
default CompletableFuture<DescribeSpeakerEnrollmentJobResponse> describeSpeakerEnrollmentJob(Consumer<DescribeSpeakerEnrollmentJobRequest.Builder> describeSpeakerEnrollmentJobRequest) Describes the specified speaker enrollment job.
This is a convenience which creates an instance of the
DescribeSpeakerEnrollmentJobRequest.Builder
avoiding the need to create one manually viaDescribeSpeakerEnrollmentJobRequest.builder()
- Parameters:
describeSpeakerEnrollmentJobRequest
- AConsumer
that will call methods onDescribeSpeakerEnrollmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeSpeakerEnrollmentJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeWatchlist
default CompletableFuture<DescribeWatchlistResponse> describeWatchlist(DescribeWatchlistRequest describeWatchlistRequest) Describes the specified watchlist.
- Parameters:
describeWatchlistRequest
-- Returns:
- A Java Future containing the result of the DescribeWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
describeWatchlist
default CompletableFuture<DescribeWatchlistResponse> describeWatchlist(Consumer<DescribeWatchlistRequest.Builder> describeWatchlistRequest) Describes the specified watchlist.
This is a convenience which creates an instance of the
DescribeWatchlistRequest.Builder
avoiding the need to create one manually viaDescribeWatchlistRequest.builder()
- Parameters:
describeWatchlistRequest
- AConsumer
that will call methods onDescribeWatchlistRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
disassociateFraudster
default CompletableFuture<DisassociateFraudsterResponse> disassociateFraudster(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.- Parameters:
disassociateFraudsterRequest
-- Returns:
- A Java Future containing the result of the DisassociateFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
disassociateFraudster
default CompletableFuture<DisassociateFraudsterResponse> disassociateFraudster(Consumer<DisassociateFraudsterRequest.Builder> 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.
This is a convenience which creates an instance of the
DisassociateFraudsterRequest.Builder
avoiding the need to create one manually viaDisassociateFraudsterRequest.builder()
- Parameters:
disassociateFraudsterRequest
- AConsumer
that will call methods onDisassociateFraudsterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DisassociateFraudster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
evaluateSession
default CompletableFuture<EvaluateSessionResponse> evaluateSession(EvaluateSessionRequest evaluateSessionRequest) Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
- Parameters:
evaluateSessionRequest
-- Returns:
- A Java Future containing the result of the EvaluateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
evaluateSession
default CompletableFuture<EvaluateSessionResponse> evaluateSession(Consumer<EvaluateSessionRequest.Builder> evaluateSessionRequest) Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
This is a convenience which creates an instance of the
EvaluateSessionRequest.Builder
avoiding the need to create one manually viaEvaluateSessionRequest.builder()
- Parameters:
evaluateSessionRequest
- AConsumer
that will call methods onEvaluateSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the EvaluateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listDomains
Lists all the domains in the Amazon Web Services account.
- Parameters:
listDomainsRequest
-- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Lists all the domains in the Amazon Web Services account.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDomains operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
This is a variant of
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListDomainsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation.- Parameters:
listDomainsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant of
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListDomainsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)
operation.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listFraudsterRegistrationJobs
default CompletableFuture<ListFraudsterRegistrationJobsResponse> listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) Lists all the fraudster registration jobs in the domain with the given
JobStatus
. IfJobStatus
is not provided, this lists all fraudster registration jobs in the given domain.- Parameters:
listFraudsterRegistrationJobsRequest
-- Returns:
- A Java Future containing the result of the ListFraudsterRegistrationJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudsterRegistrationJobs
default CompletableFuture<ListFraudsterRegistrationJobsResponse> listFraudsterRegistrationJobs(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) Lists all the fraudster registration jobs in the domain with the given
JobStatus
. IfJobStatus
is not provided, this lists all fraudster registration jobs in the given domain.
This is a convenience which creates an instance of the
ListFraudsterRegistrationJobsRequest.Builder
avoiding the need to create one manually viaListFraudsterRegistrationJobsRequest.builder()
- Parameters:
listFraudsterRegistrationJobsRequest
- AConsumer
that will call methods onListFraudsterRegistrationJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListFraudsterRegistrationJobs operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudsterRegistrationJobsPaginator
default ListFraudsterRegistrationJobsPublisher listFraudsterRegistrationJobsPaginator(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) This is a variant of
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsPublisher publisher = client.listFraudsterRegistrationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsPublisher publisher = client.listFraudsterRegistrationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation.- Parameters:
listFraudsterRegistrationJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudsterRegistrationJobsPaginator
default ListFraudsterRegistrationJobsPublisher listFraudsterRegistrationJobsPaginator(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) This is a variant of
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsPublisher publisher = client.listFraudsterRegistrationJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsPublisher publisher = client.listFraudsterRegistrationJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)
operation.
This is a convenience which creates an instance of the
ListFraudsterRegistrationJobsRequest.Builder
avoiding the need to create one manually viaListFraudsterRegistrationJobsRequest.builder()
- Parameters:
listFraudsterRegistrationJobsRequest
- AConsumer
that will call methods onListFraudsterRegistrationJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudsters
default CompletableFuture<ListFraudstersResponse> listFraudsters(ListFraudstersRequest listFraudstersRequest) Lists all fraudsters in a specified watchlist or domain.
- Parameters:
listFraudstersRequest
-- Returns:
- A Java Future containing the result of the ListFraudsters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudsters
default CompletableFuture<ListFraudstersResponse> listFraudsters(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) Lists all fraudsters in a specified watchlist or domain.
This is a convenience which creates an instance of the
ListFraudstersRequest.Builder
avoiding the need to create one manually viaListFraudstersRequest.builder()
- Parameters:
listFraudstersRequest
- AConsumer
that will call methods onListFraudstersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListFraudsters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudstersPaginator
default ListFraudstersPublisher listFraudstersPaginator(ListFraudstersRequest listFraudstersRequest) This is a variant of
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersPublisher publisher = client.listFraudstersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListFraudstersPublisher publisher = client.listFraudstersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation.- Parameters:
listFraudstersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listFraudstersPaginator
default ListFraudstersPublisher listFraudstersPaginator(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) This is a variant of
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersPublisher publisher = client.listFraudstersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListFraudstersPublisher publisher = client.listFraudstersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)
operation.
This is a convenience which creates an instance of the
ListFraudstersRequest.Builder
avoiding the need to create one manually viaListFraudstersRequest.builder()
- Parameters:
listFraudstersRequest
- AConsumer
that will call methods onListFraudstersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakerEnrollmentJobs
default CompletableFuture<ListSpeakerEnrollmentJobsResponse> listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) Lists all the speaker enrollment jobs in the domain with the specified
JobStatus
. IfJobStatus
is not provided, this lists all jobs with all possible speaker enrollment job statuses.- Parameters:
listSpeakerEnrollmentJobsRequest
-- Returns:
- A Java Future containing the result of the ListSpeakerEnrollmentJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakerEnrollmentJobs
default CompletableFuture<ListSpeakerEnrollmentJobsResponse> listSpeakerEnrollmentJobs(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) Lists all the speaker enrollment jobs in the domain with the specified
JobStatus
. IfJobStatus
is not provided, this lists all jobs with all possible speaker enrollment job statuses.
This is a convenience which creates an instance of the
ListSpeakerEnrollmentJobsRequest.Builder
avoiding the need to create one manually viaListSpeakerEnrollmentJobsRequest.builder()
- Parameters:
listSpeakerEnrollmentJobsRequest
- AConsumer
that will call methods onListSpeakerEnrollmentJobsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSpeakerEnrollmentJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakerEnrollmentJobsPaginator
default ListSpeakerEnrollmentJobsPublisher listSpeakerEnrollmentJobsPaginator(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) This is a variant of
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsPublisher publisher = client.listSpeakerEnrollmentJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsPublisher publisher = client.listSpeakerEnrollmentJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation.- Parameters:
listSpeakerEnrollmentJobsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakerEnrollmentJobsPaginator
default ListSpeakerEnrollmentJobsPublisher listSpeakerEnrollmentJobsPaginator(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) This is a variant of
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsPublisher publisher = client.listSpeakerEnrollmentJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsPublisher publisher = client.listSpeakerEnrollmentJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)
operation.
This is a convenience which creates an instance of the
ListSpeakerEnrollmentJobsRequest.Builder
avoiding the need to create one manually viaListSpeakerEnrollmentJobsRequest.builder()
- Parameters:
listSpeakerEnrollmentJobsRequest
- AConsumer
that will call methods onListSpeakerEnrollmentJobsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakers
default CompletableFuture<ListSpeakersResponse> listSpeakers(ListSpeakersRequest listSpeakersRequest) Lists all speakers in a specified domain.
- Parameters:
listSpeakersRequest
-- Returns:
- A Java Future containing the result of the ListSpeakers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakers
default CompletableFuture<ListSpeakersResponse> listSpeakers(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) Lists all speakers in a specified domain.
This is a convenience which creates an instance of the
ListSpeakersRequest.Builder
avoiding the need to create one manually viaListSpeakersRequest.builder()
- Parameters:
listSpeakersRequest
- AConsumer
that will call methods onListSpeakersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSpeakers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakersPaginator
This is a variant of
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersPublisher publisher = client.listSpeakersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListSpeakersPublisher publisher = client.listSpeakersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation.- Parameters:
listSpeakersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listSpeakersPaginator
default ListSpeakersPublisher listSpeakersPaginator(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) This is a variant of
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersPublisher publisher = client.listSpeakersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListSpeakersPublisher publisher = client.listSpeakersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)
operation.
This is a convenience which creates an instance of the
ListSpeakersRequest.Builder
avoiding the need to create one manually viaListSpeakersRequest.builder()
- Parameters:
listSpeakersRequest
- AConsumer
that will call methods onListSpeakersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags associated with a specified Voice ID resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags associated with a specified Voice ID resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listWatchlists
default CompletableFuture<ListWatchlistsResponse> listWatchlists(ListWatchlistsRequest listWatchlistsRequest) Lists all watchlists in a specified domain.
- Parameters:
listWatchlistsRequest
-- Returns:
- A Java Future containing the result of the ListWatchlists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listWatchlists
default CompletableFuture<ListWatchlistsResponse> listWatchlists(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) Lists all watchlists in a specified domain.
This is a convenience which creates an instance of the
ListWatchlistsRequest.Builder
avoiding the need to create one manually viaListWatchlistsRequest.builder()
- Parameters:
listWatchlistsRequest
- AConsumer
that will call methods onListWatchlistsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWatchlists operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listWatchlistsPaginator
default ListWatchlistsPublisher listWatchlistsPaginator(ListWatchlistsRequest listWatchlistsRequest) This is a variant of
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsPublisher publisher = client.listWatchlistsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListWatchlistsPublisher publisher = client.listWatchlistsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation.- Parameters:
listWatchlistsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
listWatchlistsPaginator
default ListWatchlistsPublisher listWatchlistsPaginator(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) This is a variant of
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsPublisher publisher = client.listWatchlistsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.voiceid.paginators.ListWatchlistsPublisher publisher = client.listWatchlistsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)
operation.
This is a convenience which creates an instance of the
ListWatchlistsRequest.Builder
avoiding the need to create one manually viaListWatchlistsRequest.builder()
- Parameters:
listWatchlistsRequest
- AConsumer
that will call methods onListWatchlistsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
optOutSpeaker
default CompletableFuture<OptOutSpeakerResponse> optOutSpeaker(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.
- Parameters:
optOutSpeakerRequest
-- Returns:
- A Java Future containing the result of the OptOutSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
optOutSpeaker
default CompletableFuture<OptOutSpeakerResponse> optOutSpeaker(Consumer<OptOutSpeakerRequest.Builder> 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.
This is a convenience which creates an instance of the
OptOutSpeakerRequest.Builder
avoiding the need to create one manually viaOptOutSpeakerRequest.builder()
- Parameters:
optOutSpeakerRequest
- AConsumer
that will call methods onOptOutSpeakerRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the OptOutSpeaker operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFraudsterRegistrationJob
default CompletableFuture<StartFraudsterRegistrationJobResponse> startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest) Starts a new batch fraudster registration job using provided details.
- Parameters:
startFraudsterRegistrationJobRequest
-- Returns:
- A Java Future containing the result of the StartFraudsterRegistrationJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startFraudsterRegistrationJob
default CompletableFuture<StartFraudsterRegistrationJobResponse> startFraudsterRegistrationJob(Consumer<StartFraudsterRegistrationJobRequest.Builder> startFraudsterRegistrationJobRequest) Starts a new batch fraudster registration job using provided details.
This is a convenience which creates an instance of the
StartFraudsterRegistrationJobRequest.Builder
avoiding the need to create one manually viaStartFraudsterRegistrationJobRequest.builder()
- Parameters:
startFraudsterRegistrationJobRequest
- AConsumer
that will call methods onStartFraudsterRegistrationJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartFraudsterRegistrationJob operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSpeakerEnrollmentJob
default CompletableFuture<StartSpeakerEnrollmentJobResponse> startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest) Starts a new batch speaker enrollment job using specified details.
- Parameters:
startSpeakerEnrollmentJobRequest
-- Returns:
- A Java Future containing the result of the StartSpeakerEnrollmentJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startSpeakerEnrollmentJob
default CompletableFuture<StartSpeakerEnrollmentJobResponse> startSpeakerEnrollmentJob(Consumer<StartSpeakerEnrollmentJobRequest.Builder> startSpeakerEnrollmentJobRequest) Starts a new batch speaker enrollment job using specified details.
This is a convenience which creates an instance of the
StartSpeakerEnrollmentJobRequest.Builder
avoiding the need to create one manually viaStartSpeakerEnrollmentJobRequest.builder()
- Parameters:
startSpeakerEnrollmentJobRequest
- AConsumer
that will call methods onStartSpeakerEnrollmentJobRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartSpeakerEnrollmentJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Tags a Voice ID resource with the provided list of tags.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags a Voice ID resource with the provided list of tags.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes specified tags from a specified Amazon Connect Voice ID resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes specified tags from a specified Amazon Connect Voice ID resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
updateDomain
default CompletableFuture<UpdateDomainResponse> updateDomain(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.
- Parameters:
updateDomainRequest
-- Returns:
- A Java Future containing the result of the UpdateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
updateDomain
default CompletableFuture<UpdateDomainResponse> updateDomain(Consumer<UpdateDomainRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateDomainRequest.Builder
avoiding the need to create one manually viaUpdateDomainRequest.builder()
- Parameters:
updateDomainRequest
- AConsumer
that will call methods onUpdateDomainRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
updateWatchlist
default CompletableFuture<UpdateWatchlistResponse> updateWatchlist(UpdateWatchlistRequest updateWatchlistRequest) Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
- Parameters:
updateWatchlistRequest
-- Returns:
- A Java Future containing the result of the UpdateWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
updateWatchlist
default CompletableFuture<UpdateWatchlistResponse> updateWatchlist(Consumer<UpdateWatchlistRequest.Builder> updateWatchlistRequest) Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
This is a convenience which creates an instance of the
UpdateWatchlistRequest.Builder
avoiding the need to create one manually viaUpdateWatchlistRequest.builder()
- Parameters:
updateWatchlistRequest
- AConsumer
that will call methods onUpdateWatchlistRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateWatchlist operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The specified resource cannot be found. Check the
ResourceType
and error message for more details. - ValidationException The request failed one or more validations; check the error message for more details.
- ConflictException The request failed due to a conflict. Check the
ConflictType
and error message for more details. - InternalServerException The request failed due to an unknown error on the server side.
- ThrottlingException The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
- AccessDeniedException You do not have sufficient permissions to perform this action. Check the error message and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- VoiceIdException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The specified resource cannot be found. Check the
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aVoiceIdAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aVoiceIdAsyncClient
.
-