@aws-sdk/client-voice-id 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { VoiceIDServiceException as __BaseException } from "./VoiceIDServiceException";
 /**
+ * @public
  * <p>You do not have sufficient permissions to perform this action. Check the error message
  *             and try again.</p>
  */
@@ -14,6 +15,7 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
+ * @public
  * <p>The configuration used to authenticate a speaker during a session.</p>
  */
 export interface AuthenticationConfiguration {
@@ -22,6 +24,9 @@ export interface AuthenticationConfiguration {
      */
     AcceptanceThreshold: number | undefined;
 }
+/**
+ * @public
+ */
 export declare enum AuthenticationDecision {
     ACCEPT = "ACCEPT",
     NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH",
@@ -32,6 +37,7 @@ export declare enum AuthenticationDecision {
     SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
 }
 /**
+ * @public
  * <p>The authentication result produced by Voice ID, processed against the current session
  *             state and streamed audio of the speaker.</p>
  */
@@ -81,6 +87,9 @@ export interface AuthenticationResult {
      */
     Configuration?: AuthenticationConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum ConflictType {
     ANOTHER_ACTIVE_STREAM = "ANOTHER_ACTIVE_STREAM",
     CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT",
@@ -92,6 +101,7 @@ export declare enum ConflictType {
     SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
 }
 /**
+ * @public
  * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error
  *             message for more details.</p>
  */
@@ -141,6 +151,7 @@ export declare class ConflictException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
 }
 /**
+ * @public
  * <p>The configuration containing information about the customer managed key used for
  *             encrypting customer data.</p>
  */
@@ -152,7 +163,8 @@ export interface ServerSideEncryptionConfiguration {
     KmsKeyId: string | undefined;
 }
 /**
- * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
+ * @public
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
  */
 export interface Tag {
     /**
@@ -166,6 +178,9 @@ export interface Tag {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateDomainRequest {
     /**
      * <p>The name of the domain.</p>
@@ -191,17 +206,24 @@ export interface CreateDomainRequest {
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum DomainStatus {
     ACTIVE = "ACTIVE",
     PENDING = "PENDING",
     SUSPENDED = "SUSPENDED"
 }
+/**
+ * @public
+ */
 export declare enum ServerSideEncryptionUpdateStatus {
     COMPLETED = "COMPLETED",
     FAILED = "FAILED",
     IN_PROGRESS = "IN_PROGRESS"
 }
 /**
+ * @public
  * <p>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.</p>
@@ -227,6 +249,7 @@ export interface ServerSideEncryptionUpdateDetails {
     Message?: string;
 }
 /**
+ * @public
  * <p>Contains all the information about a domain.</p>
  */
 export interface Domain {
@@ -270,6 +293,9 @@ export interface Domain {
      */
     ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
 }
+/**
+ * @public
+ */
 export interface CreateDomainResponse {
     /**
      * <p>Information about the newly created domain.</p>
@@ -277,6 +303,7 @@ export interface CreateDomainResponse {
     Domain?: Domain;
 }
 /**
+ * @public
  * <p>The request failed due to an unknown error on the server side.</p>
  */
 export declare class InternalServerException extends __BaseException {
@@ -288,6 +315,9 @@ export declare class InternalServerException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
 }
+/**
+ * @public
+ */
 export declare enum ResourceType {
     BATCH_JOB = "BATCH_JOB",
     COMPLIANCE_CONSENT = "COMPLIANCE_CONSENT",
@@ -297,6 +327,7 @@ export declare enum ResourceType {
     SPEAKER = "SPEAKER"
 }
 /**
+ * @public
  * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
  *             message for more details.</p>
  */
@@ -316,6 +347,7 @@ export declare class ResourceNotFoundException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request exceeded the service quota. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas">Voice ID Service Quotas</a> and try your request again.</p>
  */
 export declare class ServiceQuotaExceededException extends __BaseException {
@@ -328,6 +360,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was denied due to request throttling. Please slow down your request rate.
  *             Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
  *                 Amazon Connect Voice ID Service API throttling quotas </a> and try your
@@ -343,6 +376,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request failed one or more validations; check the error message for more
  *             details.</p>
  */
@@ -355,12 +389,18 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteDomainRequest {
     /**
      * <p>The identifier of the domain you want to delete.</p>
      */
     DomainId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteFraudsterRequest {
     /**
      * <p>The identifier of the domain containing the fraudster.</p>
@@ -371,6 +411,9 @@ export interface DeleteFraudsterRequest {
      */
     FraudsterId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteSpeakerRequest {
     /**
      * <p>The identifier of the domain containing the speaker.</p>
@@ -381,18 +424,27 @@ export interface DeleteSpeakerRequest {
      */
     SpeakerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeDomainRequest {
     /**
      * <p>The identifier of the domain you are describing.</p>
      */
     DomainId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeDomainResponse {
     /**
      * <p>Information about the specified domain.</p>
      */
     Domain?: Domain;
 }
+/**
+ * @public
+ */
 export interface DescribeFraudsterRequest {
     /**
      * <p>The identifier of the domain containing the fraudster.</p>
@@ -404,6 +456,7 @@ export interface DescribeFraudsterRequest {
     FraudsterId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains all the information about a fraudster.</p>
  */
 export interface Fraudster {
@@ -420,12 +473,18 @@ export interface Fraudster {
      */
     CreatedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeFraudsterResponse {
     /**
      * <p>Information about the specified fraudster.</p>
      */
     Fraudster?: Fraudster;
 }
+/**
+ * @public
+ */
 export interface DescribeFraudsterRegistrationJobRequest {
     /**
      * <p>The identifier for the domain containing the fraudster registration job.</p>
@@ -437,6 +496,7 @@ export interface DescribeFraudsterRegistrationJobRequest {
     JobId: string | undefined;
 }
 /**
+ * @public
  * <p>Contains error details for a failed batch job.</p>
  */
 export interface FailureDetails {
@@ -450,6 +510,7 @@ export interface FailureDetails {
     Message?: string;
 }
 /**
+ * @public
  * <p>The configuration containing input file information for a batch job.</p>
  */
 export interface InputDataConfig {
@@ -460,6 +521,7 @@ export interface InputDataConfig {
     S3Uri: string | undefined;
 }
 /**
+ * @public
  * <p>Indicates the completion progress for a batch job.</p>
  */
 export interface JobProgress {
@@ -469,6 +531,9 @@ export interface JobProgress {
      */
     PercentComplete?: number;
 }
+/**
+ * @public
+ */
 export declare enum FraudsterRegistrationJobStatus {
     COMPLETED = "COMPLETED",
     COMPLETED_WITH_ERRORS = "COMPLETED_WITH_ERRORS",
@@ -477,6 +542,7 @@ export declare enum FraudsterRegistrationJobStatus {
     SUBMITTED = "SUBMITTED"
 }
 /**
+ * @public
  * <p>The configuration containing output file information for a batch job.</p>
  */
 export interface OutputDataConfig {
@@ -495,11 +561,15 @@ export interface OutputDataConfig {
      */
     KmsKeyId?: string;
 }
+/**
+ * @public
+ */
 export declare enum DuplicateRegistrationAction {
     REGISTER_AS_NEW = "REGISTER_AS_NEW",
     SKIP = "SKIP"
 }
 /**
+ * @public
  * <p>The configuration defining the action to take when a duplicate fraudster is detected,
  *             and the similarity threshold to use for detecting a duplicate fraudster during a batch
  *             fraudster registration job.</p>
@@ -519,6 +589,7 @@ export interface RegistrationConfig {
     FraudsterSimilarityThreshold?: number;
 }
 /**
+ * @public
  * <p>Contains all the information about a fraudster registration job.</p>
  */
 export interface FraudsterRegistrationJob {
@@ -582,12 +653,18 @@ export interface FraudsterRegistrationJob {
      */
     JobProgress?: JobProgress;
 }
+/**
+ * @public
+ */
 export interface DescribeFraudsterRegistrationJobResponse {
     /**
      * <p>Contains details about the specified fraudster registration job.</p>
      */
     Job?: FraudsterRegistrationJob;
 }
+/**
+ * @public
+ */
 export interface DescribeSpeakerRequest {
     /**
      * <p>The identifier of the domain that contains the speaker.</p>
@@ -598,6 +675,9 @@ export interface DescribeSpeakerRequest {
      */
     SpeakerId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum SpeakerStatus {
     ENROLLED = "ENROLLED",
     EXPIRED = "EXPIRED",
@@ -605,6 +685,7 @@ export declare enum SpeakerStatus {
     PENDING = "PENDING"
 }
 /**
+ * @public
  * <p>Contains all the information about a speaker.</p>
  */
 export interface Speaker {
@@ -638,12 +719,18 @@ export interface Speaker {
      */
     LastAccessedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeSpeakerResponse {
     /**
      * <p>Information about the specified speaker.</p>
      */
     Speaker?: Speaker;
 }
+/**
+ * @public
+ */
 export interface DescribeSpeakerEnrollmentJobRequest {
     /**
      * <p>The identifier of the domain containing the speaker enrollment job.</p>
@@ -654,15 +741,22 @@ export interface DescribeSpeakerEnrollmentJobRequest {
      */
     JobId: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ExistingEnrollmentAction {
     OVERWRITE = "OVERWRITE",
     SKIP = "SKIP"
 }
+/**
+ * @public
+ */
 export declare enum FraudDetectionAction {
     FAIL = "FAIL",
     IGNORE = "IGNORE"
 }
 /**
+ * @public
  * <p>The configuration defining the action to take when a speaker is flagged by the fraud
  *             detection system during a batch speaker enrollment job, and the risk threshold to use
  *             for identification.</p>
@@ -683,6 +777,7 @@ export interface EnrollmentJobFraudDetectionConfig {
     RiskThreshold?: number;
 }
 /**
+ * @public
  * <p>Contains configurations defining enrollment behavior for the batch job.</p>
  */
 export interface EnrollmentConfig {
@@ -699,6 +794,9 @@ export interface EnrollmentConfig {
      */
     FraudDetectionConfig?: EnrollmentJobFraudDetectionConfig;
 }
+/**
+ * @public
+ */
 export declare enum SpeakerEnrollmentJobStatus {
     COMPLETED = "COMPLETED",
     COMPLETED_WITH_ERRORS = "COMPLETED_WITH_ERRORS",
@@ -707,6 +805,7 @@ export declare enum SpeakerEnrollmentJobStatus {
     SUBMITTED = "SUBMITTED"
 }
 /**
+ * @public
  * <p>Contains all the information about a speaker enrollment job.</p>
  */
 export interface SpeakerEnrollmentJob {
@@ -769,12 +868,18 @@ export interface SpeakerEnrollmentJob {
      */
     JobProgress?: JobProgress;
 }
+/**
+ * @public
+ */
 export interface DescribeSpeakerEnrollmentJobResponse {
     /**
      * <p>Contains details about the specified speaker enrollment job.</p>
      */
     Job?: SpeakerEnrollmentJob;
 }
+/**
+ * @public
+ */
 export interface ListDomainsRequest {
     /**
      * <p>The maximum number of domains to list per API call.</p>
@@ -789,6 +894,7 @@ export interface ListDomainsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Contains a summary of information about a domain.</p>
  */
 export interface DomainSummary {
@@ -832,6 +938,9 @@ export interface DomainSummary {
      */
     ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
 }
+/**
+ * @public
+ */
 export interface ListDomainsResponse {
     /**
      * <p>A list containing details about each domain in the Amazon Web Services account.</p>
@@ -845,6 +954,9 @@ export interface ListDomainsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateDomainRequest {
     /**
      * <p>The identifier of the domain to be updated.</p>
@@ -869,12 +981,18 @@ export interface UpdateDomainRequest {
      */
     ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateDomainResponse {
     /**
      * <p>Details about the updated domain</p>
      */
     Domain?: Domain;
 }
+/**
+ * @public
+ */
 export interface EvaluateSessionRequest {
     /**
      * <p>The identifier of the domain where the session started.</p>
@@ -887,6 +1005,7 @@ export interface EvaluateSessionRequest {
     SessionNameOrId: string | undefined;
 }
 /**
+ * @public
  * <p>The configuration used for performing fraud detection over a speaker during a
  *             session.</p>
  */
@@ -898,16 +1017,23 @@ export interface FraudDetectionConfiguration {
      */
     RiskThreshold: number | undefined;
 }
+/**
+ * @public
+ */
 export declare enum FraudDetectionDecision {
     HIGH_RISK = "HIGH_RISK",
     LOW_RISK = "LOW_RISK",
     NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH"
 }
+/**
+ * @public
+ */
 export declare enum FraudDetectionReason {
     KNOWN_FRAUDSTER = "KNOWN_FRAUDSTER",
     VOICE_SPOOFING = "VOICE_SPOOFING"
 }
 /**
+ * @public
  * <p>Contains details produced as a result of performing known fraudster risk analysis on a
  *             speaker.</p>
  */
@@ -924,6 +1050,7 @@ export interface KnownFraudsterRisk {
     GeneratedFraudsterId?: string;
 }
 /**
+ * @public
  * <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
  */
 export interface VoiceSpoofingRisk {
@@ -933,6 +1060,7 @@ export interface VoiceSpoofingRisk {
     RiskScore: number | undefined;
 }
 /**
+ * @public
  * <p>Details regarding various fraud risk analyses performed against the current session
  *             state and streamed audio of the speaker.</p>
  */
@@ -947,6 +1075,7 @@ export interface FraudRiskDetails {
     VoiceSpoofingRisk: VoiceSpoofingRisk | undefined;
 }
 /**
+ * @public
  * <p>The fraud detection result produced by Voice ID, processed against the current
  *             session state and streamed audio of the speaker.</p>
  */
@@ -991,11 +1120,17 @@ export interface FraudDetectionResult {
      */
     RiskDetails?: FraudRiskDetails;
 }
+/**
+ * @public
+ */
 export declare enum StreamingStatus {
     ENDED = "ENDED",
     ONGOING = "ONGOING",
     PENDING_CONFIGURATION = "PENDING_CONFIGURATION"
 }
+/**
+ * @public
+ */
 export interface EvaluateSessionResponse {
     /**
      * <p>The identifier of the domain containing the session.</p>
@@ -1033,6 +1168,7 @@ export interface EvaluateSessionResponse {
     FraudDetectionResult?: FraudDetectionResult;
 }
 /**
+ * @public
  * <p>Contains a summary of information about a fraudster registration job.</p>
  */
 export interface FraudsterRegistrationJobSummary {
@@ -1074,6 +1210,9 @@ export interface FraudsterRegistrationJobSummary {
      */
     JobProgress?: JobProgress;
 }
+/**
+ * @public
+ */
 export interface ListFraudsterRegistrationJobsRequest {
     /**
      * <p>The identifier of the domain containing the fraudster registration Jobs.</p>
@@ -1097,6 +1236,9 @@ export interface ListFraudsterRegistrationJobsRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListFraudsterRegistrationJobsResponse {
     /**
      * <p>A list containing details about each specified fraudster registration job.</p>
@@ -1110,6 +1252,9 @@ export interface ListFraudsterRegistrationJobsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSpeakerEnrollmentJobsRequest {
     /**
      * <p>The identifier of the domain containing the speaker enrollment jobs.</p>
@@ -1134,6 +1279,7 @@ export interface ListSpeakerEnrollmentJobsRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Contains a summary of information about a speaker enrollment job.</p>
  */
 export interface SpeakerEnrollmentJobSummary {
@@ -1175,6 +1321,9 @@ export interface SpeakerEnrollmentJobSummary {
      */
     JobProgress?: JobProgress;
 }
+/**
+ * @public
+ */
 export interface ListSpeakerEnrollmentJobsResponse {
     /**
      * <p>A list containing details about each specified speaker enrollment job.</p>
@@ -1188,6 +1337,9 @@ export interface ListSpeakerEnrollmentJobsResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListSpeakersRequest {
     /**
      * <p>The identifier of the domain.</p>
@@ -1208,6 +1360,7 @@ export interface ListSpeakersRequest {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>Contains a summary of information about a speaker.</p>
  */
 export interface SpeakerSummary {
@@ -1241,6 +1394,9 @@ export interface SpeakerSummary {
      */
     LastAccessedAt?: Date;
 }
+/**
+ * @public
+ */
 export interface ListSpeakersResponse {
     /**
      * <p>A list containing details about each speaker in the Amazon Web Services account.
@@ -1255,6 +1411,9 @@ export interface ListSpeakersResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list
@@ -1262,12 +1421,18 @@ export interface ListTagsForResourceRequest {
      */
     ResourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The list of tags associated with the specified resource.</p>
      */
     Tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface OptOutSpeakerRequest {
     /**
      * <p>The identifier of the domain containing the speaker.</p>
@@ -1278,12 +1443,18 @@ export interface OptOutSpeakerRequest {
      */
     SpeakerId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface OptOutSpeakerResponse {
     /**
      * <p>Details about the opted-out speaker.</p>
      */
     Speaker?: Speaker;
 }
+/**
+ * @public
+ */
 export interface StartFraudsterRegistrationJobRequest {
     /**
      * <p>The idempotency token for starting a new fraudster registration job. If not provided,
@@ -1325,12 +1496,18 @@ export interface StartFraudsterRegistrationJobRequest {
      */
     OutputDataConfig: OutputDataConfig | undefined;
 }
+/**
+ * @public
+ */
 export interface StartFraudsterRegistrationJobResponse {
     /**
      * <p>Details about the started fraudster registration job.</p>
      */
     Job?: FraudsterRegistrationJob;
 }
+/**
+ * @public
+ */
 export interface StartSpeakerEnrollmentJobRequest {
     /**
      * <p>The idempotency token for starting a new speaker enrollment Job. If not provided,
@@ -1370,12 +1547,18 @@ export interface StartSpeakerEnrollmentJobRequest {
      */
     OutputDataConfig: OutputDataConfig | undefined;
 }
+/**
+ * @public
+ */
 export interface StartSpeakerEnrollmentJobResponse {
     /**
      * <p>Details about the started speaker enrollment job.</p>
      */
     Job?: SpeakerEnrollmentJob;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.</p>
@@ -1386,8 +1569,14 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags
@@ -1399,6 +1588,9 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
 /**