@aws-sdk/client-entityresolution 3.614.0 → 3.618.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-cjs/index.js +34 -10
- package/dist-es/EntityResolutionClient.js +5 -5
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/protocols/Aws_restJson1.js +5 -0
- package/dist-types/EntityResolutionClient.d.ts +2 -2
- package/dist-types/commands/AddPolicyStatementCommand.d.ts +6 -15
- package/dist-types/commands/BatchDeleteUniqueIdCommand.d.ts +3 -7
- package/dist-types/commands/CreateIdMappingWorkflowCommand.d.ts +36 -19
- package/dist-types/commands/CreateIdNamespaceCommand.d.ts +42 -17
- package/dist-types/commands/CreateMatchingWorkflowCommand.d.ts +8 -15
- package/dist-types/commands/CreateSchemaMappingCommand.d.ts +8 -15
- package/dist-types/commands/DeleteIdMappingWorkflowCommand.d.ts +5 -13
- package/dist-types/commands/DeleteIdNamespaceCommand.d.ts +4 -11
- package/dist-types/commands/DeleteMatchingWorkflowCommand.d.ts +5 -13
- package/dist-types/commands/DeletePolicyStatementCommand.d.ts +6 -15
- package/dist-types/commands/DeleteSchemaMappingCommand.d.ts +5 -13
- package/dist-types/commands/GetIdMappingJobCommand.d.ts +8 -13
- package/dist-types/commands/GetIdMappingWorkflowCommand.d.ts +20 -15
- package/dist-types/commands/GetIdNamespaceCommand.d.ts +23 -14
- package/dist-types/commands/GetMatchIdCommand.d.ts +5 -13
- package/dist-types/commands/GetMatchingJobCommand.d.ts +5 -13
- package/dist-types/commands/GetMatchingWorkflowCommand.d.ts +6 -13
- package/dist-types/commands/GetPolicyCommand.d.ts +5 -13
- package/dist-types/commands/GetProviderServiceCommand.d.ts +5 -13
- package/dist-types/commands/GetSchemaMappingCommand.d.ts +6 -13
- package/dist-types/commands/ListIdMappingJobsCommand.d.ts +5 -13
- package/dist-types/commands/ListIdMappingWorkflowsCommand.d.ts +4 -11
- package/dist-types/commands/ListIdNamespacesCommand.d.ts +9 -11
- package/dist-types/commands/ListMatchingJobsCommand.d.ts +5 -13
- package/dist-types/commands/ListMatchingWorkflowsCommand.d.ts +4 -11
- package/dist-types/commands/ListProviderServicesCommand.d.ts +4 -11
- package/dist-types/commands/ListSchemaMappingsCommand.d.ts +4 -11
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -7
- package/dist-types/commands/PutPolicyCommand.d.ts +6 -15
- package/dist-types/commands/StartIdMappingJobCommand.d.ts +7 -17
- package/dist-types/commands/StartMatchingJobCommand.d.ts +7 -17
- package/dist-types/commands/TagResourceCommand.d.ts +3 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateIdMappingWorkflowCommand.d.ts +35 -17
- package/dist-types/commands/UpdateIdNamespaceCommand.d.ts +41 -15
- package/dist-types/commands/UpdateMatchingWorkflowCommand.d.ts +7 -13
- package/dist-types/commands/UpdateSchemaMappingCommand.d.ts +8 -15
- package/dist-types/models/models_0.d.ts +265 -77
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/EntityResolutionClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +50 -9
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +17 -17
|
@@ -48,6 +48,7 @@ declare const UpdateSchemaMappingCommand_base: {
|
|
|
48
48
|
* groupName: "STRING_VALUE",
|
|
49
49
|
* matchKey: "STRING_VALUE",
|
|
50
50
|
* subType: "STRING_VALUE",
|
|
51
|
+
* hashed: true || false,
|
|
51
52
|
* },
|
|
52
53
|
* ],
|
|
53
54
|
* };
|
|
@@ -64,6 +65,7 @@ declare const UpdateSchemaMappingCommand_base: {
|
|
|
64
65
|
* // groupName: "STRING_VALUE",
|
|
65
66
|
* // matchKey: "STRING_VALUE",
|
|
66
67
|
* // subType: "STRING_VALUE",
|
|
68
|
+
* // hashed: true || false,
|
|
67
69
|
* // },
|
|
68
70
|
* // ],
|
|
69
71
|
* // };
|
|
@@ -77,34 +79,25 @@ declare const UpdateSchemaMappingCommand_base: {
|
|
|
77
79
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
78
80
|
*
|
|
79
81
|
* @throws {@link AccessDeniedException} (client fault)
|
|
80
|
-
* <p>You do not have sufficient access to perform this action.
|
|
81
|
-
* 403</code>
|
|
82
|
-
* </p>
|
|
82
|
+
* <p>You do not have sufficient access to perform this action. </p>
|
|
83
83
|
*
|
|
84
84
|
* @throws {@link ConflictException} (client fault)
|
|
85
85
|
* <p>The request could not be processed because of conflict in the current state of the
|
|
86
86
|
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
|
|
87
|
-
* running, etc.
|
|
88
|
-
* </p>
|
|
87
|
+
* running, etc. </p>
|
|
89
88
|
*
|
|
90
89
|
* @throws {@link InternalServerException} (server fault)
|
|
91
90
|
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
92
|
-
* service.
|
|
93
|
-
* </p>
|
|
91
|
+
* service. </p>
|
|
94
92
|
*
|
|
95
93
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
96
|
-
* <p>The resource could not be found.
|
|
97
|
-
* </p>
|
|
94
|
+
* <p>The resource could not be found. </p>
|
|
98
95
|
*
|
|
99
96
|
* @throws {@link ThrottlingException} (client fault)
|
|
100
|
-
* <p>The request was denied due to request throttling.
|
|
101
|
-
* 429</code>
|
|
102
|
-
* </p>
|
|
97
|
+
* <p>The request was denied due to request throttling. </p>
|
|
103
98
|
*
|
|
104
99
|
* @throws {@link ValidationException} (client fault)
|
|
105
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution.
|
|
106
|
-
* Status Code: 400</code>
|
|
107
|
-
* </p>
|
|
100
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
|
|
108
101
|
*
|
|
109
102
|
* @throws {@link EntityResolutionServiceException}
|
|
110
103
|
* <p>Base exception class for all service exceptions from EntityResolution service.</p>
|
|
@@ -2,9 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
|
|
|
2
2
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
3
|
import { EntityResolutionServiceException as __BaseException } from "./EntityResolutionServiceException";
|
|
4
4
|
/**
|
|
5
|
-
* <p>You do not have sufficient access to perform this action.
|
|
6
|
-
* 403</code>
|
|
7
|
-
* </p>
|
|
5
|
+
* <p>You do not have sufficient access to perform this action. </p>
|
|
8
6
|
* @public
|
|
9
7
|
*/
|
|
10
8
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -46,6 +44,12 @@ export interface AddPolicyStatementInput {
|
|
|
46
44
|
/**
|
|
47
45
|
* <p>Determines whether the permissions specified in the policy are to be allowed
|
|
48
46
|
* (<code>Allow</code>) or denied (<code>Deny</code>).</p>
|
|
47
|
+
* <important>
|
|
48
|
+
* <p> If you set the value of the <code>effect</code> parameter to <code>Deny</code> for
|
|
49
|
+
* the <code>AddPolicyStatement</code> operation, you must also set the value of the
|
|
50
|
+
* <code>effect</code> parameter in the <code>policy</code> to <code>Deny</code> for the
|
|
51
|
+
* <code>PutPolicy</code> operation.</p>
|
|
52
|
+
* </important>
|
|
49
53
|
* @public
|
|
50
54
|
*/
|
|
51
55
|
effect: StatementEffect | undefined;
|
|
@@ -92,8 +96,7 @@ export interface AddPolicyStatementOutput {
|
|
|
92
96
|
/**
|
|
93
97
|
* <p>The request could not be processed because of conflict in the current state of the
|
|
94
98
|
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
|
|
95
|
-
* running, etc.
|
|
96
|
-
* </p>
|
|
99
|
+
* running, etc. </p>
|
|
97
100
|
* @public
|
|
98
101
|
*/
|
|
99
102
|
export declare class ConflictException extends __BaseException {
|
|
@@ -106,8 +109,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
106
109
|
}
|
|
107
110
|
/**
|
|
108
111
|
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
109
|
-
* service.
|
|
110
|
-
* </p>
|
|
112
|
+
* service. </p>
|
|
111
113
|
* @public
|
|
112
114
|
*/
|
|
113
115
|
export declare class InternalServerException extends __BaseException {
|
|
@@ -120,8 +122,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
120
122
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
121
123
|
}
|
|
122
124
|
/**
|
|
123
|
-
* <p>The resource could not be found.
|
|
124
|
-
* </p>
|
|
125
|
+
* <p>The resource could not be found. </p>
|
|
125
126
|
* @public
|
|
126
127
|
*/
|
|
127
128
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
@@ -133,9 +134,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
133
134
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
134
135
|
}
|
|
135
136
|
/**
|
|
136
|
-
* <p>The request was denied due to request throttling.
|
|
137
|
-
* 429</code>
|
|
138
|
-
* </p>
|
|
137
|
+
* <p>The request was denied due to request throttling. </p>
|
|
139
138
|
* @public
|
|
140
139
|
*/
|
|
141
140
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -150,9 +149,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
150
149
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
151
150
|
}
|
|
152
151
|
/**
|
|
153
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution.
|
|
154
|
-
* Status Code: 400</code>
|
|
155
|
-
* </p>
|
|
152
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. </p>
|
|
156
153
|
* @public
|
|
157
154
|
*/
|
|
158
155
|
export declare class ValidationException extends __BaseException {
|
|
@@ -277,6 +274,7 @@ export interface BatchDeleteUniqueIdOutput {
|
|
|
277
274
|
*/
|
|
278
275
|
export declare const IdMappingType: {
|
|
279
276
|
readonly PROVIDER: "PROVIDER";
|
|
277
|
+
readonly RULE_BASED: "RULE_BASED";
|
|
280
278
|
};
|
|
281
279
|
/**
|
|
282
280
|
* @public
|
|
@@ -321,7 +319,91 @@ export interface ProviderProperties {
|
|
|
321
319
|
intermediateSourceConfiguration?: IntermediateSourceConfiguration;
|
|
322
320
|
}
|
|
323
321
|
/**
|
|
324
|
-
*
|
|
322
|
+
* @public
|
|
323
|
+
* @enum
|
|
324
|
+
*/
|
|
325
|
+
export declare const RecordMatchingModel: {
|
|
326
|
+
readonly MANY_SOURCE_TO_ONE_TARGET: "MANY_SOURCE_TO_ONE_TARGET";
|
|
327
|
+
readonly ONE_SOURCE_TO_ONE_TARGET: "ONE_SOURCE_TO_ONE_TARGET";
|
|
328
|
+
};
|
|
329
|
+
/**
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
export type RecordMatchingModel = (typeof RecordMatchingModel)[keyof typeof RecordMatchingModel];
|
|
333
|
+
/**
|
|
334
|
+
* @public
|
|
335
|
+
* @enum
|
|
336
|
+
*/
|
|
337
|
+
export declare const IdMappingWorkflowRuleDefinitionType: {
|
|
338
|
+
readonly SOURCE: "SOURCE";
|
|
339
|
+
readonly TARGET: "TARGET";
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export type IdMappingWorkflowRuleDefinitionType = (typeof IdMappingWorkflowRuleDefinitionType)[keyof typeof IdMappingWorkflowRuleDefinitionType];
|
|
345
|
+
/**
|
|
346
|
+
* <p>An object containing <code>RuleName</code>, and <code>MatchingKeys</code>.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
export interface Rule {
|
|
350
|
+
/**
|
|
351
|
+
* <p>A name for the matching rule.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
ruleName: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been
|
|
357
|
+
* defined in the <code>SchemaMapping</code>. Two records are considered to match according to
|
|
358
|
+
* this rule if all of the <code>MatchingKeys</code> match.</p>
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
matchingKeys: string[] | undefined;
|
|
362
|
+
}
|
|
363
|
+
/**
|
|
364
|
+
* <p> An object that defines the list of matching rules to run in an ID mapping
|
|
365
|
+
* workflow.</p>
|
|
366
|
+
* @public
|
|
367
|
+
*/
|
|
368
|
+
export interface IdMappingRuleBasedProperties {
|
|
369
|
+
/**
|
|
370
|
+
* <p> The rules that can be used for ID mapping.</p>
|
|
371
|
+
* @public
|
|
372
|
+
*/
|
|
373
|
+
rules?: Rule[];
|
|
374
|
+
/**
|
|
375
|
+
* <p> The set of rules you can use in an ID mapping workflow. The limitations specified for
|
|
376
|
+
* the source or target to define the match rules must be compatible.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
ruleDefinitionType: IdMappingWorkflowRuleDefinitionType | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The comparison type. You can either choose <code>ONE_TO_ONE</code> or
|
|
382
|
+
* <code>MANY_TO_MANY</code> as the <code>attributeMatchingModel</code>. </p>
|
|
383
|
+
* <p>If you choose <code>MANY_TO_MANY</code>, the system can match attributes across the
|
|
384
|
+
* sub-types of an attribute type. For example, if the value of the <code>Email</code> field
|
|
385
|
+
* of Profile A matches the value of the <code>BusinessEmail</code> field of Profile B, the
|
|
386
|
+
* two profiles are matched on the <code>Email</code> attribute type. </p>
|
|
387
|
+
* <p>If you choose <code>ONE_TO_ONE</code>, the system can only match attributes if the
|
|
388
|
+
* sub-types are an exact match. For example, for the <code>Email</code> attribute type, the
|
|
389
|
+
* system will only consider it a match if the value of the <code>Email</code> field of
|
|
390
|
+
* Profile A matches the value of the <code>Email</code> field of Profile B.</p>
|
|
391
|
+
* @public
|
|
392
|
+
*/
|
|
393
|
+
attributeMatchingModel: AttributeMatchingModel | undefined;
|
|
394
|
+
/**
|
|
395
|
+
* <p> The type of matching record that is allowed to be used in an ID mapping workflow. </p>
|
|
396
|
+
* <p>If the value is set to <code>ONE_SOURCE_TO_ONE_TARGET</code>, only one record in the
|
|
397
|
+
* source can be matched to the same record in the target.</p>
|
|
398
|
+
* <p>If the value is set to <code>MANY_SOURCE_TO_ONE_TARGET</code>, multiple records in the
|
|
399
|
+
* source can be matched to one record in the target.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
recordMatchingModel: RecordMatchingModel | undefined;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
406
|
+
* configurations.</p>
|
|
325
407
|
* @public
|
|
326
408
|
*/
|
|
327
409
|
export interface IdMappingTechniques {
|
|
@@ -330,6 +412,12 @@ export interface IdMappingTechniques {
|
|
|
330
412
|
* @public
|
|
331
413
|
*/
|
|
332
414
|
idMappingType: IdMappingType | undefined;
|
|
415
|
+
/**
|
|
416
|
+
* <p> An object which defines any additional configurations required by rule-based
|
|
417
|
+
* matching.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
ruleBasedProperties?: IdMappingRuleBasedProperties;
|
|
333
421
|
/**
|
|
334
422
|
* <p>An object which defines any additional configurations required by the provider
|
|
335
423
|
* service.</p>
|
|
@@ -356,7 +444,8 @@ export type IdNamespaceType = (typeof IdNamespaceType)[keyof typeof IdNamespaceT
|
|
|
356
444
|
*/
|
|
357
445
|
export interface IdMappingWorkflowInputSource {
|
|
358
446
|
/**
|
|
359
|
-
* <p>An Glue table ARN
|
|
447
|
+
* <p>An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for
|
|
448
|
+
* the input source table.</p>
|
|
360
449
|
* @public
|
|
361
450
|
*/
|
|
362
451
|
inputSourceARN: string | undefined;
|
|
@@ -370,7 +459,7 @@ export interface IdMappingWorkflowInputSource {
|
|
|
370
459
|
* <code>TARGET</code>. </p>
|
|
371
460
|
* <p>The <code>SOURCE</code> contains configurations for <code>sourceId</code> data that will
|
|
372
461
|
* be processed in an ID mapping workflow. </p>
|
|
373
|
-
* <p>The <code>TARGET</code> contains a configuration of <code>targetId</code>
|
|
462
|
+
* <p>The <code>TARGET</code> contains a configuration of <code>targetId</code> which all
|
|
374
463
|
* <code>sourceIds</code> will resolve to.</p>
|
|
375
464
|
* @public
|
|
376
465
|
*/
|
|
@@ -421,8 +510,8 @@ export interface CreateIdMappingWorkflowInput {
|
|
|
421
510
|
*/
|
|
422
511
|
outputSourceConfig?: IdMappingWorkflowOutputSource[];
|
|
423
512
|
/**
|
|
424
|
-
* <p>An object which defines the
|
|
425
|
-
*
|
|
513
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
514
|
+
* configurations.</p>
|
|
426
515
|
* @public
|
|
427
516
|
*/
|
|
428
517
|
idMappingTechniques: IdMappingTechniques | undefined;
|
|
@@ -431,7 +520,7 @@ export interface CreateIdMappingWorkflowInput {
|
|
|
431
520
|
* this role to create resources on your behalf as part of workflow execution.</p>
|
|
432
521
|
* @public
|
|
433
522
|
*/
|
|
434
|
-
roleArn
|
|
523
|
+
roleArn?: string;
|
|
435
524
|
/**
|
|
436
525
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
437
526
|
* @public
|
|
@@ -471,8 +560,8 @@ export interface CreateIdMappingWorkflowOutput {
|
|
|
471
560
|
*/
|
|
472
561
|
outputSourceConfig?: IdMappingWorkflowOutputSource[];
|
|
473
562
|
/**
|
|
474
|
-
* <p>An object which defines the
|
|
475
|
-
*
|
|
563
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
564
|
+
* configurations.</p>
|
|
476
565
|
* @public
|
|
477
566
|
*/
|
|
478
567
|
idMappingTechniques: IdMappingTechniques | undefined;
|
|
@@ -481,13 +570,12 @@ export interface CreateIdMappingWorkflowOutput {
|
|
|
481
570
|
* this role to create resources on your behalf as part of workflow execution.</p>
|
|
482
571
|
* @public
|
|
483
572
|
*/
|
|
484
|
-
roleArn
|
|
573
|
+
roleArn?: string;
|
|
485
574
|
}
|
|
486
575
|
/**
|
|
487
576
|
* <p>The request was rejected because it attempted to create resources beyond the current
|
|
488
577
|
* Entity Resolution account limits. The error message describes the limit exceeded.
|
|
489
|
-
*
|
|
490
|
-
* </p>
|
|
578
|
+
* </p>
|
|
491
579
|
* @public
|
|
492
580
|
*/
|
|
493
581
|
export declare class ExceedsLimitException extends __BaseException {
|
|
@@ -527,8 +615,49 @@ export interface NamespaceProviderProperties {
|
|
|
527
615
|
providerConfiguration?: __DocumentType;
|
|
528
616
|
}
|
|
529
617
|
/**
|
|
530
|
-
* <p>
|
|
531
|
-
*
|
|
618
|
+
* <p> The rule-based properties of an ID namespace. These properties define how the ID
|
|
619
|
+
* namespace can be used in an ID mapping workflow.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
export interface NamespaceRuleBasedProperties {
|
|
623
|
+
/**
|
|
624
|
+
* <p> The rules for the ID namespace.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
rules?: Rule[];
|
|
628
|
+
/**
|
|
629
|
+
* <p> The sets of rules you can use in an ID mapping workflow. The limitations specified for
|
|
630
|
+
* the source and target must be compatible.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
ruleDefinitionTypes?: IdMappingWorkflowRuleDefinitionType[];
|
|
634
|
+
/**
|
|
635
|
+
* <p>The comparison type. You can either choose <code>ONE_TO_ONE</code> or
|
|
636
|
+
* <code>MANY_TO_MANY</code> as the <code>attributeMatchingModel</code>. </p>
|
|
637
|
+
* <p>If you choose <code>MANY_TO_MANY</code>, the system can match attributes across the
|
|
638
|
+
* sub-types of an attribute type. For example, if the value of the <code>Email</code> field
|
|
639
|
+
* of Profile A matches the value of <code>BusinessEmail</code> field of Profile B, the two
|
|
640
|
+
* profiles are matched on the <code>Email</code> attribute type. </p>
|
|
641
|
+
* <p>If you choose <code>ONE_TO_ONE</code>, the system can only match attributes if the
|
|
642
|
+
* sub-types are an exact match. For example, for the <code>Email</code> attribute type, the
|
|
643
|
+
* system will only consider it a match if the value of the <code>Email</code> field of
|
|
644
|
+
* Profile A matches the value of the <code>Email</code> field of Profile B.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
attributeMatchingModel?: AttributeMatchingModel;
|
|
648
|
+
/**
|
|
649
|
+
* <p> The type of matching record that is allowed to be used in an ID mapping workflow. </p>
|
|
650
|
+
* <p>If the value is set to <code>ONE_SOURCE_TO_ONE_TARGET</code>, only one record in the
|
|
651
|
+
* source is matched to one record in the target. </p>
|
|
652
|
+
* <p>If the value is set to <code>MANY_SOURCE_TO_ONE_TARGET</code>, all matching records in
|
|
653
|
+
* the source are matched to one record in the target.</p>
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
recordMatchingModels?: RecordMatchingModel[];
|
|
657
|
+
}
|
|
658
|
+
/**
|
|
659
|
+
* <p>An object containing <code>IdMappingType</code>, <code>ProviderProperties</code>, and
|
|
660
|
+
* <code>RuleBasedProperties</code>.</p>
|
|
532
661
|
* @public
|
|
533
662
|
*/
|
|
534
663
|
export interface IdNamespaceIdMappingWorkflowProperties {
|
|
@@ -537,6 +666,12 @@ export interface IdNamespaceIdMappingWorkflowProperties {
|
|
|
537
666
|
* @public
|
|
538
667
|
*/
|
|
539
668
|
idMappingType: IdMappingType | undefined;
|
|
669
|
+
/**
|
|
670
|
+
* <p> An object which defines any additional configurations required by rule-based
|
|
671
|
+
* matching.</p>
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
ruleBasedProperties?: NamespaceRuleBasedProperties;
|
|
540
675
|
/**
|
|
541
676
|
* <p>An object which defines any additional configurations required by the provider
|
|
542
677
|
* service.</p>
|
|
@@ -550,7 +685,8 @@ export interface IdNamespaceIdMappingWorkflowProperties {
|
|
|
550
685
|
*/
|
|
551
686
|
export interface IdNamespaceInputSource {
|
|
552
687
|
/**
|
|
553
|
-
* <p>An Glue table ARN
|
|
688
|
+
* <p>An Glue table Amazon Resource Name (ARN) or a matching workflow ARN for
|
|
689
|
+
* the input source table.</p>
|
|
554
690
|
* @public
|
|
555
691
|
*/
|
|
556
692
|
inputSourceARN: string | undefined;
|
|
@@ -705,7 +841,8 @@ export interface IncrementalRunConfig {
|
|
|
705
841
|
*/
|
|
706
842
|
export interface InputSource {
|
|
707
843
|
/**
|
|
708
|
-
* <p>An Glue table ARN for the input source
|
|
844
|
+
* <p>An Glue table Amazon Resource Name (ARN) for the input source
|
|
845
|
+
* table.</p>
|
|
709
846
|
* @public
|
|
710
847
|
*/
|
|
711
848
|
inputSourceARN: string | undefined;
|
|
@@ -789,26 +926,21 @@ export declare const ResolutionType: {
|
|
|
789
926
|
*/
|
|
790
927
|
export type ResolutionType = (typeof ResolutionType)[keyof typeof ResolutionType];
|
|
791
928
|
/**
|
|
792
|
-
* <p>An object containing <code>RuleName</code>, and <code>MatchingKeys</code>.</p>
|
|
793
929
|
* @public
|
|
930
|
+
* @enum
|
|
794
931
|
*/
|
|
795
|
-
export
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
* defined in the <code>SchemaMapping</code>. Two records are considered to match according to
|
|
804
|
-
* this rule if all of the <code>MatchingKeys</code> match.</p>
|
|
805
|
-
* @public
|
|
806
|
-
*/
|
|
807
|
-
matchingKeys: string[] | undefined;
|
|
808
|
-
}
|
|
932
|
+
export declare const MatchPurpose: {
|
|
933
|
+
readonly IDENTIFIER_GENERATION: "IDENTIFIER_GENERATION";
|
|
934
|
+
readonly INDEXING: "INDEXING";
|
|
935
|
+
};
|
|
936
|
+
/**
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
export type MatchPurpose = (typeof MatchPurpose)[keyof typeof MatchPurpose];
|
|
809
940
|
/**
|
|
810
|
-
* <p>An object which defines the list of matching rules to run
|
|
811
|
-
*
|
|
941
|
+
* <p>An object which defines the list of matching rules to run in a matching workflow.
|
|
942
|
+
* RuleBasedProperties contain a <code>Rules</code> field, which is a list of rule
|
|
943
|
+
* objects.</p>
|
|
812
944
|
* @public
|
|
813
945
|
*/
|
|
814
946
|
export interface RuleBasedProperties {
|
|
@@ -820,17 +952,27 @@ export interface RuleBasedProperties {
|
|
|
820
952
|
rules: Rule[] | undefined;
|
|
821
953
|
/**
|
|
822
954
|
* <p>The comparison type. You can either choose <code>ONE_TO_ONE</code> or
|
|
823
|
-
* <code>MANY_TO_MANY</code> as the
|
|
824
|
-
*
|
|
825
|
-
* attribute type. For example, if the value of the <code>Email</code> field
|
|
826
|
-
* the value of <code>BusinessEmail</code> field of Profile B matches, the
|
|
827
|
-
* matched on the <code>Email</code> type.
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
955
|
+
* <code>MANY_TO_MANY</code> as the <code>attributeMatchingModel</code>. </p>
|
|
956
|
+
* <p>If you choose <code>MANY_TO_MANY</code>, the system can match attributes across the
|
|
957
|
+
* sub-types of an attribute type. For example, if the value of the <code>Email</code> field
|
|
958
|
+
* of Profile A and the value of <code>BusinessEmail</code> field of Profile B matches, the
|
|
959
|
+
* two profiles are matched on the <code>Email</code> attribute type. </p>
|
|
960
|
+
* <p>If you choose <code>ONE_TO_ONE</code>, the system can only match attributes if the
|
|
961
|
+
* sub-types are an exact match. For example, for the <code>Email</code> attribute type, the
|
|
962
|
+
* system will only consider it a match if the value of the <code>Email</code> field of
|
|
963
|
+
* Profile A matches the value of the <code>Email</code> field of Profile B.</p>
|
|
831
964
|
* @public
|
|
832
965
|
*/
|
|
833
966
|
attributeMatchingModel: AttributeMatchingModel | undefined;
|
|
967
|
+
/**
|
|
968
|
+
* <p> An indicator of whether to generate IDs and index the data or not.</p>
|
|
969
|
+
* <p>If you choose <code>IDENTIFIER_GENERATION</code>, the process generates IDs and indexes
|
|
970
|
+
* the data.</p>
|
|
971
|
+
* <p>If you choose <code>INDEXING</code>, the process indexes the data without generating
|
|
972
|
+
* IDs.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
matchPurpose?: MatchPurpose;
|
|
834
976
|
}
|
|
835
977
|
/**
|
|
836
978
|
* <p>An object which defines the <code>resolutionType</code> and the
|
|
@@ -992,7 +1134,7 @@ export declare const SchemaAttributeType: {
|
|
|
992
1134
|
export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
|
|
993
1135
|
/**
|
|
994
1136
|
* <p>An object containing <code>FieldName</code>, <code>Type</code>, <code>GroupName</code>,
|
|
995
|
-
*
|
|
1137
|
+
* <code>MatchKey</code>, <code>Hashing</code>, and <code>SubType</code>.</p>
|
|
996
1138
|
* @public
|
|
997
1139
|
*/
|
|
998
1140
|
export interface SchemaInputAttribute {
|
|
@@ -1017,12 +1159,12 @@ export interface SchemaInputAttribute {
|
|
|
1017
1159
|
*/
|
|
1018
1160
|
groupName?: string;
|
|
1019
1161
|
/**
|
|
1020
|
-
* <p>A key that allows grouping of multiple input attributes into a unified matching group.
|
|
1021
|
-
* For example, consider a scenario where the source table contains various addresses, such
|
|
1022
|
-
*
|
|
1023
|
-
* <code>matchKey</code>
|
|
1024
|
-
* will match records across these fields to create a consolidated matching group
|
|
1025
|
-
*
|
|
1162
|
+
* <p>A key that allows grouping of multiple input attributes into a unified matching group. </p>
|
|
1163
|
+
* <p>For example, consider a scenario where the source table contains various addresses, such
|
|
1164
|
+
* as <code>business_address</code> and <code>shipping_address</code>. By assigning a
|
|
1165
|
+
* <code>matchKey</code> called <code>address</code> to both attributes, Entity Resolution
|
|
1166
|
+
* will match records across these fields to create a consolidated matching group.</p>
|
|
1167
|
+
* <p>If no <code>matchKey</code> is specified for a column, it won't be utilized for matching
|
|
1026
1168
|
* purposes but will still be included in the output table.</p>
|
|
1027
1169
|
* @public
|
|
1028
1170
|
*/
|
|
@@ -1032,6 +1174,13 @@ export interface SchemaInputAttribute {
|
|
|
1032
1174
|
* @public
|
|
1033
1175
|
*/
|
|
1034
1176
|
subType?: string;
|
|
1177
|
+
/**
|
|
1178
|
+
* <p> Indicates if the column values are hashed in the schema input. If the value is set to
|
|
1179
|
+
* <code>TRUE</code>, the column values are hashed. If the value is set to
|
|
1180
|
+
* <code>FALSE</code>, the column values are cleartext.</p>
|
|
1181
|
+
* @public
|
|
1182
|
+
*/
|
|
1183
|
+
hashed?: boolean;
|
|
1035
1184
|
}
|
|
1036
1185
|
/**
|
|
1037
1186
|
* @public
|
|
@@ -1232,18 +1381,19 @@ export interface ErrorDetails {
|
|
|
1232
1381
|
errorMessage?: string;
|
|
1233
1382
|
}
|
|
1234
1383
|
/**
|
|
1235
|
-
* <p>An object containing <code>InputRecords</code>, <code>
|
|
1236
|
-
* <code>
|
|
1384
|
+
* <p>An object containing <code>InputRecords</code>, <code>RecordsNotProcessed</code>,
|
|
1385
|
+
* <code>TotalRecordsProcessed</code>, <code>TotalMappedRecords</code>,
|
|
1386
|
+
* <code>TotalMappedSourceRecords</code>, and <code>TotalMappedTargetRecords</code>.</p>
|
|
1237
1387
|
* @public
|
|
1238
1388
|
*/
|
|
1239
1389
|
export interface IdMappingJobMetrics {
|
|
1240
1390
|
/**
|
|
1241
|
-
* <p>The total number of input
|
|
1391
|
+
* <p>The total number of records that were input for processing.</p>
|
|
1242
1392
|
* @public
|
|
1243
1393
|
*/
|
|
1244
1394
|
inputRecords?: number;
|
|
1245
1395
|
/**
|
|
1246
|
-
* <p>The total number of records processed.</p>
|
|
1396
|
+
* <p>The total number of records that were processed.</p>
|
|
1247
1397
|
* @public
|
|
1248
1398
|
*/
|
|
1249
1399
|
totalRecordsProcessed?: number;
|
|
@@ -1252,6 +1402,21 @@ export interface IdMappingJobMetrics {
|
|
|
1252
1402
|
* @public
|
|
1253
1403
|
*/
|
|
1254
1404
|
recordsNotProcessed?: number;
|
|
1405
|
+
/**
|
|
1406
|
+
* <p> The total number of records that were mapped.</p>
|
|
1407
|
+
* @public
|
|
1408
|
+
*/
|
|
1409
|
+
totalMappedRecords?: number;
|
|
1410
|
+
/**
|
|
1411
|
+
* <p> The total number of mapped source records.</p>
|
|
1412
|
+
* @public
|
|
1413
|
+
*/
|
|
1414
|
+
totalMappedSourceRecords?: number;
|
|
1415
|
+
/**
|
|
1416
|
+
* <p> The total number of distinct mapped target records.</p>
|
|
1417
|
+
* @public
|
|
1418
|
+
*/
|
|
1419
|
+
totalMappedTargetRecords?: number;
|
|
1255
1420
|
}
|
|
1256
1421
|
/**
|
|
1257
1422
|
* <p>An object containing <code>KMSArn</code>, <code>OutputS3Path</code>, and
|
|
@@ -1376,8 +1541,8 @@ export interface GetIdMappingWorkflowOutput {
|
|
|
1376
1541
|
*/
|
|
1377
1542
|
outputSourceConfig?: IdMappingWorkflowOutputSource[];
|
|
1378
1543
|
/**
|
|
1379
|
-
* <p>An object which defines the
|
|
1380
|
-
*
|
|
1544
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
1545
|
+
* configurations.</p>
|
|
1381
1546
|
* @public
|
|
1382
1547
|
*/
|
|
1383
1548
|
idMappingTechniques: IdMappingTechniques | undefined;
|
|
@@ -1396,7 +1561,7 @@ export interface GetIdMappingWorkflowOutput {
|
|
|
1396
1561
|
* this role to access Amazon Web Services resources on your behalf.</p>
|
|
1397
1562
|
* @public
|
|
1398
1563
|
*/
|
|
1399
|
-
roleArn
|
|
1564
|
+
roleArn?: string;
|
|
1400
1565
|
/**
|
|
1401
1566
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1402
1567
|
* @public
|
|
@@ -1856,7 +2021,7 @@ export interface ProviderIdNameSpaceConfiguration {
|
|
|
1856
2021
|
*/
|
|
1857
2022
|
description?: string;
|
|
1858
2023
|
/**
|
|
1859
|
-
* <p>Configurations required for the target
|
|
2024
|
+
* <p>Configurations required for the target ID namespace.</p>
|
|
1860
2025
|
* @public
|
|
1861
2026
|
*/
|
|
1862
2027
|
providerTargetConfigurationDefinition?: __DocumentType;
|
|
@@ -2166,6 +2331,17 @@ export interface ListIdNamespacesInput {
|
|
|
2166
2331
|
*/
|
|
2167
2332
|
maxResults?: number;
|
|
2168
2333
|
}
|
|
2334
|
+
/**
|
|
2335
|
+
* <p>The settings for the ID namespace for the ID mapping workflow job.</p>
|
|
2336
|
+
* @public
|
|
2337
|
+
*/
|
|
2338
|
+
export interface IdNamespaceIdMappingWorkflowMetadata {
|
|
2339
|
+
/**
|
|
2340
|
+
* <p>The type of ID mapping.</p>
|
|
2341
|
+
* @public
|
|
2342
|
+
*/
|
|
2343
|
+
idMappingType: IdMappingType | undefined;
|
|
2344
|
+
}
|
|
2169
2345
|
/**
|
|
2170
2346
|
* <p>A summary of ID namespaces.</p>
|
|
2171
2347
|
* @public
|
|
@@ -2186,12 +2362,18 @@ export interface IdNamespaceSummary {
|
|
|
2186
2362
|
* @public
|
|
2187
2363
|
*/
|
|
2188
2364
|
description?: string;
|
|
2365
|
+
/**
|
|
2366
|
+
* <p>An object which defines any additional configurations required by the ID mapping
|
|
2367
|
+
* workflow.</p>
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2370
|
+
idMappingWorkflowProperties?: IdNamespaceIdMappingWorkflowMetadata[];
|
|
2189
2371
|
/**
|
|
2190
2372
|
* <p>The type of ID namespace. There are two types: <code>SOURCE</code> and
|
|
2191
2373
|
* <code>TARGET</code>.</p>
|
|
2192
2374
|
* <p>The <code>SOURCE</code> contains configurations for <code>sourceId</code> data that will
|
|
2193
2375
|
* be processed in an ID mapping workflow. </p>
|
|
2194
|
-
* <p>The <code>TARGET</code> contains a configuration of <code>targetId</code>
|
|
2376
|
+
* <p>The <code>TARGET</code> contains a configuration of <code>targetId</code> which all
|
|
2195
2377
|
* <code>sourceIds</code> will resolve to.</p>
|
|
2196
2378
|
* @public
|
|
2197
2379
|
*/
|
|
@@ -2496,6 +2678,12 @@ export interface PutPolicyInput {
|
|
|
2496
2678
|
token?: string;
|
|
2497
2679
|
/**
|
|
2498
2680
|
* <p>The resource-based policy.</p>
|
|
2681
|
+
* <important>
|
|
2682
|
+
* <p>If you set the value of the <code>effect</code> parameter in the <code>policy</code>
|
|
2683
|
+
* to <code>Deny</code> for the <code>PutPolicy</code> operation, you must also set the
|
|
2684
|
+
* value of the <code>effect</code> parameter to <code>Deny</code> for the
|
|
2685
|
+
* <code>AddPolicyStatement</code> operation.</p>
|
|
2686
|
+
* </important>
|
|
2499
2687
|
* @public
|
|
2500
2688
|
*/
|
|
2501
2689
|
policy: string | undefined;
|
|
@@ -2637,8 +2825,8 @@ export interface UpdateIdMappingWorkflowInput {
|
|
|
2637
2825
|
*/
|
|
2638
2826
|
outputSourceConfig?: IdMappingWorkflowOutputSource[];
|
|
2639
2827
|
/**
|
|
2640
|
-
* <p>An object which defines the
|
|
2641
|
-
*
|
|
2828
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
2829
|
+
* configurations.</p>
|
|
2642
2830
|
* @public
|
|
2643
2831
|
*/
|
|
2644
2832
|
idMappingTechniques: IdMappingTechniques | undefined;
|
|
@@ -2647,7 +2835,7 @@ export interface UpdateIdMappingWorkflowInput {
|
|
|
2647
2835
|
* this role to access Amazon Web Services resources on your behalf.</p>
|
|
2648
2836
|
* @public
|
|
2649
2837
|
*/
|
|
2650
|
-
roleArn
|
|
2838
|
+
roleArn?: string;
|
|
2651
2839
|
}
|
|
2652
2840
|
/**
|
|
2653
2841
|
* @public
|
|
@@ -2682,8 +2870,8 @@ export interface UpdateIdMappingWorkflowOutput {
|
|
|
2682
2870
|
*/
|
|
2683
2871
|
outputSourceConfig?: IdMappingWorkflowOutputSource[];
|
|
2684
2872
|
/**
|
|
2685
|
-
* <p>An object which defines the
|
|
2686
|
-
*
|
|
2873
|
+
* <p>An object which defines the ID mapping technique and any additional
|
|
2874
|
+
* configurations.</p>
|
|
2687
2875
|
* @public
|
|
2688
2876
|
*/
|
|
2689
2877
|
idMappingTechniques: IdMappingTechniques | undefined;
|
|
@@ -2692,7 +2880,7 @@ export interface UpdateIdMappingWorkflowOutput {
|
|
|
2692
2880
|
* this role to access Amazon Web Services resources on your behalf.</p>
|
|
2693
2881
|
* @public
|
|
2694
2882
|
*/
|
|
2695
|
-
roleArn
|
|
2883
|
+
roleArn?: string;
|
|
2696
2884
|
}
|
|
2697
2885
|
/**
|
|
2698
2886
|
* @public
|