@aws-sdk/client-voice-id 3.159.0 → 3.162.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { VoiceIDServiceException as __BaseException } from "./VoiceIDServiceException";
3
3
  /**
4
- * <p>You do not have sufficient permissions to perform this action. Check the error message and try
5
- * again.</p>
4
+ * <p>You do not have sufficient permissions to perform this action. Check the error message
5
+ * and try again.</p>
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -32,47 +32,52 @@ export declare enum AuthenticationDecision {
32
32
  SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
33
33
  }
34
34
  /**
35
- * <p>The authentication result produced by Voice ID, processed against the current session state and streamed
36
- * audio of the speaker.</p>
35
+ * <p>The authentication result produced by Voice ID, processed against the current session
36
+ * state and streamed audio of the speaker.</p>
37
37
  */
38
38
  export interface AuthenticationResult {
39
39
  /**
40
- * <p>The unique identifier for this authentication result. Because there can be multiple authentications
41
- * for a given session, this field helps to identify if the returned result is from a previous streaming
42
- * activity or a new result. Note that in absence of any new streaming activity,
43
- * <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code> changes, Voice ID
44
- * always returns cached Authentication Result for this API.</p>
40
+ * <p>The unique identifier for this authentication result. Because there can be multiple
41
+ * authentications for a given session, this field helps to identify if the returned result
42
+ * is from a previous streaming activity or a new result. Note that in absence of any new
43
+ * streaming activity, <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code>
44
+ * changes, Voice ID always returns cached Authentication Result for this API.</p>
45
45
  */
46
46
  AuthenticationResultId?: string;
47
47
  /**
48
- * <p>A timestamp indicating when audio aggregation started for this authentication result.</p>
48
+ * <p>A timestamp indicating when audio aggregation started for this authentication
49
+ * result.</p>
49
50
  */
50
51
  AudioAggregationStartedAt?: Date;
51
52
  /**
52
- * <p>A timestamp indicating when audio aggregation ended for this authentication result.</p>
53
+ * <p>A timestamp indicating when audio aggregation ended for this authentication
54
+ * result.</p>
53
55
  */
54
56
  AudioAggregationEndedAt?: Date;
55
57
  /**
56
- * <p>The client-provided identifier for the speaker whose authentication result is produced. Only present if a
57
- * <code>SpeakerId</code> is provided for the session.</p>
58
+ * <p>The client-provided identifier for the speaker whose authentication result is
59
+ * produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>
58
60
  */
59
61
  CustomerSpeakerId?: string;
60
62
  /**
61
- * <p>The service-generated identifier for the speaker whose authentication result is produced.</p>
63
+ * <p>The service-generated identifier for the speaker whose authentication result is
64
+ * produced.</p>
62
65
  */
63
66
  GeneratedSpeakerId?: string;
64
67
  /**
65
- * <p>The authentication decision produced by Voice ID, processed against the current session state and streamed
66
- * audio of the speaker.</p>
68
+ * <p>The authentication decision produced by Voice ID, processed against the current
69
+ * session state and streamed audio of the speaker.</p>
67
70
  */
68
71
  Decision?: AuthenticationDecision | string;
69
72
  /**
70
- * <p>The authentication score for the speaker whose authentication result is produced. This value is
71
- * only present if the authentication decision is either <code>ACCEPT</code> or <code>REJECT</code>.</p>
73
+ * <p>The authentication score for the speaker whose authentication result is produced. This
74
+ * value is only present if the authentication decision is either <code>ACCEPT</code> or
75
+ * <code>REJECT</code>.</p>
72
76
  */
73
77
  Score?: number;
74
78
  /**
75
- * <p>The <code>AuthenticationConfiguration</code> used to generate this authentication result.</p>
79
+ * <p>The <code>AuthenticationConfiguration</code> used to generate this authentication
80
+ * result.</p>
76
81
  */
77
82
  Configuration?: AuthenticationConfiguration;
78
83
  }
@@ -87,41 +92,46 @@ export declare enum ConflictType {
87
92
  SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
88
93
  }
89
94
  /**
90
- * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error message for
91
- * more details.</p>
95
+ * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error
96
+ * message for more details.</p>
92
97
  */
