@aws-sdk/client-voice-id 3.529.1 → 3.535.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.
- package/dist-types/VoiceID.d.ts +2 -1
- package/dist-types/VoiceIDClient.d.ts +1 -1
- package/dist-types/commands/AssociateFraudsterCommand.d.ts +2 -1
- package/dist-types/commands/CreateDomainCommand.d.ts +2 -1
- package/dist-types/commands/CreateWatchlistCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDomainCommand.d.ts +2 -1
- package/dist-types/commands/DeleteFraudsterCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSpeakerCommand.d.ts +2 -1
- package/dist-types/commands/DeleteWatchlistCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDomainCommand.d.ts +2 -1
- package/dist-types/commands/DescribeFraudsterCommand.d.ts +2 -1
- package/dist-types/commands/DescribeFraudsterRegistrationJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSpeakerCommand.d.ts +2 -1
- package/dist-types/commands/DescribeSpeakerEnrollmentJobCommand.d.ts +2 -1
- package/dist-types/commands/DescribeWatchlistCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateFraudsterCommand.d.ts +2 -1
- package/dist-types/commands/EvaluateSessionCommand.d.ts +2 -1
- package/dist-types/commands/ListDomainsCommand.d.ts +2 -1
- package/dist-types/commands/ListFraudsterRegistrationJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListFraudstersCommand.d.ts +2 -1
- package/dist-types/commands/ListSpeakerEnrollmentJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListSpeakersCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListWatchlistsCommand.d.ts +2 -1
- package/dist-types/commands/OptOutSpeakerCommand.d.ts +2 -1
- package/dist-types/commands/StartFraudsterRegistrationJobCommand.d.ts +2 -1
- package/dist-types/commands/StartSpeakerEnrollmentJobCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDomainCommand.d.ts +2 -1
- package/dist-types/commands/UpdateWatchlistCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +297 -297
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/VoiceID.d.ts +1 -0
- package/dist-types/ts3.4/commands/AssociateFraudsterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateWatchlistCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteFraudsterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSpeakerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteWatchlistCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeFraudsterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeFraudsterRegistrationJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSpeakerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSpeakerEnrollmentJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeWatchlistCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateFraudsterCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/EvaluateSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFraudsterRegistrationJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListFraudstersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSpeakerEnrollmentJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSpeakersCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListWatchlistsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/OptOutSpeakerCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartFraudsterRegistrationJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartSpeakerEnrollmentJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateWatchlistCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { VoiceIDServiceException as __BaseException } from "./VoiceIDServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient permissions to perform this action. Check the error message
|
|
6
5
|
* and try again.</p>
|
|
6
|
+
* @public
|
|
7
7
|
*/
|
|
8
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
9
9
|
readonly name: "AccessDeniedException";
|
|
@@ -19,44 +19,44 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
*/
|
|
20
20
|
export interface AssociateFraudsterRequest {
|
|
21
21
|
/**
|
|
22
|
-
* @public
|
|
23
22
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
23
|
+
* @public
|
|
24
24
|
*/
|
|
25
25
|
DomainId: string | undefined;
|
|
26
26
|
/**
|
|
27
|
-
* @public
|
|
28
27
|
* <p>The identifier of the watchlist you want to associate with the fraudster.</p>
|
|
28
|
+
* @public
|
|
29
29
|
*/
|
|
30
30
|
WatchlistId: string | undefined;
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>The identifier of the fraudster to be associated with the watchlist.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
FraudsterId: string | undefined;
|
|
36
36
|
}
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>Contains all the information about a fraudster.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
export interface Fraudster {
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
DomainId?: string;
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The service-generated identifier for the fraudster.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
GeneratedFraudsterId?: string;
|
|
52
52
|
/**
|
|
53
|
-
* @public
|
|
54
53
|
* <p>The timestamp of when Voice ID identified the fraudster.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
CreatedAt?: Date;
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>The identifier of the watchlists the fraudster is a part of.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
WatchlistIds?: string[];
|
|
62
62
|
}
|
|
@@ -65,8 +65,8 @@ export interface Fraudster {
|
|
|
65
65
|
*/
|
|
66
66
|
export interface AssociateFraudsterResponse {
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>Contains all the information about a fraudster.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
Fraudster?: Fraudster;
|
|
72
72
|
}
|
|
@@ -91,16 +91,15 @@ export declare const ConflictType: {
|
|
|
91
91
|
*/
|
|
92
92
|
export type ConflictType = (typeof ConflictType)[keyof typeof ConflictType];
|
|
93
93
|
/**
|
|
94
|
-
* @public
|
|
95
94
|
* <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error
|
|
96
95
|
* message for more details.</p>
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class ConflictException extends __BaseException {
|
|
99
99
|
readonly name: "ConflictException";
|
|
100
100
|
readonly $fault: "client";
|
|
101
101
|
Message?: string;
|
|
102
102
|
/**
|
|
103
|
-
* @public
|
|
104
103
|
* <p>The type of conflict which caused a ConflictException. Possible types and the
|
|
105
104
|
* corresponding error messages are as follows:</p>
|
|
106
105
|
* <ul>
|
|
@@ -134,6 +133,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
134
133
|
* resource was modified by another request during execution.</p>
|
|
135
134
|
* </li>
|
|
136
135
|
* </ul>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
ConflictType?: ConflictType;
|
|
139
139
|
/**
|
|
@@ -142,8 +142,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
142
142
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
143
143
|
}
|
|
144
144
|
/**
|
|
145
|
-
* @public
|
|
146
145
|
* <p>The request failed due to an unknown error on the server side.</p>
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
export declare class InternalServerException extends __BaseException {
|
|
149
149
|
readonly name: "InternalServerException";
|
|
@@ -172,19 +172,19 @@ export declare const ResourceType: {
|
|
|
172
172
|
*/
|
|
173
173
|
export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
|
|
177
176
|
* message for more details.</p>
|
|
177
|
+
* @public
|
|
178
178
|
*/
|
|
179
179
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
180
180
|
readonly name: "ResourceNotFoundException";
|
|
181
181
|
readonly $fault: "client";
|
|
182
182
|
Message?: string;
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>The type of resource which cannot not be found. Possible types are
|
|
186
185
|
* <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>, <code>DOMAIN</code>,
|
|
187
186
|
* <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
ResourceType?: ResourceType;
|
|
190
190
|
/**
|
|
@@ -193,8 +193,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
193
193
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <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>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
200
200
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -206,11 +206,11 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
206
206
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
207
207
|
}
|
|
208
208
|
/**
|
|
209
|
-
* @public
|
|
210
209
|
* <p>The request was denied due to request throttling. Please slow down your request rate.
|
|
211
210
|
* Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
|
|
212
211
|
* Amazon Connect Voice ID Service API throttling quotas </a> and try your
|
|
213
212
|
* request again.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
export declare class ThrottlingException extends __BaseException {
|
|
216
216
|
readonly name: "ThrottlingException";
|
|
@@ -222,9 +222,9 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
222
222
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>The request failed one or more validations; check the error message for more
|
|
227
226
|
* details.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
export declare class ValidationException extends __BaseException {
|
|
230
230
|
readonly name: "ValidationException";
|
|
@@ -236,13 +236,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
236
236
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* @public
|
|
240
239
|
* <p>The configuration used to authenticate a speaker during a session.</p>
|
|
240
|
+
* @public
|
|
241
241
|
*/
|
|
242
242
|
export interface AuthenticationConfiguration {
|
|
243
243
|
/**
|
|
244
|
-
* @public
|
|
245
244
|
* <p>The minimum threshold needed to successfully authenticate a speaker.</p>
|
|
245
|
+
* @public
|
|
246
246
|
*/
|
|
247
247
|
AcceptanceThreshold: number | undefined;
|
|
248
248
|
}
|
|
@@ -264,93 +264,93 @@ export declare const AuthenticationDecision: {
|
|
|
264
264
|
*/
|
|
265
265
|
export type AuthenticationDecision = (typeof AuthenticationDecision)[keyof typeof AuthenticationDecision];
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The authentication result produced by Voice ID, processed against the current session
|
|
269
268
|
* state and streamed audio of the speaker.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
export interface AuthenticationResult {
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The unique identifier for this authentication result. Because there can be multiple
|
|
275
274
|
* authentications for a given session, this field helps to identify if the returned result
|
|
276
275
|
* is from a previous streaming activity or a new result. Note that in absence of any new
|
|
277
276
|
* streaming activity, <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code>
|
|
278
277
|
* changes, Voice ID always returns cached Authentication Result for this API.</p>
|
|
278
|
+
* @public
|
|
279
279
|
*/
|
|
280
280
|
AuthenticationResultId?: string;
|
|
281
281
|
/**
|
|
282
|
-
* @public
|
|
283
282
|
* <p>A timestamp of when audio aggregation started for this authentication
|
|
284
283
|
* result.</p>
|
|
284
|
+
* @public
|
|
285
285
|
*/
|
|
286
286
|
AudioAggregationStartedAt?: Date;
|
|
287
287
|
/**
|
|
288
|
-
* @public
|
|
289
288
|
* <p>A timestamp of when audio aggregation ended for this authentication
|
|
290
289
|
* result.</p>
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
AudioAggregationEndedAt?: Date;
|
|
293
293
|
/**
|
|
294
|
-
* @public
|
|
295
294
|
* <p>The client-provided identifier for the speaker whose authentication result is
|
|
296
295
|
* produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
CustomerSpeakerId?: string;
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>The service-generated identifier for the speaker whose authentication result is
|
|
302
301
|
* produced.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
GeneratedSpeakerId?: string;
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>The authentication decision produced by Voice ID, processed against the current
|
|
308
307
|
* session state and streamed audio of the speaker.</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
Decision?: AuthenticationDecision;
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>The authentication score for the speaker whose authentication result is produced. This
|
|
314
313
|
* value is only present if the authentication decision is either <code>ACCEPT</code> or
|
|
315
314
|
* <code>REJECT</code>.</p>
|
|
315
|
+
* @public
|
|
316
316
|
*/
|
|
317
317
|
Score?: number;
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>The <code>AuthenticationConfiguration</code> used to generate this authentication
|
|
321
320
|
* result.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
Configuration?: AuthenticationConfiguration;
|
|
324
324
|
}
|
|
325
325
|
/**
|
|
326
|
-
* @public
|
|
327
326
|
* <p>The configuration containing information about the customer managed key used for
|
|
328
327
|
* encrypting customer data.</p>
|
|
328
|
+
* @public
|
|
329
329
|
*/
|
|
330
330
|
export interface ServerSideEncryptionConfiguration {
|
|
331
331
|
/**
|
|
332
|
-
* @public
|
|
333
332
|
* <p>The identifier of the KMS key to use to encrypt data stored by
|
|
334
333
|
* Voice ID. Voice ID doesn't support asymmetric customer managed keys. </p>
|
|
334
|
+
* @public
|
|
335
335
|
*/
|
|
336
336
|
KmsKeyId: string | undefined;
|
|
337
337
|
}
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>The tags used to organize, track, or control access for this resource. For example, \{
|
|
341
340
|
* "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
export interface Tag {
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p>The first part of a key:value pair that forms a tag associated with a given resource.
|
|
347
346
|
* For example, in the tag 'Department':'Sales', the key is 'Department'. </p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
Key: string | undefined;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>The second part of a key:value pair that forms a tag associated with a given resource.
|
|
353
352
|
* For example, in the tag 'Department':'Sales', the value is 'Sales'. </p>
|
|
353
|
+
* @public
|
|
354
354
|
*/
|
|
355
355
|
Value: string | undefined;
|
|
356
356
|
}
|
|
@@ -359,33 +359,33 @@ export interface Tag {
|
|
|
359
359
|
*/
|
|
360
360
|
export interface CreateDomainRequest {
|
|
361
361
|
/**
|
|
362
|
-
* @public
|
|
363
362
|
* <p>The name of the domain.</p>
|
|
363
|
+
* @public
|
|
364
364
|
*/
|
|
365
365
|
Name: string | undefined;
|
|
366
366
|
/**
|
|
367
|
-
* @public
|
|
368
367
|
* <p>A brief description of this domain.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
Description?: string;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>The configuration, containing the KMS key identifier, to be used by
|
|
374
373
|
* 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">
|
|
375
374
|
* Amazon Connect Voice ID encryption at rest</a> for more details on how the KMS key is used. </p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
381
380
|
* request. If not provided, the Amazon Web Services
|
|
382
381
|
* SDK populates this field. For more information about idempotency, see
|
|
383
382
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
383
|
+
* @public
|
|
384
384
|
*/
|
|
385
385
|
ClientToken?: string;
|
|
386
386
|
/**
|
|
387
|
-
* @public
|
|
388
387
|
* <p>A list of tags you want added to the domain.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
Tags?: Tag[];
|
|
391
391
|
}
|
|
@@ -416,101 +416,101 @@ export declare const ServerSideEncryptionUpdateStatus: {
|
|
|
416
416
|
*/
|
|
417
417
|
export type ServerSideEncryptionUpdateStatus = (typeof ServerSideEncryptionUpdateStatus)[keyof typeof ServerSideEncryptionUpdateStatus];
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>Details about the most recent server-side encryption configuration update. When the
|
|
421
420
|
* server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
|
|
422
421
|
* complete, the domain’s data can only be accessed using the new KMS key.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
export interface ServerSideEncryptionUpdateDetails {
|
|
425
425
|
/**
|
|
426
|
-
* @public
|
|
427
426
|
* <p>The previous KMS key ID the domain was encrypted with, before
|
|
428
427
|
* ServerSideEncryptionConfiguration was updated to a new KMS key ID.</p>
|
|
428
|
+
* @public
|
|
429
429
|
*/
|
|
430
430
|
OldKmsKeyId?: string;
|
|
431
431
|
/**
|
|
432
|
-
* @public
|
|
433
432
|
* <p>Status of the server-side encryption update. During an update, if there is an issue
|
|
434
433
|
* with the domain's current or old KMS key ID, such as an inaccessible or
|
|
435
434
|
* disabled key, then the status is FAILED. In order to resolve this, the key needs to be
|
|
436
435
|
* made accessible, and then an UpdateDomain call with the existing server-side encryption
|
|
437
436
|
* configuration will re-attempt this update process.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
UpdateStatus?: ServerSideEncryptionUpdateStatus;
|
|
440
440
|
/**
|
|
441
|
-
* @public
|
|
442
441
|
* <p>Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this
|
|
443
442
|
* message explains the cause of the failure.</p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
Message?: string;
|
|
446
446
|
}
|
|
447
447
|
/**
|
|
448
|
-
* @public
|
|
449
448
|
* <p>Details of the watchlists in a domain.</p>
|
|
449
|
+
* @public
|
|
450
450
|
*/
|
|
451
451
|
export interface WatchlistDetails {
|
|
452
452
|
/**
|
|
453
|
-
* @public
|
|
454
453
|
* <p>The identifier of the default watchlist.</p>
|
|
454
|
+
* @public
|
|
455
455
|
*/
|
|
456
456
|
DefaultWatchlistId: string | undefined;
|
|
457
457
|
}
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>Contains all the information about a domain.</p>
|
|
460
|
+
* @public
|
|
461
461
|
*/
|
|
462
462
|
export interface Domain {
|
|
463
463
|
/**
|
|
464
|
-
* @public
|
|
465
464
|
* <p>The identifier of the domain.</p>
|
|
465
|
+
* @public
|
|
466
466
|
*/
|
|
467
467
|
DomainId?: string;
|
|
468
468
|
/**
|
|
469
|
-
* @public
|
|
470
469
|
* <p>The Amazon Resource Name (ARN) for the domain.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
Arn?: string;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>The name for the domain.</p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
Name?: string;
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>The description of the domain.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
Description?: string;
|
|
483
483
|
/**
|
|
484
|
-
* @public
|
|
485
484
|
* <p>The current status of the domain.</p>
|
|
485
|
+
* @public
|
|
486
486
|
*/
|
|
487
487
|
DomainStatus?: DomainStatus;
|
|
488
488
|
/**
|
|
489
|
-
* @public
|
|
490
489
|
* <p>The server-side encryption configuration containing the KMS key
|
|
491
490
|
* identifier you want Voice ID to use to encrypt your data.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <p>The timestamp of when the domain was created.</p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
CreatedAt?: Date;
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The timestamp of when the domain was last update.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
UpdatedAt?: Date;
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>Details about the most recent server-side encryption configuration update. When the
|
|
507
506
|
* server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
|
|
508
507
|
* complete, the domain's data can only be accessed using the new KMS key.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The watchlist details of a domain. Contains the default watchlist ID of the domain.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
WatchlistDetails?: WatchlistDetails;
|
|
516
516
|
}
|
|
@@ -519,8 +519,8 @@ export interface Domain {
|
|
|
519
519
|
*/
|
|
520
520
|
export interface CreateDomainResponse {
|
|
521
521
|
/**
|
|
522
|
-
* @public
|
|
523
522
|
* <p>Information about the newly created domain.</p>
|
|
523
|
+
* @public
|
|
524
524
|
*/
|
|
525
525
|
Domain?: Domain;
|
|
526
526
|
}
|
|
@@ -529,67 +529,67 @@ export interface CreateDomainResponse {
|
|
|
529
529
|
*/
|
|
530
530
|
export interface CreateWatchlistRequest {
|
|
531
531
|
/**
|
|
532
|
-
* @public
|
|
533
532
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
533
|
+
* @public
|
|
534
534
|
*/
|
|
535
535
|
DomainId: string | undefined;
|
|
536
536
|
/**
|
|
537
|
-
* @public
|
|
538
537
|
* <p>The name of the watchlist.</p>
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
Name: string | undefined;
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>A brief description of this watchlist.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
Description?: string;
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
549
548
|
* request. If not provided, the Amazon Web Services
|
|
550
549
|
* SDK populates this field. For more information about idempotency, see
|
|
551
550
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
ClientToken?: string;
|
|
554
554
|
}
|
|
555
555
|
/**
|
|
556
|
-
* @public
|
|
557
556
|
* <p>Contains all the information about a watchlist.</p>
|
|
557
|
+
* @public
|
|
558
558
|
*/
|
|
559
559
|
export interface Watchlist {
|
|
560
560
|
/**
|
|
561
|
-
* @public
|
|
562
561
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
562
|
+
* @public
|
|
563
563
|
*/
|
|
564
564
|
DomainId?: string;
|
|
565
565
|
/**
|
|
566
|
-
* @public
|
|
567
566
|
* <p>The identifier of the watchlist.</p>
|
|
567
|
+
* @public
|
|
568
568
|
*/
|
|
569
569
|
WatchlistId?: string;
|
|
570
570
|
/**
|
|
571
|
-
* @public
|
|
572
571
|
* <p>The name for the watchlist.</p>
|
|
572
|
+
* @public
|
|
573
573
|
*/
|
|
574
574
|
Name?: string;
|
|
575
575
|
/**
|
|
576
|
-
* @public
|
|
577
576
|
* <p>The description of the watchlist.</p>
|
|
577
|
+
* @public
|
|
578
578
|
*/
|
|
579
579
|
Description?: string;
|
|
580
580
|
/**
|
|
581
|
-
* @public
|
|
582
581
|
* <p>Whether the specified watchlist is the default watchlist of a domain.</p>
|
|
582
|
+
* @public
|
|
583
583
|
*/
|
|
584
584
|
DefaultWatchlist?: boolean;
|
|
585
585
|
/**
|
|
586
|
-
* @public
|
|
587
586
|
* <p>The timestamp of when the watchlist was created.</p>
|
|
587
|
+
* @public
|
|
588
588
|
*/
|
|
589
589
|
CreatedAt?: Date;
|
|
590
590
|
/**
|
|
591
|
-
* @public
|
|
592
591
|
* <p>The timestamp of when the watchlist was updated.</p>
|
|
592
|
+
* @public
|
|
593
593
|
*/
|
|
594
594
|
UpdatedAt?: Date;
|
|
595
595
|
}
|
|
@@ -598,8 +598,8 @@ export interface Watchlist {
|
|
|
598
598
|
*/
|
|
599
599
|
export interface CreateWatchlistResponse {
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <p>Information about the newly created watchlist.</p>
|
|
602
|
+
* @public
|
|
603
603
|
*/
|
|
604
604
|
Watchlist?: Watchlist;
|
|
605
605
|
}
|
|
@@ -608,8 +608,8 @@ export interface CreateWatchlistResponse {
|
|
|
608
608
|
*/
|
|
609
609
|
export interface DeleteDomainRequest {
|
|
610
610
|
/**
|
|
611
|
-
* @public
|
|
612
611
|
* <p>The identifier of the domain you want to delete.</p>
|
|
612
|
+
* @public
|
|
613
613
|
*/
|
|
614
614
|
DomainId: string | undefined;
|
|
615
615
|
}
|
|
@@ -618,13 +618,13 @@ export interface DeleteDomainRequest {
|
|
|
618
618
|
*/
|
|
619
619
|
export interface DeleteFraudsterRequest {
|
|
620
620
|
/**
|
|
621
|
-
* @public
|
|
622
621
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
622
|
+
* @public
|
|
623
623
|
*/
|
|
624
624
|
DomainId: string | undefined;
|
|
625
625
|
/**
|
|
626
|
-
* @public
|
|
627
626
|
* <p>The identifier of the fraudster you want to delete.</p>
|
|
627
|
+
* @public
|
|
628
628
|
*/
|
|
629
629
|
FraudsterId: string | undefined;
|
|
630
630
|
}
|
|
@@ -633,13 +633,13 @@ export interface DeleteFraudsterRequest {
|
|
|
633
633
|
*/
|
|
634
634
|
export interface DeleteSpeakerRequest {
|
|
635
635
|
/**
|
|
636
|
-
* @public
|
|
637
636
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
637
|
+
* @public
|
|
638
638
|
*/
|
|
639
639
|
DomainId: string | undefined;
|
|
640
640
|
/**
|
|
641
|
-
* @public
|
|
642
641
|
* <p>The identifier of the speaker you want to delete.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
SpeakerId: string | undefined;
|
|
645
645
|
}
|
|
@@ -648,13 +648,13 @@ export interface DeleteSpeakerRequest {
|
|
|
648
648
|
*/
|
|
649
649
|
export interface DeleteWatchlistRequest {
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
652
|
+
* @public
|
|
653
653
|
*/
|
|
654
654
|
DomainId: string | undefined;
|
|
655
655
|
/**
|
|
656
|
-
* @public
|
|
657
656
|
* <p>The identifier of the watchlist to be deleted.</p>
|
|
657
|
+
* @public
|
|
658
658
|
*/
|
|
659
659
|
WatchlistId: string | undefined;
|
|
660
660
|
}
|
|
@@ -663,8 +663,8 @@ export interface DeleteWatchlistRequest {
|
|
|
663
663
|
*/
|
|
664
664
|
export interface DescribeDomainRequest {
|
|
665
665
|
/**
|
|
666
|
-
* @public
|
|
667
666
|
* <p>The identifier of the domain that you are describing.</p>
|
|
667
|
+
* @public
|
|
668
668
|
*/
|
|
669
669
|
DomainId: string | undefined;
|
|
670
670
|
}
|
|
@@ -673,8 +673,8 @@ export interface DescribeDomainRequest {
|
|
|
673
673
|
*/
|
|
674
674
|
export interface DescribeDomainResponse {
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>Information about the specified domain.</p>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
Domain?: Domain;
|
|
680
680
|
}
|
|
@@ -683,13 +683,13 @@ export interface DescribeDomainResponse {
|
|
|
683
683
|
*/
|
|
684
684
|
export interface DescribeFraudsterRequest {
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
DomainId: string | undefined;
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The identifier of the fraudster you are describing.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
FraudsterId: string | undefined;
|
|
695
695
|
}
|
|
@@ -698,8 +698,8 @@ export interface DescribeFraudsterRequest {
|
|
|
698
698
|
*/
|
|
699
699
|
export interface DescribeFraudsterResponse {
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>Information about the specified fraudster.</p>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
Fraudster?: Fraudster;
|
|
705
705
|
}
|
|
@@ -708,53 +708,53 @@ export interface DescribeFraudsterResponse {
|
|
|
708
708
|
*/
|
|
709
709
|
export interface DescribeFraudsterRegistrationJobRequest {
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
DomainId: string | undefined;
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>The identifier of the fraudster registration job you are describing.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
JobId: string | undefined;
|
|
720
720
|
}
|
|
721
721
|
/**
|
|
722
|
-
* @public
|
|
723
722
|
* <p>Contains error details for a failed batch job.</p>
|
|
723
|
+
* @public
|
|
724
724
|
*/
|
|
725
725
|
export interface FailureDetails {
|
|
726
726
|
/**
|
|
727
|
-
* @public
|
|
728
727
|
* <p>An HTTP status code representing the nature of the error.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
StatusCode?: number;
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>A description of the error that caused the batch job failure.</p>
|
|
733
|
+
* @public
|
|
734
734
|
*/
|
|
735
735
|
Message?: string;
|
|
736
736
|
}
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>The configuration containing input file information for a batch job.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
export interface InputDataConfig {
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>The S3 location for the input manifest file that contains the list of individual
|
|
745
744
|
* enrollment or registration job requests.</p>
|
|
745
|
+
* @public
|
|
746
746
|
*/
|
|
747
747
|
S3Uri: string | undefined;
|
|
748
748
|
}
|
|
749
749
|
/**
|
|
750
|
-
* @public
|
|
751
750
|
* <p>Indicates the completion progress for a batch job.</p>
|
|
751
|
+
* @public
|
|
752
752
|
*/
|
|
753
753
|
export interface JobProgress {
|
|
754
754
|
/**
|
|
755
|
-
* @public
|
|
756
755
|
* <p>Shows the completed percentage of enrollment or registration requests listed in the
|
|
757
756
|
* input file.</p>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
PercentComplete?: number;
|
|
760
760
|
}
|
|
@@ -774,24 +774,24 @@ export declare const FraudsterRegistrationJobStatus: {
|
|
|
774
774
|
*/
|
|
775
775
|
export type FraudsterRegistrationJobStatus = (typeof FraudsterRegistrationJobStatus)[keyof typeof FraudsterRegistrationJobStatus];
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>The configuration containing output file information for a batch job.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
export interface OutputDataConfig {
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <p>The S3 path of the folder where Voice ID writes the job output file. It has a
|
|
784
783
|
* <code>*.out</code> extension. For example, if the input file name is
|
|
785
784
|
* <code>input-file.json</code> and the output folder path is
|
|
786
785
|
* <code>s3://output-bucket/output-folder</code>, the full output file path is
|
|
787
786
|
* <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
S3Uri: string | undefined;
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>The identifier of the KMS key you want Voice ID to use to encrypt the
|
|
793
792
|
* output file of a speaker enrollment job/fraudster registration job.
|
|
794
793
|
* </p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
KmsKeyId?: string;
|
|
797
797
|
}
|
|
@@ -808,105 +808,105 @@ export declare const DuplicateRegistrationAction: {
|
|
|
808
808
|
*/
|
|
809
809
|
export type DuplicateRegistrationAction = (typeof DuplicateRegistrationAction)[keyof typeof DuplicateRegistrationAction];
|
|
810
810
|
/**
|
|
811
|
-
* @public
|
|
812
811
|
* <p>The registration configuration to be used during the batch fraudster registration job.</p>
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
export interface RegistrationConfig {
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>The action to take when a fraudster is identified as a duplicate. The default action
|
|
818
817
|
* is <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value
|
|
819
818
|
* to <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified
|
|
820
819
|
* domain.</p>
|
|
820
|
+
* @public
|
|
821
821
|
*/
|
|
822
822
|
DuplicateRegistrationAction?: DuplicateRegistrationAction;
|
|
823
823
|
/**
|
|
824
|
-
* @public
|
|
825
824
|
* <p>The minimum similarity score between the new and old fraudsters in order to consider
|
|
826
825
|
* the new fraudster a duplicate.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
FraudsterSimilarityThreshold?: number;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <p>The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.
|
|
832
831
|
* </p>
|
|
832
|
+
* @public
|
|
833
833
|
*/
|
|
834
834
|
WatchlistIds?: string[];
|
|
835
835
|
}
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>Contains all the information about a fraudster registration job.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
export interface FraudsterRegistrationJob {
|
|
841
841
|
/**
|
|
842
|
-
* @public
|
|
843
842
|
* <p>The client-provided name for the fraudster registration job.</p>
|
|
843
|
+
* @public
|
|
844
844
|
*/
|
|
845
845
|
JobName?: string;
|
|
846
846
|
/**
|
|
847
|
-
* @public
|
|
848
847
|
* <p>The service-generated identifier for the fraudster registration job.</p>
|
|
848
|
+
* @public
|
|
849
849
|
*/
|
|
850
850
|
JobId?: string;
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>The current status of the fraudster registration job.</p>
|
|
853
|
+
* @public
|
|
854
854
|
*/
|
|
855
855
|
JobStatus?: FraudsterRegistrationJobStatus;
|
|
856
856
|
/**
|
|
857
|
-
* @public
|
|
858
857
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
858
|
+
* @public
|
|
859
859
|
*/
|
|
860
860
|
DomainId?: string;
|
|
861
861
|
/**
|
|
862
|
-
* @public
|
|
863
862
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
864
863
|
* customer's buckets to read the input manifest file and write the job output file.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
DataAccessRoleArn?: string;
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>The registration config containing details such as the action to take when a duplicate
|
|
870
869
|
* fraudster is detected, and the similarity threshold to use for detecting a duplicate
|
|
871
870
|
* fraudster.</p>
|
|
871
|
+
* @public
|
|
872
872
|
*/
|
|
873
873
|
RegistrationConfig?: RegistrationConfig;
|
|
874
874
|
/**
|
|
875
|
-
* @public
|
|
876
875
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
877
876
|
* the list of fraudster registration job requests.</p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
InputDataConfig?: InputDataConfig;
|
|
880
880
|
/**
|
|
881
|
-
* @public
|
|
882
881
|
* <p>The output data config containing the S3 location where you want Voice ID to write
|
|
883
882
|
* your job output file; you must also include a KMS key ID in order to
|
|
884
883
|
* encrypt the file.</p>
|
|
884
|
+
* @public
|
|
885
885
|
*/
|
|
886
886
|
OutputDataConfig?: OutputDataConfig;
|
|
887
887
|
/**
|
|
888
|
-
* @public
|
|
889
888
|
* <p>A timestamp of when the fraudster registration job was created.</p>
|
|
889
|
+
* @public
|
|
890
890
|
*/
|
|
891
891
|
CreatedAt?: Date;
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>A timestamp of when the fraudster registration job ended.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
EndedAt?: Date;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
900
899
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
901
900
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
902
901
|
* use the job output file to identify the individual registration requests that
|
|
903
902
|
* failed.</p>
|
|
903
|
+
* @public
|
|
904
904
|
*/
|
|
905
905
|
FailureDetails?: FailureDetails;
|
|
906
906
|
/**
|
|
907
|
-
* @public
|
|
908
907
|
* <p>Shows the completed percentage of registration requests listed in the input
|
|
909
908
|
* file.</p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
JobProgress?: JobProgress;
|
|
912
912
|
}
|
|
@@ -915,8 +915,8 @@ export interface FraudsterRegistrationJob {
|
|
|
915
915
|
*/
|
|
916
916
|
export interface DescribeFraudsterRegistrationJobResponse {
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>Contains details about the specified fraudster registration job.</p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
Job?: FraudsterRegistrationJob;
|
|
922
922
|
}
|
|
@@ -925,13 +925,13 @@ export interface DescribeFraudsterRegistrationJobResponse {
|
|
|
925
925
|
*/
|
|
926
926
|
export interface DescribeSpeakerRequest {
|
|
927
927
|
/**
|
|
928
|
-
* @public
|
|
929
928
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
929
|
+
* @public
|
|
930
930
|
*/
|
|
931
931
|
DomainId: string | undefined;
|
|
932
932
|
/**
|
|
933
|
-
* @public
|
|
934
933
|
* <p>The identifier of the speaker you are describing.</p>
|
|
934
|
+
* @public
|
|
935
935
|
*/
|
|
936
936
|
SpeakerId: string | undefined;
|
|
937
937
|
}
|
|
@@ -950,44 +950,44 @@ export declare const SpeakerStatus: {
|
|
|
950
950
|
*/
|
|
951
951
|
export type SpeakerStatus = (typeof SpeakerStatus)[keyof typeof SpeakerStatus];
|
|
952
952
|
/**
|
|
953
|
-
* @public
|
|
954
953
|
* <p>Contains all the information about a speaker.</p>
|
|
954
|
+
* @public
|
|
955
955
|
*/
|
|
956
956
|
export interface Speaker {
|
|
957
957
|
/**
|
|
958
|
-
* @public
|
|
959
958
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
959
|
+
* @public
|
|
960
960
|
*/
|
|
961
961
|
DomainId?: string;
|
|
962
962
|
/**
|
|
963
|
-
* @public
|
|
964
963
|
* <p>The client-provided identifier for the speaker.</p>
|
|
964
|
+
* @public
|
|
965
965
|
*/
|
|
966
966
|
CustomerSpeakerId?: string;
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>The service-generated identifier for the speaker.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
GeneratedSpeakerId?: string;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>The current status of the speaker.</p>
|
|
974
|
+
* @public
|
|
975
975
|
*/
|
|
976
976
|
Status?: SpeakerStatus;
|
|
977
977
|
/**
|
|
978
|
-
* @public
|
|
979
978
|
* <p>A timestamp of when the speaker was created. </p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
CreatedAt?: Date;
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>A timestamp of the speaker's last update.</p>
|
|
984
|
+
* @public
|
|
985
985
|
*/
|
|
986
986
|
UpdatedAt?: Date;
|
|
987
987
|
/**
|
|
988
|
-
* @public
|
|
989
988
|
* <p>The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a
|
|
990
989
|
* successful authentication. This timestamp is accurate to one hour.</p>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
LastAccessedAt?: Date;
|
|
993
993
|
}
|
|
@@ -996,8 +996,8 @@ export interface Speaker {
|
|
|
996
996
|
*/
|
|
997
997
|
export interface DescribeSpeakerResponse {
|
|
998
998
|
/**
|
|
999
|
-
* @public
|
|
1000
999
|
* <p>Information about the specified speaker.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
Speaker?: Speaker;
|
|
1003
1003
|
}
|
|
@@ -1006,13 +1006,13 @@ export interface DescribeSpeakerResponse {
|
|
|
1006
1006
|
*/
|
|
1007
1007
|
export interface DescribeSpeakerEnrollmentJobRequest {
|
|
1008
1008
|
/**
|
|
1009
|
-
* @public
|
|
1010
1009
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
1010
|
+
* @public
|
|
1011
1011
|
*/
|
|
1012
1012
|
DomainId: string | undefined;
|
|
1013
1013
|
/**
|
|
1014
|
-
* @public
|
|
1015
1014
|
* <p>The identifier of the speaker enrollment job you are describing.</p>
|
|
1015
|
+
* @public
|
|
1016
1016
|
*/
|
|
1017
1017
|
JobId: string | undefined;
|
|
1018
1018
|
}
|
|
@@ -1041,49 +1041,49 @@ export declare const FraudDetectionAction: {
|
|
|
1041
1041
|
*/
|
|
1042
1042
|
export type FraudDetectionAction = (typeof FraudDetectionAction)[keyof typeof FraudDetectionAction];
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The fraud detection configuration to be used during the batch speaker enrollment job.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
export interface EnrollmentJobFraudDetectionConfig {
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The action to take when the given speaker is flagged by the fraud detection system.
|
|
1051
1050
|
* The default value is <code>FAIL</code>, which fails the speaker enrollment. Changing
|
|
1052
1051
|
* this value to <code>IGNORE</code> results in the speaker being enrolled even if they are
|
|
1053
1052
|
* flagged by the fraud detection system.</p>
|
|
1053
|
+
* @public
|
|
1054
1054
|
*/
|
|
1055
1055
|
FraudDetectionAction?: FraudDetectionAction;
|
|
1056
1056
|
/**
|
|
1057
|
-
* @public
|
|
1058
1057
|
* <p>Threshold value for determining whether the speaker is a high risk to be fraudulent.
|
|
1059
1058
|
* If the detected risk score calculated by Voice ID is greater than or equal to the
|
|
1060
1059
|
* threshold, the speaker is considered a fraudster.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
RiskThreshold?: number;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The identifier of watchlists against which fraud detection is performed.
|
|
1066
1065
|
* </p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
WatchlistIds?: string[];
|
|
1069
1069
|
}
|
|
1070
1070
|
/**
|
|
1071
|
-
* @public
|
|
1072
1071
|
* <p>Contains configurations defining enrollment behavior for the batch job.</p>
|
|
1072
|
+
* @public
|
|
1073
1073
|
*/
|
|
1074
1074
|
export interface EnrollmentConfig {
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p> The action to take when the specified speaker is already enrolled in the specified
|
|
1078
1077
|
* domain. The default value is <code>SKIP</code>, which skips the enrollment for the
|
|
1079
1078
|
* existing speaker. Setting the value to <code>OVERWRITE</code> replaces the existing
|
|
1080
1079
|
* voice prints and enrollment audio stored for that speaker with new data generated from
|
|
1081
1080
|
* the latest audio.</p>
|
|
1081
|
+
* @public
|
|
1082
1082
|
*/
|
|
1083
1083
|
ExistingEnrollmentAction?: ExistingEnrollmentAction;
|
|
1084
1084
|
/**
|
|
1085
|
-
* @public
|
|
1086
1085
|
* <p>The fraud detection configuration to use for the speaker enrollment job.</p>
|
|
1086
|
+
* @public
|
|
1087
1087
|
*/
|
|
1088
1088
|
FraudDetectionConfig?: EnrollmentJobFraudDetectionConfig;
|
|
1089
1089
|
}
|
|
@@ -1103,78 +1103,78 @@ export declare const SpeakerEnrollmentJobStatus: {
|
|
|
1103
1103
|
*/
|
|
1104
1104
|
export type SpeakerEnrollmentJobStatus = (typeof SpeakerEnrollmentJobStatus)[keyof typeof SpeakerEnrollmentJobStatus];
|
|
1105
1105
|
/**
|
|
1106
|
-
* @public
|
|
1107
1106
|
* <p>Contains all the information about a speaker enrollment job.</p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
export interface SpeakerEnrollmentJob {
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The client-provided name for the speaker enrollment job.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
JobName?: string;
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The service-generated identifier for the speaker enrollment job.</p>
|
|
1117
|
+
* @public
|
|
1118
1118
|
*/
|
|
1119
1119
|
JobId?: string;
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>The current status of the speaker enrollment job.</p>
|
|
1122
|
+
* @public
|
|
1123
1123
|
*/
|
|
1124
1124
|
JobStatus?: SpeakerEnrollmentJobStatus;
|
|
1125
1125
|
/**
|
|
1126
|
-
* @public
|
|
1127
1126
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
1127
|
+
* @public
|
|
1128
1128
|
*/
|
|
1129
1129
|
DomainId?: string;
|
|
1130
1130
|
/**
|
|
1131
|
-
* @public
|
|
1132
1131
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
1133
1132
|
* customer's buckets to read the input manifest file and write the job output file.</p>
|
|
1133
|
+
* @public
|
|
1134
1134
|
*/
|
|
1135
1135
|
DataAccessRoleArn?: string;
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>The configuration that defines the action to take when the speaker is already enrolled
|
|
1139
1138
|
* in Voice ID, and the <code>FraudDetectionConfig</code> to use.</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
EnrollmentConfig?: EnrollmentConfig;
|
|
1142
1142
|
/**
|
|
1143
|
-
* @public
|
|
1144
1143
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
1145
1144
|
* the list of speaker enrollment job requests.</p>
|
|
1145
|
+
* @public
|
|
1146
1146
|
*/
|
|
1147
1147
|
InputDataConfig?: InputDataConfig;
|
|
1148
1148
|
/**
|
|
1149
|
-
* @public
|
|
1150
1149
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
1151
1150
|
* output file; you must also include a KMS key ID to encrypt the
|
|
1152
1151
|
* file.</p>
|
|
1152
|
+
* @public
|
|
1153
1153
|
*/
|
|
1154
1154
|
OutputDataConfig?: OutputDataConfig;
|
|
1155
1155
|
/**
|
|
1156
|
-
* @public
|
|
1157
1156
|
* <p>A timestamp of when the speaker enrollment job was created.</p>
|
|
1157
|
+
* @public
|
|
1158
1158
|
*/
|
|
1159
1159
|
CreatedAt?: Date;
|
|
1160
1160
|
/**
|
|
1161
|
-
* @public
|
|
1162
1161
|
* <p>A timestamp of when the speaker enrollment job ended. </p>
|
|
1162
|
+
* @public
|
|
1163
1163
|
*/
|
|
1164
1164
|
EndedAt?: Date;
|
|
1165
1165
|
/**
|
|
1166
|
-
* @public
|
|
1167
1166
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1168
1167
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1169
1168
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
1170
1169
|
* use the job output file to identify the individual registration requests that
|
|
1171
1170
|
* failed.</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
FailureDetails?: FailureDetails;
|
|
1174
1174
|
/**
|
|
1175
|
-
* @public
|
|
1176
1175
|
* <p>Provides details on job progress. This field shows the completed percentage of
|
|
1177
1176
|
* registration requests listed in the input file.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
JobProgress?: JobProgress;
|
|
1180
1180
|
}
|
|
@@ -1183,8 +1183,8 @@ export interface SpeakerEnrollmentJob {
|
|
|
1183
1183
|
*/
|
|
1184
1184
|
export interface DescribeSpeakerEnrollmentJobResponse {
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>Contains details about the specified speaker enrollment job.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
Job?: SpeakerEnrollmentJob;
|
|
1190
1190
|
}
|
|
@@ -1193,13 +1193,13 @@ export interface DescribeSpeakerEnrollmentJobResponse {
|
|
|
1193
1193
|
*/
|
|
1194
1194
|
export interface DescribeWatchlistRequest {
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
DomainId: string | undefined;
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The identifier of the watchlist that you are describing.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
WatchlistId: string | undefined;
|
|
1205
1205
|
}
|
|
@@ -1208,8 +1208,8 @@ export interface DescribeWatchlistRequest {
|
|
|
1208
1208
|
*/
|
|
1209
1209
|
export interface DescribeWatchlistResponse {
|
|
1210
1210
|
/**
|
|
1211
|
-
* @public
|
|
1212
1211
|
* <p>Information about the specified watchlist.</p>
|
|
1212
|
+
* @public
|
|
1213
1213
|
*/
|
|
1214
1214
|
Watchlist?: Watchlist;
|
|
1215
1215
|
}
|
|
@@ -1218,18 +1218,18 @@ export interface DescribeWatchlistResponse {
|
|
|
1218
1218
|
*/
|
|
1219
1219
|
export interface DisassociateFraudsterRequest {
|
|
1220
1220
|
/**
|
|
1221
|
-
* @public
|
|
1222
1221
|
* <p>The identifier of the domain that contains the fraudster.</p>
|
|
1222
|
+
* @public
|
|
1223
1223
|
*/
|
|
1224
1224
|
DomainId: string | undefined;
|
|
1225
1225
|
/**
|
|
1226
|
-
* @public
|
|
1227
1226
|
* <p>The identifier of the watchlist that you want to disassociate from the fraudster.</p>
|
|
1227
|
+
* @public
|
|
1228
1228
|
*/
|
|
1229
1229
|
WatchlistId: string | undefined;
|
|
1230
1230
|
/**
|
|
1231
|
-
* @public
|
|
1232
1231
|
* <p>The identifier of the fraudster to be disassociated from the watchlist.</p>
|
|
1232
|
+
* @public
|
|
1233
1233
|
*/
|
|
1234
1234
|
FraudsterId: string | undefined;
|
|
1235
1235
|
}
|
|
@@ -1238,8 +1238,8 @@ export interface DisassociateFraudsterRequest {
|
|
|
1238
1238
|
*/
|
|
1239
1239
|
export interface DisassociateFraudsterResponse {
|
|
1240
1240
|
/**
|
|
1241
|
-
* @public
|
|
1242
1241
|
* <p>Contains all the information about a fraudster.</p>
|
|
1242
|
+
* @public
|
|
1243
1243
|
*/
|
|
1244
1244
|
Fraudster?: Fraudster;
|
|
1245
1245
|
}
|
|
@@ -1248,76 +1248,76 @@ export interface DisassociateFraudsterResponse {
|
|
|
1248
1248
|
*/
|
|
1249
1249
|
export interface ListDomainsRequest {
|
|
1250
1250
|
/**
|
|
1251
|
-
* @public
|
|
1252
1251
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1253
1252
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
|
|
1253
|
+
* @public
|
|
1254
1254
|
*/
|
|
1255
1255
|
MaxResults?: number;
|
|
1256
1256
|
/**
|
|
1257
|
-
* @public
|
|
1258
1257
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1259
1258
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1260
1259
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1261
1260
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1261
|
+
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
NextToken?: string;
|
|
1264
1264
|
}
|
|
1265
1265
|
/**
|
|
1266
|
-
* @public
|
|
1267
1266
|
* <p>Contains a summary of information about a domain.</p>
|
|
1267
|
+
* @public
|
|
1268
1268
|
*/
|
|
1269
1269
|
export interface DomainSummary {
|
|
1270
1270
|
/**
|
|
1271
|
-
* @public
|
|
1272
1271
|
* <p>The identifier of the domain.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
DomainId?: string;
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>The Amazon Resource Name (ARN) for the domain.</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
Arn?: string;
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>The client-provided name for the domain.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
Name?: string;
|
|
1285
1285
|
/**
|
|
1286
|
-
* @public
|
|
1287
1286
|
* <p>The description of the domain.</p>
|
|
1287
|
+
* @public
|
|
1288
1288
|
*/
|
|
1289
1289
|
Description?: string;
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>The current status of the domain.</p>
|
|
1292
|
+
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
DomainStatus?: DomainStatus;
|
|
1295
1295
|
/**
|
|
1296
|
-
* @public
|
|
1297
1296
|
* <p>The server-side encryption configuration containing the KMS key
|
|
1298
1297
|
* identifier you want Voice ID to use to encrypt your data.</p>
|
|
1298
|
+
* @public
|
|
1299
1299
|
*/
|
|
1300
1300
|
ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1301
1301
|
/**
|
|
1302
|
-
* @public
|
|
1303
1302
|
* <p>The timestamp of when the domain was created.</p>
|
|
1303
|
+
* @public
|
|
1304
1304
|
*/
|
|
1305
1305
|
CreatedAt?: Date;
|
|
1306
1306
|
/**
|
|
1307
|
-
* @public
|
|
1308
1307
|
* <p>The timestamp of when the domain was last updated.</p>
|
|
1308
|
+
* @public
|
|
1309
1309
|
*/
|
|
1310
1310
|
UpdatedAt?: Date;
|
|
1311
1311
|
/**
|
|
1312
|
-
* @public
|
|
1313
1312
|
* <p>Details about the most recent server-side encryption configuration update. When the
|
|
1314
1313
|
* server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is
|
|
1315
1314
|
* complete, the domain's data can only be accessed using the new KMS key.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
|
|
1318
1318
|
/**
|
|
1319
|
-
* @public
|
|
1320
1319
|
* <p>Provides information about <code>watchlistDetails</code> and <code>DefaultWatchlistID</code>. </p>
|
|
1320
|
+
* @public
|
|
1321
1321
|
*/
|
|
1322
1322
|
WatchlistDetails?: WatchlistDetails;
|
|
1323
1323
|
}
|
|
@@ -1326,16 +1326,16 @@ export interface DomainSummary {
|
|
|
1326
1326
|
*/
|
|
1327
1327
|
export interface ListDomainsResponse {
|
|
1328
1328
|
/**
|
|
1329
|
-
* @public
|
|
1330
1329
|
* <p>A list containing details about each domain in the Amazon Web Services account.</p>
|
|
1330
|
+
* @public
|
|
1331
1331
|
*/
|
|
1332
1332
|
DomainSummaries?: DomainSummary[];
|
|
1333
1333
|
/**
|
|
1334
|
-
* @public
|
|
1335
1334
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1336
1335
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1337
1336
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1338
1337
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
NextToken?: string;
|
|
1341
1341
|
}
|
|
@@ -1344,22 +1344,21 @@ export interface ListDomainsResponse {
|
|
|
1344
1344
|
*/
|
|
1345
1345
|
export interface UpdateDomainRequest {
|
|
1346
1346
|
/**
|
|
1347
|
-
* @public
|
|
1348
1347
|
* <p>The identifier of the domain to be updated.</p>
|
|
1348
|
+
* @public
|
|
1349
1349
|
*/
|
|
1350
1350
|
DomainId: string | undefined;
|
|
1351
1351
|
/**
|
|
1352
|
-
* @public
|
|
1353
1352
|
* <p>The name of the domain.</p>
|
|
1353
|
+
* @public
|
|
1354
1354
|
*/
|
|
1355
1355
|
Name: string | undefined;
|
|
1356
1356
|
/**
|
|
1357
|
-
* @public
|
|
1358
1357
|
* <p>A brief description about this domain.</p>
|
|
1358
|
+
* @public
|
|
1359
1359
|
*/
|
|
1360
1360
|
Description?: string;
|
|
1361
1361
|
/**
|
|
1362
|
-
* @public
|
|
1363
1362
|
* <p>The configuration, containing the KMS key identifier, to be used by
|
|
1364
1363
|
* Voice ID for the server-side encryption of your data. Changing the domain's associated
|
|
1365
1364
|
* KMS key immediately triggers an asynchronous process to remove
|
|
@@ -1367,6 +1366,7 @@ export interface UpdateDomainRequest {
|
|
|
1367
1366
|
* accessed using the new KMS key. The domain's
|
|
1368
1367
|
* <code>ServerSideEncryptionUpdateDetails</code> contains the details for this
|
|
1369
1368
|
* process.</p>
|
|
1369
|
+
* @public
|
|
1370
1370
|
*/
|
|
1371
1371
|
ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
|
|
1372
1372
|
}
|
|
@@ -1375,8 +1375,8 @@ export interface UpdateDomainRequest {
|
|
|
1375
1375
|
*/
|
|
1376
1376
|
export interface UpdateDomainResponse {
|
|
1377
1377
|
/**
|
|
1378
|
-
* @public
|
|
1379
1378
|
* <p>Details about the updated domain</p>
|
|
1379
|
+
* @public
|
|
1380
1380
|
*/
|
|
1381
1381
|
Domain?: Domain;
|
|
1382
1382
|
}
|
|
@@ -1385,34 +1385,34 @@ export interface UpdateDomainResponse {
|
|
|
1385
1385
|
*/
|
|
1386
1386
|
export interface EvaluateSessionRequest {
|
|
1387
1387
|
/**
|
|
1388
|
-
* @public
|
|
1389
1388
|
* <p>The identifier of the domain where the session started.</p>
|
|
1389
|
+
* @public
|
|
1390
1390
|
*/
|
|
1391
1391
|
DomainId: string | undefined;
|
|
1392
1392
|
/**
|
|
1393
|
-
* @public
|
|
1394
1393
|
* <p>The session identifier, or name of the session, that you want to evaluate. In
|
|
1395
1394
|
* Voice ID integration, this is the Contact-Id.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
SessionNameOrId: string | undefined;
|
|
1398
1398
|
}
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>The configuration used for performing fraud detection over a speaker during a
|
|
1402
1401
|
* session.</p>
|
|
1402
|
+
* @public
|
|
1403
1403
|
*/
|
|
1404
1404
|
export interface FraudDetectionConfiguration {
|
|
1405
1405
|
/**
|
|
1406
|
-
* @public
|
|
1407
1406
|
* <p>Threshold value for determining whether the speaker is a fraudster. If the detected
|
|
1408
1407
|
* risk score calculated by Voice ID is higher than the threshold, the speaker is
|
|
1409
1408
|
* considered a fraudster.</p>
|
|
1409
|
+
* @public
|
|
1410
1410
|
*/
|
|
1411
1411
|
RiskThreshold?: number;
|
|
1412
1412
|
/**
|
|
1413
|
-
* @public
|
|
1414
1413
|
* <p>The identifier of the watchlist against which fraud detection is performed.
|
|
1415
1414
|
* </p>
|
|
1415
|
+
* @public
|
|
1416
1416
|
*/
|
|
1417
1417
|
WatchlistId?: string;
|
|
1418
1418
|
}
|
|
@@ -1442,102 +1442,102 @@ export declare const FraudDetectionReason: {
|
|
|
1442
1442
|
*/
|
|
1443
1443
|
export type FraudDetectionReason = (typeof FraudDetectionReason)[keyof typeof FraudDetectionReason];
|
|
1444
1444
|
/**
|
|
1445
|
-
* @public
|
|
1446
1445
|
* <p>Contains details produced as a result of performing known fraudster risk analysis on a
|
|
1447
1446
|
* speaker.</p>
|
|
1447
|
+
* @public
|
|
1448
1448
|
*/
|
|
1449
1449
|
export interface KnownFraudsterRisk {
|
|
1450
1450
|
/**
|
|
1451
|
-
* @public
|
|
1452
1451
|
* <p>The score indicating the likelihood the speaker is a known fraudster.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
RiskScore: number | undefined;
|
|
1455
1455
|
/**
|
|
1456
|
-
* @public
|
|
1457
1456
|
* <p>The identifier of the fraudster that is the closest match to the speaker. If there are
|
|
1458
1457
|
* no fraudsters registered in a given domain, or if there are no fraudsters with a
|
|
1459
1458
|
* non-zero RiskScore, this value is <code>null</code>.</p>
|
|
1459
|
+
* @public
|
|
1460
1460
|
*/
|
|
1461
1461
|
GeneratedFraudsterId?: string;
|
|
1462
1462
|
}
|
|
1463
1463
|
/**
|
|
1464
|
-
* @public
|
|
1465
1464
|
* <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
|
|
1465
|
+
* @public
|
|
1466
1466
|
*/
|
|
1467
1467
|
export interface VoiceSpoofingRisk {
|
|
1468
1468
|
/**
|
|
1469
|
-
* @public
|
|
1470
1469
|
* <p>The score indicating the likelihood of speaker’s voice being spoofed.</p>
|
|
1470
|
+
* @public
|
|
1471
1471
|
*/
|
|
1472
1472
|
RiskScore: number | undefined;
|
|
1473
1473
|
}
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>Details regarding various fraud risk analyses performed against the current session
|
|
1477
1476
|
* state and streamed audio of the speaker.</p>
|
|
1477
|
+
* @public
|
|
1478
1478
|
*/
|
|
1479
1479
|
export interface FraudRiskDetails {
|
|
1480
1480
|
/**
|
|
1481
|
-
* @public
|
|
1482
1481
|
* <p>The details resulting from 'Known Fraudster Risk' analysis of the speaker.</p>
|
|
1482
|
+
* @public
|
|
1483
1483
|
*/
|
|
1484
1484
|
KnownFraudsterRisk: KnownFraudsterRisk | undefined;
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
VoiceSpoofingRisk: VoiceSpoofingRisk | undefined;
|
|
1490
1490
|
}
|
|
1491
1491
|
/**
|
|
1492
|
-
* @public
|
|
1493
1492
|
* <p>The fraud detection result produced by Voice ID, processed against the current
|
|
1494
1493
|
* session state and streamed audio of the speaker.</p>
|
|
1494
|
+
* @public
|
|
1495
1495
|
*/
|
|
1496
1496
|
export interface FraudDetectionResult {
|
|
1497
1497
|
/**
|
|
1498
|
-
* @public
|
|
1499
1498
|
* <p>The unique identifier for this fraud detection result. Given there can be multiple
|
|
1500
1499
|
* fraud detections for a given session, this field helps in identifying if the returned
|
|
1501
1500
|
* result is from previous streaming activity or a new result. Note that in the absence of
|
|
1502
1501
|
* any new streaming activity or risk threshold changes, Voice ID always returns cached
|
|
1503
1502
|
* Fraud Detection result for this API.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
FraudDetectionResultId?: string;
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>A timestamp of when audio aggregation started for this fraud detection
|
|
1509
1508
|
* result.</p>
|
|
1509
|
+
* @public
|
|
1510
1510
|
*/
|
|
1511
1511
|
AudioAggregationStartedAt?: Date;
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>A timestamp of when audio aggregation ended for this fraud detection
|
|
1515
1514
|
* result.</p>
|
|
1515
|
+
* @public
|
|
1516
1516
|
*/
|
|
1517
1517
|
AudioAggregationEndedAt?: Date;
|
|
1518
1518
|
/**
|
|
1519
|
-
* @public
|
|
1520
1519
|
* <p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection
|
|
1521
1520
|
* result.</p>
|
|
1521
|
+
* @public
|
|
1522
1522
|
*/
|
|
1523
1523
|
Configuration?: FraudDetectionConfiguration;
|
|
1524
1524
|
/**
|
|
1525
|
-
* @public
|
|
1526
1525
|
* <p>The fraud detection decision produced by Voice ID, processed against the current
|
|
1527
1526
|
* session state and streamed audio of the speaker.</p>
|
|
1527
|
+
* @public
|
|
1528
1528
|
*/
|
|
1529
1529
|
Decision?: FraudDetectionDecision;
|
|
1530
1530
|
/**
|
|
1531
|
-
* @public
|
|
1532
1531
|
* <p>The reason speaker was flagged by the fraud detection system. This is only be
|
|
1533
1532
|
* populated if fraud detection Decision is <code>HIGH_RISK</code>, and the following
|
|
1534
1533
|
* possible values: <code>KNOWN_FRAUDSTER</code> and <code>VOICE_SPOOFING</code>.</p>
|
|
1534
|
+
* @public
|
|
1535
1535
|
*/
|
|
1536
1536
|
Reasons?: FraudDetectionReason[];
|
|
1537
1537
|
/**
|
|
1538
|
-
* @public
|
|
1539
1538
|
* <p>Details about each risk analyzed for this speaker. Currently, this contains
|
|
1540
1539
|
* KnownFraudsterRisk and VoiceSpoofingRisk details.</p>
|
|
1540
|
+
* @public
|
|
1541
1541
|
*/
|
|
1542
1542
|
RiskDetails?: FraudRiskDetails;
|
|
1543
1543
|
}
|
|
@@ -1559,22 +1559,21 @@ export type StreamingStatus = (typeof StreamingStatus)[keyof typeof StreamingSta
|
|
|
1559
1559
|
*/
|
|
1560
1560
|
export interface EvaluateSessionResponse {
|
|
1561
1561
|
/**
|
|
1562
|
-
* @public
|
|
1563
1562
|
* <p>The identifier of the domain that contains the session.</p>
|
|
1563
|
+
* @public
|
|
1564
1564
|
*/
|
|
1565
1565
|
DomainId?: string;
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>The service-generated identifier of the session.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
SessionId?: string;
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <p>The client-provided name of the session.</p>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
SessionName?: string;
|
|
1576
1576
|
/**
|
|
1577
|
-
* @public
|
|
1578
1577
|
* <p>The current status of audio streaming for this session. This field is useful to infer
|
|
1579
1578
|
* next steps when the Authentication or Fraud Detection results are empty or the decision
|
|
1580
1579
|
* is <code>NOT_ENOUGH_SPEECH</code>. In this situation, if the
|
|
@@ -1584,96 +1583,97 @@ export interface EvaluateSessionResponse {
|
|
|
1584
1583
|
* <code>StreamingStatus</code> is <code>ENDED</code>, it means that the previously
|
|
1585
1584
|
* streamed session did not have enough speech to perform evaluation, and a new streaming
|
|
1586
1585
|
* session is needed to try again.</p>
|
|
1586
|
+
* @public
|
|
1587
1587
|
*/
|
|
1588
1588
|
StreamingStatus?: StreamingStatus;
|
|
1589
1589
|
/**
|
|
1590
|
-
* @public
|
|
1591
1590
|
* <p>Details resulting from the authentication process, such as authentication decision and
|
|
1592
1591
|
* authentication score.</p>
|
|
1592
|
+
* @public
|
|
1593
1593
|
*/
|
|
1594
1594
|
AuthenticationResult?: AuthenticationResult;
|
|
1595
1595
|
/**
|
|
1596
|
-
* @public
|
|
1597
1596
|
* <p>Details resulting from the fraud detection process, such as fraud detection decision
|
|
1598
1597
|
* and risk score.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
FraudDetectionResult?: FraudDetectionResult;
|
|
1601
1601
|
}
|
|
1602
1602
|
/**
|
|
1603
|
-
* @public
|
|
1604
1603
|
* <p>Contains a summary of information about a fraudster registration job.</p>
|
|
1604
|
+
* @public
|
|
1605
1605
|
*/
|
|
1606
1606
|
export interface FraudsterRegistrationJobSummary {
|
|
1607
1607
|
/**
|
|
1608
|
-
* @public
|
|
1609
1608
|
* <p>The client-provided name for the fraudster registration job.</p>
|
|
1609
|
+
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
JobName?: string;
|
|
1612
1612
|
/**
|
|
1613
|
-
* @public
|
|
1614
1613
|
* <p>The service-generated identifier for the fraudster registration job.</p>
|
|
1614
|
+
* @public
|
|
1615
1615
|
*/
|
|
1616
1616
|
JobId?: string;
|
|
1617
1617
|
/**
|
|
1618
|
-
* @public
|
|
1619
1618
|
* <p>The current status of the fraudster registration job.</p>
|
|
1619
|
+
* @public
|
|
1620
1620
|
*/
|
|
1621
1621
|
JobStatus?: FraudsterRegistrationJobStatus;
|
|
1622
1622
|
/**
|
|
1623
|
-
* @public
|
|
1624
1623
|
* <p>The identifier of the domain that contains the fraudster registration job.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
DomainId?: string;
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>A timestamp of when the fraudster registration job was created. </p>
|
|
1629
|
+
* @public
|
|
1630
1630
|
*/
|
|
1631
1631
|
CreatedAt?: Date;
|
|
1632
1632
|
/**
|
|
1633
|
-
* @public
|
|
1634
1633
|
* <p>A timestamp of when the fraudster registration job ended.</p>
|
|
1634
|
+
* @public
|
|
1635
1635
|
*/
|
|
1636
1636
|
EndedAt?: Date;
|
|
1637
1637
|
/**
|
|
1638
|
-
* @public
|
|
1639
1638
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1640
1639
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1641
1640
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
1642
1641
|
* use the job output file to identify the individual registration requests that
|
|
1643
1642
|
* failed.</p>
|
|
1643
|
+
* @public
|
|
1644
1644
|
*/
|
|
1645
1645
|
FailureDetails?: FailureDetails;
|
|
1646
1646
|
/**
|
|
1647
|
-
* @public
|
|
1648
1647
|
* <p>Shows the completed percentage of registration requests listed in the input
|
|
1649
1648
|
* file.</p>
|
|
1649
|
+
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
JobProgress?: JobProgress;
|
|
1652
1652
|
}
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>Contains a summary of information about a fraudster.
|
|
1656
1655
|
* </p>
|
|
1656
|
+
* @public
|
|
1657
1657
|
*/
|
|
1658
1658
|
export interface FraudsterSummary {
|
|
1659
1659
|
/**
|
|
1660
|
-
* @public
|
|
1661
1660
|
* <p>The identifier of the domain that contains the fraudster summary.</p>
|
|
1661
|
+
* @public
|
|
1662
1662
|
*/
|
|
1663
1663
|
DomainId?: string;
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>The service-generated identifier for the fraudster.</p>
|
|
1666
|
+
* @public
|
|
1667
1667
|
*/
|
|
1668
1668
|
GeneratedFraudsterId?: string;
|
|
1669
1669
|
/**
|
|
1670
|
-
* @public
|
|
1671
1670
|
* <p>The timestamp of when the fraudster summary was created.</p>
|
|
1671
|
+
* @public
|
|
1672
1672
|
*/
|
|
1673
1673
|
CreatedAt?: Date;
|
|
1674
1674
|
/**
|
|
1675
|
-
* @public
|
|
1676
1675
|
* <p>The identifier of the watchlists the fraudster is a part of.</p>
|
|
1676
|
+
* @public
|
|
1677
1677
|
*/
|
|
1678
1678
|
WatchlistIds?: string[];
|
|
1679
1679
|
}
|
|
@@ -1682,27 +1682,27 @@ export interface FraudsterSummary {
|
|
|
1682
1682
|
*/
|
|
1683
1683
|
export interface ListFraudsterRegistrationJobsRequest {
|
|
1684
1684
|
/**
|
|
1685
|
-
* @public
|
|
1686
1685
|
* <p>The identifier of the domain that contains the fraudster registration Jobs.</p>
|
|
1686
|
+
* @public
|
|
1687
1687
|
*/
|
|
1688
1688
|
DomainId: string | undefined;
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>Provides the status of your fraudster registration job.</p>
|
|
1691
|
+
* @public
|
|
1692
1692
|
*/
|
|
1693
1693
|
JobStatus?: FraudsterRegistrationJobStatus;
|
|
1694
1694
|
/**
|
|
1695
|
-
* @public
|
|
1696
1695
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1697
1696
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
MaxResults?: number;
|
|
1700
1700
|
/**
|
|
1701
|
-
* @public
|
|
1702
1701
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1703
1702
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1704
1703
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1705
1704
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1705
|
+
* @public
|
|
1706
1706
|
*/
|
|
1707
1707
|
NextToken?: string;
|
|
1708
1708
|
}
|
|
@@ -1711,16 +1711,16 @@ export interface ListFraudsterRegistrationJobsRequest {
|
|
|
1711
1711
|
*/
|
|
1712
1712
|
export interface ListFraudsterRegistrationJobsResponse {
|
|
1713
1713
|
/**
|
|
1714
|
-
* @public
|
|
1715
1714
|
* <p>A list containing details about each specified fraudster registration job.</p>
|
|
1715
|
+
* @public
|
|
1716
1716
|
*/
|
|
1717
1717
|
JobSummaries?: FraudsterRegistrationJobSummary[];
|
|
1718
1718
|
/**
|
|
1719
|
-
* @public
|
|
1720
1719
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1721
1720
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1722
1721
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1723
1722
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1723
|
+
* @public
|
|
1724
1724
|
*/
|
|
1725
1725
|
NextToken?: string;
|
|
1726
1726
|
}
|
|
@@ -1729,28 +1729,28 @@ export interface ListFraudsterRegistrationJobsResponse {
|
|
|
1729
1729
|
*/
|
|
1730
1730
|
export interface ListFraudstersRequest {
|
|
1731
1731
|
/**
|
|
1732
|
-
* @public
|
|
1733
1732
|
* <p>The identifier of the domain. </p>
|
|
1733
|
+
* @public
|
|
1734
1734
|
*/
|
|
1735
1735
|
DomainId: string | undefined;
|
|
1736
1736
|
/**
|
|
1737
|
-
* @public
|
|
1738
1737
|
* <p>The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.</p>
|
|
1738
|
+
* @public
|
|
1739
1739
|
*/
|
|
1740
1740
|
WatchlistId?: string;
|
|
1741
1741
|
/**
|
|
1742
|
-
* @public
|
|
1743
1742
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1744
1743
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1744
|
+
* @public
|
|
1745
1745
|
*/
|
|
1746
1746
|
MaxResults?: number;
|
|
1747
1747
|
/**
|
|
1748
|
-
* @public
|
|
1749
1748
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1750
1749
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1751
1750
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1752
1751
|
* unchanged. Each pagination token expires after 24 hours.
|
|
1753
1752
|
* </p>
|
|
1753
|
+
* @public
|
|
1754
1754
|
*/
|
|
1755
1755
|
NextToken?: string;
|
|
1756
1756
|
}
|
|
@@ -1759,18 +1759,18 @@ export interface ListFraudstersRequest {
|
|
|
1759
1759
|
*/
|
|
1760
1760
|
export interface ListFraudstersResponse {
|
|
1761
1761
|
/**
|
|
1762
|
-
* @public
|
|
1763
1762
|
* <p>A list that contains details about each fraudster in the Amazon Web Services account.
|
|
1764
1763
|
* </p>
|
|
1764
|
+
* @public
|
|
1765
1765
|
*/
|
|
1766
1766
|
FraudsterSummaries?: FraudsterSummary[];
|
|
1767
1767
|
/**
|
|
1768
|
-
* @public
|
|
1769
1768
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1770
1769
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1771
1770
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1772
1771
|
* unchanged. Each pagination token expires after 24 hours.
|
|
1773
1772
|
* </p>
|
|
1773
|
+
* @public
|
|
1774
1774
|
*/
|
|
1775
1775
|
NextToken?: string;
|
|
1776
1776
|
}
|
|
@@ -1779,78 +1779,78 @@ export interface ListFraudstersResponse {
|
|
|
1779
1779
|
*/
|
|
1780
1780
|
export interface ListSpeakerEnrollmentJobsRequest {
|
|
1781
1781
|
/**
|
|
1782
|
-
* @public
|
|
1783
1782
|
* <p>The identifier of the domain that contains the speaker enrollment jobs.</p>
|
|
1783
|
+
* @public
|
|
1784
1784
|
*/
|
|
1785
1785
|
DomainId: string | undefined;
|
|
1786
1786
|
/**
|
|
1787
|
-
* @public
|
|
1788
1787
|
* <p>Provides the status of your speaker enrollment Job.</p>
|
|
1788
|
+
* @public
|
|
1789
1789
|
*/
|
|
1790
1790
|
JobStatus?: SpeakerEnrollmentJobStatus;
|
|
1791
1791
|
/**
|
|
1792
|
-
* @public
|
|
1793
1792
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1794
1793
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
|
|
1794
|
+
* @public
|
|
1795
1795
|
*/
|
|
1796
1796
|
MaxResults?: number;
|
|
1797
1797
|
/**
|
|
1798
|
-
* @public
|
|
1799
1798
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1800
1799
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1801
1800
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1802
1801
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
NextToken?: string;
|
|
1805
1805
|
}
|
|
1806
1806
|
/**
|
|
1807
|
-
* @public
|
|
1808
1807
|
* <p>Contains a summary of information about a speaker enrollment job.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
export interface SpeakerEnrollmentJobSummary {
|
|
1811
1811
|
/**
|
|
1812
|
-
* @public
|
|
1813
1812
|
* <p>The client-provided name for the speaker enrollment job.</p>
|
|
1813
|
+
* @public
|
|
1814
1814
|
*/
|
|
1815
1815
|
JobName?: string;
|
|
1816
1816
|
/**
|
|
1817
|
-
* @public
|
|
1818
1817
|
* <p>The service-generated identifier for the speaker enrollment job.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
JobId?: string;
|
|
1821
1821
|
/**
|
|
1822
|
-
* @public
|
|
1823
1822
|
* <p>The current status of the speaker enrollment job.</p>
|
|
1823
|
+
* @public
|
|
1824
1824
|
*/
|
|
1825
1825
|
JobStatus?: SpeakerEnrollmentJobStatus;
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The identifier of the domain that contains the speaker enrollment job.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
DomainId?: string;
|
|
1831
1831
|
/**
|
|
1832
|
-
* @public
|
|
1833
1832
|
* <p>A timestamp of when of the speaker enrollment job was created.</p>
|
|
1833
|
+
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
CreatedAt?: Date;
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>A timestamp of when the speaker enrollment job ended.</p>
|
|
1838
|
+
* @public
|
|
1839
1839
|
*/
|
|
1840
1840
|
EndedAt?: Date;
|
|
1841
1841
|
/**
|
|
1842
|
-
* @public
|
|
1843
1842
|
* <p>Contains details that are populated when an entire batch job fails. In cases of
|
|
1844
1843
|
* individual registration job failures, the batch job as a whole doesn't fail; it is
|
|
1845
1844
|
* completed with a <code>JobStatus</code> of <code>COMPLETED_WITH_ERRORS</code>. You can
|
|
1846
1845
|
* use the job output file to identify the individual registration requests that
|
|
1847
1846
|
* failed.</p>
|
|
1847
|
+
* @public
|
|
1848
1848
|
*/
|
|
1849
1849
|
FailureDetails?: FailureDetails;
|
|
1850
1850
|
/**
|
|
1851
|
-
* @public
|
|
1852
1851
|
* <p>Provides details regarding job progress. This field shows the completed percentage of
|
|
1853
1852
|
* enrollment requests listed in the input file.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
JobProgress?: JobProgress;
|
|
1856
1856
|
}
|
|
@@ -1859,16 +1859,16 @@ export interface SpeakerEnrollmentJobSummary {
|
|
|
1859
1859
|
*/
|
|
1860
1860
|
export interface ListSpeakerEnrollmentJobsResponse {
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p>A list containing details about each specified speaker enrollment job.</p>
|
|
1863
|
+
* @public
|
|
1864
1864
|
*/
|
|
1865
1865
|
JobSummaries?: SpeakerEnrollmentJobSummary[];
|
|
1866
1866
|
/**
|
|
1867
|
-
* @public
|
|
1868
1867
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1869
1868
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1870
1869
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1871
1870
|
* unchanged. Each pagination token expires after 24 hours. </p>
|
|
1871
|
+
* @public
|
|
1872
1872
|
*/
|
|
1873
1873
|
NextToken?: string;
|
|
1874
1874
|
}
|
|
@@ -1877,64 +1877,64 @@ export interface ListSpeakerEnrollmentJobsResponse {
|
|
|
1877
1877
|
*/
|
|
1878
1878
|
export interface ListSpeakersRequest {
|
|
1879
1879
|
/**
|
|
1880
|
-
* @public
|
|
1881
1880
|
* <p>The identifier of the domain.</p>
|
|
1881
|
+
* @public
|
|
1882
1882
|
*/
|
|
1883
1883
|
DomainId: string | undefined;
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1887
1886
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
MaxResults?: number;
|
|
1890
1890
|
/**
|
|
1891
|
-
* @public
|
|
1892
1891
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1893
1892
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1894
1893
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1895
1894
|
* unchanged. Each pagination token expires after 24 hours.</p>
|
|
1895
|
+
* @public
|
|
1896
1896
|
*/
|
|
1897
1897
|
NextToken?: string;
|
|
1898
1898
|
}
|
|
1899
1899
|
/**
|
|
1900
|
-
* @public
|
|
1901
1900
|
* <p>Contains a summary of information about a speaker.</p>
|
|
1901
|
+
* @public
|
|
1902
1902
|
*/
|
|
1903
1903
|
export interface SpeakerSummary {
|
|
1904
1904
|
/**
|
|
1905
|
-
* @public
|
|
1906
1905
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
1906
|
+
* @public
|
|
1907
1907
|
*/
|
|
1908
1908
|
DomainId?: string;
|
|
1909
1909
|
/**
|
|
1910
|
-
* @public
|
|
1911
1910
|
* <p>The client-provided identifier for the speaker.</p>
|
|
1911
|
+
* @public
|
|
1912
1912
|
*/
|
|
1913
1913
|
CustomerSpeakerId?: string;
|
|
1914
1914
|
/**
|
|
1915
|
-
* @public
|
|
1916
1915
|
* <p>The service-generated identifier for the speaker. </p>
|
|
1916
|
+
* @public
|
|
1917
1917
|
*/
|
|
1918
1918
|
GeneratedSpeakerId?: string;
|
|
1919
1919
|
/**
|
|
1920
|
-
* @public
|
|
1921
1920
|
* <p>The current status of the speaker.</p>
|
|
1921
|
+
* @public
|
|
1922
1922
|
*/
|
|
1923
1923
|
Status?: SpeakerStatus;
|
|
1924
1924
|
/**
|
|
1925
|
-
* @public
|
|
1926
1925
|
* <p>A timestamp showing the speaker's creation time. </p>
|
|
1926
|
+
* @public
|
|
1927
1927
|
*/
|
|
1928
1928
|
CreatedAt?: Date;
|
|
1929
1929
|
/**
|
|
1930
|
-
* @public
|
|
1931
1930
|
* <p>A timestamp showing the speaker's last update.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
UpdatedAt?: Date;
|
|
1934
1934
|
/**
|
|
1935
|
-
* @public
|
|
1936
1935
|
* <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a
|
|
1937
1936
|
* successful authentication. This timestamp is accurate to one hour.</p>
|
|
1937
|
+
* @public
|
|
1938
1938
|
*/
|
|
1939
1939
|
LastAccessedAt?: Date;
|
|
1940
1940
|
}
|
|
@@ -1943,17 +1943,17 @@ export interface SpeakerSummary {
|
|
|
1943
1943
|
*/
|
|
1944
1944
|
export interface ListSpeakersResponse {
|
|
1945
1945
|
/**
|
|
1946
|
-
* @public
|
|
1947
1946
|
* <p>A list containing details about each speaker in the Amazon Web Services account.
|
|
1948
1947
|
* </p>
|
|
1948
|
+
* @public
|
|
1949
1949
|
*/
|
|
1950
1950
|
SpeakerSummaries?: SpeakerSummary[];
|
|
1951
1951
|
/**
|
|
1952
|
-
* @public
|
|
1953
1952
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
1954
1953
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
1955
1954
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
1956
1955
|
* unchanged. Each pagination token expires after 24 hours. </p>
|
|
1956
|
+
* @public
|
|
1957
1957
|
*/
|
|
1958
1958
|
NextToken?: string;
|
|
1959
1959
|
}
|
|
@@ -1962,9 +1962,9 @@ export interface ListSpeakersResponse {
|
|
|
1962
1962
|
*/
|
|
1963
1963
|
export interface ListTagsForResourceRequest {
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list
|
|
1967
1966
|
* the tags.</p>
|
|
1967
|
+
* @public
|
|
1968
1968
|
*/
|
|
1969
1969
|
ResourceArn: string | undefined;
|
|
1970
1970
|
}
|
|
@@ -1973,8 +1973,8 @@ export interface ListTagsForResourceRequest {
|
|
|
1973
1973
|
*/
|
|
1974
1974
|
export interface ListTagsForResourceResponse {
|
|
1975
1975
|
/**
|
|
1976
|
-
* @public
|
|
1977
1976
|
* <p>The list of tags associated with the specified resource.</p>
|
|
1977
|
+
* @public
|
|
1978
1978
|
*/
|
|
1979
1979
|
Tags?: Tag[];
|
|
1980
1980
|
}
|
|
@@ -1983,65 +1983,65 @@ export interface ListTagsForResourceResponse {
|
|
|
1983
1983
|
*/
|
|
1984
1984
|
export interface ListWatchlistsRequest {
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>The identifier of the domain.</p>
|
|
1987
|
+
* @public
|
|
1988
1988
|
*/
|
|
1989
1989
|
DomainId: string | undefined;
|
|
1990
1990
|
/**
|
|
1991
|
-
* @public
|
|
1992
1991
|
* <p>The maximum number of results that are returned per call. You can use
|
|
1993
1992
|
* <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
|
|
1994
1993
|
* </p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
MaxResults?: number;
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
2000
1999
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
2001
2000
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
2002
2001
|
* unchanged. Each pagination token expires after 24 hours.
|
|
2003
2002
|
* </p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
NextToken?: string;
|
|
2006
2006
|
}
|
|
2007
2007
|
/**
|
|
2008
|
-
* @public
|
|
2009
2008
|
* <p>Contains a summary of information about a watchlist.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
export interface WatchlistSummary {
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
2014
|
+
* @public
|
|
2015
2015
|
*/
|
|
2016
2016
|
DomainId?: string;
|
|
2017
2017
|
/**
|
|
2018
|
-
* @public
|
|
2019
2018
|
* <p>The identifier of the watchlist.</p>
|
|
2019
|
+
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
WatchlistId?: string;
|
|
2022
2022
|
/**
|
|
2023
|
-
* @public
|
|
2024
2023
|
* <p>The name for the watchlist.</p>
|
|
2024
|
+
* @public
|
|
2025
2025
|
*/
|
|
2026
2026
|
Name?: string;
|
|
2027
2027
|
/**
|
|
2028
|
-
* @public
|
|
2029
2028
|
* <p>The description of the watchlist.</p>
|
|
2029
|
+
* @public
|
|
2030
2030
|
*/
|
|
2031
2031
|
Description?: string;
|
|
2032
2032
|
/**
|
|
2033
|
-
* @public
|
|
2034
2033
|
* <p>Whether the specified watchlist is the default watchlist of a domain.</p>
|
|
2034
|
+
* @public
|
|
2035
2035
|
*/
|
|
2036
2036
|
DefaultWatchlist?: boolean;
|
|
2037
2037
|
/**
|
|
2038
|
-
* @public
|
|
2039
2038
|
* <p>The timestamp of when the watchlist was created.</p>
|
|
2039
|
+
* @public
|
|
2040
2040
|
*/
|
|
2041
2041
|
CreatedAt?: Date;
|
|
2042
2042
|
/**
|
|
2043
|
-
* @public
|
|
2044
2043
|
* <p>The timestamp of when the watchlist was last updated.</p>
|
|
2044
|
+
* @public
|
|
2045
2045
|
*/
|
|
2046
2046
|
UpdatedAt?: Date;
|
|
2047
2047
|
}
|
|
@@ -2050,18 +2050,18 @@ export interface WatchlistSummary {
|
|
|
2050
2050
|
*/
|
|
2051
2051
|
export interface ListWatchlistsResponse {
|
|
2052
2052
|
/**
|
|
2053
|
-
* @public
|
|
2054
2053
|
* <p>A list that contains details about each watchlist in the Amazon Web Services account.
|
|
2055
2054
|
* </p>
|
|
2055
|
+
* @public
|
|
2056
2056
|
*/
|
|
2057
2057
|
WatchlistSummaries?: WatchlistSummary[];
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>If <code>NextToken</code> is returned, there are more results available. The value of
|
|
2061
2060
|
* <code>NextToken</code> is a unique pagination token for each page. Make the call
|
|
2062
2061
|
* again using the returned token to retrieve the next page. Keep all other arguments
|
|
2063
2062
|
* unchanged. Each pagination token expires after 24 hours.
|
|
2064
2063
|
* </p>
|
|
2064
|
+
* @public
|
|
2065
2065
|
*/
|
|
2066
2066
|
NextToken?: string;
|
|
2067
2067
|
}
|
|
@@ -2070,13 +2070,13 @@ export interface ListWatchlistsResponse {
|
|
|
2070
2070
|
*/
|
|
2071
2071
|
export interface OptOutSpeakerRequest {
|
|
2072
2072
|
/**
|
|
2073
|
-
* @public
|
|
2074
2073
|
* <p>The identifier of the domain that contains the speaker.</p>
|
|
2074
|
+
* @public
|
|
2075
2075
|
*/
|
|
2076
2076
|
DomainId: string | undefined;
|
|
2077
2077
|
/**
|
|
2078
|
-
* @public
|
|
2079
2078
|
* <p>The identifier of the speaker you want opted-out.</p>
|
|
2079
|
+
* @public
|
|
2080
2080
|
*/
|
|
2081
2081
|
SpeakerId: string | undefined;
|
|
2082
2082
|
}
|
|
@@ -2085,8 +2085,8 @@ export interface OptOutSpeakerRequest {
|
|
|
2085
2085
|
*/
|
|
2086
2086
|
export interface OptOutSpeakerResponse {
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>Details about the opted-out speaker.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
Speaker?: Speaker;
|
|
2092
2092
|
}
|
|
@@ -2095,51 +2095,51 @@ export interface OptOutSpeakerResponse {
|
|
|
2095
2095
|
*/
|
|
2096
2096
|
export interface StartFraudsterRegistrationJobRequest {
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2100
2099
|
* request. If not provided, the Amazon Web Services
|
|
2101
2100
|
* SDK populates this field. For more information about idempotency, see
|
|
2102
2101
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2102
|
+
* @public
|
|
2103
2103
|
*/
|
|
2104
2104
|
ClientToken?: string;
|
|
2105
2105
|
/**
|
|
2106
|
-
* @public
|
|
2107
2106
|
* <p>The name of the new fraudster registration job.</p>
|
|
2107
|
+
* @public
|
|
2108
2108
|
*/
|
|
2109
2109
|
JobName?: string;
|
|
2110
2110
|
/**
|
|
2111
|
-
* @public
|
|
2112
2111
|
* <p>The identifier of the domain that contains the fraudster registration job and in which
|
|
2113
2112
|
* the fraudsters are registered.</p>
|
|
2113
|
+
* @public
|
|
2114
2114
|
*/
|
|
2115
2115
|
DomainId: string | undefined;
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
2119
2118
|
* customer's buckets to read the input manifest file and write the Job output file. Refer
|
|
2120
2119
|
* to the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and edit a
|
|
2121
2120
|
* fraudster watchlist</a> documentation for the permissions needed in this
|
|
2122
2121
|
* role.</p>
|
|
2122
|
+
* @public
|
|
2123
2123
|
*/
|
|
2124
2124
|
DataAccessRoleArn: string | undefined;
|
|
2125
2125
|
/**
|
|
2126
|
-
* @public
|
|
2127
2126
|
* <p>The registration config containing details such as the action to take when a duplicate
|
|
2128
2127
|
* fraudster is detected, and the similarity threshold to use for detecting a duplicate
|
|
2129
2128
|
* fraudster. </p>
|
|
2129
|
+
* @public
|
|
2130
2130
|
*/
|
|
2131
2131
|
RegistrationConfig?: RegistrationConfig;
|
|
2132
2132
|
/**
|
|
2133
|
-
* @public
|
|
2134
2133
|
* <p>The input data config containing an S3 URI for the input manifest file that contains
|
|
2135
2134
|
* the list of fraudster registration requests.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
InputDataConfig: InputDataConfig | undefined;
|
|
2138
2138
|
/**
|
|
2139
|
-
* @public
|
|
2140
2139
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
2141
2140
|
* output file; you must also include a KMS key ID to encrypt the
|
|
2142
2141
|
* file.</p>
|
|
2142
|
+
* @public
|
|
2143
2143
|
*/
|
|
2144
2144
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2145
2145
|
}
|
|
@@ -2148,8 +2148,8 @@ export interface StartFraudsterRegistrationJobRequest {
|
|
|
2148
2148
|
*/
|
|
2149
2149
|
export interface StartFraudsterRegistrationJobResponse {
|
|
2150
2150
|
/**
|
|
2151
|
-
* @public
|
|
2152
2151
|
* <p>Details about the started fraudster registration job.</p>
|
|
2152
|
+
* @public
|
|
2153
2153
|
*/
|
|
2154
2154
|
Job?: FraudsterRegistrationJob;
|
|
2155
2155
|
}
|
|
@@ -2158,49 +2158,49 @@ export interface StartFraudsterRegistrationJobResponse {
|
|
|
2158
2158
|
*/
|
|
2159
2159
|
export interface StartSpeakerEnrollmentJobRequest {
|
|
2160
2160
|
/**
|
|
2161
|
-
* @public
|
|
2162
2161
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2163
2162
|
* request. If not provided, the Amazon Web Services
|
|
2164
2163
|
* SDK populates this field. For more information about idempotency, see
|
|
2165
2164
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
ClientToken?: string;
|
|
2168
2168
|
/**
|
|
2169
|
-
* @public
|
|
2170
2169
|
* <p>A name for your speaker enrollment job.</p>
|
|
2170
|
+
* @public
|
|
2171
2171
|
*/
|
|
2172
2172
|
JobName?: string;
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>The identifier of the domain that contains the speaker enrollment job and in which the
|
|
2176
2175
|
* speakers are enrolled. </p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
DomainId: string | undefined;
|
|
2179
2179
|
/**
|
|
2180
|
-
* @public
|
|
2181
2180
|
* <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access
|
|
2182
2181
|
* customer's buckets to read the input manifest file and write the job output file. Refer
|
|
2183
2182
|
* to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using
|
|
2184
2183
|
* audio data from prior calls</a> for the permissions needed in this role.</p>
|
|
2184
|
+
* @public
|
|
2185
2185
|
*/
|
|
2186
2186
|
DataAccessRoleArn: string | undefined;
|
|
2187
2187
|
/**
|
|
2188
|
-
* @public
|
|
2189
2188
|
* <p>The enrollment config that contains details such as the action to take when a speaker
|
|
2190
2189
|
* is already enrolled in Voice ID or when a speaker is identified as a fraudster.</p>
|
|
2190
|
+
* @public
|
|
2191
2191
|
*/
|
|
2192
2192
|
EnrollmentConfig?: EnrollmentConfig;
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>The input data config containing the S3 location for the input manifest file that
|
|
2196
2195
|
* contains the list of speaker enrollment requests.</p>
|
|
2196
|
+
* @public
|
|
2197
2197
|
*/
|
|
2198
2198
|
InputDataConfig: InputDataConfig | undefined;
|
|
2199
2199
|
/**
|
|
2200
|
-
* @public
|
|
2201
2200
|
* <p>The output data config containing the S3 location where Voice ID writes the job
|
|
2202
2201
|
* output file; you must also include a KMS key ID to encrypt the
|
|
2203
2202
|
* file.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
OutputDataConfig: OutputDataConfig | undefined;
|
|
2206
2206
|
}
|
|
@@ -2209,8 +2209,8 @@ export interface StartSpeakerEnrollmentJobRequest {
|
|
|
2209
2209
|
*/
|
|
2210
2210
|
export interface StartSpeakerEnrollmentJobResponse {
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>Details about the started speaker enrollment job.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
Job?: SpeakerEnrollmentJob;
|
|
2216
2216
|
}
|
|
@@ -2219,13 +2219,13 @@ export interface StartSpeakerEnrollmentJobResponse {
|
|
|
2219
2219
|
*/
|
|
2220
2220
|
export interface TagResourceRequest {
|
|
2221
2221
|
/**
|
|
2222
|
-
* @public
|
|
2223
2222
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.</p>
|
|
2223
|
+
* @public
|
|
2224
2224
|
*/
|
|
2225
2225
|
ResourceArn: string | undefined;
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <p>The list of tags to assign to the specified resource.</p>
|
|
2228
|
+
* @public
|
|
2229
2229
|
*/
|
|
2230
2230
|
Tags: Tag[] | undefined;
|
|
2231
2231
|
}
|
|
@@ -2239,14 +2239,14 @@ export interface TagResourceResponse {
|
|
|
2239
2239
|
*/
|
|
2240
2240
|
export interface UntagResourceRequest {
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags
|
|
2244
2243
|
* from.</p>
|
|
2244
|
+
* @public
|
|
2245
2245
|
*/
|
|
2246
2246
|
ResourceArn: string | undefined;
|
|
2247
2247
|
/**
|
|
2248
|
-
* @public
|
|
2249
2248
|
* <p>The list of tag keys you want to remove from the specified resource.</p>
|
|
2249
|
+
* @public
|
|
2250
2250
|
*/
|
|
2251
2251
|
TagKeys: string[] | undefined;
|
|
2252
2252
|
}
|
|
@@ -2260,23 +2260,23 @@ export interface UntagResourceResponse {
|
|
|
2260
2260
|
*/
|
|
2261
2261
|
export interface UpdateWatchlistRequest {
|
|
2262
2262
|
/**
|
|
2263
|
-
* @public
|
|
2264
2263
|
* <p>The identifier of the domain that contains the watchlist.</p>
|
|
2264
|
+
* @public
|
|
2265
2265
|
*/
|
|
2266
2266
|
DomainId: string | undefined;
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The identifier of the watchlist to be updated.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
WatchlistId: string | undefined;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p>The name of the watchlist.</p>
|
|
2274
|
+
* @public
|
|
2275
2275
|
*/
|
|
2276
2276
|
Name?: string;
|
|
2277
2277
|
/**
|
|
2278
|
-
* @public
|
|
2279
2278
|
* <p>A brief description about this watchlist.</p>
|
|
2279
|
+
* @public
|
|
2280
2280
|
*/
|
|
2281
2281
|
Description?: string;
|
|
2282
2282
|
}
|
|
@@ -2285,8 +2285,8 @@ export interface UpdateWatchlistRequest {
|
|
|
2285
2285
|
*/
|
|
2286
2286
|
export interface UpdateWatchlistResponse {
|
|
2287
2287
|
/**
|
|
2288
|
-
* @public
|
|
2289
2288
|
* <p>Details about the updated watchlist.</p>
|
|
2289
|
+
* @public
|
|
2290
2290
|
*/
|
|
2291
2291
|
Watchlist?: Watchlist;
|
|
2292
2292
|
}
|