@aws-sdk/client-voice-id 3.299.0 → 3.301.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.
Files changed (87) hide show
  1. package/README.md +73 -9
  2. package/dist-cjs/VoiceID.js +120 -0
  3. package/dist-cjs/commands/AssociateFraudsterCommand.js +46 -0
  4. package/dist-cjs/commands/CreateWatchlistCommand.js +46 -0
  5. package/dist-cjs/commands/DeleteWatchlistCommand.js +45 -0
  6. package/dist-cjs/commands/DescribeWatchlistCommand.js +46 -0
  7. package/dist-cjs/commands/DisassociateFraudsterCommand.js +46 -0
  8. package/dist-cjs/commands/ListFraudstersCommand.js +45 -0
  9. package/dist-cjs/commands/ListWatchlistsCommand.js +46 -0
  10. package/dist-cjs/commands/UpdateWatchlistCommand.js +46 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/endpoint/ruleset.js +3 -3
  13. package/dist-cjs/models/models_0.js +83 -24
  14. package/dist-cjs/pagination/ListFraudstersPaginator.js +29 -0
  15. package/dist-cjs/pagination/ListWatchlistsPaginator.js +29 -0
  16. package/dist-cjs/pagination/index.js +2 -0
  17. package/dist-cjs/protocols/Aws_json1_0.js +722 -29
  18. package/dist-es/VoiceID.js +120 -0
  19. package/dist-es/commands/AssociateFraudsterCommand.js +42 -0
  20. package/dist-es/commands/CreateWatchlistCommand.js +42 -0
  21. package/dist-es/commands/DeleteWatchlistCommand.js +41 -0
  22. package/dist-es/commands/DescribeWatchlistCommand.js +42 -0
  23. package/dist-es/commands/DisassociateFraudsterCommand.js +42 -0
  24. package/dist-es/commands/ListFraudstersCommand.js +41 -0
  25. package/dist-es/commands/ListWatchlistsCommand.js +42 -0
  26. package/dist-es/commands/UpdateWatchlistCommand.js +42 -0
  27. package/dist-es/commands/index.js +8 -0
  28. package/dist-es/endpoint/ruleset.js +3 -3
  29. package/dist-es/models/models_0.js +71 -22
  30. package/dist-es/pagination/ListFraudstersPaginator.js +25 -0
  31. package/dist-es/pagination/ListWatchlistsPaginator.js +25 -0
  32. package/dist-es/pagination/index.js +2 -0
  33. package/dist-es/protocols/Aws_json1_0.js +707 -31
  34. package/dist-types/VoiceID.d.ts +74 -4
  35. package/dist-types/VoiceIDClient.d.ts +12 -4
  36. package/dist-types/commands/AssociateFraudsterCommand.d.ts +93 -0
  37. package/dist-types/commands/CreateDomainCommand.d.ts +15 -1
  38. package/dist-types/commands/CreateWatchlistCommand.d.ts +94 -0
  39. package/dist-types/commands/DeleteDomainCommand.d.ts +3 -0
  40. package/dist-types/commands/DeleteFraudsterCommand.d.ts +5 -1
  41. package/dist-types/commands/DeleteSpeakerCommand.d.ts +4 -0
  42. package/dist-types/commands/DeleteWatchlistCommand.d.ts +91 -0
  43. package/dist-types/commands/DescribeDomainCommand.d.ts +3 -0
  44. package/dist-types/commands/DescribeFraudsterCommand.d.ts +4 -0
  45. package/dist-types/commands/DescribeFraudsterRegistrationJobCommand.d.ts +4 -0
  46. package/dist-types/commands/DescribeSpeakerCommand.d.ts +4 -0
  47. package/dist-types/commands/DescribeSpeakerEnrollmentJobCommand.d.ts +4 -0
  48. package/dist-types/commands/DescribeWatchlistCommand.d.ts +85 -0
  49. package/dist-types/commands/DisassociateFraudsterCommand.d.ts +93 -0
  50. package/dist-types/commands/EvaluateSessionCommand.d.ts +4 -0
  51. package/dist-types/commands/ListDomainsCommand.d.ts +4 -0
  52. package/dist-types/commands/ListFraudsterRegistrationJobsCommand.d.ts +6 -0
  53. package/dist-types/commands/ListFraudstersCommand.d.ts +87 -0
  54. package/dist-types/commands/ListSpeakerEnrollmentJobsCommand.d.ts +6 -0
  55. package/dist-types/commands/ListSpeakersCommand.d.ts +5 -0
  56. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  57. package/dist-types/commands/ListWatchlistsCommand.d.ts +86 -0
  58. package/dist-types/commands/OptOutSpeakerCommand.d.ts +4 -0
  59. package/dist-types/commands/StartFraudsterRegistrationJobCommand.d.ts +20 -0
  60. package/dist-types/commands/StartSpeakerEnrollmentJobCommand.d.ts +23 -0
  61. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  62. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  63. package/dist-types/commands/UpdateDomainCommand.d.ts +8 -0
  64. package/dist-types/commands/UpdateWatchlistCommand.d.ts +92 -0
  65. package/dist-types/commands/index.d.ts +8 -0
  66. package/dist-types/models/models_0.d.ts +621 -214
  67. package/dist-types/pagination/ListFraudstersPaginator.d.ts +7 -0
  68. package/dist-types/pagination/ListWatchlistsPaginator.d.ts +7 -0
  69. package/dist-types/pagination/index.d.ts +2 -0
  70. package/dist-types/protocols/Aws_json1_0.d.ts +24 -0
  71. package/dist-types/ts3.4/VoiceID.d.ts +136 -0
  72. package/dist-types/ts3.4/VoiceIDClient.d.ts +50 -2
  73. package/dist-types/ts3.4/commands/AssociateFraudsterCommand.d.ts +38 -0
  74. package/dist-types/ts3.4/commands/CreateWatchlistCommand.d.ts +37 -0
  75. package/dist-types/ts3.4/commands/DeleteWatchlistCommand.d.ts +32 -0
  76. package/dist-types/ts3.4/commands/DescribeWatchlistCommand.d.ts +38 -0
  77. package/dist-types/ts3.4/commands/DisassociateFraudsterCommand.d.ts +41 -0
  78. package/dist-types/ts3.4/commands/ListFraudstersCommand.d.ts +37 -0
  79. package/dist-types/ts3.4/commands/ListWatchlistsCommand.d.ts +37 -0
  80. package/dist-types/ts3.4/commands/UpdateWatchlistCommand.d.ts +37 -0
  81. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  82. package/dist-types/ts3.4/models/models_0.d.ts +197 -69
  83. package/dist-types/ts3.4/pagination/ListFraudstersPaginator.d.ts +11 -0
  84. package/dist-types/ts3.4/pagination/ListWatchlistsPaginator.d.ts +11 -0
  85. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  86. package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +96 -0
  87. package/package.json +8 -8
@@ -16,76 +16,51 @@ export declare class AccessDeniedException extends __BaseException {
16
16
  }
17
17
  /**
18
18
  * @public
19
- * <p>The configuration used to authenticate a speaker during a session.</p>
20
- */
21
- export interface AuthenticationConfiguration {
22
- /**
23
- * <p>The minimum threshold needed to successfully authenticate a speaker.</p>
24
- */
25
- AcceptanceThreshold: number | undefined;
26
- }
27
- /**
28
- * @public
29
- */
30
- export declare enum AuthenticationDecision {
31
- ACCEPT = "ACCEPT",
32
- NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH",
33
- REJECT = "REJECT",
34
- SPEAKER_EXPIRED = "SPEAKER_EXPIRED",
35
- SPEAKER_ID_NOT_PROVIDED = "SPEAKER_ID_NOT_PROVIDED",
36
- SPEAKER_NOT_ENROLLED = "SPEAKER_NOT_ENROLLED",
37
- SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
38
- }
39
- /**
40
- * @public
41
- * <p>The authentication result produced by Voice ID, processed against the current session
42
- * state and streamed audio of the speaker.</p>
43
19
  */