93
98
  export declare class ConflictException extends __BaseException {
94
99
  readonly name: "ConflictException";
95
100
  readonly $fault: "client";
96
101
  Message?: string;
97
102
  /**
98
- * <p>The type of conflict which caused a ConflictException. Possible types and the corresponding error messages
99
- * are as follows:</p>
103
+ * <p>The type of conflict which caused a ConflictException. Possible types and the
104
+ * corresponding error messages are as follows:</p>
100
105
  * <ul>
101
106
  * <li>
102
- * <p>
107
+ * <p>
103
108
  * <code>DOMAIN_NOT_ACTIVE</code>: The domain is not active.</p>
104
- * </li>
109
+ * </li>
105
110
  * <li>
106
- * <p>
107
- * <code>CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT</code>: You cannot change the speaker ID after an enrollment has been requested.</p>
108
- * </li>
111
+ * <p>
112
+ * <code>CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT</code>: You cannot change the
113
+ * speaker ID after an enrollment has been requested.</p>
114
+ * </li>
109
115
  * <li>
110
- * <p>
111
- * <code>ENROLLMENT_ALREADY_EXISTS</code>: There is already an enrollment for this session.</p>
112
- * </li>
116
+ * <p>
117
+ * <code>ENROLLMENT_ALREADY_EXISTS</code>: There is already an enrollment for
118
+ * this session.</p>
119
+ * </li>
113
120
  * <li>
114
- * <p>
115
- * <code>SPEAKER_NOT_SET</code>: You must set the speaker ID before requesting an enrollment.</p>
116
- * </li>
121
+ * <p>
122
+ * <code>SPEAKER_NOT_SET</code>: You must set the speaker ID before requesting an
123
+ * enrollment.</p>
124
+ * </li>
117
125
  * <li>
118
- * <p>
119
- * <code>SPEAKER_OPTED_OUT</code>: You cannot request an enrollment for an opted out speaker.</p>
120
- * </li>
126
+ * <p>
127
+ * <code>SPEAKER_OPTED_OUT</code>: You cannot request an enrollment for an opted
128
+ * out speaker.</p>
129
+ * </li>
121
130
  * <li>
122
- * <p>
123
- * <code>CONCURRENT_CHANGES</code>: The request could not be processed as the resource was modified by another request during execution.</p>
124
- * </li>
131
+ * <p>
132
+ * <code>CONCURRENT_CHANGES</code>: The request could not be processed as the
133
+ * resource was modified by another request during execution.</p>
134
+ * </li>
125
135
  * </ul>
126
136
  */
127
137
  ConflictType?: ConflictType | string;
@@ -131,29 +141,28 @@ export declare class ConflictException extends __BaseException {
131
141
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
132
142
  }
133
143
  /**
134
- * <p>The configuration containing information about the customer managed key used for encrypting
135
- * customer data.</p>
144
+ * <p>The configuration containing information about the customer managed key used for
145
+ * encrypting customer data.</p>
136
146
  */
137
147
  export interface ServerSideEncryptionConfiguration {
138
148
  /**
139
- * <p>The identifier of the KMS key you want Voice ID to use to encrypt your data.</p>
149
+ * <p>The identifier of the KMS key to use to encrypt data stored by
150
+ * Voice ID. Voice ID doesn't support asymmetric customer managed keys. </p>
140
151
  */
141
152
  KmsKeyId: string | undefined;
142
153
  }
143
154
  /**
144
- * <p>A tag that can be assigned to a Voice ID resource.</p>
155
+ * <p>The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</p>
145
156
  */
146
157
  export interface Tag {
147
158
  /**
148
- * <p>The first part of a key:value pair that forms a tag associated with a given resource. For example,
149
- * in the tag Department’:’Sales’, the key is 'Department'.
150
- * </p>
159
+ * <p>The first part of a key:value pair that forms a tag associated with a given resource.
160
+ * For example, in the tag 'Department':'Sales', the key is 'Department'. </p>
151
161
  */
152
162
  Key: string | undefined;
153
163
  /**
154
- * <p>The second part of a key:value pair that forms a tag associated with a given resource. For example,
155
- * in the tag Department’:’Sales’, the value is 'Sales'.
156
- * </p>
164
+ * <p>The second part of a key:value pair that forms a tag associated with a given resource.
165
+ * For example, in the tag 'Department':'Sales', the value is 'Sales'. </p>
157
166
  */
158
167
  Value: string | undefined;
159
168
  }
@@ -163,19 +172,18 @@ export interface CreateDomainRequest {
163
172
  */
164
173
  Name: string | undefined;
165
174
  /**
166
- * <p>A brief description of this domain.</p>
175
+ * <p>A brief description of the domain.</p>
167
176
  */
168
177
  Description?: string;
169
178
  /**
170
- * <p>The configuration, containing the KMS key identifier, to be used by Voice ID for
171
- * the server-side encryption of your data. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid">
172
- * Amazon Connect Voice ID encryption at rest</a> for more details on how the KMS key is used.
173
- * </p>
179
+ * <p>The configuration, containing the KMS key identifier, to be used by
180
+ * Voice ID for the server-side encryption of your data. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid">
181
+ * Amazon Connect Voice ID encryption at rest</a> for more details on how the KMS key is used. </p>
174
182
  */
175
183
  ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
176
184
  /**
177
- * <p>The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates
178
- * this field.</p>
185
+ * <p>The idempotency token for creating a new domain. If not provided, Amazon Web Services
186
+ * SDK populates this field.</p>
179
187
  */
180
188
  ClientToken?: string;
181
189
  /**
@@ -194,10 +202,9 @@ export declare enum ServerSideEncryptionUpdateStatus {
194
202
  IN_PROGRESS = "IN_PROGRESS"
195
203
  }
196
204
  /**
197
- * <p>Details about the most recent server-side encryption configuration update. When the server-side
198
- * encryption configuration is changed, dependency on the old KMS key is removed through an
199
- * asynchronous process. When this update is complete, the domain’s data can only be accessed using the
200
- * new KMS key.</p>
205
+ * <p>Details about the most recent server-side encryption configuration update. When the
206
+ * server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
207
+ * complete, the domain’s data can only be accessed using the new KMS key.</p>
201
208
  */
202
209
  export interface ServerSideEncryptionUpdateDetails {
203
210
  /**
@@ -206,15 +213,16 @@ export interface ServerSideEncryptionUpdateDetails {
206
213
  */
207
214
  OldKmsKeyId?: string;
208
215
  /**
209
- * <p>Status of the server-side encryption update. During an update, if there is an issue with the domain's
210
- * current or old KMS key ID, such as an inaccessible or disabled key, then the status
211
- * is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call
212
- * with the existing server-side encryption configuration will re-attempt this update process.</p>
216
+ * <p>Status of the server-side encryption update. During an update, if there is an issue
217
+ * with the domain's current or old KMS key ID, such as an inaccessible or
218
+ * disabled key, then the status is FAILED. In order to resolve this, the key needs to be
219
+ * made accessible, and then an UpdateDomain call with the existing server-side encryption
220
+ * configuration will re-attempt this update process.</p>
213
221
  */
214
222
  UpdateStatus?: ServerSideEncryptionUpdateStatus | string;
215
223
  /**
216
- * <p>Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains
217
- * the cause of the failure.</p>
224
+ * <p>Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this
225
+ * message explains the cause of the failure.</p>
218
226
  */
219
227
  Message?: string;
220
228
  }
@@ -243,8 +251,8 @@ export interface Domain {
243
251
  */
244
252
  DomainStatus?: DomainStatus | string;
245
253
  /**
246
- * <p>The server-side encryption configuration containing the KMS key identifier you want Voice ID to use
247
- * to encrypt your data.</p>
254
+ * <p>The server-side encryption configuration containing the KMS key
255
+ * identifier you want Voice ID to use to encrypt your data.</p>
248
256
  */
249
257
  ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
250
258
  /**
@@ -256,10 +264,9 @@ export interface Domain {
256
264
  */
257
265
  UpdatedAt?: Date;
258
266
  /**
259
- * <p>Details about the most recent server-side encryption configuration update. When the server-side
260
- * encryption configuration is changed, dependency on the old KMS key is removed through an
261
- * asynchronous process. When this update is complete, the domain's data can only be accessed using the
262
- * new KMS key.</p>
267
+ * <p>Details about the most recent server-side encryption configuration update. When the
268
+ * server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
269
+ * complete, the domain's data can only be accessed using the new KMS key.</p>
263
270
  */
264
271
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
265
272
  }
@@ -290,16 +297,17 @@ export declare enum ResourceType {
290
297
  SPEAKER = "SPEAKER"
291
298
  }
292
299
  /**
293
- * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error message for
294
- * more details.</p>
300
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
301
+ * message for more details.</p>
295
302
  */
296
303
  export declare class ResourceNotFoundException extends __BaseException {
297
304
  readonly name: "ResourceNotFoundException";
298
305
  readonly $fault: "client";
299
306
  Message?: string;
300
307
  /**
301
- * <p>The type of resource which cannot not be found. Possible types are <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>,
302
- * <code>DOMAIN</code>, <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
308
+ * <p>The type of resource which cannot not be found. Possible types are
309
+ * <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>, <code>DOMAIN</code>,
310
+ * <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
303
311
  */
304
312
  ResourceType?: ResourceType | string;
305
313
  /**
@@ -308,8 +316,7 @@ export declare class ResourceNotFoundException extends __BaseException {
308
316
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
309
317
  }
310
318
  /**
311
- * <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
312
- * Quotas</a> and try your request again.</p>
319
+ * <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>
313
320
  */
314
321
  export declare class ServiceQuotaExceededException extends __BaseException {
315
322
  readonly name: "ServiceQuotaExceededException";
@@ -321,10 +328,10 @@ export declare class ServiceQuotaExceededException extends __BaseException {
321
328
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
322
329
  }
323
330
  /**
324
- * <p>The request was denied due to request throttling. Please slow down your request rate. Refer to
325
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
326
- * Amazon Connect Voice ID Service API throttling quotas
327
- * </a> and try your request again.</p>
331
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
332
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
333
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
334
+ * request again.</p>
328
335
  */
329
336
  export declare class ThrottlingException extends __BaseException {
330
337
  readonly name: "ThrottlingException";
@@ -336,7 +343,8 @@ export declare class ThrottlingException extends __BaseException {
336
343
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
337
344
  }
338
345
  /**
339
- * <p>The request failed one or more validations; check the error message for more details.</p>
346
+ * <p>The request failed one or more validations; check the error message for more
347
+ * details.</p>
340
348
  */
341
349
  export declare class ValidationException extends __BaseException {
342
350
  readonly name: "ValidationException";
@@ -446,8 +454,8 @@ export interface FailureDetails {
446
454
  */
447
455
  export interface InputDataConfig {
448
456
  /**
449
- * <p>The S3 location for the input manifest file that contains the list of individual enrollment or registration
450
- * job requests.</p>
457
+ * <p>The S3 location for the input manifest file that contains the list of individual
458
+ * enrollment or registration job requests.</p>
451
459
  */
452
460
  S3Uri: string | undefined;
453
461
  }
@@ -456,7 +464,8 @@ export interface InputDataConfig {
456
464
  */
457
465
  export interface JobProgress {
458
466
  /**
459
- * <p>Shows the completed percentage of enrollment or registration requests listed in the input file.</p>
467
+ * <p>Shows the completed percentage of enrollment or registration requests listed in the
468
+ * input file.</p>
460
469
  */
461
470
  PercentComplete?: number;
462
471
  }
@@ -473,14 +482,16 @@ export declare enum FraudsterRegistrationJobStatus {
473
482
  export interface OutputDataConfig {
474
483
  /**
475
484
  * <p>The S3 path of the folder where Voice ID writes the job output file. It has a
476
- * <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and
477
- * the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is
478
- * <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>
485
+ * <code>*.out</code> extension. For example, if the input file name is
486
+ * <code>input-file.json</code> and the output folder path is
487
+ * <code>s3://output-bucket/output-folder</code>, the full output file path is
488
+ * <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>
479
489
  */
480
490
  S3Uri: string | undefined;
481
491
  /**
482
- * <p>the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster
483
- * registration job.</p>
492
+ * <p>The identifier of the KMS key you want Voice ID to use to encrypt the
493
+ * output file of a speaker enrollment job/fraudster registration job.
494
+ * </p>
484
495
  */
485
496
  KmsKeyId?: string;
486
497
  }
@@ -489,19 +500,21 @@ export declare enum DuplicateRegistrationAction {
489
500
  SKIP = "SKIP"
490
501
  }
491
502
  /**
492
- * <p>The configuration defining the action to take when a duplicate fraudster is detected, and the
493
- * similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.</p>
503
+ * <p>The configuration defining the action to take when a duplicate fraudster is detected,
504
+ * and the similarity threshold to use for detecting a duplicate fraudster during a batch
505
+ * fraudster registration job.</p>
494
506
  */
495
507
  export interface RegistrationConfig {
496
508
  /**
497
- * <p>The action to take when a fraudster is identified as a duplicate. The default action is
498
- * <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value to
499
- * <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified domain.</p>
509
+ * <p>The action to take when a fraudster is identified as a duplicate. The default action
510
+ * is <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value
511
+ * to <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified
512
+ * domain.</p>
500
513
  */
501
514
  DuplicateRegistrationAction?: DuplicateRegistrationAction | string;
502
515
  /**
503
- * <p>The minimum similarity score between the new and old fraudsters in order to consider the new
504
- * fraudster a duplicate.</p>
516
+ * <p>The minimum similarity score between the new and old fraudsters in order to consider
517
+ * the new fraudster a duplicate.</p>
505
518
  */
506
519
  FraudsterSimilarityThreshold?: number;
507
520
  }
@@ -526,23 +539,25 @@ export interface FraudsterRegistrationJob {
526
539
  */
527
540
  DomainId?: string;
528
541
  /**
529
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
530
- * to read the input manifest file and write the job output file.</p>
542
+ * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
543
+ * customer's buckets to read the input manifest file and write the job output file.</p>
531
544
  */
532
545
  DataAccessRoleArn?: string;
533
546
  /**
534
- * <p>The registration config containing details such as the action to take when a duplicate fraudster is
535
- * detected, and the similarity threshold to use for detecting a duplicate fraudster.</p>
547
+ * <p>The registration config containing details such as the action to take when a duplicate
548
+ * fraudster is detected, and the similarity threshold to use for detecting a duplicate
549
+ * fraudster.</p>
536
550
  */
537
551
  RegistrationConfig?: RegistrationConfig;
538
552
  /**
539
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
540
- * of fraudster registration job requests.</p>
553
+ * <p>The input data config containing an S3 URI for the input manifest file that contains
554
+ * the list of fraudster registration job requests.</p>
541
555
  */
542
556
  InputDataConfig?: InputDataConfig;
543
557
  /**
544
- * <p>The output data config containing the S3 location where you want Voice ID to write your job output
545
- * file; you must also include a KMS key iD in order to encrypt the file.</p>
558
+ * <p>The output data config containing the S3 location where you want Voice ID to write
559
+ * your job output file; you must also include a KMS key ID in order to
560
+ * encrypt the file.</p>
546
561
  */
547
562
  OutputDataConfig?: OutputDataConfig;
548
563
  /**
@@ -554,14 +569,16 @@ export interface FraudsterRegistrationJob {
554
569
  */
555
570
  EndedAt?: Date;
556
571
  /**
557
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
558
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
559
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
560
- * registration requests that failed.</p>
572
+ * <p>Contains details that are populated when an entire batch job fails. In cases of
573
+ * individual registration job failures, the batch job as a whole doesn't fail; it is
574
+ * completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
575
+ * use the job output file to identify the individual registration requests that
576
+ * failed.</p>
561
577
  */
562
578
  FailureDetails?: FailureDetails;
563
579
  /**
564
- * <p>Shows the completed percentage of registration requests listed in the input file.</p>
580
+ * <p>Shows the completed percentage of registration requests listed in the input
581
+ * file.</p>
565
582
  */
566
583
  JobProgress?: JobProgress;
567
584
  }
@@ -616,7 +633,8 @@ export interface Speaker {
616
633
  */
617
634
  UpdatedAt?: Date;
618
635
  /**
619
- * <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.</p>
636
+ * <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a
637
+ * successful authentication. This timestamp is accurate to one hour.</p>
620
638
  */
621
639
  LastAccessedAt?: Date;
622
640
  }
@@ -645,19 +663,22 @@ export declare enum FraudDetectionAction {
645
663
  IGNORE = "IGNORE"
646
664
  }
647
665
  /**
648
- * <p>The configuration defining the action to take when a speaker is flagged by the fraud detection system
649
- * during a batch speaker enrollment job, and the risk threshold to use for identification.</p>
666
+ * <p>The configuration defining the action to take when a speaker is flagged by the fraud
667
+ * detection system during a batch speaker enrollment job, and the risk threshold to use
668
+ * for identification.</p>
650
669
  */
651
670
  export interface EnrollmentJobFraudDetectionConfig {
652
671
  /**
653
- * <p>The action to take when the given speaker is flagged by the fraud detection system. The default value is
654
- * <code>FAIL</code>, which fails the speaker enrollment. Changing this value to <code>IGNORE</code>
655
- * results in the speaker being enrolled even if they are flagged by the fraud detection system.</p>
672
+ * <p>The action to take when the given speaker is flagged by the fraud detection system.
673
+ * The default value is <code>FAIL</code>, which fails the speaker enrollment. Changing
674
+ * this value to <code>IGNORE</code> results in the speaker being enrolled even if they are
675
+ * flagged by the fraud detection system.</p>
656
676
  */
657
677
  FraudDetectionAction?: FraudDetectionAction | string;
658
678
  /**
659
- * <p>Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk
660
- * score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.</p>
679
+ * <p>Threshold value for determining whether the speaker is a high risk to be fraudulent.
680
+ * If the detected risk score calculated by Voice ID is greater than or equal to the
681
+ * threshold, the speaker is considered a fraudster.</p>
661
682
  */
662
683
  RiskThreshold?: number;
663
684
  }
@@ -666,10 +687,11 @@ export interface EnrollmentJobFraudDetectionConfig {
666
687
  */
667
688
  export interface EnrollmentConfig {
668
689
  /**
669
- * <p> The action to take when the specified speaker is already enrolled in the specified domain. The default
670
- * value is <code>SKIP</code>, which skips the enrollment for the existing speaker. Setting the value to
671
- * <code>OVERWRITE</code> replaces the existing voice prints and enrollment audio stored for that speaker
672
- * with new data generated from the latest audio.</p>
690
+ * <p> The action to take when the specified speaker is already enrolled in the specified
691
+ * domain. The default value is <code>SKIP</code>, which skips the enrollment for the
692
+ * existing speaker. Setting the value to <code>OVERWRITE</code> replaces the existing
693
+ * voice prints and enrollment audio stored for that speaker with new data generated from
694
+ * the latest audio.</p>
673
695
  */
674
696
  ExistingEnrollmentAction?: ExistingEnrollmentAction | string;
675
697
  /**
@@ -705,23 +727,24 @@ export interface SpeakerEnrollmentJob {
705
727
  */
706
728
  DomainId?: string;
707
729
  /**
708
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
709
- * to read the input manifest file and write the job output file.</p>
730
+ * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
731
+ * customer's buckets to read the input manifest file and write the job output file.</p>
710
732
  */
711
733
  DataAccessRoleArn?: string;
712
734
  /**
713
- * <p>The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the
714
- * <code>FraudDetectionConfig</code> to use.</p>
735
+ * <p>The configuration that defines the action to take when the speaker is already enrolled
736
+ * in Voice ID, and the <code>FraudDetectionConfig</code> to use.</p>
715
737
  */
716
738
  EnrollmentConfig?: EnrollmentConfig;
717
739
  /**
718
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
719
- * of speaker enrollment job requests.</p>
740
+ * <p>The input data config containing an S3 URI for the input manifest file that contains
741
+ * the list of speaker enrollment job requests.</p>
720
742
  */
721
743
  InputDataConfig?: InputDataConfig;
722
744
  /**
723
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
724
- * also include a KMS key ID to encrypt the file.</p>
745
+ * <p>The output data config containing the S3 location where Voice ID writes the job
746
+ * output file; you must also include a KMS key ID to encrypt the
747
+ * file.</p>
725
748
  */
726
749
  OutputDataConfig?: OutputDataConfig;
727
750
  /**
@@ -733,15 +756,16 @@ export interface SpeakerEnrollmentJob {
733
756
  */
734
757
  EndedAt?: Date;
735
758
  /**
736
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
737
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
738
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
739
- * registration requests that failed.</p>
759
+ * <p>Contains details that are populated when an entire batch job fails. In cases of
760
+ * individual registration job failures, the batch job as a whole doesn't fail; it is
761
+ * completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
762
+ * use the job output file to identify the individual registration requests that
763
+ * failed.</p>
740
764
  */
741
765
  FailureDetails?: FailureDetails;
742
766
  /**
743
- * <p>Provides details on job progress. This field shows the completed percentage of registration
744
- * requests listed in the input file.</p>
767
+ * <p>Provides details on job progress. This field shows the completed percentage of
768
+ * registration requests listed in the input file.</p>
745
769
  */
746
770
  JobProgress?: JobProgress;
747
771
  }
@@ -751,6 +775,19 @@ export interface DescribeSpeakerEnrollmentJobResponse {
751
775
  */
752
776
  Job?: SpeakerEnrollmentJob;
753
777
  }
778
+ export interface ListDomainsRequest {
779
+ /**
780
+ * <p>The maximum number of domains to list per API call.</p>
781
+ */
782
+ MaxResults?: number;
783
+ /**
784
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
785
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
786
+ * again using the returned token to retrieve the next page. Keep all other arguments
787
+ * unchanged. Each pagination token expires after 24 hours. </p>
788
+ */
789
+ NextToken?: string;
790
+ }
754
791
  /**
755
792
  * <p>Contains a summary of information about a domain.</p>
756
793
  */
@@ -776,8 +813,8 @@ export interface DomainSummary {
776
813
  */
777
814
  DomainStatus?: DomainStatus | string;
778
815
  /**
779
- * <p>The server-side encryption configuration containing the KMS key identifier you want Voice ID to use
780
- * to encrypt your data.</p>
816
+ * <p>The server-side encryption configuration containing the KMS key
817
+ * identifier you want Voice ID to use to encrypt your data.</p>
781
818
  */
782
819
  ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
783
820
  /**
@@ -789,31 +826,75 @@ export interface DomainSummary {
789
826
  */
790
827
  UpdatedAt?: Date;
791
828
  /**
792
- * <p>Details about the most recent server-side encryption configuration update. When the server-side
793
- * encryption configuration is changed, dependency on the old KMS key is removed through an
794
- * asynchronous process. When this update is complete, the domains data can only be accessed using the
795
- * new KMS key.</p>
829
+ * <p>Details about the most recent server-side encryption configuration update. When the
830
+ * server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
831
+ * complete, the domain's data can only be accessed using the new KMS key.</p>
796
832
  */
797
833
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
798
834
  }
835
+ export interface ListDomainsResponse {
836
+ /**
837
+ * <p>A list containing details about each domain in the Amazon Web Services account.</p>
838
+ */
839
+ DomainSummaries?: DomainSummary[];
840
+ /**
841
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
842
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
843
+ * again using the returned token to retrieve the next page. Keep all other arguments
844
+ * unchanged. Each pagination token expires after 24 hours. </p>
845
+ */
846
+ NextToken?: string;
847
+ }
848
+ export interface UpdateDomainRequest {
849
+ /**
850
+ * <p>The identifier of the domain to be updated.</p>
851
+ */
852
+ DomainId: string | undefined;
853
+ /**
854
+ * <p>The name of the domain.</p>
855
+ */
856
+ Name: string | undefined;
857
+ /**
858
+ * <p>A brief description of the domain.</p>
859
+ */
860
+ Description?: string;
861
+ /**
862
+ * <p>The configuration, containing the KMS key identifier, to be used by
863
+ * Voice ID for the server-side encryption of your data. Changing the domain's associated
864
+ * KMS key immediately triggers an asynchronous process to remove
865
+ * dependency on the old KMS key, such that the domain's data can only be
866
+ * accessed using the new KMS key. The domain's
867
+ * <code>ServerSideEncryptionUpdateDetails</code> contains the details for this
868
+ * process.</p>
869
+ */
870
+ ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
871
+ }
872
+ export interface UpdateDomainResponse {
873
+ /**
874
+ * <p>Details about the updated domain</p>
875
+ */
876
+ Domain?: Domain;
877
+ }
799
878
  export interface EvaluateSessionRequest {
800
879
  /**
801
880
  * <p>The identifier of the domain where the session started.</p>
802
881
  */
803
882
  DomainId: string | undefined;
804
883
  /**
805
- * <p>The session identifier, or name of the session, that you want to evaluate. In Voice ID
806
- * integration, this is the Contact-Id.</p>
884
+ * <p>The session identifier, or name of the session, that you want to evaluate. In
885
+ * Voice ID integration, this is the Contact-Id.</p>
807
886
  */
808
887
  SessionNameOrId: string | undefined;
809
888
  }
810
889
  /**
811
- * <p>The configuration used for performing fraud detection over a speaker during a session.</p>
890
+ * <p>The configuration used for performing fraud detection over a speaker during a
891
+ * session.</p>
812
892
  */
813
893
  export interface FraudDetectionConfiguration {
814
894
  /**
815
- * <p>Threshold value for determining whether the speaker is a fraudster. If the detected risk score
816
- * calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.</p>
895
+ * <p>Threshold value for determining whether the speaker is a fraudster. If the detected
896
+ * risk score calculated by Voice ID is higher than the threshold, the speaker is
897
+ * considered a fraudster.</p>
817
898
  */
818
899
  RiskThreshold: number | undefined;
819
900
  }
@@ -823,10 +904,12 @@ export declare enum FraudDetectionDecision {
823
904
  NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH"
824
905
  }
825
906
  export declare enum FraudDetectionReason {
826
- KNOWN_FRAUDSTER = "KNOWN_FRAUDSTER"
907
+ KNOWN_FRAUDSTER = "KNOWN_FRAUDSTER",
908
+ VOICE_SPOOFING = "VOICE_SPOOFING"
827
909
  }
828
910
  /**
829
- * <p>Contains details produced as a result of performing known fraudster risk analysis on a speaker.</p>
911
+ * <p>Contains details produced as a result of performing known fraudster risk analysis on a
912
+ * speaker.</p>
830
913
  */
831
914
  export interface KnownFraudsterRisk {
832
915
  /**
@@ -834,59 +917,77 @@ export interface KnownFraudsterRisk {
834
917
  */
835
918
  RiskScore: number | undefined;
836
919
  /**
837
- * <p>The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters
838
- * registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is
839
- * <code>null</code>.</p>
920
+ * <p>The identifier of the fraudster that is the closest match to the speaker. If there are
921
+ * no fraudsters registered in a given domain, or if there are no fraudsters with a
922
+ * non-zero RiskScore, this value is <code>null</code>.</p>
840
923
  */
841
924
  GeneratedFraudsterId?: string;
842
925
  }
843
926
  /**
844
- * <p>Details regarding various fraud risk analyses performed against the current session state and streamed
845
- * audio of the speaker.</p>
927
+ * <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
928
+ */
929
+ export interface VoiceSpoofingRisk {
930
+ /**
931
+ * <p>The score indicating the likelihood of speaker’s voice being spoofed.</p>
932
+ */
933
+ RiskScore: number | undefined;
934
+ }
935
+ /**
936
+ * <p>Details regarding various fraud risk analyses performed against the current session
937
+ * state and streamed audio of the speaker.</p>
846
938
  */
847
939
  export interface FraudRiskDetails {
848
940
  /**
849
941
  * <p>The details resulting from 'Known Fraudster Risk' analysis of the speaker.</p>
850
942
  */
851
943
  KnownFraudsterRisk: KnownFraudsterRisk | undefined;
944
+ /**
945
+ * <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
946
+ */
947
+ VoiceSpoofingRisk: VoiceSpoofingRisk | undefined;
852
948
  }
853
949
  /**
854
- * <p>The fraud detection result produced by Voice ID, processed against the current session state and streamed
855
- * audio of the speaker.</p>
950
+ * <p>The fraud detection result produced by Voice ID, processed against the current
951
+ * session state and streamed audio of the speaker.</p>
856
952
  */
857
953
  export interface FraudDetectionResult {
858
954
  /**
859
- * <p>The unique identifier for this fraud detection result. Given there can be multiple fraud detections
860
- * for a given session, this field helps in identifying if the returned result is from previous streaming
861
- * activity or a new result. Note that in the absence of any new streaming activity or risk threshold
862
- * changes, Voice ID always returns cached Fraud Detection result for this API.</p>
955
+ * <p>The unique identifier for this fraud detection result. Given there can be multiple
956
+ * fraud detections for a given session, this field helps in identifying if the returned
957
+ * result is from previous streaming activity or a new result. Note that in the absence of
958
+ * any new streaming activity or risk threshold changes, Voice ID always returns cached
959
+ * Fraud Detection result for this API.</p>
863
960
  */
864
961
  FraudDetectionResultId?: string;
865
962
  /**
866
- * <p>A timestamp indicating when audio aggregation started for this fraud detection result.</p>
963
+ * <p>A timestamp indicating when audio aggregation started for this fraud detection
964
+ * result.</p>
867
965
  */
868
966
  AudioAggregationStartedAt?: Date;
869
967
  /**
870
- * <p>A timestamp indicating when audio aggregation ended for this fraud detection result.</p>
968
+ * <p>A timestamp indicating when audio aggregation ended for this fraud detection
969
+ * result.</p>
871
970
  */
872
971
  AudioAggregationEndedAt?: Date;
873
972
  /**
874
- * <p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection result.</p>
973
+ * <p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection
974
+ * result.</p>
875
975
  */
876
976
  Configuration?: FraudDetectionConfiguration;
877
977
  /**
878
- * <p>The fraud detection decision produced by Voice ID, processed against the current session state and
879
- * streamed audio of the speaker.</p>
978
+ * <p>The fraud detection decision produced by Voice ID, processed against the current
979
+ * session state and streamed audio of the speaker.</p>
880
980
  */
881
981
  Decision?: FraudDetectionDecision | string;
882
982
  /**
883
- * <p>The reason speaker was flagged by the fraud detection system. This is only be populated if fraud
884
- * detection Decision is <code>HIGH_RISK</code>, and only has one possible value:
885
- * <code>KNOWN_FRAUDSTER</code>.</p>
983
+ * <p>The reason speaker was flagged by the fraud detection system. This is only be
984
+ * populated if fraud detection Decision is <code>HIGH_RISK</code>, and the following
985
+ * possible values: <code>KNOWN_FRAUDSTER</code> and <code>VOICE_SPOOFING</code>.</p>
886
986
  */
887
987
  Reasons?: (FraudDetectionReason | string)[];
888
988
  /**
889
- * <p>Details about each risk analyzed for this speaker.</p>
989
+ * <p>Details about each risk analyzed for this speaker. Currently, this contains
990
+ * KnownFraudsterRisk and VoiceSpoofingRisk details.</p>
890
991
  */
891
992
  RiskDetails?: FraudRiskDetails;
892
993
  }
@@ -909,13 +1010,15 @@ export interface EvaluateSessionResponse {
909
1010
  */
910
1011
  SessionName?: string;
911
1012
  /**
912
- * <p>The current status of audio streaming for this session. This field is useful to infer next steps when
913
- * the Authentication or Fraud Detection results are empty or the decision is <code>NOT_ENOUGH_SPEECH</code>.
914
- * In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, it can
915
- * mean that the client should call the API again later, after Voice ID has enough audio to produce a result.
916
- * If the decision remains <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>,
917
- * it means that the previously streamed session did not have enough speech to perform evaluation, and a new
918
- * streaming session is needed to try again.</p>
1013
+ * <p>The current status of audio streaming for this session. This field is useful to infer
1014
+ * next steps when the Authentication or Fraud Detection results are empty or the decision
1015
+ * is <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the
1016
+ * <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, it can
1017
+ * mean that the client should call the API again later, after Voice ID has enough audio
1018
+ * to produce a result. If the decision remains <code>NOT_ENOUGH_SPEECH</code> even after
1019
+ * <code>StreamingStatus</code> is <code>ENDED</code>, it means that the previously
1020
+ * streamed session did not have enough speech to perform evaluation, and a new streaming
1021
+ * session is needed to try again.</p>
919
1022
  */
920
1023
  StreamingStatus?: StreamingStatus | string;
921
1024
  /**
@@ -924,7 +1027,8 @@ export interface EvaluateSessionResponse {
924
1027
  */
925
1028
  AuthenticationResult?: AuthenticationResult;
926
1029
  /**
927
- * <p>Details resulting from the fraud detection process, such as fraud detection decision and risk score.</p>
1030
+ * <p>Details resulting from the fraud detection process, such as fraud detection decision
1031
+ * and risk score.</p>
928
1032
  */
929
1033
  FraudDetectionResult?: FraudDetectionResult;
930
1034
  }
@@ -933,7 +1037,7 @@ export interface EvaluateSessionResponse {
933
1037
  */
934
1038
  export interface FraudsterRegistrationJobSummary {
935
1039
  /**
936
- * <p>The client-provied name for the fraudster registration job.</p>
1040
+ * <p>The client-provided name for the fraudster registration job.</p>
937
1041
  */
938
1042
  JobName?: string;
939
1043
  /**
@@ -957,45 +1061,19 @@ export interface FraudsterRegistrationJobSummary {
957
1061
  */
958
1062
  EndedAt?: Date;
959
1063
  /**
960
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
961
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
962
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
963
- * registration requests that failed.</p>
1064
+ * <p>Contains details that are populated when an entire batch job fails. In cases of
1065
+ * individual registration job failures, the batch job as a whole doesn't fail; it is
1066
+ * completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
1067
+ * use the job output file to identify the individual registration requests that
1068
+ * failed.</p>
964
1069
  */
965
1070
  FailureDetails?: FailureDetails;
966
1071
  /**
967
- * <p>Shows the completed percentage of registration requests listed in the input file.</p>
1072
+ * <p>Shows the completed percentage of registration requests listed in the input
1073
+ * file.</p>
968
1074
  */
969
1075
  JobProgress?: JobProgress;
970
1076
  }
971
- export interface ListDomainsRequest {
972
- /**
973
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
974
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
975
- * </p>
976
- */
977
- MaxResults?: number;
978
- /**
979
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
980
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
981
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
982
- * </p>
983
- */
984
- NextToken?: string;
985
- }
986
- export interface ListDomainsResponse {
987
- /**
988
- * <p>A list containing details about each domain in the Amazon Web Services account.</p>
989
- */
990
- DomainSummaries?: DomainSummary[];
991
- /**
992
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
993
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
994
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
995
- * </p>
996
- */
997
- NextToken?: string;
998
- }
999
1077
  export interface ListFraudsterRegistrationJobsRequest {
1000
1078
  /**
1001
1079
  * <p>The identifier of the domain containing the fraudster registration Jobs.</p>
@@ -1006,16 +1084,16 @@ export interface ListFraudsterRegistrationJobsRequest {
1006
1084
  */
1007
1085
  JobStatus?: FraudsterRegistrationJobStatus | string;
1008
1086
  /**
1009
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1010
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1011
- * </p>
1087
+ * <p>The maximum number of results that are returned per call. You can use
1088
+ * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1089
+ * maximum allowed page size is also 100. </p>
1012
1090
  */
1013
1091
  MaxResults?: number;
1014
1092
  /**
1015
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1016
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1017
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1018
- * </p>
1093
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1094
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1095
+ * again using the returned token to retrieve the next page. Keep all other arguments
1096
+ * unchanged. Each pagination token expires after 24 hours. </p>
1019
1097
  */
1020
1098
  NextToken?: string;
1021
1099
  }
@@ -1025,10 +1103,10 @@ export interface ListFraudsterRegistrationJobsResponse {
1025
1103
  */
1026
1104
  JobSummaries?: FraudsterRegistrationJobSummary[];
1027
1105
  /**
1028
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1029
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1030
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1031
- * </p>
1106
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1107
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1108
+ * again using the returned token to retrieve the next page. Keep all other arguments
1109
+ * unchanged. Each pagination token expires after 24 hours. </p>
1032
1110
  */
1033
1111
  NextToken?: string;
1034
1112
  }
@@ -1042,16 +1120,16 @@ export interface ListSpeakerEnrollmentJobsRequest {
1042
1120
  */
1043
1121
  JobStatus?: SpeakerEnrollmentJobStatus | string;
1044
1122
  /**
1045
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1046
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1047
- * </p>
1123
+ * <p>The maximum number of results that are returned per call. You can use
1124
+ * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1125
+ * maximum allowed page size is also 100. </p>
1048
1126
  */
1049
1127
  MaxResults?: number;
1050
1128
  /**
1051
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1052
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1053
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1054
- * </p>
1129
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1130
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1131
+ * again using the returned token to retrieve the next page. Keep all other arguments
1132
+ * unchanged. Each pagination token expires after 24 hours. </p>
1055
1133
  */
1056
1134
  NextToken?: string;
1057
1135
  }
@@ -1084,15 +1162,16 @@ export interface SpeakerEnrollmentJobSummary {
1084
1162
  */
1085
1163
  EndedAt?: Date;
1086
1164
  /**
1087
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
1088
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
1089
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
1090
- * registration requests that failed.</p>
1165
+ * <p>Contains details that are populated when an entire batch job fails. In cases of
1166
+ * individual registration job failures, the batch job as a whole doesn't fail; it is
1167
+ * completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
1168
+ * use the job output file to identify the individual registration requests that
1169
+ * failed.</p>
1091
1170
  */
1092
1171
  FailureDetails?: FailureDetails;
1093
1172
  /**
1094
- * <p>Provides details regarding job progress. This field shows the completed percentage of enrollment
1095
- * requests listed in the input file.</p>
1173
+ * <p>Provides details regarding job progress. This field shows the completed percentage of
1174
+ * enrollment requests listed in the input file.</p>
1096
1175
  */
1097
1176
  JobProgress?: JobProgress;
1098
1177
  }
@@ -1102,10 +1181,10 @@ export interface ListSpeakerEnrollmentJobsResponse {
1102
1181
  */
1103
1182
  JobSummaries?: SpeakerEnrollmentJobSummary[];
1104
1183
  /**
1105
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1106
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1107
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1108
- * </p>
1184
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1185
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1186
+ * again using the returned token to retrieve the next page. Keep all other arguments
1187
+ * unchanged. Each pagination token expires after 24 hours. </p>
1109
1188
  */
1110
1189
  NextToken?: string;
1111
1190
  }
@@ -1115,16 +1194,16 @@ export interface ListSpeakersRequest {
1115
1194
  */
1116
1195
  DomainId: string | undefined;
1117
1196
  /**
1118
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1119
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1120
- * </p>
1197
+ * <p>The maximum number of results that are returned per call. You can use
1198
+ * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1199
+ * maximum allowed page size is also 100. </p>
1121
1200
  */
1122
1201
  MaxResults?: number;
1123
1202
  /**
1124
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1125
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1126
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1127
- * </p>
1203
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1204
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1205
+ * again using the returned token to retrieve the next page. Keep all other arguments
1206
+ * unchanged. Each pagination token expires after 24 hours. </p>
1128
1207
  */
1129
1208
  NextToken?: string;
1130
1209
  }
@@ -1157,7 +1236,8 @@ export interface SpeakerSummary {
1157
1236
  */
1158
1237
  UpdatedAt?: Date;
1159
1238
  /**
1160
- * <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.</p>
1239
+ * <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a
1240
+ * successful authentication. This timestamp is accurate to one hour.</p>
1161
1241
  */
1162
1242
  LastAccessedAt?: Date;
1163
1243
  }
@@ -1168,16 +1248,17 @@ export interface ListSpeakersResponse {
1168
1248
  */
1169
1249
  SpeakerSummaries?: SpeakerSummary[];
1170
1250
  /**
1171
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1172
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1173
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1174
- * </p>
1251
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1252
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1253
+ * again using the returned token to retrieve the next page. Keep all other arguments
1254
+ * unchanged. Each pagination token expires after 24 hours. </p>
1175
1255
  */
1176
1256
  NextToken?: string;
1177
1257
  }
1178
1258
  export interface ListTagsForResourceRequest {
1179
1259
  /**
1180
- * <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.</p>
1260
+ * <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list
1261
+ * the tags.</p>
1181
1262
  */
1182
1263
  ResourceArn: string | undefined;
1183
1264
  }
@@ -1205,8 +1286,8 @@ export interface OptOutSpeakerResponse {
1205
1286
  }
1206
1287
  export interface StartFraudsterRegistrationJobRequest {
1207
1288
  /**
1208
- * <p>The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services
1209
- * SDK populates this field.</p>
1289
+ * <p>The idempotency token for starting a new fraudster registration job. If not provided,
1290
+ * Amazon Web Services SDK populates this field.</p>
1210
1291
  */
1211
1292
  ClientToken?: string;
1212
1293
  /**
@@ -1214,30 +1295,33 @@ export interface StartFraudsterRegistrationJobRequest {
1214
1295
  */
1215
1296
  JobName?: string;
1216
1297
  /**
1217
- * <p>The identifier of the domain containing the fraudster registration job and in which the fraudsters are
1218
- * registered.</p>
1298
+ * <p>The identifier of the domain containing the fraudster registration job and in which
1299
+ * the fraudsters are registered.</p>
1219
1300
  */
1220
1301
  DomainId: string | undefined;
1221
1302
  /**
1222
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
1223
- * to read the input manifest file and write the Job output file. Refer to the
1224
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and
1225
- * edit a fraudster watchlist</a> documentation for the permissions needed in this role.</p>
1303
+ * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
1304
+ * customer's buckets to read the input manifest file and write the Job output file. Refer
1305
+ * to the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and edit a
1306
+ * fraudster watchlist</a> documentation for the permissions needed in this
1307
+ * role.</p>
1226
1308
  */
1227
1309
  DataAccessRoleArn: string | undefined;
1228
1310
  /**
1229
- * <p>The registration config containing details such as the action to take when a duplicate fraudster is
1230
- * detected, and the similarity threshold to use for detecting a duplicate fraudster.</p>
1311
+ * <p>The registration config containing details such as the action to take when a duplicate
1312
+ * fraudster is detected, and the similarity threshold to use for detecting a duplicate
1313
+ * fraudster. </p>
1231
1314
  */
1232
1315
  RegistrationConfig?: RegistrationConfig;
1233
1316
  /**
1234
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
1235
- * of fraudster registration requests.</p>
1317
+ * <p>The input data config containing an S3 URI for the input manifest file that contains
1318
+ * the list of fraudster registration requests.</p>
1236
1319
  */
1237
1320
  InputDataConfig: InputDataConfig | undefined;
1238
1321
  /**
1239
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
1240
- * also include a KMS key ID to encrypt the file.</p>
1322
+ * <p>The output data config containing the S3 location where Voice ID writes the job
1323
+ * output file; you must also include a KMS key ID to encrypt the
1324
+ * file.</p>
1241
1325
  */
1242
1326
  OutputDataConfig: OutputDataConfig | undefined;
1243
1327
  }
@@ -1249,8 +1333,8 @@ export interface StartFraudsterRegistrationJobResponse {
1249
1333
  }
1250
1334
  export interface StartSpeakerEnrollmentJobRequest {
1251
1335
  /**
1252
- * <p>The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services
1253
- * SDK populates this field.</p>
1336
+ * <p>The idempotency token for starting a new speaker enrollment Job. If not provided,
1337
+ * Amazon Web Services SDK populates this field.</p>
1254
1338
  */
1255
1339
  ClientToken?: string;
1256
1340
  /**
@@ -1258,30 +1342,31 @@ export interface StartSpeakerEnrollmentJobRequest {
1258
1342
  */
1259
1343
  JobName?: string;
1260
1344
  /**
1261
- * <p>The identifier of the domain that contains the speaker enrollment job and in which the speakers are
1262
- * enrolled.
1263
- * </p>
1345
+ * <p>The identifier of the domain that contains the speaker enrollment job and in which the
1346
+ * speakers are enrolled. </p>
1264
1347
  */
1265
1348
  DomainId: string | undefined;
1266
1349
  /**
1267
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
1268
- * to read the input manifest file and write the job output file. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using audio data from prior
1269
- * calls</a> documentation for the permissions needed in this role.</p>
1350
+ * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
1351
+ * customer's buckets to read the input manifest file and write the job output file. Refer
1352
+ * to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using
1353
+ * audio data from prior calls</a> for the permissions needed in this role.</p>
1270
1354
  */
1271
1355
  DataAccessRoleArn: string | undefined;
1272
1356
  /**
1273
- * <p>The enrollment config that contains details such as the action to take when a speaker is already
1274
- * enrolled in Voice ID or when a speaker is identified as a fraudster.</p>
1357
+ * <p>The enrollment config that contains details such as the action to take when a speaker
1358
+ * is already enrolled in Voice ID or when a speaker is identified as a fraudster.</p>
1275
1359
  */
1276
1360
  EnrollmentConfig?: EnrollmentConfig;
1277
1361
  /**
1278
- * <p>The input data config containing the S3 location for the input manifest file that contains the list of
1279
- * speaker enrollment requests.</p>
1362
+ * <p>The input data config containing the S3 location for the input manifest file that
1363
+ * contains the list of speaker enrollment requests.</p>
1280
1364
  */
1281
1365
  InputDataConfig: InputDataConfig | undefined;
1282
1366
  /**
1283
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
1284
- * also include a KMS key ID to encrypt the file.</p>
1367
+ * <p>The output data config containing the S3 location where Voice ID writes the job
1368
+ * output file; you must also include a KMS key ID to encrypt the
1369
+ * file.</p>
1285
1370
  */
1286
1371
  OutputDataConfig: OutputDataConfig | undefined;
1287
1372
  }
@@ -1305,7 +1390,8 @@ export interface TagResourceResponse {
1305
1390
  }
1306
1391
  export interface UntagResourceRequest {
1307
1392
  /**
1308
- * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.</p>
1393
+ * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags
1394
+ * from.</p>
1309
1395
  */
1310
1396
  ResourceArn: string | undefined;
1311
1397
  /**
@@ -1315,32 +1401,6 @@ export interface UntagResourceRequest {
1315
1401
  }
1316
1402
  export interface UntagResourceResponse {
1317
1403
  }
1318
- export interface UpdateDomainRequest {
1319
- /**
1320
- * <p>The identifier of the domain to be updated.</p>
1321
- */
1322
- DomainId: string | undefined;
1323
- /**
1324
- * <p>The name of the domain.</p>
1325
- */
1326
- Name: string | undefined;
1327
- /**
1328
- * <p>A brief description about this domain.</p>
1329
- */
1330
- Description?: string;
1331
- /**
1332
- * <p>The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side
1333
- * encryption of your data. Note that all the existing data in the domain are still encrypted using the
1334
- * existing key, only the data added to domain after updating the key is encrypted using the new key. </p>
1335
- */
1336
- ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
1337
- }
1338
- export interface UpdateDomainResponse {
1339
- /**
1340
- * <p>Details about the updated domain</p>
1341
- */
1342
- Domain?: Domain;
1343
- }
1344
1404
  /**
1345
1405
  * @internal
1346
1406
  */
@@ -1469,10 +1529,26 @@ export declare const SpeakerEnrollmentJobFilterSensitiveLog: (obj: SpeakerEnroll
1469
1529
  * @internal
1470
1530
  */
1471
1531
  export declare const DescribeSpeakerEnrollmentJobResponseFilterSensitiveLog: (obj: DescribeSpeakerEnrollmentJobResponse) => any;
1532
+ /**
1533
+ * @internal
1534
+ */
1535
+ export declare const ListDomainsRequestFilterSensitiveLog: (obj: ListDomainsRequest) => any;
1472
1536
  /**
1473
1537
  * @internal
1474
1538
  */
1475
1539
  export declare const DomainSummaryFilterSensitiveLog: (obj: DomainSummary) => any;
1540
+ /**
1541
+ * @internal
1542
+ */
1543
+ export declare const ListDomainsResponseFilterSensitiveLog: (obj: ListDomainsResponse) => any;
1544
+ /**
1545
+ * @internal
1546
+ */
1547
+ export declare const UpdateDomainRequestFilterSensitiveLog: (obj: UpdateDomainRequest) => any;
1548
+ /**
1549
+ * @internal
1550
+ */
1551
+ export declare const UpdateDomainResponseFilterSensitiveLog: (obj: UpdateDomainResponse) => any;
1476
1552
  /**
1477
1553
  * @internal
1478
1554
  */
@@ -1485,6 +1561,10 @@ export declare const FraudDetectionConfigurationFilterSensitiveLog: (obj: FraudD
1485
1561
  * @internal
1486
1562
  */
1487
1563
  export declare const KnownFraudsterRiskFilterSensitiveLog: (obj: KnownFraudsterRisk) => any;
1564
+ /**
1565
+ * @internal
1566
+ */
1567
+ export declare const VoiceSpoofingRiskFilterSensitiveLog: (obj: VoiceSpoofingRisk) => any;
1488
1568
  /**
1489
1569
  * @internal
1490
1570
  */
@@ -1501,14 +1581,6 @@ export declare const EvaluateSessionResponseFilterSensitiveLog: (obj: EvaluateSe
1501
1581
  * @internal
1502
1582
  */
1503
1583
  export declare const FraudsterRegistrationJobSummaryFilterSensitiveLog: (obj: FraudsterRegistrationJobSummary) => any;
1504
- /**
1505
- * @internal
1506
- */
1507
- export declare const ListDomainsRequestFilterSensitiveLog: (obj: ListDomainsRequest) => any;
1508
- /**
1509
- * @internal
1510
- */
1511
- export declare const ListDomainsResponseFilterSensitiveLog: (obj: ListDomainsResponse) => any;
1512
1584
  /**
1513
1585
  * @internal
1514
1586
  */
@@ -1589,11 +1661,3 @@ export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResource
1589
1661
  * @internal
1590
1662
  */
1591
1663
  export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
1592
- /**
1593
- * @internal
1594
- */
1595
- export declare const UpdateDomainRequestFilterSensitiveLog: (obj: UpdateDomainRequest) => any;
1596
- /**
1597
- * @internal
1598
- */
1599
- export declare const UpdateDomainResponseFilterSensitiveLog: (obj: UpdateDomainResponse) => any;