@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonVoiceID
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonVoiceID
instead.
Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CreateDomainResult |
createDomain(CreateDomainRequest createDomainRequest)
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio,
and voiceprints.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain from the Amazon Connect Voice ID system.
|
DeleteFraudsterResult |
deleteFraudster(DeleteFraudsterRequest deleteFraudsterRequest)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
|
DeleteSpeakerResult |
deleteSpeaker(DeleteSpeakerRequest deleteSpeakerRequest)
Deletes the specified speaker from the Amazon Connect Voice ID system.
|
DescribeDomainResult |
describeDomain(DescribeDomainRequest describeDomainRequest)
Describes the specified domain.
|
DescribeFraudsterResult |
describeFraudster(DescribeFraudsterRequest describeFraudsterRequest)
Describes the specified fraudster.
|
DescribeFraudsterRegistrationJobResult |
describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest)
Describes the specified fraudster registration job.
|
DescribeSpeakerResult |
describeSpeaker(DescribeSpeakerRequest describeSpeakerRequest)
Describes the specified speaker.
|
DescribeSpeakerEnrollmentJobResult |
describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest)
Describes the specified speaker enrollment job.
|
EvaluateSessionResult |
evaluateSession(EvaluateSessionRequest evaluateSessionRequest)
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 listDomainsRequest)
Lists all the domains in the Amazon Web Services account.
|
ListFraudsterRegistrationJobsResult |
listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest)
Lists all the fraudster registration jobs in the domain with the given
JobStatus . |
ListSpeakerEnrollmentJobsResult |
listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest)
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus . |
ListSpeakersResult |
listSpeakers(ListSpeakersRequest listSpeakersRequest)
Lists all speakers in a specified domain.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a specified Voice ID resource.
|
OptOutSpeakerResult |
optOutSpeaker(OptOutSpeakerRequest optOutSpeakerRequest)
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 startFraudsterRegistrationJobRequest)
Starts a new batch fraudster registration job using provided details.
|
StartSpeakerEnrollmentJobResult |
startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest)
Starts a new batch speaker enrollment job using specified details.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Tags an Amazon Connect Voice ID resource with the provided list of tags.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes specified tags from a specified Amazon Connect Voice ID resource.
|
UpdateDomainResult |
updateDomain(UpdateDomainRequest updateDomainRequest)
Updates the specified domain.
|
static final String ENDPOINT_PREFIX
CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
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.DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes the specified domain from the Amazon Connect Voice ID system.
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.DeleteFraudsterResult deleteFraudster(DeleteFraudsterRequest deleteFraudsterRequest)
Deletes the specified fraudster from the Amazon Connect Voice ID system.
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.DeleteSpeakerResult deleteSpeaker(DeleteSpeakerRequest deleteSpeakerRequest)
Deletes the specified speaker from the Amazon Connect Voice ID system.
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.DescribeDomainResult describeDomain(DescribeDomainRequest describeDomainRequest)
Describes the specified domain.
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.DescribeFraudsterResult describeFraudster(DescribeFraudsterRequest describeFraudsterRequest)
Describes the specified fraudster.
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.DescribeFraudsterRegistrationJobResult describeFraudsterRegistrationJob(DescribeFraudsterRegistrationJobRequest describeFraudsterRegistrationJobRequest)
Describes the specified fraudster registration job.
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.DescribeSpeakerResult describeSpeaker(DescribeSpeakerRequest describeSpeakerRequest)
Describes the specified speaker.
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.DescribeSpeakerEnrollmentJobResult describeSpeakerEnrollmentJob(DescribeSpeakerEnrollmentJobRequest describeSpeakerEnrollmentJobRequest)
Describes the specified speaker enrollment job.
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.EvaluateSessionResult evaluateSession(EvaluateSessionRequest evaluateSessionRequest)
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
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.ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
Lists all the domains in the Amazon Web Services account.
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.ListFraudsterRegistrationJobsResult listFraudsterRegistrationJobs(ListFraudsterRegistrationJobsRequest listFraudsterRegistrationJobsRequest)
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.
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.ListSpeakerEnrollmentJobsResult listSpeakerEnrollmentJobs(ListSpeakerEnrollmentJobsRequest listSpeakerEnrollmentJobsRequest)
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.
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.ListSpeakersResult listSpeakers(ListSpeakersRequest listSpeakersRequest)
Lists all speakers in a specified domain.
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a specified Voice ID resource.
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.OptOutSpeakerResult optOutSpeaker(OptOutSpeakerRequest optOutSpeakerRequest)
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.
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.StartFraudsterRegistrationJobResult startFraudsterRegistrationJob(StartFraudsterRegistrationJobRequest startFraudsterRegistrationJobRequest)
Starts a new batch fraudster registration job using provided details.
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.StartSpeakerEnrollmentJobResult startSpeakerEnrollmentJob(StartSpeakerEnrollmentJobRequest startSpeakerEnrollmentJobRequest)
Starts a new batch speaker enrollment job using specified details.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Tags an Amazon Connect Voice ID resource with the provided list of tags.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes specified tags from a specified Amazon Connect Voice ID resource.
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.UpdateDomainResult updateDomain(UpdateDomainRequest updateDomainRequest)
Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.
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.void shutdown()
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 a request.
request
- The originally executed request.