44
- export interface AuthenticationResult {
20
+ export interface AssociateFraudsterRequest {
45
21
  /**
46
- * <p>The unique identifier for this authentication result. Because there can be multiple
47
- * authentications for a given session, this field helps to identify if the returned result
48
- * is from a previous streaming activity or a new result. Note that in absence of any new
49
- * streaming activity, <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code>
50
- * changes, Voice ID always returns cached Authentication Result for this API.</p>
22
+ * <p>The identifier of the domain that contains the fraudster.</p>
51
23
  */
52
- AuthenticationResultId?: string;
24
+ DomainId: string | undefined;
53
25
  /**
54
- * <p>A timestamp indicating when audio aggregation started for this authentication
55
- * result.</p>
26
+ * <p>The identifier of the watchlist you want to associate with the fraudster.</p>
56
27
  */
57
- AudioAggregationStartedAt?: Date;
28
+ WatchlistId: string | undefined;
58
29
  /**
59
- * <p>A timestamp indicating when audio aggregation ended for this authentication
60
- * result.</p>
30
+ * <p>The identifier of the fraudster to be associated with the watchlist.</p>
61
31
  */
62
- AudioAggregationEndedAt?: Date;
32
+ FraudsterId: string | undefined;
33
+ }
34
+ /**
35
+ * @public
36
+ * <p>Contains all the information about a fraudster.</p>
37
+ */
38
+ export interface Fraudster {
63
39
  /**
64
- * <p>The client-provided identifier for the speaker whose authentication result is
65
- * produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>
40
+ * <p>The identifier of the domain that contains the fraudster.</p>
66
41
  */
67
- CustomerSpeakerId?: string;
42
+ DomainId?: string;
68
43
  /**
69
- * <p>The service-generated identifier for the speaker whose authentication result is
70
- * produced.</p>
44
+ * <p>The service-generated identifier for the fraudster.</p>
71
45
  */
72
- GeneratedSpeakerId?: string;
46
+ GeneratedFraudsterId?: string;
73
47
  /**
74
- * <p>The authentication decision produced by Voice ID, processed against the current
75
- * session state and streamed audio of the speaker.</p>
48
+ * <p>The timestamp of when Voice ID identified the fraudster.</p>
76
49
  */
77
- Decision?: AuthenticationDecision | string;
50
+ CreatedAt?: Date;
78
51
  /**
79
- * <p>The authentication score for the speaker whose authentication result is produced. This
80
- * value is only present if the authentication decision is either <code>ACCEPT</code> or
81
- * <code>REJECT</code>.</p>
52
+ * <p>The identifier of the watchlists the fraudster is a part of.</p>
82
53
  */
83
- Score?: number;
54
+ WatchlistIds?: string[];
55
+ }
56
+ /**
57
+ * @public
58
+ */
59
+ export interface AssociateFraudsterResponse {
84
60
  /**
85
- * <p>The <code>AuthenticationConfiguration</code> used to generate this authentication
86
- * result.</p>
61
+ * <p>Contains all the information about a fraudster.</p>
87
62
  */
88
- Configuration?: AuthenticationConfiguration;
63
+ Fraudster?: Fraudster;
89
64
  }
90
65
  /**
91
66
  * @public
@@ -93,10 +68,12 @@ export interface AuthenticationResult {
93
68
  export declare enum ConflictType {
94
69
  ANOTHER_ACTIVE_STREAM = "ANOTHER_ACTIVE_STREAM",
95
70
  CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT",
71
+ CANNOT_DELETE_NON_EMPTY_WATCHLIST = "CANNOT_DELETE_NON_EMPTY_WATCHLIST",
96
72
  CONCURRENT_CHANGES = "CONCURRENT_CHANGES",
97
73
  DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES = "DOMAIN_LOCKED_FROM_ENCRYPTION_UPDATES",
98
74
  DOMAIN_NOT_ACTIVE = "DOMAIN_NOT_ACTIVE",
99
75
  ENROLLMENT_ALREADY_EXISTS = "ENROLLMENT_ALREADY_EXISTS",
76
+ FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST = "FRAUDSTER_MUST_BELONG_TO_AT_LEAST_ONE_WATCHLIST",
100
77
  SPEAKER_NOT_SET = "SPEAKER_NOT_SET",
101
78
  SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
102
79
  }
@@ -112,33 +89,33 @@ export declare class ConflictException extends __BaseException {
112
89
  /**
113
90
  * <p>The type of conflict which caused a ConflictException. Possible types and the
114
91
  * corresponding error messages are as follows:</p>
115
- * <ul>
92
+ * <ul>
116
93
  * <li>
117
- * <p>
94
+ * <p>
118
95
  * <code>DOMAIN_NOT_ACTIVE</code>: The domain is not active.</p>
119
96
  * </li>
120
97
  * <li>
121
- * <p>
98
+ * <p>
122
99
  * <code>CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT</code>: You cannot change the
123
100
  * speaker ID after an enrollment has been requested.</p>
124
101
  * </li>
125
102
  * <li>
126
- * <p>
103
+ * <p>
127
104
  * <code>ENROLLMENT_ALREADY_EXISTS</code>: There is already an enrollment for
128
105
  * this session.</p>
129
106
  * </li>
130
107
  * <li>
131
- * <p>
108
+ * <p>
132
109
  * <code>SPEAKER_NOT_SET</code>: You must set the speaker ID before requesting an
133
110
  * enrollment.</p>
134
111
  * </li>
135
112
  * <li>
136
- * <p>
113
+ * <p>
137
114
  * <code>SPEAKER_OPTED_OUT</code>: You cannot request an enrollment for an opted
138
115
  * out speaker.</p>
139
116
  * </li>
140
117
  * <li>
141
- * <p>
118
+ * <p>
142
119
  * <code>CONCURRENT_CHANGES</code>: The request could not be processed as the
143
120
  * resource was modified by another request during execution.</p>
144
121
  * </li>
@@ -150,6 +127,167 @@ export declare class ConflictException extends __BaseException {
150
127
  */
151
128
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
152
129
  }
