@aws-sdk/client-entityresolution 3.378.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/LICENSE +201 -0
- package/README.md +346 -0
- package/dist-cjs/EntityResolution.js +43 -0
- package/dist-cjs/EntityResolutionClient.js +41 -0
- package/dist-cjs/commands/CreateMatchingWorkflowCommand.js +46 -0
- package/dist-cjs/commands/CreateSchemaMappingCommand.js +46 -0
- package/dist-cjs/commands/DeleteMatchingWorkflowCommand.js +46 -0
- package/dist-cjs/commands/DeleteSchemaMappingCommand.js +46 -0
- package/dist-cjs/commands/GetMatchIdCommand.js +47 -0
- package/dist-cjs/commands/GetMatchingJobCommand.js +46 -0
- package/dist-cjs/commands/GetMatchingWorkflowCommand.js +46 -0
- package/dist-cjs/commands/GetSchemaMappingCommand.js +46 -0
- package/dist-cjs/commands/ListMatchingJobsCommand.js +46 -0
- package/dist-cjs/commands/ListMatchingWorkflowsCommand.js +46 -0
- package/dist-cjs/commands/ListSchemaMappingsCommand.js +46 -0
- package/dist-cjs/commands/ListTagsForResourceCommand.js +46 -0
- package/dist-cjs/commands/StartMatchingJobCommand.js +46 -0
- package/dist-cjs/commands/TagResourceCommand.js +46 -0
- package/dist-cjs/commands/UntagResourceCommand.js +46 -0
- package/dist-cjs/commands/UpdateMatchingWorkflowCommand.js +46 -0
- package/dist-cjs/commands/index.js +19 -0
- package/dist-cjs/endpoint/EndpointParameters.js +12 -0
- package/dist-cjs/endpoint/endpointResolver.js +12 -0
- package/dist-cjs/endpoint/ruleset.js +7 -0
- package/dist-cjs/index.js +11 -0
- package/dist-cjs/models/EntityResolutionServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +143 -0
- package/dist-cjs/pagination/Interfaces.js +2 -0
- package/dist-cjs/pagination/ListMatchingJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListMatchingWorkflowsPaginator.js +29 -0
- package/dist-cjs/pagination/ListSchemaMappingsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1281 -0
- package/dist-cjs/runtimeConfig.browser.js +39 -0
- package/dist-cjs/runtimeConfig.js +48 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +21 -0
- package/dist-es/EntityResolution.js +39 -0
- package/dist-es/EntityResolutionClient.js +37 -0
- package/dist-es/commands/CreateMatchingWorkflowCommand.js +42 -0
- package/dist-es/commands/CreateSchemaMappingCommand.js +42 -0
- package/dist-es/commands/DeleteMatchingWorkflowCommand.js +42 -0
- package/dist-es/commands/DeleteSchemaMappingCommand.js +42 -0
- package/dist-es/commands/GetMatchIdCommand.js +43 -0
- package/dist-es/commands/GetMatchingJobCommand.js +42 -0
- package/dist-es/commands/GetMatchingWorkflowCommand.js +42 -0
- package/dist-es/commands/GetSchemaMappingCommand.js +42 -0
- package/dist-es/commands/ListMatchingJobsCommand.js +42 -0
- package/dist-es/commands/ListMatchingWorkflowsCommand.js +42 -0
- package/dist-es/commands/ListSchemaMappingsCommand.js +42 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +42 -0
- package/dist-es/commands/StartMatchingJobCommand.js +42 -0
- package/dist-es/commands/TagResourceCommand.js +42 -0
- package/dist-es/commands/UntagResourceCommand.js +42 -0
- package/dist-es/commands/UpdateMatchingWorkflowCommand.js +42 -0
- package/dist-es/commands/index.js +16 -0
- package/dist-es/endpoint/EndpointParameters.js +8 -0
- package/dist-es/endpoint/endpointResolver.js +8 -0
- package/dist-es/endpoint/ruleset.js +4 -0
- package/dist-es/index.js +6 -0
- package/dist-es/models/EntityResolutionServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +132 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListMatchingJobsPaginator.js +25 -0
- package/dist-es/pagination/ListMatchingWorkflowsPaginator.js +25 -0
- package/dist-es/pagination/ListSchemaMappingsPaginator.js +25 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +1246 -0
- package/dist-es/runtimeConfig.browser.js +34 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +17 -0
- package/dist-types/EntityResolution.d.ts +135 -0
- package/dist-types/EntityResolutionClient.d.ts +191 -0
- package/dist-types/commands/CreateMatchingWorkflowCommand.d.ts +183 -0
- package/dist-types/commands/CreateSchemaMappingCommand.d.ts +123 -0
- package/dist-types/commands/DeleteMatchingWorkflowCommand.d.ts +90 -0
- package/dist-types/commands/DeleteSchemaMappingCommand.d.ts +96 -0
- package/dist-types/commands/GetMatchIdCommand.d.ts +96 -0
- package/dist-types/commands/GetMatchingJobCommand.d.ts +106 -0
- package/dist-types/commands/GetMatchingWorkflowCommand.d.ts +138 -0
- package/dist-types/commands/GetSchemaMappingCommand.d.ts +108 -0
- package/dist-types/commands/ListMatchingJobsCommand.d.ts +103 -0
- package/dist-types/commands/ListMatchingWorkflowsCommand.d.ts +98 -0
- package/dist-types/commands/ListSchemaMappingsCommand.d.ts +98 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +89 -0
- package/dist-types/commands/StartMatchingJobCommand.d.ts +104 -0
- package/dist-types/commands/TagResourceCommand.d.ts +95 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +84 -0
- package/dist-types/commands/UpdateMatchingWorkflowCommand.d.ts +174 -0
- package/dist-types/commands/index.d.ts +16 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +19 -0
- package/dist-types/endpoint/endpointResolver.d.ts +5 -0
- package/dist-types/endpoint/ruleset.d.ts +2 -0
- package/dist-types/index.d.ts +24 -0
- package/dist-types/models/EntityResolutionServiceException.d.ts +13 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1017 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListMatchingJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMatchingWorkflowsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSchemaMappingsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +146 -0
- package/dist-types/runtimeConfig.browser.d.ts +42 -0
- package/dist-types/runtimeConfig.d.ts +42 -0
- package/dist-types/runtimeConfig.native.d.ts +41 -0
- package/dist-types/runtimeConfig.shared.d.ts +18 -0
- package/dist-types/ts3.4/EntityResolution.d.ts +279 -0
- package/dist-types/ts3.4/EntityResolutionClient.d.ts +209 -0
- package/dist-types/ts3.4/commands/CreateMatchingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateSchemaMappingCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteMatchingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteSchemaMappingCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetMatchIdCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetMatchingJobCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/GetMatchingWorkflowCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetSchemaMappingCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListMatchingJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListMatchingWorkflowsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListSchemaMappingsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StartMatchingJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/UpdateMatchingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +16 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
- package/dist-types/ts3.4/index.d.ts +6 -0
- package/dist-types/ts3.4/models/EntityResolutionServiceException.d.ts +8 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +322 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
- package/dist-types/ts3.4/pagination/ListMatchingJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMatchingWorkflowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSchemaMappingsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +197 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +91 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +82 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +20 -0
- package/package.json +99 -0
|
@@ -0,0 +1,1017 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { EntityResolutionServiceException as __BaseException } from "./EntityResolutionServiceException";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code: 403</code>
|
|
6
|
+
* </p>
|
|
7
|
+
*/
|
|
8
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
9
|
+
readonly name: "AccessDeniedException";
|
|
10
|
+
readonly $fault: "client";
|
|
11
|
+
/**
|
|
12
|
+
* @internal
|
|
13
|
+
*/
|
|
14
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
* @enum
|
|
19
|
+
*/
|
|
20
|
+
export declare const AttributeMatchingModel: {
|
|
21
|
+
readonly MANY_TO_MANY: "MANY_TO_MANY";
|
|
22
|
+
readonly ONE_TO_ONE: "ONE_TO_ONE";
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
*/
|
|
27
|
+
export type AttributeMatchingModel = (typeof AttributeMatchingModel)[keyof typeof AttributeMatchingModel];
|
|
28
|
+
/**
|
|
29
|
+
* @public
|
|
30
|
+
* <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
|
|
31
|
+
* Schema already exists, Workflow is currently running, etc. <code>HTTP Status Code: 400</code>
|
|
32
|
+
* </p>
|
|
33
|
+
*/
|
|
34
|
+
export declare class ConflictException extends __BaseException {
|
|
35
|
+
readonly name: "ConflictException";
|
|
36
|
+
readonly $fault: "client";
|
|
37
|
+
/**
|
|
38
|
+
* @internal
|
|
39
|
+
*/
|
|
40
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* @public
|
|
44
|
+
* @enum
|
|
45
|
+
*/
|
|
46
|
+
export declare const IncrementalRunType: {
|
|
47
|
+
readonly IMMEDIATE: "IMMEDIATE";
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
export type IncrementalRunType = (typeof IncrementalRunType)[keyof typeof IncrementalRunType];
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
56
|
+
*/
|
|
57
|
+
export interface IncrementalRunConfig {
|
|
58
|
+
/**
|
|
59
|
+
* <p>The type of incremental run. It takes only one value: <code>IMMEDIATE</code>.</p>
|
|
60
|
+
*/
|
|
61
|
+
incrementalRunType?: IncrementalRunType | string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
* <p>An object containing <code>InputSourceARN</code>, <code>SchemaName</code>,
|
|
66
|
+
* and <code>ApplyNormalization</code>.</p>
|
|
67
|
+
*/
|
|
68
|
+
export interface InputSource {
|
|
69
|
+
/**
|
|
70
|
+
* <p>An Glue table ARN for the input source table.</p>
|
|
71
|
+
*/
|
|
72
|
+
inputSourceARN: string | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* <p>The name of the schema to be retrieved.</p>
|
|
75
|
+
*/
|
|
76
|
+
schemaName: string | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* <p>Normalizes the attributes defined in the schema in the input data. For example, if an
|
|
79
|
+
* attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in
|
|
80
|
+
* the input table is in a format of 1234567890, Entity Resolution will normalize this field
|
|
81
|
+
* in the output to (123)-456-7890.</p>
|
|
82
|
+
*/
|
|
83
|
+
applyNormalization?: boolean;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @public
|
|
87
|
+
* <p>A list of <code>OutputAttribute</code> objects, each of which have the fields Name and Hashed. Each of
|
|
88
|
+
* these objects selects a column to be included in the output table, and whether the
|
|
89
|
+
* values of the column should be hashed.</p>
|
|
90
|
+
*/
|
|
91
|
+
export interface OutputAttribute {
|
|
92
|
+
/**
|
|
93
|
+
* <p>A name of a column to be written to the output. This must be an <code>InputField</code> name
|
|
94
|
+
* in the schema mapping.</p>
|
|
95
|
+
*/
|
|
96
|
+
name: string | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* <p>Enables the ability to hash the column values in the output.</p>
|
|
99
|
+
*/
|
|
100
|
+
hashed?: boolean;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* @public
|
|
104
|
+
* <p>A list of <code>OutputAttribute</code> objects, each of which have the fields Name and Hashed. Each of
|
|
105
|
+
* these objects selects a column to be included in the output table, and whether the
|
|
106
|
+
* values of the column should be hashed.</p>
|
|
107
|
+
*/
|
|
108
|
+
export interface OutputSource {
|
|
109
|
+
/**
|
|
110
|
+
* <p>The S3 path to which Entity Resolution will write the output table.</p>
|
|
111
|
+
*/
|
|
112
|
+
outputS3Path: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>A list of <code>OutputAttribute</code> objects, each of which have the fields Name and Hashed. Each of
|
|
115
|
+
* these objects selects a column to be included in the output table, and whether the
|
|
116
|
+
* values of the column should be hashed.</p>
|
|
117
|
+
*/
|
|
118
|
+
output: OutputAttribute[] | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* <p>Customer KMS ARN for encryption at rest. If not provided, system will use an
|
|
121
|
+
* Entity Resolution managed KMS key.</p>
|
|
122
|
+
*/
|
|
123
|
+
KMSArn?: string;
|
|
124
|
+
/**
|
|
125
|
+
* <p>Normalizes the attributes defined in the schema in the input data. For example, if an
|
|
126
|
+
* attribute has an <code>AttributeType</code> of <code>PHONE_NUMBER</code>, and the data in
|
|
127
|
+
* the input table is in a format of 1234567890, Entity Resolution will normalize this field
|
|
128
|
+
* in the output to (123)-456-7890.</p>
|
|
129
|
+
*/
|
|
130
|
+
applyNormalization?: boolean;
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* @enum
|
|
135
|
+
*/
|
|
136
|
+
export declare const ResolutionType: {
|
|
137
|
+
readonly ML_MATCHING: "ML_MATCHING";
|
|
138
|
+
readonly RULE_MATCHING: "RULE_MATCHING";
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
export type ResolutionType = (typeof ResolutionType)[keyof typeof ResolutionType];
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
* <p>An object containing <code>RuleName</code>, and <code>MatchingKeys</code>.</p>
|
|
147
|
+
*/
|
|
148
|
+
export interface Rule {
|
|
149
|
+
/**
|
|
150
|
+
* <p>A name for the matching rule.</p>
|
|
151
|
+
*/
|
|
152
|
+
ruleName: string | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* <p>A list of <code>MatchingKeys</code>. The <code>MatchingKeys</code> must have been defined in
|
|
155
|
+
* the <code>SchemaMapping</code>. Two records are considered to match according to this rule if all
|
|
156
|
+
* of the <code>MatchingKeys</code> match.</p>
|
|
157
|
+
*/
|
|
158
|
+
matchingKeys: string[] | undefined;
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
* @public
|
|
162
|
+
* <p>An object which defines the list of matching rules to run and has a field <code>Rules</code>, which
|
|
163
|
+
* is a list of rule objects.</p>
|
|
164
|
+
*/
|
|
165
|
+
export interface RuleBasedProperties {
|
|
166
|
+
/**
|
|
167
|
+
* <p>A list of Rule objects, each of which have fields <code>RuleName</code> and <code>MatchingKeys</code>.</p>
|
|
168
|
+
*/
|
|
169
|
+
rules: Rule[] | undefined;
|
|
170
|
+
/**
|
|
171
|
+
* <p>You can either choose <code>ONE_TO_ONE</code> or <code>MANY_TO_MANY</code> as the AttributeMatchingModel. When
|
|
172
|
+
* choosing <code>MANY_TO_MANY</code>, the system can match attribute across the sub-types of an attribute type. For
|
|
173
|
+
* example, if the value of the Email field of Profile A and the value of BusinessEmail field of Profile B matches,
|
|
174
|
+
* the two profiles are matched on the Email type. When choosing <code>ONE_TO_ONE</code> the system can only match if
|
|
175
|
+
* the sub-types are exact matches. For example, only when the value of the Email field of Profile A and the value of
|
|
176
|
+
* the Email field of Profile B matches, the two profiles are matched on the Email type.</p>
|
|
177
|
+
*/
|
|
178
|
+
attributeMatchingModel: AttributeMatchingModel | string | undefined;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* @public
|
|
182
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
183
|
+
* </p>
|
|
184
|
+
*/
|
|
185
|
+
export interface ResolutionTechniques {
|
|
186
|
+
/**
|
|
187
|
+
* <p>There are two types of matching, <code>RULE_MATCHING</code> and <code>ML_MATCHING</code>
|
|
188
|
+
* </p>
|
|
189
|
+
*/
|
|
190
|
+
resolutionType?: ResolutionType | string;
|
|
191
|
+
/**
|
|
192
|
+
* <p>An object which defines the list of matching rules to run and has a field <code>Rules</code>, which
|
|
193
|
+
* is a list of rule objects.</p>
|
|
194
|
+
*/
|
|
195
|
+
ruleBasedProperties?: RuleBasedProperties;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
export interface CreateMatchingWorkflowInput {
|
|
201
|
+
/**
|
|
202
|
+
* <p>The name of the workflow. There cannot be multiple <code>DataIntegrationWorkflows</code> with the same name.</p>
|
|
203
|
+
*/
|
|
204
|
+
workflowName: string | undefined;
|
|
205
|
+
/**
|
|
206
|
+
* <p>A description of the workflow.</p>
|
|
207
|
+
*/
|
|
208
|
+
description?: string;
|
|
209
|
+
/**
|
|
210
|
+
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
211
|
+
* <code>SchemaName</code>.</p>
|
|
212
|
+
*/
|
|
213
|
+
inputSourceConfig: InputSource[] | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
216
|
+
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
217
|
+
*/
|
|
218
|
+
outputSourceConfig: OutputSource[] | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
221
|
+
* </p>
|
|
222
|
+
*/
|
|
223
|
+
resolutionTechniques: ResolutionTechniques | undefined;
|
|
224
|
+
/**
|
|
225
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
226
|
+
*/
|
|
227
|
+
incrementalRunConfig?: IncrementalRunConfig;
|
|
228
|
+
/**
|
|
229
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
230
|
+
* to create resources on your behalf as part of workflow execution.</p>
|
|
231
|
+
*/
|
|
232
|
+
roleArn: string | undefined;
|
|
233
|
+
/**
|
|
234
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
235
|
+
*/
|
|
236
|
+
tags?: Record<string, string>;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
export interface CreateMatchingWorkflowOutput {
|
|
242
|
+
/**
|
|
243
|
+
* <p>The name of the workflow.</p>
|
|
244
|
+
*/
|
|
245
|
+
workflowName: string | undefined;
|
|
246
|
+
/**
|
|
247
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
248
|
+
*/
|
|
249
|
+
workflowArn: string | undefined;
|
|
250
|
+
/**
|
|
251
|
+
* <p>A description of the workflow.</p>
|
|
252
|
+
*/
|
|
253
|
+
description?: string;
|
|
254
|
+
/**
|
|
255
|
+
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
256
|
+
* <code>SchemaName</code>.</p>
|
|
257
|
+
*/
|
|
258
|
+
inputSourceConfig: InputSource[] | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
261
|
+
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
262
|
+
*/
|
|
263
|
+
outputSourceConfig: OutputSource[] | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
266
|
+
* </p>
|
|
267
|
+
*/
|
|
268
|
+
resolutionTechniques: ResolutionTechniques | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
271
|
+
*/
|
|
272
|
+
incrementalRunConfig?: IncrementalRunConfig;
|
|
273
|
+
/**
|
|
274
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
275
|
+
* to create resources on your behalf as part of workflow execution.</p>
|
|
276
|
+
*/
|
|
277
|
+
roleArn: string | undefined;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* @public
|
|
281
|
+
* <p>The request was rejected because it attempted to create resources beyond the current AWS Entity Resolution account limits.
|
|
282
|
+
* The error message describes the limit exceeded. <code>HTTP Status Code: 402</code>
|
|
283
|
+
* </p>
|
|
284
|
+
*/
|
|
285
|
+
export declare class ExceedsLimitException extends __BaseException {
|
|
286
|
+
readonly name: "ExceedsLimitException";
|
|
287
|
+
readonly $fault: "client";
|
|
288
|
+
/**
|
|
289
|
+
* @internal
|
|
290
|
+
*/
|
|
291
|
+
constructor(opts: __ExceptionOptionType<ExceedsLimitException, __BaseException>);
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* @public
|
|
295
|
+
* <p>This exception occurs when there is an internal failure in the AWS Entity Resolution service. <code>HTTP Status Code: 500</code>
|
|
296
|
+
* </p>
|
|
297
|
+
*/
|
|
298
|
+
export declare class InternalServerException extends __BaseException {
|
|
299
|
+
readonly name: "InternalServerException";
|
|
300
|
+
readonly $fault: "server";
|
|
301
|
+
$retryable: {};
|
|
302
|
+
/**
|
|
303
|
+
* @internal
|
|
304
|
+
*/
|
|
305
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
306
|
+
}
|
|
307
|
+
/**
|
|
308
|
+
* @public
|
|
309
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
|
|
310
|
+
* </p>
|
|
311
|
+
*/
|
|
312
|
+
export declare class ThrottlingException extends __BaseException {
|
|
313
|
+
readonly name: "ThrottlingException";
|
|
314
|
+
readonly $fault: "client";
|
|
315
|
+
$retryable: {
|
|
316
|
+
throttling: boolean;
|
|
317
|
+
};
|
|
318
|
+
/**
|
|
319
|
+
* @internal
|
|
320
|
+
*/
|
|
321
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* @public
|
|
325
|
+
* <p>The input fails to satisfy the constraints specified by AWS Entity Resolution. <code>HTTP Status Code: 400</code>
|
|
326
|
+
* </p>
|
|
327
|
+
*/
|
|
328
|
+
export declare class ValidationException extends __BaseException {
|
|
329
|
+
readonly name: "ValidationException";
|
|
330
|
+
readonly $fault: "client";
|
|
331
|
+
/**
|
|
332
|
+
* @internal
|
|
333
|
+
*/
|
|
334
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* @enum
|
|
339
|
+
*/
|
|
340
|
+
export declare const SchemaAttributeType: {
|
|
341
|
+
readonly ADDRESS: "ADDRESS";
|
|
342
|
+
readonly ADDRESS_CITY: "ADDRESS_CITY";
|
|
343
|
+
readonly ADDRESS_COUNTRY: "ADDRESS_COUNTRY";
|
|
344
|
+
readonly ADDRESS_POSTALCODE: "ADDRESS_POSTALCODE";
|
|
345
|
+
readonly ADDRESS_STATE: "ADDRESS_STATE";
|
|
346
|
+
readonly ADDRESS_STREET1: "ADDRESS_STREET1";
|
|
347
|
+
readonly ADDRESS_STREET2: "ADDRESS_STREET2";
|
|
348
|
+
readonly ADDRESS_STREET3: "ADDRESS_STREET3";
|
|
349
|
+
readonly DATE: "DATE";
|
|
350
|
+
readonly EMAIL_ADDRESS: "EMAIL_ADDRESS";
|
|
351
|
+
readonly NAME: "NAME";
|
|
352
|
+
readonly NAME_FIRST: "NAME_FIRST";
|
|
353
|
+
readonly NAME_LAST: "NAME_LAST";
|
|
354
|
+
readonly NAME_MIDDLE: "NAME_MIDDLE";
|
|
355
|
+
readonly PHONE: "PHONE";
|
|
356
|
+
readonly PHONE_COUNTRYCODE: "PHONE_COUNTRYCODE";
|
|
357
|
+
readonly PHONE_NUMBER: "PHONE_NUMBER";
|
|
358
|
+
readonly STRING: "STRING";
|
|
359
|
+
readonly UNIQUE_ID: "UNIQUE_ID";
|
|
360
|
+
};
|
|
361
|
+
/**
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
export type SchemaAttributeType = (typeof SchemaAttributeType)[keyof typeof SchemaAttributeType];
|
|
365
|
+
/**
|
|
366
|
+
* @public
|
|
367
|
+
* <p>An object containing <code>FieldField</code>, <code>Type</code>, <code>GroupName</code>,
|
|
368
|
+
* and <code>MatchKey</code>.</p>
|
|
369
|
+
*/
|
|
370
|
+
export interface SchemaInputAttribute {
|
|
371
|
+
/**
|
|
372
|
+
* <p>A string containing the field name.</p>
|
|
373
|
+
*/
|
|
374
|
+
fieldName: string | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* <p>The type of the attribute, selected from a list of values.</p>
|
|
377
|
+
*/
|
|
378
|
+
type: SchemaAttributeType | string | undefined;
|
|
379
|
+
/**
|
|
380
|
+
* <p>Instruct Entity Resolution to combine several columns into a unified column with the
|
|
381
|
+
* identical attribute type. For example, when working with columns such as first_name,
|
|
382
|
+
* middle_name, and last_name, assigning them a common <code>GroupName</code> will prompt
|
|
383
|
+
* Entity Resolution to concatenate them into a single value.</p>
|
|
384
|
+
*/
|
|
385
|
+
groupName?: string;
|
|
386
|
+
/**
|
|
387
|
+
* <p>A key that allows grouping of multiple input attributes into a unified matching group.
|
|
388
|
+
* For example, let's consider a scenario where the source table contains various addresses,
|
|
389
|
+
* such as business_address and shipping_address. By assigning the <code>MatchKey</code>
|
|
390
|
+
* <i>Address</i>' to both attributes, Entity Resolution will match records
|
|
391
|
+
* across these fields to create a consolidated matching group. If no <code>MatchKey</code> is
|
|
392
|
+
* specified for a column, it won't be utilized for matching purposes but will still be
|
|
393
|
+
* included in the output table.</p>
|
|
394
|
+
*/
|
|
395
|
+
matchKey?: string;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
export interface CreateSchemaMappingInput {
|
|
401
|
+
/**
|
|
402
|
+
* <p>The name of the schema. There cannot be multiple <code>SchemaMappings</code> with the
|
|
403
|
+
* same name.</p>
|
|
404
|
+
*/
|
|
405
|
+
schemaName: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>A description of the schema.</p>
|
|
408
|
+
*/
|
|
409
|
+
description?: string;
|
|
410
|
+
/**
|
|
411
|
+
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
412
|
+
* to a column the source data table, and contains column name plus additional information
|
|
413
|
+
* that Entity Resolution uses for matching.</p>
|
|
414
|
+
*/
|
|
415
|
+
mappedInputFields?: SchemaInputAttribute[];
|
|
416
|
+
/**
|
|
417
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
418
|
+
*/
|
|
419
|
+
tags?: Record<string, string>;
|
|
420
|
+
}
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
export interface CreateSchemaMappingOutput {
|
|
425
|
+
/**
|
|
426
|
+
* <p>The name of the schema.</p>
|
|
427
|
+
*/
|
|
428
|
+
schemaName: string | undefined;
|
|
429
|
+
/**
|
|
430
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the
|
|
431
|
+
* <code>SchemaMapping</code>.</p>
|
|
432
|
+
*/
|
|
433
|
+
schemaArn: string | undefined;
|
|
434
|
+
/**
|
|
435
|
+
* <p>A description of the schema.</p>
|
|
436
|
+
*/
|
|
437
|
+
description: string | undefined;
|
|
438
|
+
/**
|
|
439
|
+
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
440
|
+
* to a column the source data table, and contains column name plus additional information
|
|
441
|
+
* that Entity Resolution uses for matching.</p>
|
|
442
|
+
*/
|
|
443
|
+
mappedInputFields: SchemaInputAttribute[] | undefined;
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
export interface DeleteMatchingWorkflowInput {
|
|
449
|
+
/**
|
|
450
|
+
* <p>The name of the workflow to be retrieved.</p>
|
|
451
|
+
*/
|
|
452
|
+
workflowName: string | undefined;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* @public
|
|
456
|
+
*/
|
|
457
|
+
export interface DeleteMatchingWorkflowOutput {
|
|
458
|
+
/**
|
|
459
|
+
* <p>A successful operation message.</p>
|
|
460
|
+
*/
|
|
461
|
+
message: string | undefined;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
export interface DeleteSchemaMappingInput {
|
|
467
|
+
/**
|
|
468
|
+
* <p>The name of the schema to delete.</p>
|
|
469
|
+
*/
|
|
470
|
+
schemaName: string | undefined;
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
export interface DeleteSchemaMappingOutput {
|
|
476
|
+
/**
|
|
477
|
+
* <p>A successful operation message.</p>
|
|
478
|
+
*/
|
|
479
|
+
message: string | undefined;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
export interface GetMatchIdInput {
|
|
485
|
+
/**
|
|
486
|
+
* <p>The name of the workflow.</p>
|
|
487
|
+
*/
|
|
488
|
+
workflowName: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* <p>The record to fetch the Match ID for.</p>
|
|
491
|
+
*/
|
|
492
|
+
record: Record<string, string> | undefined;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
export interface GetMatchIdOutput {
|
|
498
|
+
/**
|
|
499
|
+
* <p>The unique identifiers for this group of match records.</p>
|
|
500
|
+
*/
|
|
501
|
+
matchId?: string;
|
|
502
|
+
}
|
|
503
|
+
/**
|
|
504
|
+
* @public
|
|
505
|
+
* <p>The resource could not be found. <code>HTTP Status Code: 404</code>
|
|
506
|
+
* </p>
|
|
507
|
+
*/
|
|
508
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
509
|
+
readonly name: "ResourceNotFoundException";
|
|
510
|
+
readonly $fault: "client";
|
|
511
|
+
/**
|
|
512
|
+
* @internal
|
|
513
|
+
*/
|
|
514
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
515
|
+
}
|
|
516
|
+
/**
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
export interface GetMatchingJobInput {
|
|
520
|
+
/**
|
|
521
|
+
* <p>The name of the workflow.</p>
|
|
522
|
+
*/
|
|
523
|
+
workflowName: string | undefined;
|
|
524
|
+
/**
|
|
525
|
+
* <p>The ID of the job.</p>
|
|
526
|
+
*/
|
|
527
|
+
jobId: string | undefined;
|
|
528
|
+
}
|
|
529
|
+
/**
|
|
530
|
+
* @public
|
|
531
|
+
* <p>An object containing an error message, if there was an error.</p>
|
|
532
|
+
*/
|
|
533
|
+
export interface ErrorDetails {
|
|
534
|
+
/**
|
|
535
|
+
* <p>The error message from the job, if there is one.</p>
|
|
536
|
+
*/
|
|
537
|
+
errorMessage?: string;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* @public
|
|
541
|
+
* <p>An object containing <code>InputRecords</code>, <code>TotalRecordsProcessed</code>,
|
|
542
|
+
* <code>MatchIDs</code>, and <code>RecordsNotProcessed</code>.</p>
|
|
543
|
+
*/
|
|
544
|
+
export interface JobMetrics {
|
|
545
|
+
/**
|
|
546
|
+
* <p>The total number of input records.</p>
|
|
547
|
+
*/
|
|
548
|
+
inputRecords?: number;
|
|
549
|
+
/**
|
|
550
|
+
* <p>The total number of records processed.</p>
|
|
551
|
+
*/
|
|
552
|
+
totalRecordsProcessed?: number;
|
|
553
|
+
/**
|
|
554
|
+
* <p>The total number of <code>matchID</code>s generated.</p>
|
|
555
|
+
*/
|
|
556
|
+
matchIDs?: number;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The total number of records that did not get processed,</p>
|
|
559
|
+
*/
|
|
560
|
+
recordsNotProcessed?: number;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* @public
|
|
564
|
+
* @enum
|
|
565
|
+
*/
|
|
566
|
+
export declare const JobStatus: {
|
|
567
|
+
readonly FAILED: "FAILED";
|
|
568
|
+
readonly QUEUED: "QUEUED";
|
|
569
|
+
readonly RUNNING: "RUNNING";
|
|
570
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
571
|
+
};
|
|
572
|
+
/**
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
576
|
+
/**
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
export interface GetMatchingJobOutput {
|
|
580
|
+
/**
|
|
581
|
+
* <p>The ID of the job.</p>
|
|
582
|
+
*/
|
|
583
|
+
jobId: string | undefined;
|
|
584
|
+
/**
|
|
585
|
+
* <p>The current status of the job. Either <code>running</code>, <code>succeeded</code>,
|
|
586
|
+
* <code>queued</code>, or <code>failed</code>.</p>
|
|
587
|
+
*/
|
|
588
|
+
status: JobStatus | string | undefined;
|
|
589
|
+
/**
|
|
590
|
+
* <p>The time at which the job was started.</p>
|
|
591
|
+
*/
|
|
592
|
+
startTime: Date | undefined;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The time at which the job has finished.</p>
|
|
595
|
+
*/
|
|
596
|
+
endTime?: Date;
|
|
597
|
+
/**
|
|
598
|
+
* <p>Metrics associated with the execution, specifically total records processed,
|
|
599
|
+
* unique IDs generated, and records the execution skipped.</p>
|
|
600
|
+
*/
|
|
601
|
+
metrics?: JobMetrics;
|
|
602
|
+
/**
|
|
603
|
+
* <p>An object containing an error message, if there was an error.</p>
|
|
604
|
+
*/
|
|
605
|
+
errorDetails?: ErrorDetails;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
export interface GetMatchingWorkflowInput {
|
|
611
|
+
/**
|
|
612
|
+
* <p>The name of the workflow.</p>
|
|
613
|
+
*/
|
|
614
|
+
workflowName: string | undefined;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
* @public
|
|
618
|
+
*/
|
|
619
|
+
export interface GetMatchingWorkflowOutput {
|
|
620
|
+
/**
|
|
621
|
+
* <p>The name of the workflow.</p>
|
|
622
|
+
*/
|
|
623
|
+
workflowName: string | undefined;
|
|
624
|
+
/**
|
|
625
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
626
|
+
*/
|
|
627
|
+
workflowArn: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* <p>A description of the workflow.</p>
|
|
630
|
+
*/
|
|
631
|
+
description?: string;
|
|
632
|
+
/**
|
|
633
|
+
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
634
|
+
* <code>SchemaName</code>.</p>
|
|
635
|
+
*/
|
|
636
|
+
inputSourceConfig: InputSource[] | undefined;
|
|
637
|
+
/**
|
|
638
|
+
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
639
|
+
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
640
|
+
*/
|
|
641
|
+
outputSourceConfig: OutputSource[] | undefined;
|
|
642
|
+
/**
|
|
643
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
644
|
+
* </p>
|
|
645
|
+
*/
|
|
646
|
+
resolutionTechniques: ResolutionTechniques | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The timestamp of when the workflow was created.</p>
|
|
649
|
+
*/
|
|
650
|
+
createdAt: Date | undefined;
|
|
651
|
+
/**
|
|
652
|
+
* <p>The timestamp of when the workflow was last updated.</p>
|
|
653
|
+
*/
|
|
654
|
+
updatedAt: Date | undefined;
|
|
655
|
+
/**
|
|
656
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
657
|
+
*/
|
|
658
|
+
incrementalRunConfig?: IncrementalRunConfig;
|
|
659
|
+
/**
|
|
660
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role to access
|
|
661
|
+
* resources on your behalf.</p>
|
|
662
|
+
*/
|
|
663
|
+
roleArn: string | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
666
|
+
*/
|
|
667
|
+
tags?: Record<string, string>;
|
|
668
|
+
}
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export interface GetSchemaMappingInput {
|
|
673
|
+
/**
|
|
674
|
+
* <p>The name of the schema to be retrieved.</p>
|
|
675
|
+
*/
|
|
676
|
+
schemaName: string | undefined;
|
|
677
|
+
}
|
|
678
|
+
/**
|
|
679
|
+
* @public
|
|
680
|
+
*/
|
|
681
|
+
export interface GetSchemaMappingOutput {
|
|
682
|
+
/**
|
|
683
|
+
* <p>The name of the schema.</p>
|
|
684
|
+
*/
|
|
685
|
+
schemaName: string | undefined;
|
|
686
|
+
/**
|
|
687
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the SchemaMapping.</p>
|
|
688
|
+
*/
|
|
689
|
+
schemaArn: string | undefined;
|
|
690
|
+
/**
|
|
691
|
+
* <p>A description of the schema.</p>
|
|
692
|
+
*/
|
|
693
|
+
description?: string;
|
|
694
|
+
/**
|
|
695
|
+
* <p>A list of <code>MappedInputFields</code>. Each <code>MappedInputField</code> corresponds
|
|
696
|
+
* to a column the source data table, and contains column name plus additional information
|
|
697
|
+
* Venice uses for matching.</p>
|
|
698
|
+
*/
|
|
699
|
+
mappedInputFields: SchemaInputAttribute[] | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* <p>The timestamp of when the <code>SchemaMapping</code> was created.</p>
|
|
702
|
+
*/
|
|
703
|
+
createdAt: Date | undefined;
|
|
704
|
+
/**
|
|
705
|
+
* <p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>
|
|
706
|
+
*/
|
|
707
|
+
updatedAt: Date | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
710
|
+
*/
|
|
711
|
+
tags?: Record<string, string>;
|
|
712
|
+
}
|
|
713
|
+
/**
|
|
714
|
+
* @public
|
|
715
|
+
*/
|
|
716
|
+
export interface ListMatchingJobsInput {
|
|
717
|
+
/**
|
|
718
|
+
* <p>The name of the workflow to be retrieved.</p>
|
|
719
|
+
*/
|
|
720
|
+
workflowName: string | undefined;
|
|
721
|
+
/**
|
|
722
|
+
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
723
|
+
*/
|
|
724
|
+
nextToken?: string;
|
|
725
|
+
/**
|
|
726
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
727
|
+
*/
|
|
728
|
+
maxResults?: number;
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* @public
|
|
732
|
+
* <p>An object containing the <code>JobId</code>, <code>Status</code>,
|
|
733
|
+
* <code>StartTime</code>, and <code>EndTime</code> of a job.</p>
|
|
734
|
+
*/
|
|
735
|
+
export interface JobSummary {
|
|
736
|
+
/**
|
|
737
|
+
* <p>The ID of the job.</p>
|
|
738
|
+
*/
|
|
739
|
+
jobId: string | undefined;
|
|
740
|
+
/**
|
|
741
|
+
* <p>The current status of the job. Either <code>running</code>, <code>succeeded</code>,
|
|
742
|
+
* <code>queued</code>, or <code>failed</code>.</p>
|
|
743
|
+
*/
|
|
744
|
+
status: JobStatus | string | undefined;
|
|
745
|
+
/**
|
|
746
|
+
* <p>The time at which the job was started.</p>
|
|
747
|
+
*/
|
|
748
|
+
startTime: Date | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* <p>The time at which the job has finished.</p>
|
|
751
|
+
*/
|
|
752
|
+
endTime?: Date;
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
export interface ListMatchingJobsOutput {
|
|
758
|
+
/**
|
|
759
|
+
* <p>A list of JobSummary objects, each of which contain the ID, status, start time, and end time of a job.</p>
|
|
760
|
+
*/
|
|
761
|
+
jobs?: JobSummary[];
|
|
762
|
+
/**
|
|
763
|
+
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
764
|
+
*/
|
|
765
|
+
nextToken?: string;
|
|
766
|
+
}
|
|
767
|
+
/**
|
|
768
|
+
* @public
|
|
769
|
+
*/
|
|
770
|
+
export interface ListMatchingWorkflowsInput {
|
|
771
|
+
/**
|
|
772
|
+
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
773
|
+
*/
|
|
774
|
+
nextToken?: string;
|
|
775
|
+
/**
|
|
776
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
777
|
+
*/
|
|
778
|
+
maxResults?: number;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* @public
|
|
782
|
+
* <p>A list of <code>MatchingWorkflowSummary</code> objects, each of which contain the fields
|
|
783
|
+
* <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.</p>
|
|
784
|
+
*/
|
|
785
|
+
export interface MatchingWorkflowSummary {
|
|
786
|
+
/**
|
|
787
|
+
* <p>The name of the workflow.</p>
|
|
788
|
+
*/
|
|
789
|
+
workflowName: string | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the <code>MatchingWorkflow</code>.</p>
|
|
792
|
+
*/
|
|
793
|
+
workflowArn: string | undefined;
|
|
794
|
+
/**
|
|
795
|
+
* <p>The timestamp of when the workflow was created.</p>
|
|
796
|
+
*/
|
|
797
|
+
createdAt: Date | undefined;
|
|
798
|
+
/**
|
|
799
|
+
* <p>The timestamp of when the workflow was last updated.</p>
|
|
800
|
+
*/
|
|
801
|
+
updatedAt: Date | undefined;
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
export interface ListMatchingWorkflowsOutput {
|
|
807
|
+
/**
|
|
808
|
+
* <p>A list of <code>MatchingWorkflowSummary</code> objects, each of which contain the fields
|
|
809
|
+
* <code>WorkflowName</code>, <code>WorkflowArn</code>, <code>CreatedAt</code>, and <code>UpdatedAt</code>.</p>
|
|
810
|
+
*/
|
|
811
|
+
workflowSummaries?: MatchingWorkflowSummary[];
|
|
812
|
+
/**
|
|
813
|
+
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
814
|
+
*/
|
|
815
|
+
nextToken?: string;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
export interface ListSchemaMappingsInput {
|
|
821
|
+
/**
|
|
822
|
+
* <p>The pagination token from the previous <code>ListSchemaMappings</code> API call.</p>
|
|
823
|
+
*/
|
|
824
|
+
nextToken?: string;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The maximum number of objects returned per page.</p>
|
|
827
|
+
*/
|
|
828
|
+
maxResults?: number;
|
|
829
|
+
}
|
|
830
|
+
/**
|
|
831
|
+
* @public
|
|
832
|
+
* <p>An object containing <code>SchemaName</code>, <code>SchemaArn</code>,
|
|
833
|
+
* <code>CreatedAt</code>, and<code>UpdatedAt</code>.</p>
|
|
834
|
+
*/
|
|
835
|
+
export interface SchemaMappingSummary {
|
|
836
|
+
/**
|
|
837
|
+
* <p>The name of the schema.</p>
|
|
838
|
+
*/
|
|
839
|
+
schemaName: string | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>The ARN (Amazon Resource Name) that Entity Resolution generated for the
|
|
842
|
+
* <code>SchemaMapping</code>.</p>
|
|
843
|
+
*/
|
|
844
|
+
schemaArn: string | undefined;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The timestamp of when the <code>SchemaMapping</code> was created.</p>
|
|
847
|
+
*/
|
|
848
|
+
createdAt: Date | undefined;
|
|
849
|
+
/**
|
|
850
|
+
* <p>The timestamp of when the <code>SchemaMapping</code> was last updated.</p>
|
|
851
|
+
*/
|
|
852
|
+
updatedAt: Date | undefined;
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
export interface ListSchemaMappingsOutput {
|
|
858
|
+
/**
|
|
859
|
+
* <p>A list of <code>SchemaMappingSummary</code> objects, each of which contain the fields
|
|
860
|
+
* <code>SchemaName</code>, <code>SchemaArn</code>, <code>CreatedAt</code>, <code>UpdatedAt</code>.</p>
|
|
861
|
+
*/
|
|
862
|
+
schemaList?: SchemaMappingSummary[];
|
|
863
|
+
/**
|
|
864
|
+
* <p>The pagination token from the previous <code>ListDomains</code> API call.</p>
|
|
865
|
+
*/
|
|
866
|
+
nextToken?: string;
|
|
867
|
+
}
|
|
868
|
+
/**
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
export interface ListTagsForResourceInput {
|
|
872
|
+
/**
|
|
873
|
+
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
874
|
+
*/
|
|
875
|
+
resourceArn: string | undefined;
|
|
876
|
+
}
|
|
877
|
+
/**
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
export interface ListTagsForResourceOutput {
|
|
881
|
+
/**
|
|
882
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
883
|
+
*/
|
|
884
|
+
tags: Record<string, string> | undefined;
|
|
885
|
+
}
|
|
886
|
+
/**
|
|
887
|
+
* @public
|
|
888
|
+
*/
|
|
889
|
+
export interface StartMatchingJobInput {
|
|
890
|
+
/**
|
|
891
|
+
* <p>The name of the matching job to be retrieved.</p>
|
|
892
|
+
*/
|
|
893
|
+
workflowName: string | undefined;
|
|
894
|
+
}
|
|
895
|
+
/**
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
export interface StartMatchingJobOutput {
|
|
899
|
+
/**
|
|
900
|
+
* <p>The ID of the job.</p>
|
|
901
|
+
*/
|
|
902
|
+
jobId: string | undefined;
|
|
903
|
+
}
|
|
904
|
+
/**
|
|
905
|
+
* @public
|
|
906
|
+
*/
|
|
907
|
+
export interface TagResourceInput {
|
|
908
|
+
/**
|
|
909
|
+
* <p>The ARN of the resource for which you want to view tags.</p>
|
|
910
|
+
*/
|
|
911
|
+
resourceArn: string | undefined;
|
|
912
|
+
/**
|
|
913
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
914
|
+
*/
|
|
915
|
+
tags: Record<string, string> | undefined;
|
|
916
|
+
}
|
|
917
|
+
/**
|
|
918
|
+
* @public
|
|
919
|
+
*/
|
|
920
|
+
export interface TagResourceOutput {
|
|
921
|
+
}
|
|
922
|
+
/**
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
export interface UntagResourceInput {
|
|
926
|
+
/**
|
|
927
|
+
* <p>The ARN of the resource for which you want to untag.</p>
|
|
928
|
+
*/
|
|
929
|
+
resourceArn: string | undefined;
|
|
930
|
+
/**
|
|
931
|
+
* <p>The list of tag keys to remove from the resource.</p>
|
|
932
|
+
*/
|
|
933
|
+
tagKeys: string[] | undefined;
|
|
934
|
+
}
|
|
935
|
+
/**
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
export interface UntagResourceOutput {
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
export interface UpdateMatchingWorkflowInput {
|
|
944
|
+
/**
|
|
945
|
+
* <p>The name of the workflow to be retrieved.</p>
|
|
946
|
+
*/
|
|
947
|
+
workflowName: string | undefined;
|
|
948
|
+
/**
|
|
949
|
+
* <p>A description of the workflow.</p>
|
|
950
|
+
*/
|
|
951
|
+
description?: string;
|
|
952
|
+
/**
|
|
953
|
+
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
954
|
+
* <code>SchemaName</code>.</p>
|
|
955
|
+
*/
|
|
956
|
+
inputSourceConfig: InputSource[] | undefined;
|
|
957
|
+
/**
|
|
958
|
+
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
959
|
+
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
960
|
+
*/
|
|
961
|
+
outputSourceConfig: OutputSource[] | undefined;
|
|
962
|
+
/**
|
|
963
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
964
|
+
* </p>
|
|
965
|
+
*/
|
|
966
|
+
resolutionTechniques: ResolutionTechniques | undefined;
|
|
967
|
+
/**
|
|
968
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
969
|
+
*/
|
|
970
|
+
incrementalRunConfig?: IncrementalRunConfig;
|
|
971
|
+
/**
|
|
972
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
973
|
+
* to create resources on your behalf as part of workflow execution.</p>
|
|
974
|
+
*/
|
|
975
|
+
roleArn: string | undefined;
|
|
976
|
+
}
|
|
977
|
+
/**
|
|
978
|
+
* @public
|
|
979
|
+
*/
|
|
980
|
+
export interface UpdateMatchingWorkflowOutput {
|
|
981
|
+
/**
|
|
982
|
+
* <p>The name of the workflow.</p>
|
|
983
|
+
*/
|
|
984
|
+
workflowName: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>A description of the workflow.</p>
|
|
987
|
+
*/
|
|
988
|
+
description?: string;
|
|
989
|
+
/**
|
|
990
|
+
* <p>A list of <code>InputSource</code> objects, which have the fields <code>InputSourceARN</code> and
|
|
991
|
+
* <code>SchemaName</code>.</p>
|
|
992
|
+
*/
|
|
993
|
+
inputSourceConfig: InputSource[] | undefined;
|
|
994
|
+
/**
|
|
995
|
+
* <p>A list of <code>OutputSource</code> objects, each of which contains fields <code>OutputS3Path</code>,
|
|
996
|
+
* <code>ApplyNormalization</code>, and <code>Output</code>.</p>
|
|
997
|
+
*/
|
|
998
|
+
outputSourceConfig: OutputSource[] | undefined;
|
|
999
|
+
/**
|
|
1000
|
+
* <p>An object which defines the <code>resolutionType</code> and the <code>ruleBasedProperties</code>
|
|
1001
|
+
* </p>
|
|
1002
|
+
*/
|
|
1003
|
+
resolutionTechniques: ResolutionTechniques | undefined;
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>An object which defines an incremental run type and has only <code>incrementalRunType</code> as a field.</p>
|
|
1006
|
+
*/
|
|
1007
|
+
incrementalRunConfig?: IncrementalRunConfig;
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role. AWS Entity Resolution assumes this role
|
|
1010
|
+
* to create resources on your behalf as part of workflow execution.</p>
|
|
1011
|
+
*/
|
|
1012
|
+
roleArn: string | undefined;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
* @internal
|
|
1016
|
+
*/
|
|
1017
|
+
export declare const GetMatchIdInputFilterSensitiveLog: (obj: GetMatchIdInput) => any;
|