@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonVoiceIDClient extends AmazonWebServiceClient implements AmazonVoiceID
Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
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.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest request)
Deletes the specified domain from the Amazon Connect Voice ID system.
|
DeleteFraudsterResult |
deleteFraudster(DeleteFraudsterRequest request)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
|
DeleteSpeakerResult |
deleteSpeaker(DeleteSpeakerRequest request)
Deletes the specified speaker from the Amazon Connect Voice ID system.
|
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.
|
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 . |
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.
|
OptOutSpeakerResult |
optOutSpeaker(OptOutSpeakerRequest request)
Opts out a speaker from Voice ID system.
|
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 an Amazon Connect 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.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AmazonVoiceIDClientBuilder builder()
public CreateDomainResult createDomain(CreateDomainRequest request)
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
createDomain
in interface AmazonVoiceID
createDomainRequest
- 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.public DeleteDomainResult deleteDomain(DeleteDomainRequest request)
Deletes the specified domain from the Amazon Connect Voice ID system.
deleteDomain
in interface AmazonVoiceID
deleteDomainRequest
- 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.public DeleteFraudsterResult deleteFraudster(DeleteFraudsterRequest request)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
deleteFraudster
in interface AmazonVoiceID
deleteFraudsterRequest
- 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.public DeleteSpeakerResult deleteSpeaker(DeleteSpeakerRequest request)
Deletes the specified speaker from the Amazon Connect Voice ID system.
deleteSpeaker
in interface AmazonVoiceID
deleteSpeakerRequest
- 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.public DescribeDomainResult describeDomain(DescribeDomainRequest request)
Describes the specified domain.
describeDomain
in interface AmazonVoiceID
describeDomainRequest
- 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.public DescribeFraudsterResult describeFraudster(DescribeFraudsterRequest request)
Describes the specified fraudster.
describeFraudster
in interface AmazonVoiceID
describeFraudsterRequest
- 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.public DescribeFraudsterRegistrationJobResult describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest request)
Describes the specified fraudster registration job.
describeFraudsterRegistrationJob
in interface AmazonVoiceID
describeFraudsterRegistrationJobRequest
- 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.public DescribeSpeakerResult describeSpeaker(DescribeSpeakerRequest request)
Describes the specified speaker.
describeSpeaker
in interface AmazonVoiceID
describeSpeakerRequest
- 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.public DescribeSpeakerEnrollmentJobResult describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest request)
Describes the specified speaker enrollment job.
describeSpeakerEnrollmentJob
in interface AmazonVoiceID
describeSpeakerEnrollmentJobRequest
- 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.public EvaluateSessionResult evaluateSession(EvaluateSessionRequest request)
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
evaluateSession
in interface AmazonVoiceID
evaluateSessionRequest
- 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.public ListDomainsResult listDomains(ListDomainsRequest request)
Lists all the domains in the Amazon Web Services account.
listDomains
in interface AmazonVoiceID
listDomainsRequest
- 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.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.
listFraudsterRegistrationJobs
in interface AmazonVoiceID
listFraudsterRegistrationJobsRequest
- 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.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.
listSpeakerEnrollmentJobs
in interface AmazonVoiceID
listSpeakerEnrollmentJobsRequest
- 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.public ListSpeakersResult listSpeakers(ListSpeakersRequest request)
Lists all speakers in a specified domain.
listSpeakers
in interface AmazonVoiceID
listSpeakersRequest
- 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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Lists all tags associated with a specified Voice ID resource.
listTagsForResource
in interface AmazonVoiceID
listTagsForResourceRequest
- 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.public OptOutSpeakerResult optOutSpeaker(OptOutSpeakerRequest request)
Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. 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 the system.
optOutSpeaker
in interface AmazonVoiceID
optOutSpeakerRequest
- 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.public StartFraudsterRegistrationJobResult startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest request)
Starts a new batch fraudster registration job using provided details.
startFraudsterRegistrationJob
in interface AmazonVoiceID
startFraudsterRegistrationJobRequest
- 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.public StartSpeakerEnrollmentJobResult startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest request)
Starts a new batch speaker enrollment job using specified details.
startSpeakerEnrollmentJob
in interface AmazonVoiceID
startSpeakerEnrollmentJobRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Tags an Amazon Connect Voice ID resource with the provided list of tags.
tagResource
in interface AmazonVoiceID
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes specified tags from a specified Amazon Connect Voice ID resource.
untagResource
in interface AmazonVoiceID
untagResourceRequest
- 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.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.
updateDomain
in interface AmazonVoiceID
updateDomainRequest
- 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
getCachedResponseMetadata
in interface AmazonVoiceID
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AmazonVoiceID
shutdown
in class AmazonWebServiceClient