130
+ /**
131
+ * @public
132
+ * <p>The request failed due to an unknown error on the server side.</p>
133
+ */
134
+ export declare class InternalServerException extends __BaseException {
135
+ readonly name: "InternalServerException";
136
+ readonly $fault: "server";
137
+ Message?: string;
138
+ /**
139
+ * @internal
140
+ */
141
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
142
+ }
143
+ /**
144
+ * @public
145
+ */
146
+ export declare enum ResourceType {
147
+ BATCH_JOB = "BATCH_JOB",
148
+ COMPLIANCE_CONSENT = "COMPLIANCE_CONSENT",
149
+ DOMAIN = "DOMAIN",
150
+ FRAUDSTER = "FRAUDSTER",
151
+ SESSION = "SESSION",
152
+ SPEAKER = "SPEAKER",
153
+ WATCHLIST = "WATCHLIST"
154
+ }
155
+ /**
156
+ * @public
157
+ * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
158
+ * message for more details.</p>
159
+ */
160
+ export declare class ResourceNotFoundException extends __BaseException {
161
+ readonly name: "ResourceNotFoundException";
162
+ readonly $fault: "client";
163
+ Message?: string;
164
+ /**
165
+ * <p>The type of resource which cannot not be found. Possible types are
166
+ * <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>, <code>DOMAIN</code>,
167
+ * <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
168
+ */
169
+ ResourceType?: ResourceType | string;
170
+ /**
171
+ * @internal
172
+ */
173
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
174
+ }
175
+ /**
176
+ * @public
177
+ * <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>
178
+ */
179
+ export declare class ServiceQuotaExceededException extends __BaseException {
180
+ readonly name: "ServiceQuotaExceededException";
181
+ readonly $fault: "client";
182
+ Message?: string;
183
+ /**
184
+ * @internal
185
+ */
186
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
187
+ }
188
+ /**
189
+ * @public
190
+ * <p>The request was denied due to request throttling. Please slow down your request rate.
191
+ * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
192
+ * Amazon Connect Voice ID Service API throttling quotas </a> and try your
193
+ * request again.</p>
194
+ */
195
+ export declare class ThrottlingException extends __BaseException {
196
+ readonly name: "ThrottlingException";
197
+ readonly $fault: "client";
198
+ Message?: string;
199
+ /**
200
+ * @internal
201
+ */
202
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
203
+ }
204
+ /**
205
+ * @public
206
+ * <p>The request failed one or more validations; check the error message for more
207
+ * details.</p>
208
+ */
209
+ export declare class ValidationException extends __BaseException {
210
+ readonly name: "ValidationException";
211
+ readonly $fault: "client";
212
+ Message?: string;
213
+ /**
214
+ * @internal
215
+ */
216
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
217
+ }
218
+ /**
219
+ * @public
220
+ * <p>The configuration used to authenticate a speaker during a session.</p>
221
+ */
222
+ export interface AuthenticationConfiguration {
223
+ /**
224
+ * <p>The minimum threshold needed to successfully authenticate a speaker.</p>
225
+ */
226
+ AcceptanceThreshold: number | undefined;
227
+ }
228
+ /**
229
+ * @public
230
+ */
231
+ export declare enum AuthenticationDecision {
232
+ ACCEPT = "ACCEPT",
233
+ NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH",
234
+ REJECT = "REJECT",
235
+ SPEAKER_EXPIRED = "SPEAKER_EXPIRED",
236
+ SPEAKER_ID_NOT_PROVIDED = "SPEAKER_ID_NOT_PROVIDED",
237
+ SPEAKER_NOT_ENROLLED = "SPEAKER_NOT_ENROLLED",
238
+ SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT"
239
+ }
240
+ /**
241
+ * @public
242
+ * <p>The authentication result produced by Voice ID, processed against the current session
243
+ * state and streamed audio of the speaker.</p>
244
+ */
245
+ export interface AuthenticationResult {
246
+ /**
247
+ * <p>The unique identifier for this authentication result. Because there can be multiple
248
+ * authentications for a given session, this field helps to identify if the returned result
249
+ * is from a previous streaming activity or a new result. Note that in absence of any new
250
+ * streaming activity, <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code>
251
+ * changes, Voice ID always returns cached Authentication Result for this API.</p>
252
+ */
253
+ AuthenticationResultId?: string;
254
+ /**
255
+ * <p>A timestamp of when audio aggregation started for this authentication
256
+ * result.</p>
257
+ */
258
+ AudioAggregationStartedAt?: Date;
259
+ /**
260
+ * <p>A timestamp of when audio aggregation ended for this authentication
261
+ * result.</p>
262
+ */
263
+ AudioAggregationEndedAt?: Date;
264
+ /**
265
+ * <p>The client-provided identifier for the speaker whose authentication result is
266
+ * produced. Only present if a <code>SpeakerId</code> is provided for the session.</p>
267
+ */
268
+ CustomerSpeakerId?: string;
269
+ /**
270
+ * <p>The service-generated identifier for the speaker whose authentication result is
271
+ * produced.</p>
272
+ */
273
+ GeneratedSpeakerId?: string;
274
+ /**
275
+ * <p>The authentication decision produced by Voice ID, processed against the current
276
+ * session state and streamed audio of the speaker.</p>
277
+ */
278
+ Decision?: AuthenticationDecision | string;
279
+ /**
280
+ * <p>The authentication score for the speaker whose authentication result is produced. This
281
+ * value is only present if the authentication decision is either <code>ACCEPT</code> or
282
+ * <code>REJECT</code>.</p>
283
+ */
284
+ Score?: number;
285
+ /**
286
+ * <p>The <code>AuthenticationConfiguration</code> used to generate this authentication
287
+ * result.</p>
288
+ */
289
+ Configuration?: AuthenticationConfiguration;
290
+ }
153
291
  /**
154
292
  * @public
155
293
  * <p>The configuration containing information about the customer managed key used for
@@ -164,7 +302,8 @@ export interface ServerSideEncryptionConfiguration {
164
302
  }
165
303
  /**
166
304
  * @public
167
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
305
+ * <p>The tags used to organize, track, or control access for this resource. For example, \{
306
+ * "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
168
307
  */
169
308
  export interface Tag {
170
309
  /**
@@ -187,7 +326,7 @@ export interface CreateDomainRequest {
187
326
  */
188
327
  Name: string | undefined;
189
328
  /**
190
- * <p>A brief description of the domain.</p>
329
+ * <p>A brief description of this domain.</p>
191
330
  */
192
331
  Description?: string;
193
332
  /**
@@ -197,8 +336,10 @@ export interface CreateDomainRequest {
197
336
  */
198
337
  ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
199
338
  /**
200
- * <p>The idempotency token for creating a new domain. If not provided, Amazon Web Services
201
- * SDK populates this field.</p>
339
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
340
+ * request. If not provided, the Amazon Web Services
341
+ * SDK populates this field. For more information about idempotency, see
342
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
202
343
  */
203
344
  ClientToken?: string;
204
345
  /**
@@ -248,13 +389,23 @@ export interface ServerSideEncryptionUpdateDetails {
248
389
  */
249
390
  Message?: string;
250
391
  }
392
+ /**
393
+ * @public
394
+ * <p>Details of the watchlists in a domain.</p>
395
+ */
396
+ export interface WatchlistDetails {
397
+ /**
398
+ * <p>The identifier of the default watchlist.</p>
399
+ */
400
+ DefaultWatchlistId: string | undefined;
401
+ }
251
402
  /**
252
403
  * @public
253
404
  * <p>Contains all the information about a domain.</p>
254
405
  */
255
406
  export interface Domain {
256
407
  /**
257
- * <p>The service-generated identifier for the domain.</p>
408
+ * <p>The identifier of the domain.</p>
258
409
  */
259
410
  DomainId?: string;
260
411
  /**
@@ -262,11 +413,11 @@ export interface Domain {
262
413
  */
263
414
  Arn?: string;
264
415
  /**
265
- * <p>The client-provided name for the domain.</p>
416
+ * <p>The name for the domain.</p>
266
417
  */
267
418
  Name?: string;
268
419
  /**
269
- * <p>The client-provided description of the domain.</p>
420
+ * <p>The description of the domain.</p>
270
421
  */
271
422
  Description?: string;
272
423
  /**
@@ -279,11 +430,11 @@ export interface Domain {
279
430
  */
280
431
  ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
281
432
  /**
282
- * <p>The timestamp at which the domain is created.</p>
433
+ * <p>The timestamp of when the domain was created.</p>
283
434
  */
284
435
  CreatedAt?: Date;
285
436
  /**
286
- * <p>The timestamp showing the domain's last update.</p>
437
+ * <p>The timestamp of when the domain was last update.</p>
287
438
  */
288
439
  UpdatedAt?: Date;
289
440
  /**
@@ -292,6 +443,10 @@ export interface Domain {
292
443
  * complete, the domain's data can only be accessed using the new KMS key.</p>
293
444
  */
294
445
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
446
+ /**
447
+ * <p>The watchlist details of a domain. Contains the default watchlist ID of the domain.</p>
448
+ */
449
+ WatchlistDetails?: WatchlistDetails;
295
450
  }
