aws-sdk/clients/voiceid.d.ts

AWS SDK for JavaScript

import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class VoiceID extends Service {
  /**
   * Constructs a service object. This object has one method for each API operation.
   */
  constructor(options?: VoiceID.Types.ClientConfiguration)
  config: Config & VoiceID.Types.ClientConfiguration;
  /**
   * Associates the fraudsters with the watchlist specified in the same domain. 
   */
  associateFraudster(params: VoiceID.Types.AssociateFraudsterRequest, callback?: (err: AWSError, data: VoiceID.Types.AssociateFraudsterResponse) => void): Request<VoiceID.Types.AssociateFraudsterResponse, AWSError>;
  /**
   * Associates the fraudsters with the watchlist specified in the same domain. 
   */
  associateFraudster(callback?: (err: AWSError, data: VoiceID.Types.AssociateFraudsterResponse) => void): Request<VoiceID.Types.AssociateFraudsterResponse, AWSError>;
  /**
   * 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.
   */
  createDomain(params: VoiceID.Types.CreateDomainRequest, callback?: (err: AWSError, data: VoiceID.Types.CreateDomainResponse) => void): Request<VoiceID.Types.CreateDomainResponse, AWSError>;
  /**
   * 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.
   */
  createDomain(callback?: (err: AWSError, data: VoiceID.Types.CreateDomainResponse) => void): Request<VoiceID.Types.CreateDomainResponse, AWSError>;
  /**
   * Creates a watchlist that fraudsters can be a part of.
   */
  createWatchlist(params: VoiceID.Types.CreateWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.CreateWatchlistResponse) => void): Request<VoiceID.Types.CreateWatchlistResponse, AWSError>;
  /**
   * Creates a watchlist that fraudsters can be a part of.
   */
  createWatchlist(callback?: (err: AWSError, data: VoiceID.Types.CreateWatchlistResponse) => void): Request<VoiceID.Types.CreateWatchlistResponse, AWSError>;
  /**
   * Deletes the specified domain from Voice ID.
   */
  deleteDomain(params: VoiceID.Types.DeleteDomainRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Deletes the specified domain from Voice ID.
   */
  deleteDomain(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
   */
  deleteFraudster(params: VoiceID.Types.DeleteFraudsterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
   */
  deleteFraudster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Deletes the specified speaker from Voice ID.
   */
  deleteSpeaker(params: VoiceID.Types.DeleteSpeakerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Deletes the specified speaker from Voice ID.
   */
  deleteSpeaker(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * 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. 
   */
  deleteWatchlist(params: VoiceID.Types.DeleteWatchlistRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * 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. 
   */
  deleteWatchlist(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  /**
   * Describes the specified domain.
   */
  describeDomain(params: VoiceID.Types.DescribeDomainRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeDomainResponse) => void): Request<VoiceID.Types.DescribeDomainResponse, AWSError>;
  /**
   * Describes the specified domain.
   */
  describeDomain(callback?: (err: AWSError, data: VoiceID.Types.DescribeDomainResponse) => void): Request<VoiceID.Types.DescribeDomainResponse, AWSError>;
  /**
   * Describes the specified fraudster.
   */
  describeFraudster(params: VoiceID.Types.DescribeFraudsterRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeFraudsterResponse) => void): Request<VoiceID.Types.DescribeFraudsterResponse, AWSError>;
  /**
   * Describes the specified fraudster.
   */
  describeFraudster(callback?: (err: AWSError, data: VoiceID.Types.DescribeFraudsterResponse) => void): Request<VoiceID.Types.DescribeFraudsterResponse, AWSError>;
  /**
   * Describes the specified fraudster registration job.
   */
  describeFraudsterRegistrationJob(params: VoiceID.Types.DescribeFraudsterRegistrationJobRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeFraudsterRegistrationJobResponse) => void): Request<VoiceID.Types.DescribeFraudsterRegistrationJobResponse, AWSError>;
  /**
   * Describes the specified fraudster registration job.
   */
  describeFraudsterRegistrationJob(callback?: (err: AWSError, data: VoiceID.Types.DescribeFraudsterRegistrationJobResponse) => void): Request<VoiceID.Types.DescribeFraudsterRegistrationJobResponse, AWSError>;
  /**
   * Describes the specified speaker.
   */
  describeSpeaker(params: VoiceID.Types.DescribeSpeakerRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeSpeakerResponse) => void): Request<VoiceID.Types.DescribeSpeakerResponse, AWSError>;
  /**
   * Describes the specified speaker.
   */
  describeSpeaker(callback?: (err: AWSError, data: VoiceID.Types.DescribeSpeakerResponse) => void): Request<VoiceID.Types.DescribeSpeakerResponse, AWSError>;
  /**
   * Describes the specified speaker enrollment job.
   */
  describeSpeakerEnrollmentJob(params: VoiceID.Types.DescribeSpeakerEnrollmentJobRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeSpeakerEnrollmentJobResponse) => void): Request<VoiceID.Types.DescribeSpeakerEnrollmentJobResponse, AWSError>;
  /**
   * Describes the specified speaker enrollment job.
   */
  describeSpeakerEnrollmentJob(callback?: (err: AWSError, data: VoiceID.Types.DescribeSpeakerEnrollmentJobResponse) => void): Request<VoiceID.Types.DescribeSpeakerEnrollmentJobResponse, AWSError>;
  /**
   * Describes the specified watchlist.
   */
  describeWatchlist(params: VoiceID.Types.DescribeWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.DescribeWatchlistResponse) => void): Request<VoiceID.Types.DescribeWatchlistResponse, AWSError>;
  /**
   * Describes the specified watchlist.
   */
  describeWatchlist(callback?: (err: AWSError, data: VoiceID.Types.DescribeWatchlistResponse) => void): Request<VoiceID.Types.DescribeWatchlistResponse, AWSError>;
  /**
   * 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. 
   */
  disassociateFraudster(params: VoiceID.Types.DisassociateFraudsterRequest, callback?: (err: AWSError, data: VoiceID.Types.DisassociateFraudsterResponse) => void): Request<VoiceID.Types.DisassociateFraudsterResponse, AWSError>;
  /**
   * 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. 
   */
  disassociateFraudster(callback?: (err: AWSError, data: VoiceID.Types.DisassociateFraudsterResponse) => void): Request<VoiceID.Types.DisassociateFraudsterResponse, AWSError>;
  /**
   * Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
   */
  evaluateSession(params: VoiceID.Types.EvaluateSessionRequest, callback?: (err: AWSError, data: VoiceID.Types.EvaluateSessionResponse) => void): Request<VoiceID.Types.EvaluateSessionResponse, AWSError>;
  /**
   * Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
   */
  evaluateSession(callback?: (err: AWSError, data: VoiceID.Types.EvaluateSessionResponse) => void): Request<VoiceID.Types.EvaluateSessionResponse, AWSError>;
  /**
   * Lists all the domains in the Amazon Web Services account. 
   */
  listDomains(params: VoiceID.Types.ListDomainsRequest, callback?: (err: AWSError, data: VoiceID.Types.ListDomainsResponse) => void): Request<VoiceID.Types.ListDomainsResponse, AWSError>;
  /**
   * Lists all the domains in the Amazon Web Services account. 
   */
  listDomains(callback?: (err: AWSError, data: VoiceID.Types.ListDomainsResponse) => void): Request<VoiceID.Types.ListDomainsResponse, AWSError>;
  /**
   * 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(params: VoiceID.Types.ListFraudsterRegistrationJobsRequest, callback?: (err: AWSError, data: VoiceID.Types.ListFraudsterRegistrationJobsResponse) => void): Request<VoiceID.Types.ListFraudsterRegistrationJobsResponse, AWSError>;
  /**
   * 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(callback?: (err: AWSError, data: VoiceID.Types.ListFraudsterRegistrationJobsResponse) => void): Request<VoiceID.Types.ListFraudsterRegistrationJobsResponse, AWSError>;
  /**
   * Lists all fraudsters in a specified watchlist or domain.
   */
  listFraudsters(params: VoiceID.Types.ListFraudstersRequest, callback?: (err: AWSError, data: VoiceID.Types.ListFraudstersResponse) => void): Request<VoiceID.Types.ListFraudstersResponse, AWSError>;
  /**
   * Lists all fraudsters in a specified watchlist or domain.
   */
  listFraudsters(callback?: (err: AWSError, data: VoiceID.Types.ListFraudstersResponse) => void): Request<VoiceID.Types.ListFraudstersResponse, AWSError>;
  /**
   * 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(params: VoiceID.Types.ListSpeakerEnrollmentJobsRequest, callback?: (err: AWSError, data: VoiceID.Types.ListSpeakerEnrollmentJobsResponse) => void): Request<VoiceID.Types.ListSpeakerEnrollmentJobsResponse, AWSError>;
  /**
   * 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(callback?: (err: AWSError, data: VoiceID.Types.ListSpeakerEnrollmentJobsResponse) => void): Request<VoiceID.Types.ListSpeakerEnrollmentJobsResponse, AWSError>;
  /**
   * Lists all speakers in a specified domain.
   */
  listSpeakers(params: VoiceID.Types.ListSpeakersRequest, callback?: (err: AWSError, data: VoiceID.Types.ListSpeakersResponse) => void): Request<VoiceID.Types.ListSpeakersResponse, AWSError>;
  /**
   * Lists all speakers in a specified domain.
   */
  listSpeakers(callback?: (err: AWSError, data: VoiceID.Types.ListSpeakersResponse) => void): Request<VoiceID.Types.ListSpeakersResponse, AWSError>;
  /**
   * Lists all tags associated with a specified Voice ID resource.
   */
  listTagsForResource(params: VoiceID.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: VoiceID.Types.ListTagsForResourceResponse) => void): Request<VoiceID.Types.ListTagsForResourceResponse, AWSError>;
  /**
   * Lists all tags associated with a specified Voice ID resource.
   */
  listTagsForResource(callback?: (err: AWSError, data: VoiceID.Types.ListTagsForResourceResponse) => void): Request<VoiceID.Types.ListTagsForResourceResponse, AWSError>;
  /**
   * Lists all watchlists in a specified domain.
   */
  listWatchlists(params: VoiceID.Types.ListWatchlistsRequest, callback?: (err: AWSError, data: VoiceID.Types.ListWatchlistsResponse) => void): Request<VoiceID.Types.ListWatchlistsResponse, AWSError>;
  /**
   * Lists all watchlists in a specified domain.
   */
  listWatchlists(callback?: (err: AWSError, data: VoiceID.Types.ListWatchlistsResponse) => void): Request<VoiceID.Types.ListWatchlistsResponse, AWSError>;
  /**
   * 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.
   */
  optOutSpeaker(params: VoiceID.Types.OptOutSpeakerRequest, callback?: (err: AWSError, data: VoiceID.Types.OptOutSpeakerResponse) => void): Request<VoiceID.Types.OptOutSpeakerResponse, AWSError>;
  /**
   * 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.
   */
  optOutSpeaker(callback?: (err: AWSError, data: VoiceID.Types.OptOutSpeakerResponse) => void): Request<VoiceID.Types.OptOutSpeakerResponse, AWSError>;
  /**
   * Starts a new batch fraudster registration job using provided details.
   */
  startFraudsterRegistrationJob(params: VoiceID.Types.StartFraudsterRegistrationJobRequest, callback?: (err: AWSError, data: VoiceID.Types.StartFraudsterRegistrationJobResponse) => void): Request<VoiceID.Types.StartFraudsterRegistrationJobResponse, AWSError>;
  /**
   * Starts a new batch fraudster registration job using provided details.
   */
  startFraudsterRegistrationJob(callback?: (err: AWSError, data: VoiceID.Types.StartFraudsterRegistrationJobResponse) => void): Request<VoiceID.Types.StartFraudsterRegistrationJobResponse, AWSError>;
  /**
   * Starts a new batch speaker enrollment job using specified details.
   */
  startSpeakerEnrollmentJob(params: VoiceID.Types.StartSpeakerEnrollmentJobRequest, callback?: (err: AWSError, data: VoiceID.Types.StartSpeakerEnrollmentJobResponse) => void): Request<VoiceID.Types.StartSpeakerEnrollmentJobResponse, AWSError>;
  /**
   * Starts a new batch speaker enrollment job using specified details.
   */
  startSpeakerEnrollmentJob(callback?: (err: AWSError, data: VoiceID.Types.StartSpeakerEnrollmentJobResponse) => void): Request<VoiceID.Types.StartSpeakerEnrollmentJobResponse, AWSError>;
  /**
   * Tags a Voice ID resource with the provided list of tags.
   */
  tagResource(params: VoiceID.Types.TagResourceRequest, callback?: (err: AWSError, data: VoiceID.Types.TagResourceResponse) => void): Request<VoiceID.Types.TagResourceResponse, AWSError>;
  /**
   * Tags a Voice ID resource with the provided list of tags.
   */
  tagResource(callback?: (err: AWSError, data: VoiceID.Types.TagResourceResponse) => void): Request<VoiceID.Types.TagResourceResponse, AWSError>;
  /**
   * Removes specified tags from a specified Amazon Connect Voice ID resource.
   */
  untagResource(params: VoiceID.Types.UntagResourceRequest, callback?: (err: AWSError, data: VoiceID.Types.UntagResourceResponse) => void): Request<VoiceID.Types.UntagResourceResponse, AWSError>;
  /**
   * Removes specified tags from a specified Amazon Connect Voice ID resource.
   */
  untagResource(callback?: (err: AWSError, data: VoiceID.Types.UntagResourceResponse) => void): Request<VoiceID.Types.UntagResourceResponse, AWSError>;
  /**
   * 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(params: VoiceID.Types.UpdateDomainRequest, callback?: (err: AWSError, data: VoiceID.Types.UpdateDomainResponse) => void): Request<VoiceID.Types.UpdateDomainResponse, AWSError>;
  /**
   * 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(callback?: (err: AWSError, data: VoiceID.Types.UpdateDomainResponse) => void): Request<VoiceID.Types.UpdateDomainResponse, AWSError>;
  /**
   * Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. 
   */
  updateWatchlist(params: VoiceID.Types.UpdateWatchlistRequest, callback?: (err: AWSError, data: VoiceID.Types.UpdateWatchlistResponse) => void): Request<VoiceID.Types.UpdateWatchlistResponse, AWSError>;
  /**
   * Updates the specified watchlist. Every domain has a default watchlist which cannot be updated. 
   */
  updateWatchlist(callback?: (err: AWSError, data: VoiceID.Types.UpdateWatchlistResponse) => void): Request<VoiceID.Types.UpdateWatchlistResponse, AWSError>;
}
declare namespace VoiceID {
  export type AmazonResourceName = string;
  export type Arn = string;
  export interface AssociateFraudsterRequest {
    /**
     * The identifier of the domain that contains the fraudster.
     */
    DomainId: DomainId;
    /**
     * The identifier of the fraudster to be associated with the watchlist.
     */
    FraudsterId: FraudsterId;
    /**
     * The identifier of the watchlist you want to associate with the fraudster.
     */
    WatchlistId: WatchlistId;
  }
  export interface AssociateFraudsterResponse {
    Fraudster?: Fraudster;
  }
  export interface AuthenticationConfiguration {
    /**
     * The minimum threshold needed to successfully authenticate a speaker.
     */
    AcceptanceThreshold: Score;
  }
  export type AuthenticationDecision = "ACCEPT"|"REJECT"|"NOT_ENOUGH_SPEECH"|"SPEAKER_NOT_ENROLLED"|"SPEAKER_OPTED_OUT"|"SPEAKER_ID_NOT_PROVIDED"|"SPEAKER_EXPIRED"|string;
  export interface AuthenticationResult {
    /**
     * A timestamp of when audio aggregation ended for this authentication result.
     */
    AudioAggregationEndedAt?: Timestamp;
    /**
     * A timestamp of when audio aggregation started for this authentication result.
     */
    AudioAggregationStartedAt?: Timestamp;
    /**
     * The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold changes, or SpeakerId changes, Voice ID always returns cached Authentication Result for this API.
     */
    AuthenticationResultId?: UniqueIdLarge;
    /**
     * The AuthenticationConfiguration used to generate this authentication result.
     */
    Configuration?: AuthenticationConfiguration;
    /**
     * The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.
     */
    CustomerSpeakerId?: CustomerSpeakerId;
    /**
     * The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
     */
    Decision?: AuthenticationDecision;
    /**
     * The service-generated identifier for the speaker whose authentication result is produced.
     */
    GeneratedSpeakerId?: GeneratedSpeakerId;
    /**
     * The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT or REJECT.
     */
    Score?: Score;
  }
  export type Boolean = boolean;
  export type ClientTokenString = string;
  export interface CreateDomainRequest {
    /**
     * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
     */
    ClientToken?: ClientTokenString;
    /**
     * A brief description of this domain.
     */
    Description?: Description;
    /**
     * The name of the domain.
     */
    Name: DomainName;
    /**
     * The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to  Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used. 
     */
    ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration;
    /**
     * A list of tags you want added to the domain.
     */
    Tags?: TagList;
  }
  export interface CreateDomainResponse {
    /**
     * Information about the newly created domain.
     */
    Domain?: Domain;
  }
  export interface CreateWatchlistRequest {
    /**
     * A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
     */
    ClientToken?: ClientTokenString;
    /**
     * A brief description of this watchlist.
     */
    Description?: WatchlistDescription;
    /**
     * The identifier of the domain that contains the watchlist.
     */
    DomainId: DomainId;
    /**
     * The name of the watchlist.
     */
    Name: WatchlistName;
  }
  export interface CreateWatchlistResponse {
    /**
     * Information about the newly created watchlist.
     */
    Watchlist?: Watchlist;
  }
  export type CustomerSpeakerId = string;
  export interface DeleteDomainRequest {
    /**
     * The identifier of the domain you want to delete.
     */
    DomainId: DomainId;
  }
  export interface DeleteFraudsterRequest {
    /**
     * The identifier of the domain that contains the fraudster.
     */
    DomainId: DomainId;
    /**
     * The identifier of the fraudster you want to delete.
     */
    FraudsterId: FraudsterId;
  }
  export interface DeleteSpeakerRequest {
    /**
     * The identifier of the domain that contains the speaker.
     */
    DomainId: DomainId;
    /**
     * The identifier of the speaker you want to delete.
     */
    SpeakerId: SpeakerId;
  }
  export interface DeleteWatchlistRequest {
    /**
     * The identifier of the domain that contains the watchlist.
     */
    DomainId: DomainId;
    /**
     * The identifier of the watchlist to be deleted.
     */
    WatchlistId: WatchlistId;
  }
  export interface DescribeDomainRequest {
    /**
     * The identifier of the domain that you are describing.
     */
    DomainId: DomainId;
  }
  export interface DescribeDomainResponse {
    /**
     * Information about the specified domain.
     */
    Domain?: Domain;
  }
  export interface DescribeFraudsterRegistrationJobRequest {
    /**
     * The identifier of the domain that contains the fraudster registration job.
     */
    DomainId: DomainId;
    /**
     * The identifier of the fraudster registration job you are describing.
     */
    JobId: JobId;
  }
  export interface DescribeFraudsterRegistrationJobResponse {
    /**
     * Contains details about the specified fraudster registration job.
     */
    Job?: FraudsterRegistrationJob;
  }
  export interface DescribeFraudsterRequest {
    /**
     * The identifier of the domain that contains the fraudster.
     */
    DomainId: DomainId;
    /**
     * The identifier of the fraudster you are describing.
     */
    FraudsterId: FraudsterId;
  }
  export interface DescribeFraudsterResponse {
    /**
     * Information about the specified fraudster.
     */
    Fraudster?: Fraudster;
  }
  export interface DescribeSpeakerEnrollmentJobRequest {
    /**
     * The identifier of the domain that contains the speaker enrollment job.
     */
    DomainId: DomainId;
    /**
     * The identifier of the speaker enrollment job you are describing.
     */
    JobId: JobId;
  }
  export interface DescribeSpeakerEnrollmentJobResponse {
    /**
     * Contains details about the specified speaker enrollment job.
     */
    Job?: SpeakerEnrollmentJob;
  }
  export interface DescribeSpeakerRequest {
    /**
     * The identifier of the domain that contains the speaker.
     */
    DomainId: DomainId;
    /**
     * The identifier of the speaker you are describing.
     */
    SpeakerId: SpeakerId;
  }
  export interface DescribeSpeakerResponse {
    /**
     * Information about the specified speaker.
     */
    Speaker?: Speaker;
  }
  export interface DescribeWatchlistRequest {
    /**
     * The identifier of the domain that contains the watchlist.
     */
    DomainId: DomainId;
    /**
     * The identifier of the watchlist that you are describing.
     */
    WatchlistId: WatchlistId;
  }
  export interface DescribeWatchlistResponse {
    /**
     * Information about the specified watchlist.
     */
    Watchlist?: Watchlist;
  }
  export type Description = string;
  export interface DisassociateFraudsterRequest {
    /**
     * The identifier of the domain that contains the fraudster.
     */
    DomainId: DomainId;
    /**
     * The identifier of the fraudster to be disassociated from the watchlist.
     */
    FraudsterId: FraudsterId;
    /**
     * The identifier of the watchlist that you want to disassociate from the fraudster.
     */
    WatchlistId: WatchlistId;
  }
  export interface DisassociateFraudsterResponse {
    Fraudster?: Fraudster;
  }
  export interface Domain {
    /**
     * The Amazon Resource Name (ARN) for the domain.
     */
    Arn?: Arn;
    /**
     * The timestamp of when the domain was created.
     */
    CreatedAt?: Timestamp;
    /**
     * The description of the domain.
     */
    Description?: Description;
    /**
     * The identifier of the domain.
     */
    DomainId?: DomainId;
    /**
     * The current status of the domain.
     */
    DomainStatus?: DomainStatus;
    /**
     * The name for the domain.
     */
    Name?: DomainName;
    /**
     * The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
     */
    ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
    /**
     * Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
     */
    ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
    /**
     * The timestamp of when the domain was last update.
     */
    UpdatedAt?: Timestamp;
    /**
     * The watchlist details of a domain. Contains the default watchlist ID of the domain.
     */
    WatchlistDetails?: WatchlistDetails;
  }
  export type DomainId = string;
  export type DomainName = string;
  export type DomainStatus = "ACTIVE"|"PENDING"|"SUSPENDED"|string;
  export type DomainSummaries = DomainSummary[];
  export interface DomainSummary {
    /**
     * The Amazon Resource Name (ARN) for the domain.
     */
    Arn?: Arn;
    /**
     * The timestamp of when the domain was created.
     */
    CreatedAt?: Timestamp;
    /**
     * The description of the domain.
     */
    Description?: Description;
    /**
     * The identifier of the domain.
     */
    DomainId?: DomainId;
    /**
     * The current status of the domain.
     */
    DomainStatus?: DomainStatus;
    /**
     * The client-provided name for the domain.
     */
    Name?: DomainName;
    /**
     * The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
     */
    ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
    /**
     * Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
     */
    ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
    /**
     * The timestamp of when the domain was last updated.
     */
    UpdatedAt?: Timestamp;
    /**
     * Provides information about watchlistDetails and DefaultWatchlistID. 
     */
    WatchlistDetails?: WatchlistDetails;
  }
  export type DuplicateRegistrationAction = "SKIP"|"REGISTER_AS_NEW"|string;
  export interface EnrollmentConfig {
    /**
     *  The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP, which skips the enrollment for the existing speaker. Setting the value to OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.
     */
    ExistingEnrollmentAction?: ExistingEnrollmentAction;
    /**
     * The fraud detection configuration to use for the speaker enrollment job.
     */
    FraudDetectionConfig?: EnrollmentJobFraudDetectionConfig;
  }
  export interface EnrollmentJobFraudDetectionConfig {
    /**
     * The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL, which fails the speaker enrollment. Changing this value to IGNORE results in the speaker being enrolled even if they are flagged by the fraud detection system.
     */
    FraudDetectionAction?: FraudDetectionAction;
    /**
     * Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
     */
    RiskThreshold?: Score;
    /**
     * The identifier of watchlists against which fraud detection is performed. 
     */
    WatchlistIds?: EnrollmentJobFraudDetectionConfigWatchlistIds;
  }
  export type EnrollmentJobFraudDetectionConfigWatchlistIds = WatchlistId[];
  export interface EvaluateSessionRequest {
    /**
     * The identifier of the domain where the session started.
     */
    DomainId: DomainId;
    /**
     * The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.
     */
    SessionNameOrId: SessionNameOrId;
  }
  export interface EvaluateSessionResponse {
    /**
     * Details resulting from the authentication process, such as authentication decision and authentication score.
     */
    AuthenticationResult?: AuthenticationResult;
    /**
     * The identifier of the domain that contains the session.
     */
    DomainId?: DomainId;
    /**
     * Details resulting from the fraud detection process, such as fraud detection decision and risk score.
     */
    FraudDetectionResult?: FraudDetectionResult;
    /**
     * The service-generated identifier of the session.
     */
    SessionId?: SessionId;
    /**
     * The client-provided name of the session.
     */
    SessionName?: SessionName;
    /**
     * The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
     */
    StreamingStatus?: StreamingStatus;
  }
  export type ExistingEnrollmentAction = "SKIP"|"OVERWRITE"|string;
  export interface FailureDetails {
    /**
     * A description of the error that caused the batch job failure.
     */
    Message?: String;
    /**
     * An HTTP status code representing the nature of the error.
     */
    StatusCode?: Integer;
  }
  export type FraudDetectionAction = "IGNORE"|"FAIL"|string;
  export interface FraudDetectionConfiguration {
    /**
     * Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
     */
    RiskThreshold?: Score;
    /**
     * The identifier of the watchlist against which fraud detection is performed. 
     */
    WatchlistId?: WatchlistId;
  }
  export type FraudDetectionDecision = "HIGH_RISK"|"LOW_RISK"|"NOT_ENOUGH_SPEECH"|string;
  export type FraudDetectionReason = "KNOWN_FRAUDSTER"|"VOICE_SPOOFING"|string;
  export type FraudDetectionReasons = FraudDetectionReason[];
  export interface FraudDetectionResult {
    /**
     * A timestamp of when audio aggregation ended for this fraud detection result.
     */
    AudioAggregationEndedAt?: Timestamp;
    /**
     * A timestamp of when audio aggregation started for this fraud detection result.
     */
    AudioAggregationStartedAt?: Timestamp;
    /**
     * The FraudDetectionConfiguration used to generate this fraud detection result.
     */
    Configuration?: FraudDetectionConfiguration;
    /**
     * The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
     */
    Decision?: FraudDetectionDecision;
    /**
     * The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
     */
    FraudDetectionResultId?: UniqueIdLarge;
    /**
     * The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.
     */
    Reasons?: FraudDetectionReasons;
    /**
     * Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.
     */
    RiskDetails?: FraudRiskDetails;
  }
  export interface FraudRiskDetails {
    /**
     * The details resulting from 'Known Fraudster Risk' analysis of the speaker.
     */
    KnownFraudsterRisk: KnownFraudsterRisk;
    /**
     * The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
     */
    VoiceSpoofingRisk: VoiceSpoofingRisk;
  }
  export interface Fraudster {
    /**
     * The timestamp of when Voice ID identified the fraudster.
     */
    CreatedAt?: Timestamp;
    /**
     * The identifier of the domain that contains the fraudster.
     */
    DomainId?: DomainId;
    /**
     * The service-generated identifier for the fraudster.
     */
    GeneratedFraudsterId?: GeneratedFraudsterId;
    /**
     * The identifier of the watchlists the fraudster is a part of.
     */
    WatchlistIds?: ResponseWatchlistIds;
  }
  export type FraudsterId = string;
  export interface FraudsterRegistrationJob {
    /**
     * A timestamp of when the fraudster registration job was created.
     */
    CreatedAt?: Timestamp;
    /**
     * The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
     */
    DataAccessRoleArn?: IamRoleArn;
    /**
     * The identifier of the domain that contains the fraudster registration job.
     */
    DomainId?: DomainId;
    /**
     * A timestamp of when the fraudster registration job ended.
     */
    EndedAt?: Timestamp;
    /**
     * Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
     */
    FailureDetails?: FailureDetails;
    /**
     * The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
     */
    InputDataConfig?: InputDataConfig;
    /**
     * The service-generated identifier for the fraudster registration job.
     */
    JobId?: JobId;
    /**
     * The client-provided name for the fraudster registration job.
     */
    JobName?: JobName;
    /**
     * Shows the completed percentage of registration requests listed in the input file.
     */
    JobProgress?: JobProgress;
    /**
     * The current status of the fraudster registration job.
     */
    JobStatus?: FraudsterRegistrationJobStatus;
    /**
     * The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
     */
    OutputDataConfig?: OutputDataConfig;
    /**
     * The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
     */
    RegistrationConfig?: RegistrationConfig;
  }
  export type FraudsterRegistrationJobStatus = "SUBMITTED"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"FAILED"|string;
  export type FraudsterRegistrationJobSummaries = FraudsterRegistrationJobSummary[];
  export interface FraudsterRegistrationJobSummary {
    /**
     * A timestamp of when the fraudster registration job was created. 
     */
    CreatedAt?: Timestamp;
    /**
     * The identifier of the domain that contains the fraudster registration job.
     */
    DomainId?: DomainId;
    /**
     * A timestamp of when the fraudster registration job ended.
     */
    EndedAt?: Timestamp;
    /**
     * Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
     */
    FailureDetails?: FailureDetails;
    /**
     * The service-generated identifier for the fraudster registration job.
     */
    JobId?: JobId;
    /**
     * The client-provided name for the fraudster registration job.
     */
    JobName?: JobName;
    /**
     * Shows the completed percentage of registration requests listed in the input file.
     */
    JobProgress?: JobProgress;
    /**
     * The current status of the fraudster registration job.
     */
    JobStatus?: FraudsterRegistrationJobStatus;
  }
  export type FraudsterSummaries = FraudsterSummary[];
  export interface FraudsterSummary {
    /**
     * The timestamp of when the fraudster summary was created.
     */
    CreatedAt?: Timestamp;
    /**
     * The identifier of the domain that contains the fraudster summary.
     */
    DomainId?: DomainId;
    /**
     * The service-generated identifier for the fraudster.
     */
    GeneratedFraudsterId?: GeneratedFraudsterId;
    /**
     * The identifier of the watchlists the fraudster is a part of.
     */
    WatchlistIds?: ResponseWatchlistIds;
  }
  export type GeneratedFraudsterId = string;
  export type GeneratedSpeakerId = string;
  export type IamRoleArn = string;
  export interface InputDataConfig {
    /**
     * The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
     */
    S3Uri: S3Uri;
  }
  export type Integer = number;
  export type JobId = string;
  export type JobName = string;
  export interface JobProgress {
    /**
     * Shows the completed percentage of enrollment or registration requests listed in the input file.
     */
    PercentComplete?: Score;
  }
  export type KmsKeyId = string;
  export interface KnownFraudsterRisk {
    /**
     * The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is null.
     */
    GeneratedFraudsterId?: GeneratedFraudsterId;
    /**
     * The score indicating the likelihood the speaker is a known fraudster.
     */
    RiskScore: Score;
  }
  export interface ListDomainsRequest {
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
     */
    MaxResults?: MaxResultsForListDomainFe;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: NextToken;
  }
  export interface ListDomainsResponse {
    /**
     * A list containing details about each domain in the Amazon Web Services account.
     */
    DomainSummaries?: DomainSummaries;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: String;
  }
  export interface ListFraudsterRegistrationJobsRequest {
    /**
     * The identifier of the domain that contains the fraudster registration Jobs.
     */
    DomainId: DomainId;
    /**
     * Provides the status of your fraudster registration job.
     */
    JobStatus?: FraudsterRegistrationJobStatus;
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. 
     */
    MaxResults?: MaxResultsForList;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: NextToken;
  }
  export interface ListFraudsterRegistrationJobsResponse {
    /**
     * A list containing details about each specified fraudster registration job.
     */
    JobSummaries?: FraudsterRegistrationJobSummaries;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: String;
  }
  export interface ListFraudstersRequest {
    /**
     * The identifier of the domain. 
     */
    DomainId: DomainId;
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. 
     */
    MaxResults?: MaxResultsForList;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: NextToken;
    /**
     * The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.
     */
    WatchlistId?: WatchlistId;
  }
  export interface ListFraudstersResponse {
    /**
     * A list that contains details about each fraudster in the Amazon Web Services account. 
     */
    FraudsterSummaries?: FraudsterSummaries;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: String;
  }
  export interface ListSpeakerEnrollmentJobsRequest {
    /**
     * The identifier of the domain that contains the speaker enrollment jobs.
     */
    DomainId: DomainId;
    /**
     * Provides the status of your speaker enrollment Job.
     */
    JobStatus?: SpeakerEnrollmentJobStatus;
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
     */
    MaxResults?: MaxResultsForList;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: NextToken;
  }
  export interface ListSpeakerEnrollmentJobsResponse {
    /**
     * A list containing details about each specified speaker enrollment job.
     */
    JobSummaries?: SpeakerEnrollmentJobSummaries;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: String;
  }
  export interface ListSpeakersRequest {
    /**
     * The identifier of the domain.
     */
    DomainId: DomainId;
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. 
     */
    MaxResults?: MaxResultsForList;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
     */
    NextToken?: NextToken;
  }
  export interface ListSpeakersResponse {
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: String;
    /**
     * A list containing details about each speaker in the Amazon Web Services account. 
     */
    SpeakerSummaries?: SpeakerSummaries;
  }
  export interface ListTagsForResourceRequest {
    /**
     * The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.
     */
    ResourceArn: AmazonResourceName;
  }
  export interface ListTagsForResourceResponse {
    /**
     * The list of tags associated with the specified resource.
     */
    Tags?: TagList;
  }
  export interface ListWatchlistsRequest {
    /**
     * The identifier of the domain.
     */
    DomainId: DomainId;
    /**
     * The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. 
     */
    MaxResults?: MaxResultsForList;
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: NextToken;
  }
  export interface ListWatchlistsResponse {
    /**
     * If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. 
     */
    NextToken?: String;
    /**
     * A list that contains details about each watchlist in the Amazon Web Services account. 
     */
    WatchlistSummaries?: WatchlistSummaries;
  }
  export type MaxResultsForList = number;
  export type MaxResultsForListDomainFe = number;
  export type NextToken = string;
  export interface OptOutSpeakerRequest {
    /**
     * The identifier of the domain that contains the speaker.
     */
    DomainId: DomainId;
    /**
     * The identifier of the speaker you want opted-out.
     */
    Sp