AmazonVoiceIDClient (AWS Java SDK for Amazon Voice ID 1.12.544 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.voiceid.AmazonVoiceIDClient

All Implemented Interfaces:

AmazonVoiceID

Direct Known Subclasses:

AmazonVoiceIDAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonVoiceIDClient
extends AmazonWebServiceClient
implements AmazonVoiceID
```
Client for accessing Amazon Voice ID. All service calls made using this client are blocking, and will not return until the service call completes.

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 and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.voiceid.AmazonVoiceID
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateFraudsterResult`	`associateFraudster(AssociateFraudsterRequest request)` Associates the fraudsters with the watchlist specified in the same domain.
`static AmazonVoiceIDClientBuilder`	`builder()`
`CreateDomainResult`	`createDomain(CreateDomainRequest request)` Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
`CreateWatchlistResult`	`createWatchlist(CreateWatchlistRequest request)` Creates a watchlist that fraudsters can be a part of.
`DeleteDomainResult`	`deleteDomain(DeleteDomainRequest request)` Deletes the specified domain from Voice ID.
`DeleteFraudsterResult`	`deleteFraudster(DeleteFraudsterRequest request)` Deletes the specified fraudster from Voice ID.
`DeleteSpeakerResult`	`deleteSpeaker(DeleteSpeakerRequest request)` Deletes the specified speaker from Voice ID.
`DeleteWatchlistResult`	`deleteWatchlist(DeleteWatchlistRequest request)` Deletes the specified watchlist from Voice ID.
`DescribeDomainResult`	`describeDomain(DescribeDomainRequest request)` Describes the specified domain.
`DescribeFraudsterResult`	`describeFraudster(DescribeFraudsterRequest request)` Describes the specified fraudster.
`DescribeFraudsterRegistrationJobResult`	`describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest request)` Describes the specified fraudster registration job.
`DescribeSpeakerResult`	`describeSpeaker(DescribeSpeakerRequest request)` Describes the specified speaker.
`DescribeSpeakerEnrollmentJobResult`	`describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest request)` Describes the specified speaker enrollment job.
`DescribeWatchlistResult`	`describeWatchlist(DescribeWatchlistRequest request)` Describes the specified watchlist.
`DisassociateFraudsterResult`	`disassociateFraudster(DisassociateFraudsterRequest request)` Disassociates the fraudsters from the watchlist specified.
`EvaluateSessionResult`	`evaluateSession(EvaluateSessionRequest request)` Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
`ListDomainsResult`	`listDomains(ListDomainsRequest request)` Lists all the domains in the Amazon Web Services account.
`ListFraudsterRegistrationJobsResult`	`listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest request)` Lists all the fraudster registration jobs in the domain with the given `JobStatus`.
`ListFraudstersResult`	`listFraudsters(ListFraudstersRequest request)` Lists all fraudsters in a specified watchlist or domain.
`ListSpeakerEnrollmentJobsResult`	`listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest request)` Lists all the speaker enrollment jobs in the domain with the specified `JobStatus`.
`ListSpeakersResult`	`listSpeakers(ListSpeakersRequest request)` Lists all speakers in a specified domain.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all tags associated with a specified Voice ID resource.
`ListWatchlistsResult`	`listWatchlists(ListWatchlistsRequest request)` Lists all watchlists in a specified domain.
`OptOutSpeakerResult`	`optOutSpeaker(OptOutSpeakerRequest request)` Opts out a speaker from Voice ID.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartFraudsterRegistrationJobResult`	`startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest request)` Starts a new batch fraudster registration job using provided details.
`StartSpeakerEnrollmentJobResult`	`startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest request)` Starts a new batch speaker enrollment job using specified details.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tags a Voice ID resource with the provided list of tags.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes specified tags from a specified Amazon Connect Voice ID resource.
`UpdateDomainResult`	`updateDomain(UpdateDomainRequest request)` Updates the specified domain.
`UpdateWatchlistResult`	`updateWatchlist(UpdateWatchlistRequest request)` Updates the specified watchlist.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Method Detail
  - builder
```
public static AmazonVoiceIDClientBuilder builder()
```
  - associateFraudster
```
public AssociateFraudsterResult associateFraudster(AssociateFraudsterRequest request)
```
    Associates the fraudsters with the watchlist specified in the same domain.
    
    Specified by:
    
    associateFraudster in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - createDomain
```
public CreateDomainResult createDomain(CreateDomainRequest request)
```
    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.
    
    Specified by:
    
    createDomain in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - createWatchlist
```
public CreateWatchlistResult createWatchlist(CreateWatchlistRequest request)
```
    Creates a watchlist that fraudsters can be a part of.
    
    Specified by:
    
    createWatchlist in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteDomain
```
public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
```
    Deletes the specified domain from Voice ID.
    
    Specified by:
    
    deleteDomain in interface AmazonVoiceID
    
    Parameters:
    
    deleteDomainRequest -
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteFraudster
```
public DeleteFraudsterResult deleteFraudster(DeleteFraudsterRequest request)
```
    Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
    
    Specified by:
    
    deleteFraudster in interface AmazonVoiceID
    
    Parameters:
    
    deleteFraudsterRequest -
    
    Returns:
    
    Result of the DeleteFraudster operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteSpeaker
```
public DeleteSpeakerResult deleteSpeaker(DeleteSpeakerRequest request)
```
    Deletes the specified speaker from Voice ID.
    
    Specified by:
    
    deleteSpeaker in interface AmazonVoiceID
    
    Parameters:
    
    deleteSpeakerRequest -
    
    Returns:
    
    Result of the DeleteSpeaker operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - deleteWatchlist
```
public DeleteWatchlistResult deleteWatchlist(DeleteWatchlistRequest request)
```
    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.
    
    Specified by:
    
    deleteWatchlist in interface AmazonVoiceID
    
    Parameters:
    
    deleteWatchlistRequest -
    
    Returns:
    
    Result of the DeleteWatchlist operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeDomain
```
public DescribeDomainResult describeDomain(DescribeDomainRequest request)
```
    Describes the specified domain.
    
    Specified by:
    
    describeDomain in interface AmazonVoiceID
    
    Parameters:
    
    describeDomainRequest -
    
    Returns:
    
    Result of the DescribeDomain operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeFraudster
```
public DescribeFraudsterResult describeFraudster(DescribeFraudsterRequest request)
```
    Describes the specified fraudster.
    
    Specified by:
    
    describeFraudster in interface AmazonVoiceID
    
    Parameters:
    
    describeFraudsterRequest -
    
    Returns:
    
    Result of the DescribeFraudster operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeFraudsterRegistrationJob
```
public DescribeFraudsterRegistrationJobResult describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest request)
```
    Describes the specified fraudster registration job.
    
    Specified by:
    
    describeFraudsterRegistrationJob in interface AmazonVoiceID
    
    Parameters:
    
    describeFraudsterRegistrationJobRequest -
    
    Returns:
    
    Result of the DescribeFraudsterRegistrationJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeSpeaker
```
public DescribeSpeakerResult describeSpeaker(DescribeSpeakerRequest request)
```
    Describes the specified speaker.
    
    Specified by:
    
    describeSpeaker in interface AmazonVoiceID
    
    Parameters:
    
    describeSpeakerRequest -
    
    Returns:
    
    Result of the DescribeSpeaker operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeSpeakerEnrollmentJob
```
public DescribeSpeakerEnrollmentJobResult describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest request)
```
    Describes the specified speaker enrollment job.
    
    Specified by:
    
    describeSpeakerEnrollmentJob in interface AmazonVoiceID
    
    Parameters:
    
    describeSpeakerEnrollmentJobRequest -
    
    Returns:
    
    Result of the DescribeSpeakerEnrollmentJob operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - describeWatchlist
```
public DescribeWatchlistResult describeWatchlist(DescribeWatchlistRequest request)
```
    Describes the specified watchlist.
    
    Specified by:
    
    describeWatchlist in interface AmazonVoiceID
    
    Parameters:
    
    describeWatchlistRequest -
    
    Returns:
    
    Result of the DescribeWatchlist operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - disassociateFraudster
```
public DisassociateFraudsterResult disassociateFraudster(DisassociateFraudsterRequest request)
```
    Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.
    
    Specified by:
    
    disassociateFraudster in interface AmazonVoiceID
    
    Parameters:
    
    disassociateFraudsterRequest -
    
    Returns:
    
    Result of the DisassociateFraudster operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - evaluateSession
```
public EvaluateSessionResult evaluateSession(EvaluateSessionRequest request)
```
    Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
    
    Specified by:
    
    evaluateSession in interface AmazonVoiceID
    
    Parameters:
    
    evaluateSessionRequest -
    
    Returns:
    
    Result of the EvaluateSession operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listDomains
```
public ListDomainsResult listDomains(ListDomainsRequest request)
```
    Lists all the domains in the Amazon Web Services account.
    
    Specified by:
    
    listDomains in interface AmazonVoiceID
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listFraudsterRegistrationJobs
```
public ListFraudsterRegistrationJobsResult listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest request)
```
    Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.
    
    Specified by:
    
    listFraudsterRegistrationJobs in interface AmazonVoiceID
    
    Parameters:
    
    listFraudsterRegistrationJobsRequest -
    
    Returns:
    
    Result of the ListFraudsterRegistrationJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listFraudsters
```
public ListFraudstersResult listFraudsters(ListFraudstersRequest request)
```
    Lists all fraudsters in a specified watchlist or domain.
    
    Specified by:
    
    listFraudsters in interface AmazonVoiceID
    
    Parameters:
    
    listFraudstersRequest -
    
    Returns:
    
    Result of the ListFraudsters operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listSpeakerEnrollmentJobs
```
public ListSpeakerEnrollmentJobsResult listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest request)
```
    Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.
    
    Specified by:
    
    listSpeakerEnrollmentJobs in interface AmazonVoiceID
    
    Parameters:
    
    listSpeakerEnrollmentJobsRequest -
    
    Returns:
    
    Result of the ListSpeakerEnrollmentJobs operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listSpeakers
```
public ListSpeakersResult listSpeakers(ListSpeakersRequest request)
```
    Lists all speakers in a specified domain.
    
    Specified by:
    
    listSpeakers in interface AmazonVoiceID
    
    Parameters:
    
    listSpeakersRequest -
    
    Returns:
    
    Result of the ListSpeakers operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Lists all tags associated with a specified Voice ID resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonVoiceID
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - listWatchlists
```
public ListWatchlistsResult listWatchlists(ListWatchlistsRequest request)
```
    Lists all watchlists in a specified domain.
    
    Specified by:
    
    listWatchlists in interface AmazonVoiceID
    
    Parameters:
    
    listWatchlistsRequest -
    
    Returns:
    
    Result of the ListWatchlists operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - optOutSpeaker
```
public OptOutSpeakerResult optOutSpeaker(OptOutSpeakerRequest request)
```
    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.
    
    Specified by:
    
    optOutSpeaker in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - startFraudsterRegistrationJob
```
public StartFraudsterRegistrationJobResult startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest request)
```
    Starts a new batch fraudster registration job using provided details.
    
    Specified by:
    
    startFraudsterRegistrationJob in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - startSpeakerEnrollmentJob
```
public StartSpeakerEnrollmentJobResult startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest request)
```
    Starts a new batch speaker enrollment job using specified details.
    
    Specified by:
    
    startSpeakerEnrollmentJob in interface AmazonVoiceID
    
    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 the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Tags a Voice ID resource with the provided list of tags.
    
    Specified by:
    
    tagResource in interface AmazonVoiceID
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes specified tags from a specified Amazon Connect Voice ID resource.
    
    Specified by:
    
    untagResource in interface AmazonVoiceID
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - updateDomain
```
public UpdateDomainResult updateDomain(UpdateDomainRequest request)
```
    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.
    
    Specified by:
    
    updateDomain in interface AmazonVoiceID
    
    Parameters:
    
    updateDomainRequest -
    
    Returns:
    
    Result of the UpdateDomain operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - updateWatchlist
```
public UpdateWatchlistResult updateWatchlist(UpdateWatchlistRequest request)
```
    Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.
    
    Specified by:
    
    updateWatchlist in interface AmazonVoiceID
    
    Parameters:
    
    updateWatchlistRequest -
    
    Returns:
    
    Result of the UpdateWatchlist operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The specified resource cannot be found. Check the ResourceType and error message for more details.
    
    ValidationException - The request failed one or more validations; check the error message for more details.
    
    ConflictException - The request failed due to a conflict. Check the ConflictType and error message for more details.
    
    InternalServerException - The request failed due to an unknown error on the server side.
    
    ThrottlingException - The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
    
    AccessDeniedException - You do not have sufficient permissions to perform this action. Check the error message and try again.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonVoiceID
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonVoiceID
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonVoiceID
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Class AmazonVoiceIDClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.voiceid.AmazonVoiceID

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Field Detail

configFactory

Method Detail

builder

associateFraudster

createDomain

createWatchlist

deleteDomain

deleteFraudster

deleteSpeaker

deleteWatchlist

describeDomain

describeFraudster

describeFraudsterRegistrationJob

describeSpeaker

describeSpeakerEnrollmentJob

describeWatchlist

disassociateFraudster

evaluateSession

listDomains

listFraudsterRegistrationJobs

listFraudsters

listSpeakerEnrollmentJobs

listSpeakers

listTagsForResource

listWatchlists

optOutSpeaker

startFraudsterRegistrationJob

startSpeakerEnrollmentJob

tagResource

untagResource

updateDomain

updateWatchlist

getCachedResponseMetadata

shutdown