296
451
  /**
297
452
  * @public
@@ -304,90 +459,70 @@ export interface CreateDomainResponse {
304
459
  }
305
460
  /**
306
461
  * @public
307
- * <p>The request failed due to an unknown error on the server side.</p>
308
462
  */
309
- export declare class InternalServerException extends __BaseException {
310
- readonly name: "InternalServerException";
311
- readonly $fault: "server";
312
- Message?: string;
463
+ export interface CreateWatchlistRequest {
313
464
  /**
314
- * @internal
465
+ * <p>The identifier of the domain that contains the watchlist.</p>
315
466
  */
316
- constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
317
- }
318
- /**
319
- * @public
320
- */
321
- export declare enum ResourceType {
322
- BATCH_JOB = "BATCH_JOB",
323
- COMPLIANCE_CONSENT = "COMPLIANCE_CONSENT",
324
- DOMAIN = "DOMAIN",
325
- FRAUDSTER = "FRAUDSTER",
326
- SESSION = "SESSION",
327
- SPEAKER = "SPEAKER"
328
- }
329
- /**
330
- * @public
331
- * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error
332
- * message for more details.</p>
333
- */
334
- export declare class ResourceNotFoundException extends __BaseException {
335
- readonly name: "ResourceNotFoundException";
336
- readonly $fault: "client";
337
- Message?: string;
467
+ DomainId: string | undefined;
338
468
  /**
339
- * <p>The type of resource which cannot not be found. Possible types are
340
- * <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>, <code>DOMAIN</code>,
341
- * <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
469
+ * <p>The name of the watchlist.</p>
342
470
  */
343
- ResourceType?: ResourceType | string;
471
+ Name: string | undefined;
344
472
  /**
345
- * @internal
473
+ * <p>A brief description of this watchlist.</p>
346
474
  */
347
- constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
348
- }
349
- /**
350
- * @public
351
- * <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>
352
- */
353
- export declare class ServiceQuotaExceededException extends __BaseException {
354
- readonly name: "ServiceQuotaExceededException";
355
- readonly $fault: "client";
356
- Message?: string;
475
+ Description?: string;
357
476
  /**
358
- * @internal
477
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
478
+ * request. If not provided, the Amazon Web Services
479
+ * SDK populates this field. For more information about idempotency, see
480
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
359
481
  */
360
- constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
482
+ ClientToken?: string;
361
483
  }
362
484
  /**
363
485
  * @public
364
- * <p>The request was denied due to request throttling. Please slow down your request rate.
365
- * Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
366
- * Amazon Connect Voice ID Service API throttling quotas </a> and try your
367
- * request again.</p>
486
+ * <p>Contains all the information about a watchlist.</p>
368
487
  */
369
- export declare class ThrottlingException extends __BaseException {
370
- readonly name: "ThrottlingException";
371
- readonly $fault: "client";
372
- Message?: string;
488
+ export interface Watchlist {
489
+ /**
490
+ * <p>The identifier of the domain that contains the watchlist.</p>
491
+ */
492
+ DomainId?: string;
493
+ /**
494
+ * <p>The identifier of the watchlist.</p>
495
+ */
496
+ WatchlistId?: string;
497
+ /**
498
+ * <p>The name for the watchlist.</p>
499
+ */
500
+ Name?: string;
501
+ /**
502
+ * <p>The description of the watchlist.</p>
503
+ */
504
+ Description?: string;
373
505
  /**
374
- * @internal
506
+ * <p>Whether the specified watchlist is the default watchlist of a domain.</p>
375
507
  */
376
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
508
+ DefaultWatchlist?: boolean;
509
+ /**
510
+ * <p>The timestamp of when the watchlist was created.</p>
511
+ */
512
+ CreatedAt?: Date;
513
+ /**
514
+ * <p>The timestamp of when the watchlist was updated.</p>
515
+ */
516
+ UpdatedAt?: Date;
377
517
  }
378
518
  /**
379
519
  * @public
380
- * <p>The request failed one or more validations; check the error message for more
381
- * details.</p>
382
520
  */
383
- export declare class ValidationException extends __BaseException {
384
- readonly name: "ValidationException";
385
- readonly $fault: "client";
386
- Message?: string;
521
+ export interface CreateWatchlistResponse {
387
522
  /**
388
- * @internal
523
+ * <p>Information about the newly created watchlist.</p>
389
524
  */
390
- constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
525
+ Watchlist?: Watchlist;
391
526
  }
392
527
  /**
393
528
  * @public
@@ -403,7 +538,7 @@ export interface DeleteDomainRequest {
403
538
  */
404
539
  export interface DeleteFraudsterRequest {
405
540
  /**
406
- * <p>The identifier of the domain containing the fraudster.</p>
541
+ * <p>The identifier of the domain that contains the fraudster.</p>
407
542
  */
408
543
  DomainId: string | undefined;
409
544
  /**
@@ -416,7 +551,7 @@ export interface DeleteFraudsterRequest {
416
551
  */
417
552
  export interface DeleteSpeakerRequest {
418
553
  /**
419
- * <p>The identifier of the domain containing the speaker.</p>
554
+ * <p>The identifier of the domain that contains the speaker.</p>
420
555
  */
421
556
  DomainId: string | undefined;
422
557
  /**
@@ -424,12 +559,25 @@ export interface DeleteSpeakerRequest {
424
559
  */
425
560
  SpeakerId: string | undefined;
426
561
  }
562
+ /**
563
+ * @public
564
+ */
565
+ export interface DeleteWatchlistRequest {
566
+ /**
567
+ * <p>The identifier of the domain that contains the watchlist.</p>
568
+ */
569
+ DomainId: string | undefined;
570
+ /**
571
+ * <p>The identifier of the watchlist to be deleted.</p>
572
+ */
573
+ WatchlistId: string | undefined;
574
+ }
427
575
  /**
428
576
  * @public
429
577
  */
430
578
  export interface DescribeDomainRequest {
431
579
  /**
432
- * <p>The identifier of the domain you are describing.</p>
580
+ * <p>The identifier of the domain that you are describing.</p>
433
581
  */
434
582
  DomainId: string | undefined;
435
583
  }
@@ -447,7 +595,7 @@ export interface DescribeDomainResponse {
447
595
  */
448
596
  export interface DescribeFraudsterRequest {
449
597
  /**
450
- * <p>The identifier of the domain containing the fraudster.</p>
598
+ * <p>The identifier of the domain that contains the fraudster.</p>
451
599
  */
452
600
  DomainId: string | undefined;
453
601
  /**
@@ -455,24 +603,6 @@ export interface DescribeFraudsterRequest {
455
603
  */
456
604
  FraudsterId: string | undefined;
457
605
  }
458
- /**
459
- * @public
460
- * <p>Contains all the information about a fraudster.</p>
461
- */
462
- export interface Fraudster {
463
- /**
464
- * <p>The identifier for the domain containing the fraudster.</p>
465
- */
466
- DomainId?: string;
467
- /**
468
- * <p>The service-generated identifier for the fraudster.</p>
469
- */
470
- GeneratedFraudsterId?: string;
471
- /**
472
- * <p>The timestamp when Voice ID identified the fraudster.</p>
473
- */
474
- CreatedAt?: Date;
475
- }
476
606
  /**
477
607
  * @public
478
608
  */
@@ -487,11 +617,11 @@ export interface DescribeFraudsterResponse {
487
617
  */
488
618
  export interface DescribeFraudsterRegistrationJobRequest {
489
619
  /**
490
- * <p>The identifier for the domain containing the fraudster registration job.</p>
620
+ * <p>The identifier of the domain that contains the fraudster registration job.</p>
491
621
  */
492
622
  DomainId: string | undefined;
493
623
  /**
494
- * <p>The identifier for the fraudster registration job you are describing.</p>
624
+ * <p>The identifier of the fraudster registration job you are describing.</p>
495
625
  */
496
626
  JobId: string | undefined;
497
627
  }
@@ -570,9 +700,7 @@ export declare enum DuplicateRegistrationAction {
570
700
  }
571
701
  /**
572
702
  * @public
573
- * <p>The configuration defining the action to take when a duplicate fraudster is detected,
574
- * and the similarity threshold to use for detecting a duplicate fraudster during a batch
575
- * fraudster registration job.</p>
703
+ * <p>The registration configuration to be used during the batch fraudster registration job.</p>
576
704
  */
577
705
  export interface RegistrationConfig {
578
706
  /**
@@ -587,6 +715,11 @@ export interface RegistrationConfig {
587
715
  * the new fraudster a duplicate.</p>
588
716
  */
589
717
  FraudsterSimilarityThreshold?: number;
718
+ /**
719
+ * <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.
720
+ * </p>
721
+ */
722
+ WatchlistIds?: string[];
590
723
  }
591
724
  /**
592
725
  * @public
@@ -606,7 +739,7 @@ export interface FraudsterRegistrationJob {
606
739
  */
607
740
  JobStatus?: FraudsterRegistrationJobStatus | string;
608
741
  /**
609
- * <p>The identifier of the domain containing the fraudster registration job.</p>
742
+ * <p>The identifier of the domain that contains the fraudster registration job.</p>
610
743
  */
611
744
  DomainId?: string;
612
745
  /**
@@ -632,11 +765,11 @@ export interface FraudsterRegistrationJob {
632
765
  */
633
766
  OutputDataConfig?: OutputDataConfig;
634
767
  /**
635
- * <p>A timestamp showing the creation time of the fraudster registration job.</p>
768
+ * <p>A timestamp of when the fraudster registration job was created.</p>
636
769
  */
637
770
  CreatedAt?: Date;
638
771
  /**
639
- * <p>A timestamp showing when the fraudster registration job ended.</p>
772
+ * <p>A timestamp of when the fraudster registration job ended.</p>
640
773
  */
641
774
  EndedAt?: Date;
642
775
  /**
@@ -706,15 +839,15 @@ export interface Speaker {
706
839
  */
707
840
  Status?: SpeakerStatus | string;
708
841
  /**
709
- * <p>A timestamp showing when the speaker is created. </p>
842
+ * <p>A timestamp of when the speaker was created. </p>
710
843
  */
711
844
  CreatedAt?: Date;
712
845
  /**
713
- * <p>A timestamp showing the speaker's last update.</p>
846
+ * <p>A timestamp of the speaker's last update.</p>
714
847
  */
715
848
  UpdatedAt?: Date;
716
849
  /**
717
- * <p>The timestamp when the speaker was last accessed for enrollment, re-enrollment or a
850
+ * <p>The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a
718
851
  * successful authentication. This timestamp is accurate to one hour.</p>
719
852
  */
720
853
  LastAccessedAt?: Date;
@@ -733,7 +866,7 @@ export interface DescribeSpeakerResponse {
733
866
  */
734
867
  export interface DescribeSpeakerEnrollmentJobRequest {
735
868
  /**
736
- * <p>The identifier of the domain containing the speaker enrollment job.</p>
869
+ * <p>The identifier of the domain that contains the speaker enrollment job.</p>
737
870
  */
738
871
  DomainId: string | undefined;
739
872
  /**
@@ -757,9 +890,7 @@ export declare enum FraudDetectionAction {
757
890
  }
758
891
  /**
759
892
  * @public
760
- * <p>The configuration defining the action to take when a speaker is flagged by the fraud
761
- * detection system during a batch speaker enrollment job, and the risk threshold to use
762
- * for identification.</p>
893
+ * <p>The fraud detection configuration to be used during the batch speaker enrollment job.</p>
763
894
  */
764
895
  export interface EnrollmentJobFraudDetectionConfig {
765
896
  /**
@@ -775,6 +906,11 @@ export interface EnrollmentJobFraudDetectionConfig {
775
906
  * threshold, the speaker is considered a fraudster.</p>
776
907
  */
777
908
  RiskThreshold?: number;
909
+ /**
910
+ * <p>The identifier of watchlists against which fraud detection is performed.
911
+ * </p>
912
+ */
913
+ WatchlistIds?: string[];
778
914
  }
779
915
  /**
780
916
  * @public
@@ -847,11 +983,11 @@ export interface SpeakerEnrollmentJob {
847
983
  */
848
984
  OutputDataConfig?: OutputDataConfig;
849
985
  /**
850
- * <p>A timestamp showing the creation of the speaker enrollment job.</p>
986
+ * <p>A timestamp of when the speaker enrollment job was created.</p>
851
987
  */
852
988
  CreatedAt?: Date;
853
989
  /**
854
- * <p>A timestamp showing when the speaker enrollment job ended. </p>
990
+ * <p>A timestamp of when the speaker enrollment job ended. </p>
855
991
  */
856
992
  EndedAt?: Date;
857
993
  /**
@@ -877,19 +1013,68 @@ export interface DescribeSpeakerEnrollmentJobResponse {
877
1013
  */
878
1014
  Job?: SpeakerEnrollmentJob;
879
1015
  }
1016
+ /**
1017
+ * @public
1018
+ */
1019
+ export interface DescribeWatchlistRequest {
1020
+ /**
1021
+ * <p>The identifier of the domain that contains the watchlist.</p>
1022
+ */
1023
+ DomainId: string | undefined;
1024
+ /**
1025
+ * <p>The identifier of the watchlist that you are describing.</p>
1026
+ */
1027
+ WatchlistId: string | undefined;
1028
+ }
1029
+ /**
1030
+ * @public
1031
+ */
1032
+ export interface DescribeWatchlistResponse {
1033
+ /**
1034
+ * <p>Information about the specified watchlist.</p>
1035
+ */
1036
+ Watchlist?: Watchlist;
1037
+ }
1038
+ /**
1039
+ * @public
1040
+ */
1041
+ export interface DisassociateFraudsterRequest {
1042
+ /**
1043
+ * <p>The identifier of the domain that contains the fraudster.</p>
1044
+ */
1045
+ DomainId: string | undefined;
1046
+ /**
1047
+ * <p>The identifier of the watchlist that you want to disassociate from the fraudster.</p>
1048
+ */
1049
+ WatchlistId: string | undefined;
1050
+ /**
1051
+ * <p>The identifier of the fraudster to be disassociated from the watchlist.</p>
1052
+ */
1053
+ FraudsterId: string | undefined;
1054
+ }
1055
+ /**
1056
+ * @public
1057
+ */
1058
+ export interface DisassociateFraudsterResponse {
1059
+ /**
1060
+ * <p>Contains all the information about a fraudster.</p>
1061
+ */
1062
+ Fraudster?: Fraudster;
1063
+ }
880
1064
  /**
881
1065
  * @public
882
1066
  */
883
1067
  export interface ListDomainsRequest {
884
1068
  /**
885
- * <p>The maximum number of domains to list per API call.</p>
1069
+ * <p>The maximum number of results that are returned per call. You can use
1070
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
886
1071
  */
887
1072
  MaxResults?: number;
888
1073
  /**
889
1074
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
890
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1075
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
891
1076
  * again using the returned token to retrieve the next page. Keep all other arguments
892
- * unchanged. Each pagination token expires after 24 hours. </p>
1077
+ * unchanged. Each pagination token expires after 24 hours.</p>
893
1078
  */
894
1079
  NextToken?: string;
895
1080
  }
@@ -899,7 +1084,7 @@ export interface ListDomainsRequest {
899
1084
  */
900
1085
  export interface DomainSummary {
901
1086
  /**
902
- * <p>The service-generated identifier for the domain.</p>
1087
+ * <p>The identifier of the domain.</p>
903
1088
  */
904
1089
  DomainId?: string;
905
1090
  /**
@@ -911,7 +1096,7 @@ export interface DomainSummary {
911
1096
  */
912
1097
  Name?: string;
913
1098
  /**
914
- * <p>The client-provided description of the domain.</p>
1099
+ * <p>The description of the domain.</p>
915
1100
  */
916
1101
  Description?: string;
917
1102
  /**
@@ -924,11 +1109,11 @@ export interface DomainSummary {
924
1109
  */
925
1110
  ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
926
1111
  /**
927
- * <p>The timestamp showing when the domain is created.</p>
1112
+ * <p>The timestamp of when the domain was created.</p>
928
1113
  */
929
1114
  CreatedAt?: Date;
930
1115
  /**
931
- * <p>The timestamp showing the domain's last update.</p>
1116
+ * <p>The timestamp of when the domain was last updated.</p>
932
1117
  */
933
1118
  UpdatedAt?: Date;
934
1119
  /**
@@ -937,6 +1122,10 @@ export interface DomainSummary {
937
1122
  * complete, the domain's data can only be accessed using the new KMS key.</p>
938
1123
  */
939
1124
  ServerSideEncryptionUpdateDetails?: ServerSideEncryptionUpdateDetails;
1125
+ /**
1126
+ * <p>Provides information about <code>watchlistDetails</code> and <code>DefaultWatchlistID</code>. </p>
1127
+ */
1128
+ WatchlistDetails?: WatchlistDetails;
940
1129
  }
941
1130
  /**
942
1131
  * @public
@@ -948,9 +1137,9 @@ export interface ListDomainsResponse {
948
1137
  DomainSummaries?: DomainSummary[];
949
1138
  /**
950
1139
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
951
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1140
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
952
1141
  * again using the returned token to retrieve the next page. Keep all other arguments
953
- * unchanged. Each pagination token expires after 24 hours. </p>
1142
+ * unchanged. Each pagination token expires after 24 hours.</p>
954
1143
  */
955
1144
  NextToken?: string;
956
1145
  }
@@ -967,7 +1156,7 @@ export interface UpdateDomainRequest {
967
1156
  */
968
1157
  Name: string | undefined;
969
1158
  /**
970
- * <p>A brief description of the domain.</p>
1159
+ * <p>A brief description about this domain.</p>
971
1160
  */
972
1161
  Description?: string;
973
1162
  /**
@@ -1015,7 +1204,12 @@ export interface FraudDetectionConfiguration {
1015
1204
  * risk score calculated by Voice ID is higher than the threshold, the speaker is
1016
1205
  * considered a fraudster.</p>
1017
1206
  */
1018
- RiskThreshold: number | undefined;
1207
+ RiskThreshold?: number;
1208
+ /**
1209
+ * <p>The identifier of the watchlist against which fraud detection is performed.
1210
+ * </p>
1211
+ */
1212
+ WatchlistId?: string;
1019
1213
  }
1020
1214
  /**
1021
1215
  * @public
@@ -1089,12 +1283,12 @@ export interface FraudDetectionResult {
1089
1283
  */
1090
1284
  FraudDetectionResultId?: string;
1091
1285
  /**
1092
- * <p>A timestamp indicating when audio aggregation started for this fraud detection
1286
+ * <p>A timestamp of when audio aggregation started for this fraud detection
1093
1287
  * result.</p>
1094
1288
  */
1095
1289
  AudioAggregationStartedAt?: Date;
1096
1290
  /**
1097
- * <p>A timestamp indicating when audio aggregation ended for this fraud detection
1291
+ * <p>A timestamp of when audio aggregation ended for this fraud detection
1098
1292
  * result.</p>
1099
1293
  */
1100
1294
  AudioAggregationEndedAt?: Date;
@@ -1133,7 +1327,7 @@ export declare enum StreamingStatus {
1133
1327
  */
1134
1328
  export interface EvaluateSessionResponse {
1135
1329
  /**
1136
- * <p>The identifier of the domain containing the session.</p>
1330
+ * <p>The identifier of the domain that contains the session.</p>
1137
1331
  */
1138
1332
  DomainId?: string;
1139
1333
  /**
@@ -1185,15 +1379,15 @@ export interface FraudsterRegistrationJobSummary {
1185
1379
  */
1186
1380
  JobStatus?: FraudsterRegistrationJobStatus | string;
1187
1381
  /**
1188
- * <p>The identifier of the domain containing the fraudster registration job.</p>
1382
+ * <p>The identifier of the domain that contains the fraudster registration job.</p>
1189
1383
  */
1190
1384
  DomainId?: string;
1191
1385
  /**
1192
- * <p>A timestamp showing when the fraudster registration job is created. </p>
1386
+ * <p>A timestamp of when the fraudster registration job was created. </p>
1193
1387
  */
1194
1388
  CreatedAt?: Date;
1195
1389
  /**
1196
- * <p>A timestamp showing when the fraudster registration job ended.</p>
1390
+ * <p>A timestamp of when the fraudster registration job ended.</p>
1197
1391
  */
1198
1392
  EndedAt?: Date;
1199
1393
  /**
@@ -1210,12 +1404,35 @@ export interface FraudsterRegistrationJobSummary {
1210
1404
  */
1211
1405
  JobProgress?: JobProgress;
1212
1406
  }
1407
+ /**
1408
+ * @public
1409
+ * <p>Contains a summary of information about a fraudster.
1410
+ * </p>
1411
+ */
1412
+ export interface FraudsterSummary {
1413
+ /**
1414
+ * <p>The identifier of the domain that contains the fraudster summary.</p>
1415
+ */
1416
+ DomainId?: string;
1417
+ /**
1418
+ * <p>The service-generated identifier for the fraudster.</p>
1419
+ */
1420
+ GeneratedFraudsterId?: string;
1421
+ /**
1422
+ * <p>The timestamp of when the fraudster summary was created.</p>
1423
+ */
1424
+ CreatedAt?: Date;
1425
+ /**
1426
+ * <p>The identifier of the watchlists the fraudster is a part of.</p>
1427
+ */
1428
+ WatchlistIds?: string[];
1429
+ }
1213
1430
  /**
1214
1431
  * @public
1215
1432
  */
1216
1433
  export interface ListFraudsterRegistrationJobsRequest {
1217
1434
  /**
1218
- * <p>The identifier of the domain containing the fraudster registration Jobs.</p>
1435
+ * <p>The identifier of the domain that contains the fraudster registration Jobs.</p>
1219
1436
  */
1220
1437
  DomainId: string | undefined;
1221
1438
  /**
@@ -1224,15 +1441,14 @@ export interface ListFraudsterRegistrationJobsRequest {
1224
1441
  JobStatus?: FraudsterRegistrationJobStatus | string;
1225
1442
  /**
1226
1443
  * <p>The maximum number of results that are returned per call. You can use
1227
- * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1228
- * maximum allowed page size is also 100. </p>
1444
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
1229
1445
  */
1230
1446
  MaxResults?: number;
1231
1447
  /**
1232
1448
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1233
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1449
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1234
1450
  * again using the returned token to retrieve the next page. Keep all other arguments
1235
- * unchanged. Each pagination token expires after 24 hours. </p>
1451
+ * unchanged. Each pagination token expires after 24 hours.</p>
1236
1452
  */
1237
1453
  NextToken?: string;
1238
1454
  }
@@ -1246,9 +1462,53 @@ export interface ListFraudsterRegistrationJobsResponse {
1246
1462
  JobSummaries?: FraudsterRegistrationJobSummary[];
1247
1463
  /**
1248
1464
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1249
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1465
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1250
1466
  * again using the returned token to retrieve the next page. Keep all other arguments
1251
- * unchanged. Each pagination token expires after 24 hours. </p>
1467
+ * unchanged. Each pagination token expires after 24 hours.</p>
1468
+ */
1469
+ NextToken?: string;
1470
+ }
1471
+ /**
1472
+ * @public
1473
+ */
1474
+ export interface ListFraudstersRequest {
1475
+ /**
1476
+ * <p>The identifier of the domain. </p>
1477
+ */
1478
+ DomainId: string | undefined;
1479
+ /**
1480
+ * <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>
1481
+ */
1482
+ WatchlistId?: string;
1483
+ /**
1484
+ * <p>The maximum number of results that are returned per call. You can use
1485
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
1486
+ */
1487
+ MaxResults?: number;
1488
+ /**
1489
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1490
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1491
+ * again using the returned token to retrieve the next page. Keep all other arguments
1492
+ * unchanged. Each pagination token expires after 24 hours.
1493
+ * </p>
1494
+ */
1495
+ NextToken?: string;
1496
+ }
1497
+ /**
1498
+ * @public
1499
+ */
1500
+ export interface ListFraudstersResponse {
1501
+ /**
1502
+ * <p>A list that contains details about each fraudster in the Amazon Web Services account.
1503
+ * </p>
1504
+ */
1505
+ FraudsterSummaries?: FraudsterSummary[];
1506
+ /**
1507
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1508
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1509
+ * again using the returned token to retrieve the next page. Keep all other arguments
1510
+ * unchanged. Each pagination token expires after 24 hours.
1511
+ * </p>
1252
1512
  */
1253
1513
  NextToken?: string;
1254
1514
  }
@@ -1257,7 +1517,7 @@ export interface ListFraudsterRegistrationJobsResponse {
1257
1517
  */
1258
1518
  export interface ListSpeakerEnrollmentJobsRequest {
1259
1519
  /**
1260
- * <p>The identifier of the domain containing the speaker enrollment jobs.</p>
1520
+ * <p>The identifier of the domain that contains the speaker enrollment jobs.</p>
1261
1521
  */
1262
1522
  DomainId: string | undefined;
1263
1523
  /**
@@ -1266,15 +1526,14 @@ export interface ListSpeakerEnrollmentJobsRequest {
1266
1526
  JobStatus?: SpeakerEnrollmentJobStatus | string;
1267
1527
  /**
1268
1528
  * <p>The maximum number of results that are returned per call. You can use
1269
- * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1270
- * maximum allowed page size is also 100. </p>
1529
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.</p>
1271
1530
  */
1272
1531
  MaxResults?: number;
1273
1532
  /**
1274
1533
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1275
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1534
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1276
1535
  * again using the returned token to retrieve the next page. Keep all other arguments
1277
- * unchanged. Each pagination token expires after 24 hours. </p>
1536
+ * unchanged. Each pagination token expires after 24 hours.</p>
1278
1537
  */
1279
1538
  NextToken?: string;
1280
1539
  }
@@ -1300,11 +1559,11 @@ export interface SpeakerEnrollmentJobSummary {
1300
1559
  */
1301
1560
  DomainId?: string;
1302
1561
  /**
1303
- * <p>A timestamp showing the creation time of the speaker enrollment job.</p>
1562
+ * <p>A timestamp of when of the speaker enrollment job was created.</p>
1304
1563
  */
1305
1564
  CreatedAt?: Date;
1306
1565
  /**
1307
- * <p>A timestamp showing when the speaker enrollment job ended.</p>
1566
+ * <p>A timestamp of when the speaker enrollment job ended.</p>
1308
1567
  */
1309
1568
  EndedAt?: Date;
1310
1569
  /**
@@ -1331,7 +1590,7 @@ export interface ListSpeakerEnrollmentJobsResponse {
1331
1590
  JobSummaries?: SpeakerEnrollmentJobSummary[];
1332
1591
  /**
1333
1592
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1334
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1593
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1335
1594
  * again using the returned token to retrieve the next page. Keep all other arguments
1336
1595
  * unchanged. Each pagination token expires after 24 hours. </p>
1337
1596
  */
@@ -1347,15 +1606,14 @@ export interface ListSpeakersRequest {
1347
1606
  DomainId: string | undefined;
1348
1607
  /**
1349
1608
  * <p>The maximum number of results that are returned per call. You can use
1350
- * <code>NextToken</code> to obtain further pages of results. The default is 100; the
1351
- * maximum allowed page size is also 100. </p>
1609
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100. </p>
1352
1610
  */
1353
1611
  MaxResults?: number;
1354
1612
  /**
1355
1613
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1356
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1614
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1357
1615
  * again using the returned token to retrieve the next page. Keep all other arguments
1358
- * unchanged. Each pagination token expires after 24 hours. </p>
1616
+ * unchanged. Each pagination token expires after 24 hours.</p>
1359
1617
  */
1360
1618
  NextToken?: string;
1361
1619
  }
@@ -1405,7 +1663,7 @@ export interface ListSpeakersResponse {
1405
1663
  SpeakerSummaries?: SpeakerSummary[];
1406
1664
  /**
1407
1665
  * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1408
- * <code>NextToken</code> is a unique pagination token for each page. Make the call
1666
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1409
1667
  * again using the returned token to retrieve the next page. Keep all other arguments
1410
1668
  * unchanged. Each pagination token expires after 24 hours. </p>
1411
1669
  */
@@ -1430,12 +1688,87 @@ export interface ListTagsForResourceResponse {
1430
1688
  */
1431
1689
  Tags?: Tag[];
1432
1690
  }
1691
+ /**
1692
+ * @public
1693
+ */
1694
+ export interface ListWatchlistsRequest {
1695
+ /**
1696
+ * <p>The identifier of the domain.</p>
1697
+ */
1698
+ DomainId: string | undefined;
1699
+ /**
1700
+ * <p>The maximum number of results that are returned per call. You can use
1701
+ * <code>NextToken</code> to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.
1702
+ * </p>
1703
+ */
1704
+ MaxResults?: number;
1705
+ /**
1706
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1707
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1708
+ * again using the returned token to retrieve the next page. Keep all other arguments
1709
+ * unchanged. Each pagination token expires after 24 hours.
1710
+ * </p>
1711
+ */
1712
+ NextToken?: string;
1713
+ }
1714
+ /**
1715
+ * @public
1716
+ * <p>Contains a summary of information about a watchlist.</p>
1717
+ */
1718
+ export interface WatchlistSummary {
1719
+ /**
1720
+ * <p>The identifier of the domain that contains the watchlist.</p>
1721
+ */
1722
+ DomainId?: string;
1723
+ /**
1724
+ * <p>The identifier of the watchlist.</p>
1725
+ */
1726
+ WatchlistId?: string;
1727
+ /**
1728
+ * <p>The name for the watchlist.</p>
1729
+ */
1730
+ Name?: string;
1731
+ /**
1732
+ * <p>The description of the watchlist.</p>
1733
+ */
1734
+ Description?: string;
1735
+ /**
1736
+ * <p>Whether the specified watchlist is the default watchlist of a domain.</p>
1737
+ */
1738
+ DefaultWatchlist?: boolean;
1739
+ /**
1740
+ * <p>The timestamp of when the watchlist was created.</p>
1741
+ */
1742
+ CreatedAt?: Date;
1743
+ /**
1744
+ * <p>The timestamp of when the watchlist was last updated.</p>
1745
+ */
1746
+ UpdatedAt?: Date;
1747
+ }
1748
+ /**
1749
+ * @public
1750
+ */
1751
+ export interface ListWatchlistsResponse {
1752
+ /**
1753
+ * <p>A list that contains details about each watchlist in the Amazon Web Services account.
1754
+ * </p>
1755
+ */
1756
+ WatchlistSummaries?: WatchlistSummary[];
1757
+ /**
1758
+ * <p>If <code>NextToken</code> is returned, there are more results available. The value of
1759
+ * <code>NextToken</code> is a unique pagination token for each page. Make the call
1760
+ * again using the returned token to retrieve the next page. Keep all other arguments
1761
+ * unchanged. Each pagination token expires after 24 hours.
1762
+ * </p>
1763
+ */
1764
+ NextToken?: string;
1765
+ }
1433
1766
  /**
1434
1767
  * @public
1435
1768
  */
1436
1769
  export interface OptOutSpeakerRequest {
1437
1770
  /**
1438
- * <p>The identifier of the domain containing the speaker.</p>
1771
+ * <p>The identifier of the domain that contains the speaker.</p>
1439
1772
  */
1440
1773
  DomainId: string | undefined;
1441
1774
  /**
@@ -1457,8 +1790,10 @@ export interface OptOutSpeakerResponse {
1457
1790
  */
1458
1791
  export interface StartFraudsterRegistrationJobRequest {
1459
1792
  /**
1460
- * <p>The idempotency token for starting a new fraudster registration job. If not provided,
1461
- * Amazon Web Services SDK populates this field.</p>
1793
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1794
+ * request. If not provided, the Amazon Web Services
1795
+ * SDK populates this field. For more information about idempotency, see
1796
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1462
1797
  */
1463
1798
  ClientToken?: string;
1464
1799
  /**
@@ -1466,7 +1801,7 @@ export interface StartFraudsterRegistrationJobRequest {
1466
1801
  */
1467
1802
  JobName?: string;
1468
1803
  /**
1469
- * <p>The identifier of the domain containing the fraudster registration job and in which
1804
+ * <p>The identifier of the domain that contains the fraudster registration job and in which
1470
1805
  * the fraudsters are registered.</p>
1471
1806
  */
1472
1807
  DomainId: string | undefined;
@@ -1510,8 +1845,10 @@ export interface StartFraudsterRegistrationJobResponse {
1510
1845
  */
1511
1846
  export interface StartSpeakerEnrollmentJobRequest {
1512
1847
  /**
1513
- * <p>The idempotency token for starting a new speaker enrollment Job. If not provided,
1514
- * Amazon Web Services SDK populates this field.</p>
1848
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1849
+ * request. If not provided, the Amazon Web Services
1850
+ * SDK populates this field. For more information about idempotency, see
1851
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1515
1852
  */
1516
1853
  ClientToken?: string;
1517
1854
  /**
@@ -1593,6 +1930,40 @@ export interface UntagResourceRequest {
1593
1930
  */
1594
1931
  export interface UntagResourceResponse {
1595
1932
  }
1933
+ /**
1934
+ * @public
1935
+ */
1936
+ export interface UpdateWatchlistRequest {
1937
+ /**
1938
+ * <p>The identifier of the domain that contains the watchlist.</p>
1939
+ */
1940
+ DomainId: string | undefined;
1941
+ /**
1942
+ * <p>The identifier of the watchlist to be updated.</p>
1943
+ */
1944
+ WatchlistId: string | undefined;
1945
+ /**
1946
+ * <p>The name of the watchlist.</p>
1947
+ */
1948
+ Name?: string;
1949
+ /**
1950
+ * <p>A brief description about this watchlist.</p>
1951
+ */
1952
+ Description?: string;
1953
+ }
1954
+ /**
1955
+ * @public
1956
+ */
1957
+ export interface UpdateWatchlistResponse {
1958
+ /**
1959
+ * <p>Details about the updated watchlist.</p>
1960
+ */
1961
+ Watchlist?: Watchlist;
1962
+ }
1963
+ /**
1964
+ * @internal
1965
+ */
1966
+ export declare const AssociateFraudsterRequestFilterSensitiveLog: (obj: AssociateFraudsterRequest) => any;
1596
1967
  /**
1597
1968
  * @internal
1598
1969
  */
@@ -1613,6 +1984,18 @@ export declare const DomainFilterSensitiveLog: (obj: Domain) => any;
1613
1984
  * @internal
1614
1985
  */
1615
1986
  export declare const CreateDomainResponseFilterSensitiveLog: (obj: CreateDomainResponse) => any;
1987
+ /**
1988
+ * @internal
1989
+ */
1990
+ export declare const CreateWatchlistRequestFilterSensitiveLog: (obj: CreateWatchlistRequest) => any;
1991
+ /**
1992
+ * @internal
1993
+ */
1994
+ export declare const WatchlistFilterSensitiveLog: (obj: Watchlist) => any;
1995
+ /**
1996
+ * @internal
1997
+ */
1998
+ export declare const CreateWatchlistResponseFilterSensitiveLog: (obj: CreateWatchlistResponse) => any;
1616
1999
  /**
1617
2000
  * @internal
1618
2001
  */
@@ -1657,6 +2040,14 @@ export declare const SpeakerEnrollmentJobFilterSensitiveLog: (obj: SpeakerEnroll
1657
2040
  * @internal
1658
2041
  */
1659
2042
  export declare const DescribeSpeakerEnrollmentJobResponseFilterSensitiveLog: (obj: DescribeSpeakerEnrollmentJobResponse) => any;
2043
+ /**
2044
+ * @internal
2045
+ */
2046
+ export declare const DescribeWatchlistResponseFilterSensitiveLog: (obj: DescribeWatchlistResponse) => any;
2047
+ /**
2048
+ * @internal
2049
+ */
2050
+ export declare const DisassociateFraudsterRequestFilterSensitiveLog: (obj: DisassociateFraudsterRequest) => any;
1660
2051
  /**
1661
2052
  * @internal
1662
2053
  */
@@ -1705,6 +2096,14 @@ export declare const ListSpeakersResponseFilterSensitiveLog: (obj: ListSpeakersR
1705
2096
  * @internal
1706
2097
  */
1707
2098
  export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
2099
+ /**
2100
+ * @internal
2101
+ */
2102
+ export declare const WatchlistSummaryFilterSensitiveLog: (obj: WatchlistSummary) => any;
2103
+ /**
2104
+ * @internal
2105
+ */
2106
+ export declare const ListWatchlistsResponseFilterSensitiveLog: (obj: ListWatchlistsResponse) => any;
1708
2107
  /**
1709
2108
  * @internal
1710
2109
  */
@@ -1737,3 +2136,11 @@ export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequ
1737
2136
  * @internal
1738
2137
  */
1739
2138
  export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
2139
+ /**
2140
+ * @internal
2141
+ */
2142
+ export declare const UpdateWatchlistRequestFilterSensitiveLog: (obj: UpdateWatchlistRequest) => any;
2143
+ /**
2144
+ * @internal
2145
+ */
2146
+ export declare const UpdateWatchlistResponseFilterSensitiveLog: (obj: UpdateWatchlistResponse) => any;