@aws-sdk/client-entityresolution 3.379.1 → 3.385.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/models/models_0.d.ts +131 -0
- package/package.json +5 -5
|
@@ -56,6 +56,7 @@ export type IncrementalRunType = (typeof IncrementalRunType)[keyof typeof Increm
|
|
|
56
56
|
*/
|
|
57
57
|
export interface IncrementalRunConfig {
|
|
58
58
|
/**
|
|
59
|
+
* @public
|
|
59
60
|
* <p>The type of incremental run. It takes only one value: <code>IMMEDIATE</code>.</p>
|
|
60
61
|
*/
|
|
61
62
|
incrementalRunType?: IncrementalRunType | string;
|
|
@@ -67,14 +68,17 @@ export interface IncrementalRunConfig {
|
|
|
67
68
|
*/
|
|
68
69
|
export interface InputSource {
|
|
69
70
|
/**
|
|
71
|
+
* @public
|
|
70
72
|
* <p>An Glue table ARN for the input source table.</p>
|
|
71
73
|
*/
|
|
72
74
|
inputSourceARN: string | undefined;
|
|
73
75
|
/**
|
|
76
|
+
* @public
|
|
74
77
|
* <p>The name of the schema to be retrieved.</p>
|
|
75
78
|
*/
|
|
76
79
|
schemaName: string | undefined;
|
|
77
80
|
/**
|
|
81
|
+
* @public
|
|
78
82
|
* <p>Normalizes the attributes defined in the schema in the input data. For example, if an
|
|
79
83
|
* attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in
|
|
80
84
|
* the input table is in a format of 1234567890, Entity Resolution will normalize this field
|
|
@@ -90,11 +94,13 @@ export interface InputSource {
|
|
|
90
94
|
*/
|
|
91
95
|
export interface OutputAttribute {
|
|
92
96
|
/**
|
|
97
|
+
* @public
|
|
93
98
|
* <p>A name of a column to be written to the output. This must be an <code>InputField</code> name
|
|
94
99
|
* in the schema mapping.</p>
|
|
95
100
|
*/
|
|
96
101
|
name: string | undefined;
|
|
97
102
|
/**
|
|
103
|
+
* @public
|
|
98
104
|
* <p>Enables the ability to hash the column values in the output.</p>
|
|
99
105
|
*/
|
|
100
106
|
hashed?: boolean;
|
|
@@ -107,21 +113,25 @@ export interface OutputAttribute {
|
|
|
107
113
|
*/
|
|
108
114
|
export interface OutputSource {
|
|
109
115
|
/**
|
|
116
|
+
* @public
|
|
110
117
|
* <p>The S3 path to which Entity Resolution will write the output table.</p>
|
|
111
118
|
*/
|
|
112
119
|
outputS3Path: string | undefined;
|
|
113
120
|
/**
|
|
121
|
+
* @public
|
|
114
122
|
* <p>A list of <code>OutputAttribute</code> objects, each of which have the fields Name and Hashed. Each of
|
|
115
123
|
* these objects selects a column to be included in the output table, and whether the
|
|
116
124
|
* values of the column should be hashed.</p>
|
|
117
125
|
*/
|
|
118
126
|
output: OutputAttribute[] | undefined;
|
|
119
127
|
/**
|
|
128
|
+
* @public
|
|
120
129
|
* <p>Customer KMS ARN for encryption at rest. If not provided, system will use an
|
|
121
130
|
* Entity Resolution managed KMS key.</p>
|
|
122
131
|
*/
|
|
123
132
|
KMSArn?: string;
|
|
124
133
|
/**
|
|
134
|
+
* @public
|
|
125
135
|
* <p>Normalizes the attributes defined in the schema in the input data. For example, if an
|
|
126
136
|
* attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in
|
|
127
137
|
* the input table is in a format of 1234567890, Entity Resolution will normalize this field
|
|
@@ -147,10 +157,12 @@ export type ResolutionType = (typeof ResolutionType)[keyof typeof ResolutionType
|
|
|
147
157
|
*/
|
|
148
158
|
export interface Rule {
|
|
149
159
|
/**
|
|
160
|
+
* @public
|
|
150
161
|
* <p>A name for the matching rule.</p>
|
|
151
162
|
*/
|
|
152
163
|
ruleName: string | undefined;
|
|
153
164
|
/**
|
|
165
|
+
* @public
|
|
154
166
|
* <p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been defined in
|
|
155
167
|
* the <code>SchemaMapping</code>. Two records are considered to match according to this rule if all
|
|
156
168
|
* of the <code>MatchingKeys</code> match.</p>
|
|
@@ -164,10 +176,12 @@ export interface Rule {
|
|
|
164
176
|
*/
|
|
165
177
|
export interface RuleBasedProperties {
|
|
166
178
|
/**
|
|
179
|
+
* @public
|
|
167
180
|
* <p>A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.</p>
|
|
168
181
|
*/
|
|
169
182
|
rules: Rule[] | undefined;
|
|
170
183
|
/**
|
|
184
|
+
* @public
|
|
171
185
|
* <p>You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
|
|
172
186
|
* choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
|
|
173
187
|
* example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
|
|
@@ -184,11 +198,13 @@ export interface RuleBasedProperties {
|
|
|
184
198
|
*/
|
|
185
199
|
export interface ResolutionTechniques {
|
|
186
200
|
/**
|
|
201
|
+
* @public
|
|
187
202
|
* <p>There are two types of matching, <code>RULE_MATCHING</code> and <code>ML_MATCHING</code>
|
|
188
203
|
* </p>
|
|
189
204
|
*/
|
|
190
205
|
resolutionType?: ResolutionType | string;
|
|
191
206
|
/**
|
|
207
|
+
* @public
|
|
192
208
|
* <p>An object which defines the list of matching rules to run and has a field <code>Rules</code>, which
|
|
193
209
|
* is a list of rule objects.</p>
|
|
194
210
|
*/
|
|
@@ -199,38 +215,46 @@ export interface ResolutionTechniques {
|
|
|
199
215
|
*/
|
|
200
216
|
export interface CreateMatchingWorkflowInput {
|
|
201
217
|
/**
|
|
218
|
+
* @public
|
|
202
219
|
* <p>The name of the workflow. There cannot be multiple <code>DataIntegrationWorkflows</code> with the same name.</p>
|
|
203
220
|
*/
|
|
204
221
|
workflowName: string | undefined;
|
|
205
222
|
/**
|
|
223
|
+
* @public
|
|
206
224
|
* <p>A description of the workflow.</p>
|
|
207
225
|
*/
|
|
208
226
|
description?: string;
|
|
209
227
|
/**
|
|
228
|
+
* @public
|
|
210
229
|
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
211
230
|
* <code>SchemaName</code>.</p>
|
|
212
231
|
*/
|
|
213
232
|
inputSourceConfig: InputSource[] | undefined;
|
|
214
233
|
/**
|
|
234
|
+
* @public
|
|
215
235
|
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
216
236
|
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
217
237
|
*/
|
|
218
238
|
outputSourceConfig: OutputSource[] | undefined;
|
|
219
239
|
/**
|
|
240
|
+
* @public
|
|
220
241
|
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
221
242
|
* </p>
|
|
222
243
|
*/
|
|
223
244
|
resolutionTechniques: ResolutionTechniques | undefined;
|
|
224
245
|
/**
|
|
246
|
+
* @public
|
|
225
247
|
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
226
248
|
*/
|
|
227
249
|
incrementalRunConfig?: IncrementalRunConfig;
|
|
228
250
|
/**
|
|
251
|
+
* @public
|
|
229
252
|
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
230
253
|
* to create resources on your behalf as part of workflow execution.</p>
|
|
231
254
|
*/
|
|
232
255
|
roleArn: string | undefined;
|
|
233
256
|
/**
|
|
257
|
+
* @public
|
|
234
258
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
235
259
|
*/
|
|
236
260
|
tags?: Record<string, string>;
|
|
@@ -240,37 +264,45 @@ export interface CreateMatchingWorkflowInput {
|
|
|
240
264
|
*/
|
|
241
265
|
export interface CreateMatchingWorkflowOutput {
|
|
242
266
|
/**
|
|
267
|
+
* @public
|
|
243
268
|
* <p>The name of the workflow.</p>
|
|
244
269
|
*/
|
|
245
270
|
workflowName: string | undefined;
|
|
246
271
|
/**
|
|
272
|
+
* @public
|
|
247
273
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
248
274
|
*/
|
|
249
275
|
workflowArn: string | undefined;
|
|
250
276
|
/**
|
|
277
|
+
* @public
|
|
251
278
|
* <p>A description of the workflow.</p>
|
|
252
279
|
*/
|
|
253
280
|
description?: string;
|
|
254
281
|
/**
|
|
282
|
+
* @public
|
|
255
283
|
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
256
284
|
* <code>SchemaName</code>.</p>
|
|
257
285
|
*/
|
|
258
286
|
inputSourceConfig: InputSource[] | undefined;
|
|
259
287
|
/**
|
|
288
|
+
* @public
|
|
260
289
|
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
261
290
|
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
262
291
|
*/
|
|
263
292
|
outputSourceConfig: OutputSource[] | undefined;
|
|
264
293
|
/**
|
|
294
|
+
* @public
|
|
265
295
|
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
266
296
|
* </p>
|
|
267
297
|
*/
|
|
268
298
|
resolutionTechniques: ResolutionTechniques | undefined;
|
|
269
299
|
/**
|
|
300
|
+
* @public
|
|
270
301
|
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
271
302
|
*/
|
|
272
303
|
incrementalRunConfig?: IncrementalRunConfig;
|
|
273
304
|
/**
|
|
305
|
+
* @public
|
|
274
306
|
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
275
307
|
* to create resources on your behalf as part of workflow execution.</p>
|
|
276
308
|
*/
|
|
@@ -369,14 +401,17 @@ export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof Sche
|
|
|
369
401
|
*/
|
|
370
402
|
export interface SchemaInputAttribute {
|
|
371
403
|
/**
|
|
404
|
+
* @public
|
|
372
405
|
* <p>A string containing the field name.</p>
|
|
373
406
|
*/
|
|
374
407
|
fieldName: string | undefined;
|
|
375
408
|
/**
|
|
409
|
+
* @public
|
|
376
410
|
* <p>The type of the attribute, selected from a list of values.</p>
|
|
377
411
|
*/
|
|
378
412
|
type: SchemaAttributeType | string | undefined;
|
|
379
413
|
/**
|
|
414
|
+
* @public
|
|
380
415
|
* <p>Instruct Entity Resolution to combine several columns into a unified column with the
|
|
381
416
|
* identical attribute type. For example, when working with columns such as first_name,
|
|
382
417
|
* middle_name, and last_name, assigning them a common <code>GroupName</code> will prompt
|
|
@@ -384,6 +419,7 @@ export interface SchemaInputAttribute {
|
|
|
384
419
|
*/
|
|
385
420
|
groupName?: string;
|
|
386
421
|
/**
|
|
422
|
+
* @public
|
|
387
423
|
* <p>A key that allows grouping of multiple input attributes into a unified matching group.
|
|
388
424
|
* For example, let's consider a scenario where the source table contains various addresses,
|
|
389
425
|
* such as business_address and shipping_address. By assigning the <code>MatchKey</code>
|
|
@@ -399,21 +435,25 @@ export interface SchemaInputAttribute {
|
|
|
399
435
|
*/
|
|
400
436
|
export interface CreateSchemaMappingInput {
|
|
401
437
|
/**
|
|
438
|
+
* @public
|
|
402
439
|
* <p>The name of the schema. There cannot be multiple <code>SchemaMappings</code> with the
|
|
403
440
|
* same name.</p>
|
|
404
441
|
*/
|
|
405
442
|
schemaName: string | undefined;
|
|
406
443
|
/**
|
|
444
|
+
* @public
|
|
407
445
|
* <p>A description of the schema.</p>
|
|
408
446
|
*/
|
|
409
447
|
description?: string;
|
|
410
448
|
/**
|
|
449
|
+
* @public
|
|
411
450
|
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
412
451
|
* to a column the source data table, and contains column name plus additional information
|
|
413
452
|
* that Entity Resolution uses for matching.</p>
|
|
414
453
|
*/
|
|
415
454
|
mappedInputFields?: SchemaInputAttribute[];
|
|
416
455
|
/**
|
|
456
|
+
* @public
|
|
417
457
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
418
458
|
*/
|
|
419
459
|
tags?: Record<string, string>;
|
|
@@ -423,19 +463,23 @@ export interface CreateSchemaMappingInput {
|
|
|
423
463
|
*/
|
|
424
464
|
export interface CreateSchemaMappingOutput {
|
|
425
465
|
/**
|
|
466
|
+
* @public
|
|
426
467
|
* <p>The name of the schema.</p>
|
|
427
468
|
*/
|
|
428
469
|
schemaName: string | undefined;
|
|
429
470
|
/**
|
|
471
|
+
* @public
|
|
430
472
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the
|
|
431
473
|
* <code>SchemaMapping</code>.</p>
|
|
432
474
|
*/
|
|
433
475
|
schemaArn: string | undefined;
|
|
434
476
|
/**
|
|
477
|
+
* @public
|
|
435
478
|
* <p>A description of the schema.</p>
|
|
436
479
|
*/
|
|
437
480
|
description: string | undefined;
|
|
438
481
|
/**
|
|
482
|
+
* @public
|
|
439
483
|
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
440
484
|
* to a column the source data table, and contains column name plus additional information
|
|
441
485
|
* that Entity Resolution uses for matching.</p>
|
|
@@ -447,6 +491,7 @@ export interface CreateSchemaMappingOutput {
|
|
|
447
491
|
*/
|
|
448
492
|
export interface DeleteMatchingWorkflowInput {
|
|
449
493
|
/**
|
|
494
|
+
* @public
|
|
450
495
|
* <p>The name of the workflow to be retrieved.</p>
|
|
451
496
|
*/
|
|
452
497
|
workflowName: string | undefined;
|
|
@@ -456,6 +501,7 @@ export interface DeleteMatchingWorkflowInput {
|
|
|
456
501
|
*/
|
|
457
502
|
export interface DeleteMatchingWorkflowOutput {
|
|
458
503
|
/**
|
|
504
|
+
* @public
|
|
459
505
|
* <p>A successful operation message.</p>
|
|
460
506
|
*/
|
|
461
507
|
message: string | undefined;
|
|
@@ -465,6 +511,7 @@ export interface DeleteMatchingWorkflowOutput {
|
|
|
465
511
|
*/
|
|
466
512
|
export interface DeleteSchemaMappingInput {
|
|
467
513
|
/**
|
|
514
|
+
* @public
|
|
468
515
|
* <p>The name of the schema to delete.</p>
|
|
469
516
|
*/
|
|
470
517
|
schemaName: string | undefined;
|
|
@@ -474,6 +521,7 @@ export interface DeleteSchemaMappingInput {
|
|
|
474
521
|
*/
|
|
475
522
|
export interface DeleteSchemaMappingOutput {
|
|
476
523
|
/**
|
|
524
|
+
* @public
|
|
477
525
|
* <p>A successful operation message.</p>
|
|
478
526
|
*/
|
|
479
527
|
message: string | undefined;
|
|
@@ -483,10 +531,12 @@ export interface DeleteSchemaMappingOutput {
|
|
|
483
531
|
*/
|
|
484
532
|
export interface GetMatchIdInput {
|
|
485
533
|
/**
|
|
534
|
+
* @public
|
|
486
535
|
* <p>The name of the workflow.</p>
|
|
487
536
|
*/
|
|
488
537
|
workflowName: string | undefined;
|
|
489
538
|
/**
|
|
539
|
+
* @public
|
|
490
540
|
* <p>The record to fetch the Match ID for.</p>
|
|
491
541
|
*/
|
|
492
542
|
record: Record<string, string> | undefined;
|
|
@@ -496,6 +546,7 @@ export interface GetMatchIdInput {
|
|
|
496
546
|
*/
|
|
497
547
|
export interface GetMatchIdOutput {
|
|
498
548
|
/**
|
|
549
|
+
* @public
|
|
499
550
|
* <p>The unique identifiers for this group of match records.</p>
|
|
500
551
|
*/
|
|
501
552
|
matchId?: string;
|
|
@@ -518,10 +569,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
518
569
|
*/
|
|
519
570
|
export interface GetMatchingJobInput {
|
|
520
571
|
/**
|
|
572
|
+
* @public
|
|
521
573
|
* <p>The name of the workflow.</p>
|
|
522
574
|
*/
|
|
523
575
|
workflowName: string | undefined;
|
|
524
576
|
/**
|
|
577
|
+
* @public
|
|
525
578
|
* <p>The ID of the job.</p>
|
|
526
579
|
*/
|
|
527
580
|
jobId: string | undefined;
|
|
@@ -532,6 +585,7 @@ export interface GetMatchingJobInput {
|
|
|
532
585
|
*/
|
|
533
586
|
export interface ErrorDetails {
|
|
534
587
|
/**
|
|
588
|
+
* @public
|
|
535
589
|
* <p>The error message from the job, if there is one.</p>
|
|
536
590
|
*/
|
|
537
591
|
errorMessage?: string;
|
|
@@ -543,18 +597,22 @@ export interface ErrorDetails {
|
|
|
543
597
|
*/
|
|
544
598
|
export interface JobMetrics {
|
|
545
599
|
/**
|
|
600
|
+
* @public
|
|
546
601
|
* <p>The total number of input records.</p>
|
|
547
602
|
*/
|
|
548
603
|
inputRecords?: number;
|
|
549
604
|
/**
|
|
605
|
+
* @public
|
|
550
606
|
* <p>The total number of records processed.</p>
|
|
551
607
|
*/
|
|
552
608
|
totalRecordsProcessed?: number;
|
|
553
609
|
/**
|
|
610
|
+
* @public
|
|
554
611
|
* <p>The total number of <code>matchID</code>s generated.</p>
|
|
555
612
|
*/
|
|
556
613
|
matchIDs?: number;
|
|
557
614
|
/**
|
|
615
|
+
* @public
|
|
558
616
|
* <p>The total number of records that did not get processed,</p>
|
|
559
617
|
*/
|
|
560
618
|
recordsNotProcessed?: number;
|
|
@@ -578,28 +636,34 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
578
636
|
*/
|
|
579
637
|
export interface GetMatchingJobOutput {
|
|
580
638
|
/**
|
|
639
|
+
* @public
|
|
581
640
|
* <p>The ID of the job.</p>
|
|
582
641
|
*/
|
|
583
642
|
jobId: string | undefined;
|
|
584
643
|
/**
|
|
644
|
+
* @public
|
|
585
645
|
* <p>The current status of the job. Either <code>running</code>, <code>succeeded</code>,
|
|
586
646
|
* <code>queued</code>, or <code>failed</code>.</p>
|
|
587
647
|
*/
|
|
588
648
|
status: JobStatus | string | undefined;
|
|
589
649
|
/**
|
|
650
|
+
* @public
|
|
590
651
|
* <p>The time at which the job was started.</p>
|
|
591
652
|
*/
|
|
592
653
|
startTime: Date | undefined;
|
|
593
654
|
/**
|
|
655
|
+
* @public
|
|
594
656
|
* <p>The time at which the job has finished.</p>
|
|
595
657
|
*/
|
|
596
658
|
endTime?: Date;
|
|
597
659
|
/**
|
|
660
|
+
* @public
|
|
598
661
|
* <p>Metrics associated with the execution, specifically total records processed,
|
|
599
662
|
* unique IDs generated, and records the execution skipped.</p>
|
|
600
663
|
*/
|
|
601
664
|
metrics?: JobMetrics;
|
|
602
665
|
/**
|
|
666
|
+
* @public
|
|
603
667
|
* <p>An object containing an error message, if there was an error.</p>
|
|
604
668
|
*/
|
|
605
669
|
errorDetails?: ErrorDetails;
|
|
@@ -609,6 +673,7 @@ export interface GetMatchingJobOutput {
|
|
|
609
673
|
*/
|
|
610
674
|
export interface GetMatchingWorkflowInput {
|
|
611
675
|
/**
|
|
676
|
+
* @public
|
|
612
677
|
* <p>The name of the workflow.</p>
|
|
613
678
|
*/
|
|
614
679
|
workflowName: string | undefined;
|
|
@@ -618,50 +683,61 @@ export interface GetMatchingWorkflowInput {
|
|
|
618
683
|
*/
|
|
619
684
|
export interface GetMatchingWorkflowOutput {
|
|
620
685
|
/**
|
|
686
|
+
* @public
|
|
621
687
|
* <p>The name of the workflow.</p>
|
|
622
688
|
*/
|
|
623
689
|
workflowName: string | undefined;
|
|
624
690
|
/**
|
|
691
|
+
* @public
|
|
625
692
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
626
693
|
*/
|
|
627
694
|
workflowArn: string | undefined;
|
|
628
695
|
/**
|
|
696
|
+
* @public
|
|
629
697
|
* <p>A description of the workflow.</p>
|
|
630
698
|
*/
|
|
631
699
|
description?: string;
|
|
632
700
|
/**
|
|
701
|
+
* @public
|
|
633
702
|
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
634
703
|
* <code>SchemaName</code>.</p>
|
|
635
704
|
*/
|
|
636
705
|
inputSourceConfig: InputSource[] | undefined;
|
|
637
706
|
/**
|
|
707
|
+
* @public
|
|
638
708
|
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
639
709
|
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
640
710
|
*/
|
|
641
711
|
outputSourceConfig: OutputSource[] | undefined;
|
|
642
712
|
/**
|
|
713
|
+
* @public
|
|
643
714
|
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
644
715
|
* </p>
|
|
645
716
|
*/
|
|
646
717
|
resolutionTechniques: ResolutionTechniques | undefined;
|
|
647
718
|
/**
|
|
719
|
+
* @public
|
|
648
720
|
* <p>The timestamp of when the workflow was created.</p>
|
|
649
721
|
*/
|
|
650
722
|
createdAt: Date | undefined;
|
|
651
723
|
/**
|
|
724
|
+
* @public
|
|
652
725
|
* <p>The timestamp of when the workflow was last updated.</p>
|
|
653
726
|
*/
|
|
654
727
|
updatedAt: Date | undefined;
|
|
655
728
|
/**
|
|
729
|
+
* @public
|
|
656
730
|
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
657
731
|
*/
|
|
658
732
|
incrementalRunConfig?: IncrementalRunConfig;
|
|
659
733
|
/**
|
|
734
|
+
* @public
|
|
660
735
|
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access
|
|
661
736
|
* resources on your behalf.</p>
|
|
662
737
|
*/
|
|
663
738
|
roleArn: string | undefined;
|
|
664
739
|
/**
|
|
740
|
+
* @public
|
|
665
741
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
666
742
|
*/
|
|
667
743
|
tags?: Record<string, string>;
|
|
@@ -671,6 +747,7 @@ export interface GetMatchingWorkflowOutput {
|
|
|
671
747
|
*/
|
|
672
748
|
export interface GetSchemaMappingInput {
|
|
673
749
|
/**
|
|
750
|
+
* @public
|
|
674
751
|
* <p>The name of the schema to be retrieved.</p>
|
|
675
752
|
*/
|
|
676
753
|
schemaName: string | undefined;
|
|
@@ -680,32 +757,39 @@ export interface GetSchemaMappingInput {
|
|
|
680
757
|
*/
|
|
681
758
|
export interface GetSchemaMappingOutput {
|
|
682
759
|
/**
|
|
760
|
+
* @public
|
|
683
761
|
* <p>The name of the schema.</p>
|
|
684
762
|
*/
|
|
685
763
|
schemaName: string | undefined;
|
|
686
764
|
/**
|
|
765
|
+
* @public
|
|
687
766
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.</p>
|
|
688
767
|
*/
|
|
689
768
|
schemaArn: string | undefined;
|
|
690
769
|
/**
|
|
770
|
+
* @public
|
|
691
771
|
* <p>A description of the schema.</p>
|
|
692
772
|
*/
|
|
693
773
|
description?: string;
|
|
694
774
|
/**
|
|
775
|
+
* @public
|
|
695
776
|
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
696
777
|
* to a column the source data table, and contains column name plus additional information
|
|
697
778
|
* Venice uses for matching.</p>
|
|
698
779
|
*/
|
|
699
780
|
mappedInputFields: SchemaInputAttribute[] | undefined;
|
|
700
781
|
/**
|
|
782
|
+
* @public
|
|
701
783
|
* <p>The timestamp of when the <code>SchemaMapping</code> was created.</p>
|
|
702
784
|
*/
|
|
703
785
|
createdAt: Date | undefined;
|
|
704
786
|
/**
|
|
787
|
+
* @public
|
|
705
788
|
* <p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>
|
|
706
789
|
*/
|
|
707
790
|
updatedAt: Date | undefined;
|
|
708
791
|
/**
|
|
792
|
+
* @public
|
|
709
793
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
710
794
|
*/
|
|
711
795
|
tags?: Record<string, string>;
|
|
@@ -715,14 +799,17 @@ export interface GetSchemaMappingOutput {
|
|
|
715
799
|
*/
|
|
716
800
|
export interface ListMatchingJobsInput {
|
|
717
801
|
/**
|
|
802
|
+
* @public
|
|
718
803
|
* <p>The name of the workflow to be retrieved.</p>
|
|
719
804
|
*/
|
|
720
805
|
workflowName: string | undefined;
|
|
721
806
|
/**
|
|
807
|
+
* @public
|
|
722
808
|
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
723
809
|
*/
|
|
724
810
|
nextToken?: string;
|
|
725
811
|
/**
|
|
812
|
+
* @public
|
|
726
813
|
* <p>The maximum number of objects returned per page.</p>
|
|
727
814
|
*/
|
|
728
815
|
maxResults?: number;
|
|
@@ -734,19 +821,23 @@ export interface ListMatchingJobsInput {
|
|
|
734
821
|
*/
|
|
735
822
|
export interface JobSummary {
|
|
736
823
|
/**
|
|
824
|
+
* @public
|
|
737
825
|
* <p>The ID of the job.</p>
|
|
738
826
|
*/
|
|
739
827
|
jobId: string | undefined;
|
|
740
828
|
/**
|
|
829
|
+
* @public
|
|
741
830
|
* <p>The current status of the job. Either <code>running</code>, <code>succeeded</code>,
|
|
742
831
|
* <code>queued</code>, or <code>failed</code>.</p>
|
|
743
832
|
*/
|
|
744
833
|
status: JobStatus | string | undefined;
|
|
745
834
|
/**
|
|
835
|
+
* @public
|
|
746
836
|
* <p>The time at which the job was started.</p>
|
|
747
837
|
*/
|
|
748
838
|
startTime: Date | undefined;
|
|
749
839
|
/**
|
|
840
|
+
* @public
|
|
750
841
|
* <p>The time at which the job has finished.</p>
|
|
751
842
|
*/
|
|
752
843
|
endTime?: Date;
|
|
@@ -756,10 +847,12 @@ export interface JobSummary {
|
|
|
756
847
|
*/
|
|
757
848
|
export interface ListMatchingJobsOutput {
|
|
758
849
|
/**
|
|
850
|
+
* @public
|
|
759
851
|
* <p>A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.</p>
|
|
760
852
|
*/
|
|
761
853
|
jobs?: JobSummary[];
|
|
762
854
|
/**
|
|
855
|
+
* @public
|
|
763
856
|
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
764
857
|
*/
|
|
765
858
|
nextToken?: string;
|
|
@@ -769,10 +862,12 @@ export interface ListMatchingJobsOutput {
|
|
|
769
862
|
*/
|
|
770
863
|
export interface ListMatchingWorkflowsInput {
|
|
771
864
|
/**
|
|
865
|
+
* @public
|
|
772
866
|
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
773
867
|
*/
|
|
774
868
|
nextToken?: string;
|
|
775
869
|
/**
|
|
870
|
+
* @public
|
|
776
871
|
* <p>The maximum number of objects returned per page.</p>
|
|
777
872
|
*/
|
|
778
873
|
maxResults?: number;
|
|
@@ -784,18 +879,22 @@ export interface ListMatchingWorkflowsInput {
|
|
|
784
879
|
*/
|
|
785
880
|
export interface MatchingWorkflowSummary {
|
|
786
881
|
/**
|
|
882
|
+
* @public
|
|
787
883
|
* <p>The name of the workflow.</p>
|
|
788
884
|
*/
|
|
789
885
|
workflowName: string | undefined;
|
|
790
886
|
/**
|
|
887
|
+
* @public
|
|
791
888
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
792
889
|
*/
|
|
793
890
|
workflowArn: string | undefined;
|
|
794
891
|
/**
|
|
892
|
+
* @public
|
|
795
893
|
* <p>The timestamp of when the workflow was created.</p>
|
|
796
894
|
*/
|
|
797
895
|
createdAt: Date | undefined;
|
|
798
896
|
/**
|
|
897
|
+
* @public
|
|
799
898
|
* <p>The timestamp of when the workflow was last updated.</p>
|
|
800
899
|
*/
|
|
801
900
|
updatedAt: Date | undefined;
|
|
@@ -805,11 +904,13 @@ export interface MatchingWorkflowSummary {
|
|
|
805
904
|
*/
|
|
806
905
|
export interface ListMatchingWorkflowsOutput {
|
|
807
906
|
/**
|
|
907
|
+
* @public
|
|
808
908
|
* <p>A list of <code>MatchingWorkflowSummary</code> objects, each of which contain the fields
|
|
809
909
|
* <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, and <code>UpdatedAt</code>.</p>
|
|
810
910
|
*/
|
|
811
911
|
workflowSummaries?: MatchingWorkflowSummary[];
|
|
812
912
|
/**
|
|
913
|
+
* @public
|
|
813
914
|
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
814
915
|
*/
|
|
815
916
|
nextToken?: string;
|
|
@@ -819,10 +920,12 @@ export interface ListMatchingWorkflowsOutput {
|
|
|
819
920
|
*/
|
|
820
921
|
export interface ListSchemaMappingsInput {
|
|
821
922
|
/**
|
|
923
|
+
* @public
|
|
822
924
|
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
823
925
|
*/
|
|
824
926
|
nextToken?: string;
|
|
825
927
|
/**
|
|
928
|
+
* @public
|
|
826
929
|
* <p>The maximum number of objects returned per page.</p>
|
|
827
930
|
*/
|
|
828
931
|
maxResults?: number;
|
|
@@ -834,19 +937,23 @@ export interface ListSchemaMappingsInput {
|
|
|
834
937
|
*/
|
|
835
938
|
export interface SchemaMappingSummary {
|
|
836
939
|
/**
|
|
940
|
+
* @public
|
|
837
941
|
* <p>The name of the schema.</p>
|
|
838
942
|
*/
|
|
839
943
|
schemaName: string | undefined;
|
|
840
944
|
/**
|
|
945
|
+
* @public
|
|
841
946
|
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the
|
|
842
947
|
* <code>SchemaMapping</code>.</p>
|
|
843
948
|
*/
|
|
844
949
|
schemaArn: string | undefined;
|
|
845
950
|
/**
|
|
951
|
+
* @public
|
|
846
952
|
* <p>The timestamp of when the <code>SchemaMapping</code> was created.</p>
|
|
847
953
|
*/
|
|
848
954
|
createdAt: Date | undefined;
|
|
849
955
|
/**
|
|
956
|
+
* @public
|
|
850
957
|
* <p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>
|
|
851
958
|
*/
|
|
852
959
|
updatedAt: Date | undefined;
|
|
@@ -856,11 +963,13 @@ export interface SchemaMappingSummary {
|
|
|
856
963
|
*/
|
|
857
964
|
export interface ListSchemaMappingsOutput {
|
|
858
965
|
/**
|
|
966
|
+
* @public
|
|
859
967
|
* <p>A list of <code>SchemaMappingSummary</code> objects, each of which contain the fields
|
|
860
968
|
* <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.</p>
|
|
861
969
|
*/
|
|
862
970
|
schemaList?: SchemaMappingSummary[];
|
|
863
971
|
/**
|
|
972
|
+
* @public
|
|
864
973
|
* <p>The pagination token from the previous <code>ListDomains</code> API call.</p>
|
|
865
974
|
*/
|
|
866
975
|
nextToken?: string;
|
|
@@ -870,6 +979,7 @@ export interface ListSchemaMappingsOutput {
|
|
|
870
979
|
*/
|
|
871
980
|
export interface ListTagsForResourceInput {
|
|
872
981
|
/**
|
|
982
|
+
* @public
|
|
873
983
|
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
874
984
|
*/
|
|
875
985
|
resourceArn: string | undefined;
|
|
@@ -879,6 +989,7 @@ export interface ListTagsForResourceInput {
|
|
|
879
989
|
*/
|
|
880
990
|
export interface ListTagsForResourceOutput {
|
|
881
991
|
/**
|
|
992
|
+
* @public
|
|
882
993
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
883
994
|
*/
|
|
884
995
|
tags: Record<string, string> | undefined;
|
|
@@ -888,6 +999,7 @@ export interface ListTagsForResourceOutput {
|
|
|
888
999
|
*/
|
|
889
1000
|
export interface StartMatchingJobInput {
|
|
890
1001
|
/**
|
|
1002
|
+
* @public
|
|
891
1003
|
* <p>The name of the matching job to be retrieved.</p>
|
|
892
1004
|
*/
|
|
893
1005
|
workflowName: string | undefined;
|
|
@@ -897,6 +1009,7 @@ export interface StartMatchingJobInput {
|
|
|
897
1009
|
*/
|
|
898
1010
|
export interface StartMatchingJobOutput {
|
|
899
1011
|
/**
|
|
1012
|
+
* @public
|
|
900
1013
|
* <p>The ID of the job.</p>
|
|
901
1014
|
*/
|
|
902
1015
|
jobId: string | undefined;
|
|
@@ -906,10 +1019,12 @@ export interface StartMatchingJobOutput {
|
|
|
906
1019
|
*/
|
|
907
1020
|
export interface TagResourceInput {
|
|
908
1021
|
/**
|
|
1022
|
+
* @public
|
|
909
1023
|
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
910
1024
|
*/
|
|
911
1025
|
resourceArn: string | undefined;
|
|
912
1026
|
/**
|
|
1027
|
+
* @public
|
|
913
1028
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
914
1029
|
*/
|
|
915
1030
|
tags: Record<string, string> | undefined;
|
|
@@ -924,10 +1039,12 @@ export interface TagResourceOutput {
|
|
|
924
1039
|
*/
|
|
925
1040
|
export interface UntagResourceInput {
|
|
926
1041
|
/**
|
|
1042
|
+
* @public
|
|
927
1043
|
* <p>The ARN of the resource for which you want to untag.</p>
|
|
928
1044
|
*/
|
|
929
1045
|
resourceArn: string | undefined;
|
|
930
1046
|
/**
|
|
1047
|
+
* @public
|
|
931
1048
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
932
1049
|
*/
|
|
933
1050
|
tagKeys: string[] | undefined;
|
|
@@ -942,33 +1059,40 @@ export interface UntagResourceOutput {
|
|
|
942
1059
|
*/
|
|
943
1060
|
export interface UpdateMatchingWorkflowInput {
|
|
944
1061
|
/**
|
|
1062
|
+
* @public
|
|
945
1063
|
* <p>The name of the workflow to be retrieved.</p>
|
|
946
1064
|
*/
|
|
947
1065
|
workflowName: string | undefined;
|
|
948
1066
|
/**
|
|
1067
|
+
* @public
|
|
949
1068
|
* <p>A description of the workflow.</p>
|
|
950
1069
|
*/
|
|
951
1070
|
description?: string;
|
|
952
1071
|
/**
|
|
1072
|
+
* @public
|
|
953
1073
|
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
954
1074
|
* <code>SchemaName</code>.</p>
|
|
955
1075
|
*/
|
|
956
1076
|
inputSourceConfig: InputSource[] | undefined;
|
|
957
1077
|
/**
|
|
1078
|
+
* @public
|
|
958
1079
|
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
959
1080
|
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
960
1081
|
*/
|
|
961
1082
|
outputSourceConfig: OutputSource[] | undefined;
|
|
962
1083
|
/**
|
|
1084
|
+
* @public
|
|
963
1085
|
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
964
1086
|
* </p>
|
|
965
1087
|
*/
|
|
966
1088
|
resolutionTechniques: ResolutionTechniques | undefined;
|
|
967
1089
|
/**
|
|
1090
|
+
* @public
|
|
968
1091
|
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
969
1092
|
*/
|
|
970
1093
|
incrementalRunConfig?: IncrementalRunConfig;
|
|
971
1094
|
/**
|
|
1095
|
+
* @public
|
|
972
1096
|
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
973
1097
|
* to create resources on your behalf as part of workflow execution.</p>
|
|
974
1098
|
*/
|
|
@@ -979,33 +1103,40 @@ export interface UpdateMatchingWorkflowInput {
|
|
|
979
1103
|
*/
|
|
980
1104
|
export interface UpdateMatchingWorkflowOutput {
|
|
981
1105
|
/**
|
|
1106
|
+
* @public
|
|
982
1107
|
* <p>The name of the workflow.</p>
|
|
983
1108
|
*/
|
|
984
1109
|
workflowName: string | undefined;
|
|
985
1110
|
/**
|
|
1111
|
+
* @public
|
|
986
1112
|
* <p>A description of the workflow.</p>
|
|
987
1113
|
*/
|
|
988
1114
|
description?: string;
|
|
989
1115
|
/**
|
|
1116
|
+
* @public
|
|
990
1117
|
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
991
1118
|
* <code>SchemaName</code>.</p>
|
|
992
1119
|
*/
|
|
993
1120
|
inputSourceConfig: InputSource[] | undefined;
|
|
994
1121
|
/**
|
|
1122
|
+
* @public
|
|
995
1123
|
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
996
1124
|
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
997
1125
|
*/
|
|
998
1126
|
outputSourceConfig: OutputSource[] | undefined;
|
|
999
1127
|
/**
|
|
1128
|
+
* @public
|
|
1000
1129
|
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
1001
1130
|
* </p>
|
|
1002
1131
|
*/
|
|
1003
1132
|
resolutionTechniques: ResolutionTechniques | undefined;
|
|
1004
1133
|
/**
|
|
1134
|
+
* @public
|
|
1005
1135
|
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
1006
1136
|
*/
|
|
1007
1137
|
incrementalRunConfig?: IncrementalRunConfig;
|
|
1008
1138
|
/**
|
|
1139
|
+
* @public
|
|
1009
1140
|
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
1010
1141
|
* to create resources on your behalf as part of workflow execution.</p>
|
|
1011
1142
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-entityresolution",
|
|
3
3
|
"description": "AWS SDK for JavaScript Entityresolution Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.385.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|