/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the voice-id-2021-09-27.normal.json service model.
*/
using System;
using System.Threading;
using System.Threading.Tasks;
using System.Collections.Generic;
using Amazon.Runtime;
using Amazon.VoiceID.Model;
namespace Amazon.VoiceID
{
///
/// Interface for accessing VoiceID
///
/// Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection,
/// which make voice interactions in contact centers more secure and efficient.
///
public partial interface IAmazonVoiceID : IAmazonService, IDisposable
{
#if AWS_ASYNC_ENUMERABLES_API
///
/// Paginators for the service
///
IVoiceIDPaginatorFactory Paginators { get; }
#endif
#region AssociateFraudster
///
/// Associates the fraudsters with the watchlist specified in the same domain.
///
/// Container for the necessary parameters to execute the AssociateFraudster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the AssociateFraudster service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for AssociateFraudster Operation
Task AssociateFraudsterAsync(AssociateFraudsterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateDomain
///
/// 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.
///
/// Container for the necessary parameters to execute the CreateDomain service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateDomain service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for CreateDomain Operation
Task CreateDomainAsync(CreateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region CreateWatchlist
///
/// Creates a watchlist that fraudsters can be a part of.
///
/// Container for the necessary parameters to execute the CreateWatchlist service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the CreateWatchlist service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for CreateWatchlist Operation
Task CreateWatchlistAsync(CreateWatchlistRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteDomain
///
/// Deletes the specified domain from Voice ID.
///
/// Container for the necessary parameters to execute the DeleteDomain service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteDomain service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DeleteDomain Operation
Task DeleteDomainAsync(DeleteDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteFraudster
///
/// Deletes the specified fraudster from Voice ID. This action disassociates the fraudster
/// from any watchlists it is a part of.
///
/// Container for the necessary parameters to execute the DeleteFraudster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteFraudster service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DeleteFraudster Operation
Task DeleteFraudsterAsync(DeleteFraudsterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteSpeaker
///
/// Deletes the specified speaker from Voice ID.
///
/// Container for the necessary parameters to execute the DeleteSpeaker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteSpeaker service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DeleteSpeaker Operation
Task DeleteSpeakerAsync(DeleteSpeakerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DeleteWatchlist
///
/// 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.
///
/// Container for the necessary parameters to execute the DeleteWatchlist service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DeleteWatchlist service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DeleteWatchlist Operation
Task DeleteWatchlistAsync(DeleteWatchlistRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeDomain
///
/// Describes the specified domain.
///
/// Container for the necessary parameters to execute the DescribeDomain service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeDomain service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeDomain Operation
Task DescribeDomainAsync(DescribeDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFraudster
///
/// Describes the specified fraudster.
///
/// Container for the necessary parameters to execute the DescribeFraudster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFraudster service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeFraudster Operation
Task DescribeFraudsterAsync(DescribeFraudsterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeFraudsterRegistrationJob
///
/// Describes the specified fraudster registration job.
///
/// Container for the necessary parameters to execute the DescribeFraudsterRegistrationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeFraudsterRegistrationJob service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeFraudsterRegistrationJob Operation
Task DescribeFraudsterRegistrationJobAsync(DescribeFraudsterRegistrationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSpeaker
///
/// Describes the specified speaker.
///
/// Container for the necessary parameters to execute the DescribeSpeaker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSpeaker service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeSpeaker Operation
Task DescribeSpeakerAsync(DescribeSpeakerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeSpeakerEnrollmentJob
///
/// Describes the specified speaker enrollment job.
///
/// Container for the necessary parameters to execute the DescribeSpeakerEnrollmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeSpeakerEnrollmentJob service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeSpeakerEnrollmentJob Operation
Task DescribeSpeakerEnrollmentJobAsync(DescribeSpeakerEnrollmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DescribeWatchlist
///
/// Describes the specified watchlist.
///
/// Container for the necessary parameters to execute the DescribeWatchlist service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DescribeWatchlist service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DescribeWatchlist Operation
Task DescribeWatchlistAsync(DescribeWatchlistRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region DisassociateFraudster
///
/// 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.
///
/// Container for the necessary parameters to execute the DisassociateFraudster service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the DisassociateFraudster service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for DisassociateFraudster Operation
Task DisassociateFraudsterAsync(DisassociateFraudsterRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region EvaluateSession
///
/// Evaluates a specified session based on audio data accumulated during a streaming Amazon
/// Connect Voice ID call.
///
/// Container for the necessary parameters to execute the EvaluateSession service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the EvaluateSession service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for EvaluateSession Operation
Task EvaluateSessionAsync(EvaluateSessionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListDomains
///
/// Lists all the domains in the Amazon Web Services account.
///
/// Container for the necessary parameters to execute the ListDomains service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListDomains service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListDomains Operation
Task ListDomainsAsync(ListDomainsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFraudsterRegistrationJobs
///
/// 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.
///
/// Container for the necessary parameters to execute the ListFraudsterRegistrationJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFraudsterRegistrationJobs service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListFraudsterRegistrationJobs Operation
Task ListFraudsterRegistrationJobsAsync(ListFraudsterRegistrationJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListFraudsters
///
/// Lists all fraudsters in a specified watchlist or domain.
///
/// Container for the necessary parameters to execute the ListFraudsters service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListFraudsters service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListFraudsters Operation
Task ListFraudstersAsync(ListFraudstersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSpeakerEnrollmentJobs
///
/// 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.
///
/// Container for the necessary parameters to execute the ListSpeakerEnrollmentJobs service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSpeakerEnrollmentJobs service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListSpeakerEnrollmentJobs Operation
Task ListSpeakerEnrollmentJobsAsync(ListSpeakerEnrollmentJobsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListSpeakers
///
/// Lists all speakers in a specified domain.
///
/// Container for the necessary parameters to execute the ListSpeakers service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListSpeakers service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListSpeakers Operation
Task ListSpeakersAsync(ListSpeakersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListTagsForResource
///
/// Lists all tags associated with a specified Voice ID resource.
///
/// Container for the necessary parameters to execute the ListTagsForResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListTagsForResource service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListTagsForResource Operation
Task ListTagsForResourceAsync(ListTagsForResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region ListWatchlists
///
/// Lists all watchlists in a specified domain.
///
/// Container for the necessary parameters to execute the ListWatchlists service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the ListWatchlists service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for ListWatchlists Operation
Task ListWatchlistsAsync(ListWatchlistsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region OptOutSpeaker
///
/// 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.
///
/// Container for the necessary parameters to execute the OptOutSpeaker service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the OptOutSpeaker service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for OptOutSpeaker Operation
Task OptOutSpeakerAsync(OptOutSpeakerRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartFraudsterRegistrationJob
///
/// Starts a new batch fraudster registration job using provided details.
///
/// Container for the necessary parameters to execute the StartFraudsterRegistrationJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartFraudsterRegistrationJob service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for StartFraudsterRegistrationJob Operation
Task StartFraudsterRegistrationJobAsync(StartFraudsterRegistrationJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region StartSpeakerEnrollmentJob
///
/// Starts a new batch speaker enrollment job using specified details.
///
/// Container for the necessary parameters to execute the StartSpeakerEnrollmentJob service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the StartSpeakerEnrollmentJob service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// The request exceeded the service quota. Refer to Voice
/// ID Service Quotas and try your request again.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for StartSpeakerEnrollmentJob Operation
Task StartSpeakerEnrollmentJobAsync(StartSpeakerEnrollmentJobRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region TagResource
///
/// Tags a Voice ID resource with the provided list of tags.
///
/// Container for the necessary parameters to execute the TagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the TagResource service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for TagResource Operation
Task TagResourceAsync(TagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UntagResource
///
/// Removes specified tags from a specified Amazon Connect Voice ID resource.
///
/// Container for the necessary parameters to execute the UntagResource service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UntagResource service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for UntagResource Operation
Task UntagResourceAsync(UntagResourceRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateDomain
///
/// 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.
///
/// Container for the necessary parameters to execute the UpdateDomain service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateDomain service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for UpdateDomain Operation
Task UpdateDomainAsync(UpdateDomainRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
#region UpdateWatchlist
///
/// Updates the specified watchlist. Every domain has a default watchlist which cannot
/// be updated.
///
/// Container for the necessary parameters to execute the UpdateWatchlist service method.
///
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
///
///
/// The response from the UpdateWatchlist service method, as returned by VoiceID.
///
/// You do not have sufficient permissions to perform this action. Check the error message
/// and try again.
///
///
/// The request failed due to a conflict. Check the ConflictType
and error
/// message for more details.
///
///
/// The request failed due to an unknown error on the server side.
///
///
/// The specified resource cannot be found. Check the ResourceType
and error
/// message for more details.
///
///
/// 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.
///
///
/// The request failed one or more validations; check the error message for more details.
///
/// REST API Reference for UpdateWatchlist Operation
Task UpdateWatchlistAsync(UpdateWatchlistRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken));
#endregion
}
}