Interface VoiceIdClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface VoiceIdClient extends AwsClient
Service client for accessing Amazon Voice ID. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateFraudster
default AssociateFraudsterResponse associateFraudster(AssociateFraudsterRequest associateFraudsterRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Associates the fraudsters with the watchlist specified in the same domain.
- Parameters:
associateFraudsterRequest-- Returns:
- Result of the AssociateFraudster operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
associateFraudster
default AssociateFraudsterResponse associateFraudster(Consumer<AssociateFraudsterRequest.Builder> associateFraudsterRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Associates the fraudsters with the watchlist specified in the same domain.
This is a convenience which creates an instance of the
AssociateFraudsterRequest.Builderavoiding the need to create one manually viaAssociateFraudsterRequest.builder()- Parameters:
associateFraudsterRequest- AConsumerthat will call methods onAssociateFraudsterRequest.Builderto create a request.- Returns:
- Result of the AssociateFraudster operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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:
- Result of the CreateDomain operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaCreateDomainRequest.builder()- Parameters:
createDomainRequest- AConsumerthat will call methods onCreateDomainRequest.Builderto create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
createWatchlist
default CreateWatchlistResponse createWatchlist(CreateWatchlistRequest createWatchlistRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Creates a watchlist that fraudsters can be a part of.
- Parameters:
createWatchlistRequest-- Returns:
- Result of the CreateWatchlist operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
createWatchlist
default CreateWatchlistResponse createWatchlist(Consumer<CreateWatchlistRequest.Builder> createWatchlistRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Creates a watchlist that fraudsters can be a part of.
This is a convenience which creates an instance of the
CreateWatchlistRequest.Builderavoiding the need to create one manually viaCreateWatchlistRequest.builder()- Parameters:
createWatchlistRequest- AConsumerthat will call methods onCreateWatchlistRequest.Builderto create a request.- Returns:
- Result of the CreateWatchlist operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Deletes the specified domain from Voice ID.
- Parameters:
deleteDomainRequest-- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Deletes the specified domain from Voice ID.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builderavoiding the need to create one manually viaDeleteDomainRequest.builder()- Parameters:
deleteDomainRequest- AConsumerthat will call methods onDeleteDomainRequest.Builderto create a request.- Returns:
- Result of the DeleteDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFraudster
default DeleteFraudsterResponse deleteFraudster(DeleteFraudsterRequest deleteFraudsterRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
- Parameters:
deleteFraudsterRequest-- Returns:
- Result of the DeleteFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFraudster
default DeleteFraudsterResponse deleteFraudster(Consumer<DeleteFraudsterRequest.Builder> deleteFraudsterRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaDeleteFraudsterRequest.builder()- Parameters:
deleteFraudsterRequest- AConsumerthat will call methods onDeleteFraudsterRequest.Builderto create a request.- Returns:
- Result of the DeleteFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSpeaker
default DeleteSpeakerResponse deleteSpeaker(DeleteSpeakerRequest deleteSpeakerRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Deletes the specified speaker from Voice ID.
- Parameters:
deleteSpeakerRequest-- Returns:
- Result of the DeleteSpeaker operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSpeaker
default DeleteSpeakerResponse deleteSpeaker(Consumer<DeleteSpeakerRequest.Builder> deleteSpeakerRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Deletes the specified speaker from Voice ID.
This is a convenience which creates an instance of the
DeleteSpeakerRequest.Builderavoiding the need to create one manually viaDeleteSpeakerRequest.builder()- Parameters:
deleteSpeakerRequest- AConsumerthat will call methods onDeleteSpeakerRequest.Builderto create a request.- Returns:
- Result of the DeleteSpeaker operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWatchlist
default DeleteWatchlistResponse deleteWatchlist(DeleteWatchlistRequest deleteWatchlistRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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:
- Result of the DeleteWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWatchlist
default DeleteWatchlistResponse deleteWatchlist(Consumer<DeleteWatchlistRequest.Builder> deleteWatchlistRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaDeleteWatchlistRequest.builder()- Parameters:
deleteWatchlistRequest- AConsumerthat will call methods onDeleteWatchlistRequest.Builderto create a request.- Returns:
- Result of the DeleteWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDomain
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified domain.
- Parameters:
describeDomainRequest-- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeDomain
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified domain.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builderavoiding the need to create one manually viaDescribeDomainRequest.builder()- Parameters:
describeDomainRequest- AConsumerthat will call methods onDescribeDomainRequest.Builderto create a request.- Returns:
- Result of the DescribeDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFraudster
default DescribeFraudsterResponse describeFraudster(DescribeFraudsterRequest describeFraudsterRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified fraudster.
- Parameters:
describeFraudsterRequest-- Returns:
- Result of the DescribeFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFraudster
default DescribeFraudsterResponse describeFraudster(Consumer<DescribeFraudsterRequest.Builder> describeFraudsterRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified fraudster.
This is a convenience which creates an instance of the
DescribeFraudsterRequest.Builderavoiding the need to create one manually viaDescribeFraudsterRequest.builder()- Parameters:
describeFraudsterRequest- AConsumerthat will call methods onDescribeFraudsterRequest.Builderto create a request.- Returns:
- Result of the DescribeFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFraudsterRegistrationJob
default DescribeFraudsterRegistrationJobResponse describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified fraudster registration job.
- Parameters:
describeFraudsterRegistrationJobRequest-- Returns:
- Result of the DescribeFraudsterRegistrationJob operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeFraudsterRegistrationJob
default DescribeFraudsterRegistrationJobResponse describeFraudsterRegistrationJob(Consumer<DescribeFraudsterRegistrationJobRequest.Builder> describeFraudsterRegistrationJobRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified fraudster registration job.
This is a convenience which creates an instance of the
DescribeFraudsterRegistrationJobRequest.Builderavoiding the need to create one manually viaDescribeFraudsterRegistrationJobRequest.builder()- Parameters:
describeFraudsterRegistrationJobRequest- AConsumerthat will call methods onDescribeFraudsterRegistrationJobRequest.Builderto create a request.- Returns:
- Result of the DescribeFraudsterRegistrationJob operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSpeaker
default DescribeSpeakerResponse describeSpeaker(DescribeSpeakerRequest describeSpeakerRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified speaker.
- Parameters:
describeSpeakerRequest-- Returns:
- Result of the DescribeSpeaker operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSpeaker
default DescribeSpeakerResponse describeSpeaker(Consumer<DescribeSpeakerRequest.Builder> describeSpeakerRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified speaker.
This is a convenience which creates an instance of the
DescribeSpeakerRequest.Builderavoiding the need to create one manually viaDescribeSpeakerRequest.builder()- Parameters:
describeSpeakerRequest- AConsumerthat will call methods onDescribeSpeakerRequest.Builderto create a request.- Returns:
- Result of the DescribeSpeaker operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSpeakerEnrollmentJob
default DescribeSpeakerEnrollmentJobResponse describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified speaker enrollment job.
- Parameters:
describeSpeakerEnrollmentJobRequest-- Returns:
- Result of the DescribeSpeakerEnrollmentJob operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeSpeakerEnrollmentJob
default DescribeSpeakerEnrollmentJobResponse describeSpeakerEnrollmentJob(Consumer<DescribeSpeakerEnrollmentJobRequest.Builder> describeSpeakerEnrollmentJobRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified speaker enrollment job.
This is a convenience which creates an instance of the
DescribeSpeakerEnrollmentJobRequest.Builderavoiding the need to create one manually viaDescribeSpeakerEnrollmentJobRequest.builder()- Parameters:
describeSpeakerEnrollmentJobRequest- AConsumerthat will call methods onDescribeSpeakerEnrollmentJobRequest.Builderto create a request.- Returns:
- Result of the DescribeSpeakerEnrollmentJob operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWatchlist
default DescribeWatchlistResponse describeWatchlist(DescribeWatchlistRequest describeWatchlistRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified watchlist.
- Parameters:
describeWatchlistRequest-- Returns:
- Result of the DescribeWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
describeWatchlist
default DescribeWatchlistResponse describeWatchlist(Consumer<DescribeWatchlistRequest.Builder> describeWatchlistRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Describes the specified watchlist.
This is a convenience which creates an instance of the
DescribeWatchlistRequest.Builderavoiding the need to create one manually viaDescribeWatchlistRequest.builder()- Parameters:
describeWatchlistRequest- AConsumerthat will call methods onDescribeWatchlistRequest.Builderto create a request.- Returns:
- Result of the DescribeWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateFraudster
default DisassociateFraudsterResponse disassociateFraudster(DisassociateFraudsterRequest disassociateFraudsterRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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
ValidationExceptionis thrown.- Parameters:
disassociateFraudsterRequest-- Returns:
- Result of the DisassociateFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateFraudster
default DisassociateFraudsterResponse disassociateFraudster(Consumer<DisassociateFraudsterRequest.Builder> disassociateFraudsterRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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
ValidationExceptionis thrown.
This is a convenience which creates an instance of the
DisassociateFraudsterRequest.Builderavoiding the need to create one manually viaDisassociateFraudsterRequest.builder()- Parameters:
disassociateFraudsterRequest- AConsumerthat will call methods onDisassociateFraudsterRequest.Builderto create a request.- Returns:
- Result of the DisassociateFraudster operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
evaluateSession
default EvaluateSessionResponse evaluateSession(EvaluateSessionRequest evaluateSessionRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
- Parameters:
evaluateSessionRequest-- Returns:
- Result of the EvaluateSession operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
evaluateSession
default EvaluateSessionResponse evaluateSession(Consumer<EvaluateSessionRequest.Builder> evaluateSessionRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaEvaluateSessionRequest.builder()- Parameters:
evaluateSessionRequest- AConsumerthat will call methods onEvaluateSessionRequest.Builderto create a request.- Returns:
- Result of the EvaluateSession operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the domains in the Amazon Web Services account.
- Parameters:
listDomainsRequest-- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomains
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the domains in the Amazon Web Services account.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- Result of the ListDomains operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDomainsPaginator
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listDomains(software.amazon.awssdk.services.voiceid.model.ListDomainsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsterRegistrationJobs
default ListFraudsterRegistrationJobsResponse listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the fraudster registration jobs in the domain with the given
JobStatus. IfJobStatusis not provided, this lists all fraudster registration jobs in the given domain.- Parameters:
listFraudsterRegistrationJobsRequest-- Returns:
- Result of the ListFraudsterRegistrationJobs operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsterRegistrationJobs
default ListFraudsterRegistrationJobsResponse listFraudsterRegistrationJobs(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the fraudster registration jobs in the domain with the given
JobStatus. IfJobStatusis not provided, this lists all fraudster registration jobs in the given domain.
This is a convenience which creates an instance of the
ListFraudsterRegistrationJobsRequest.Builderavoiding the need to create one manually viaListFraudsterRegistrationJobsRequest.builder()- Parameters:
listFraudsterRegistrationJobsRequest- AConsumerthat will call methods onListFraudsterRegistrationJobsRequest.Builderto create a request.- Returns:
- Result of the ListFraudsterRegistrationJobs operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsterRegistrationJobsPaginator
default ListFraudsterRegistrationJobsIterable listFraudsterRegistrationJobsPaginator(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client.listFraudsterRegistrationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client .listFraudsterRegistrationJobsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client.listFraudsterRegistrationJobsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsterRegistrationJobsPaginator
default ListFraudsterRegistrationJobsIterable listFraudsterRegistrationJobsPaginator(Consumer<ListFraudsterRegistrationJobsRequest.Builder> listFraudsterRegistrationJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listFraudsterRegistrationJobs(software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client.listFraudsterRegistrationJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client .listFraudsterRegistrationJobsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListFraudsterRegistrationJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListFraudsterRegistrationJobsIterable responses = client.listFraudsterRegistrationJobsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListFraudsterRegistrationJobsRequest.builder()- Parameters:
listFraudsterRegistrationJobsRequest- AConsumerthat will call methods onListFraudsterRegistrationJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsters
default ListFraudstersResponse listFraudsters(ListFraudstersRequest listFraudstersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all fraudsters in a specified watchlist or domain.
- Parameters:
listFraudstersRequest-- Returns:
- Result of the ListFraudsters operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudsters
default ListFraudstersResponse listFraudsters(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all fraudsters in a specified watchlist or domain.
This is a convenience which creates an instance of the
ListFraudstersRequest.Builderavoiding the need to create one manually viaListFraudstersRequest.builder()- Parameters:
listFraudstersRequest- AConsumerthat will call methods onListFraudstersRequest.Builderto create a request.- Returns:
- Result of the ListFraudsters operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudstersPaginator
default ListFraudstersIterable listFraudstersPaginator(ListFraudstersRequest listFraudstersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listFraudstersPaginator
default ListFraudstersIterable listFraudstersPaginator(Consumer<ListFraudstersRequest.Builder> listFraudstersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listFraudsters(software.amazon.awssdk.services.voiceid.model.ListFraudstersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListFraudstersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListFraudstersIterable responses = client.listFraudstersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListFraudstersRequest.builder()- Parameters:
listFraudstersRequest- AConsumerthat will call methods onListFraudstersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakerEnrollmentJobs
default ListSpeakerEnrollmentJobsResponse listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus. IfJobStatusis not provided, this lists all jobs with all possible speaker enrollment job statuses.- Parameters:
listSpeakerEnrollmentJobsRequest-- Returns:
- Result of the ListSpeakerEnrollmentJobs operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakerEnrollmentJobs
default ListSpeakerEnrollmentJobsResponse listSpeakerEnrollmentJobs(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus. IfJobStatusis not provided, this lists all jobs with all possible speaker enrollment job statuses.
This is a convenience which creates an instance of the
ListSpeakerEnrollmentJobsRequest.Builderavoiding the need to create one manually viaListSpeakerEnrollmentJobsRequest.builder()- Parameters:
listSpeakerEnrollmentJobsRequest- AConsumerthat will call methods onListSpeakerEnrollmentJobsRequest.Builderto create a request.- Returns:
- Result of the ListSpeakerEnrollmentJobs operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakerEnrollmentJobsPaginator
default ListSpeakerEnrollmentJobsIterable listSpeakerEnrollmentJobsPaginator(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client.listSpeakerEnrollmentJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client .listSpeakerEnrollmentJobsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client.listSpeakerEnrollmentJobsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakerEnrollmentJobsPaginator
default ListSpeakerEnrollmentJobsIterable listSpeakerEnrollmentJobsPaginator(Consumer<ListSpeakerEnrollmentJobsRequest.Builder> listSpeakerEnrollmentJobsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listSpeakerEnrollmentJobs(software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client.listSpeakerEnrollmentJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client .listSpeakerEnrollmentJobsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListSpeakerEnrollmentJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakerEnrollmentJobsIterable responses = client.listSpeakerEnrollmentJobsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListSpeakerEnrollmentJobsRequest.builder()- Parameters:
listSpeakerEnrollmentJobsRequest- AConsumerthat will call methods onListSpeakerEnrollmentJobsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakers
default ListSpeakersResponse listSpeakers(ListSpeakersRequest listSpeakersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all speakers in a specified domain.
- Parameters:
listSpeakersRequest-- Returns:
- Result of the ListSpeakers operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakers
default ListSpeakersResponse listSpeakers(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all speakers in a specified domain.
This is a convenience which creates an instance of the
ListSpeakersRequest.Builderavoiding the need to create one manually viaListSpeakersRequest.builder()- Parameters:
listSpeakersRequest- AConsumerthat will call methods onListSpeakersRequest.Builderto create a request.- Returns:
- Result of the ListSpeakers operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakersPaginator
default ListSpeakersIterable listSpeakersPaginator(ListSpeakersRequest listSpeakersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listSpeakersPaginator
default ListSpeakersIterable listSpeakersPaginator(Consumer<ListSpeakersRequest.Builder> listSpeakersRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listSpeakers(software.amazon.awssdk.services.voiceid.model.ListSpeakersRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListSpeakersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListSpeakersIterable responses = client.listSpeakersPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListSpeakersRequest.builder()- Parameters:
listSpeakersRequest- AConsumerthat will call methods onListSpeakersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all tags associated with a specified Voice ID resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all tags associated with a specified Voice ID resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWatchlists
default ListWatchlistsResponse listWatchlists(ListWatchlistsRequest listWatchlistsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all watchlists in a specified domain.
- Parameters:
listWatchlistsRequest-- Returns:
- Result of the ListWatchlists operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWatchlists
default ListWatchlistsResponse listWatchlists(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Lists all watchlists in a specified domain.
This is a convenience which creates an instance of the
ListWatchlistsRequest.Builderavoiding the need to create one manually viaListWatchlistsRequest.builder()- Parameters:
listWatchlistsRequest- AConsumerthat will call methods onListWatchlistsRequest.Builderto create a request.- Returns:
- Result of the ListWatchlists operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWatchlistsPaginator
default ListWatchlistsIterable listWatchlistsPaginator(ListWatchlistsRequest listWatchlistsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
listWatchlistsPaginator
default ListWatchlistsIterable listWatchlistsPaginator(Consumer<ListWatchlistsRequest.Builder> listWatchlistsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
This is a variant of
listWatchlists(software.amazon.awssdk.services.voiceid.model.ListWatchlistsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); for (software.amazon.awssdk.services.voiceid.model.ListWatchlistsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.voiceid.paginators.ListWatchlistsIterable responses = client.listWatchlistsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListWatchlistsRequest.builder()- Parameters:
listWatchlistsRequest- AConsumerthat will call methods onListWatchlistsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
optOutSpeaker
default OptOutSpeakerResponse optOutSpeaker(OptOutSpeakerRequest optOutSpeakerRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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:
- Result of the OptOutSpeaker operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
optOutSpeaker
default OptOutSpeakerResponse optOutSpeaker(Consumer<OptOutSpeakerRequest.Builder> optOutSpeakerRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaOptOutSpeakerRequest.builder()- Parameters:
optOutSpeakerRequest- AConsumerthat will call methods onOptOutSpeakerRequest.Builderto create a request.- Returns:
- Result of the OptOutSpeaker operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
startFraudsterRegistrationJob
default StartFraudsterRegistrationJobResponse startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Starts a new batch fraudster registration job using provided details.
- Parameters:
startFraudsterRegistrationJobRequest-- Returns:
- Result of the StartFraudsterRegistrationJob operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
startFraudsterRegistrationJob
default StartFraudsterRegistrationJobResponse startFraudsterRegistrationJob(Consumer<StartFraudsterRegistrationJobRequest.Builder> startFraudsterRegistrationJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Starts a new batch fraudster registration job using provided details.
This is a convenience which creates an instance of the
StartFraudsterRegistrationJobRequest.Builderavoiding the need to create one manually viaStartFraudsterRegistrationJobRequest.builder()- Parameters:
startFraudsterRegistrationJobRequest- AConsumerthat will call methods onStartFraudsterRegistrationJobRequest.Builderto create a request.- Returns:
- Result of the StartFraudsterRegistrationJob operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
startSpeakerEnrollmentJob
default StartSpeakerEnrollmentJobResponse startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Starts a new batch speaker enrollment job using specified details.
- Parameters:
startSpeakerEnrollmentJobRequest-- Returns:
- Result of the StartSpeakerEnrollmentJob operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
startSpeakerEnrollmentJob
default StartSpeakerEnrollmentJobResponse startSpeakerEnrollmentJob(Consumer<StartSpeakerEnrollmentJobRequest.Builder> startSpeakerEnrollmentJobRequest) throws ServiceQuotaExceededException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Starts a new batch speaker enrollment job using specified details.
This is a convenience which creates an instance of the
StartSpeakerEnrollmentJobRequest.Builderavoiding the need to create one manually viaStartSpeakerEnrollmentJobRequest.builder()- Parameters:
startSpeakerEnrollmentJobRequest- AConsumerthat will call methods onStartSpeakerEnrollmentJobRequest.Builderto create a request.- Returns:
- Result of the StartSpeakerEnrollmentJob operation returned by the service.
- Throws:
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 theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Tags a Voice ID resource with the provided list of tags.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Tags a Voice ID resource with the provided list of tags.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Removes specified tags from a specified Amazon Connect Voice ID resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Removes specified tags from a specified Amazon Connect Voice ID resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDomain
default UpdateDomainResponse updateDomain(UpdateDomainRequest updateDomainRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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:
- Result of the UpdateDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDomain
default UpdateDomainResponse updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaUpdateDomainRequest.builder()- Parameters:
updateDomainRequest- AConsumerthat will call methods onUpdateDomainRequest.Builderto create a request.- Returns:
- Result of the UpdateDomain operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWatchlist
default UpdateWatchlistResponse updateWatchlist(UpdateWatchlistRequest updateWatchlistRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
- Parameters:
updateWatchlistRequest-- Returns:
- Result of the UpdateWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateWatchlist
default UpdateWatchlistResponse updateWatchlist(Consumer<UpdateWatchlistRequest.Builder> updateWatchlistRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, VoiceIdException
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.Builderavoiding the need to create one manually viaUpdateWatchlistRequest.builder()- Parameters:
updateWatchlistRequest- AConsumerthat will call methods onUpdateWatchlistRequest.Builderto create a request.- Returns:
- Result of the UpdateWatchlist operation returned by the service.
- Throws:
ResourceNotFoundException- The specified resource cannot be found. Check theResourceTypeand 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 theConflictTypeand 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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static VoiceIdClient create()
Create aVoiceIdClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static VoiceIdClientBuilder builder()
Create a builder that can be used to configure and create aVoiceIdClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default VoiceIdServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-