@aws-sdk/client-entityresolution 3.428.0 → 3.429.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/README.md +104 -17
- package/dist-cjs/EntityResolution.js +22 -0
- package/dist-cjs/commands/CreateIdMappingWorkflowCommand.js +51 -0
- package/dist-cjs/commands/DeleteIdMappingWorkflowCommand.js +51 -0
- package/dist-cjs/commands/GetIdMappingJobCommand.js +51 -0
- package/dist-cjs/commands/GetIdMappingWorkflowCommand.js +51 -0
- package/dist-cjs/commands/GetProviderServiceCommand.js +51 -0
- package/dist-cjs/commands/ListIdMappingJobsCommand.js +51 -0
- package/dist-cjs/commands/ListIdMappingWorkflowsCommand.js +51 -0
- package/dist-cjs/commands/ListProviderServicesCommand.js +51 -0
- package/dist-cjs/commands/StartIdMappingJobCommand.js +51 -0
- package/dist-cjs/commands/UpdateIdMappingWorkflowCommand.js +51 -0
- package/dist-cjs/commands/UpdateSchemaMappingCommand.js +51 -0
- package/dist-cjs/commands/index.js +11 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +29 -12
- package/dist-cjs/pagination/ListIdMappingJobsPaginator.js +29 -0
- package/dist-cjs/pagination/ListIdMappingWorkflowsPaginator.js +29 -0
- package/dist-cjs/pagination/ListProviderServicesPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +917 -71
- package/dist-es/EntityResolution.js +22 -0
- package/dist-es/commands/CreateIdMappingWorkflowCommand.js +47 -0
- package/dist-es/commands/DeleteIdMappingWorkflowCommand.js +47 -0
- package/dist-es/commands/GetIdMappingJobCommand.js +47 -0
- package/dist-es/commands/GetIdMappingWorkflowCommand.js +47 -0
- package/dist-es/commands/GetProviderServiceCommand.js +47 -0
- package/dist-es/commands/ListIdMappingJobsCommand.js +47 -0
- package/dist-es/commands/ListIdMappingWorkflowsCommand.js +47 -0
- package/dist-es/commands/ListProviderServicesCommand.js +47 -0
- package/dist-es/commands/StartIdMappingJobCommand.js +47 -0
- package/dist-es/commands/UpdateIdMappingWorkflowCommand.js +47 -0
- package/dist-es/commands/UpdateSchemaMappingCommand.js +47 -0
- package/dist-es/commands/index.js +11 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +28 -11
- package/dist-es/pagination/ListIdMappingJobsPaginator.js +25 -0
- package/dist-es/pagination/ListIdMappingWorkflowsPaginator.js +25 -0
- package/dist-es/pagination/ListProviderServicesPaginator.js +25 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +908 -85
- package/dist-types/EntityResolution.d.ts +86 -10
- package/dist-types/EntityResolutionClient.d.ts +22 -12
- package/dist-types/commands/CreateIdMappingWorkflowCommand.d.ts +160 -0
- package/dist-types/commands/CreateMatchingWorkflowCommand.d.ts +34 -13
- package/dist-types/commands/CreateSchemaMappingCommand.d.ts +18 -10
- package/dist-types/commands/DeleteIdMappingWorkflowCommand.d.ts +94 -0
- package/dist-types/commands/DeleteMatchingWorkflowCommand.d.ts +10 -6
- package/dist-types/commands/DeleteSchemaMappingCommand.d.ts +15 -9
- package/dist-types/commands/GetIdMappingJobCommand.d.ts +110 -0
- package/dist-types/commands/GetIdMappingWorkflowCommand.d.ts +127 -0
- package/dist-types/commands/GetMatchIdCommand.d.ts +10 -5
- package/dist-types/commands/GetMatchingJobCommand.d.ts +10 -5
- package/dist-types/commands/GetMatchingWorkflowCommand.d.ts +16 -5
- package/dist-types/commands/GetProviderServiceCommand.d.ts +121 -0
- package/dist-types/commands/GetSchemaMappingCommand.d.ts +11 -5
- package/dist-types/commands/ListIdMappingJobsCommand.d.ts +107 -0
- package/dist-types/commands/ListIdMappingWorkflowsCommand.d.ts +103 -0
- package/dist-types/commands/ListMatchingJobsCommand.d.ts +8 -4
- package/dist-types/commands/ListMatchingWorkflowsCommand.d.ts +11 -5
- package/dist-types/commands/ListProviderServicesCommand.d.ts +105 -0
- package/dist-types/commands/ListSchemaMappingsCommand.d.ts +11 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -5
- package/dist-types/commands/StartIdMappingJobCommand.d.ts +110 -0
- package/dist-types/commands/StartMatchingJobCommand.d.ts +16 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -9
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIdMappingWorkflowCommand.d.ts +149 -0
- package/dist-types/commands/UpdateMatchingWorkflowCommand.d.ts +27 -9
- package/dist-types/commands/UpdateSchemaMappingCommand.d.ts +128 -0
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/index.d.ts +9 -10
- package/dist-types/models/models_0.d.ts +1128 -234
- package/dist-types/pagination/ListIdMappingJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIdMappingWorkflowsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListProviderServicesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/EntityResolution.d.ts +187 -0
- package/dist-types/ts3.4/EntityResolutionClient.d.ts +68 -2
- package/dist-types/ts3.4/commands/CreateIdMappingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteIdMappingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetIdMappingJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetIdMappingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetProviderServiceCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListIdMappingJobsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListIdMappingWorkflowsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListProviderServicesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartIdMappingJobCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateIdMappingWorkflowCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateSchemaMappingCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/models_0.d.ts +268 -55
- package/dist-types/ts3.4/pagination/ListIdMappingJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListIdMappingWorkflowsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListProviderServicesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +5 -5
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
|
|
5
|
+
import { DeleteIdMappingWorkflowInput, DeleteIdMappingWorkflowOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteIdMappingWorkflowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteIdMappingWorkflowCommandInput extends DeleteIdMappingWorkflowInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteIdMappingWorkflowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteIdMappingWorkflowCommandOutput extends DeleteIdMappingWorkflowOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Deletes the <code>IdMappingWorkflow</code> with a given name. This operation will
|
|
27
|
+
* succeed even if a workflow with the given name does not exist.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EntityResolutionClient, DeleteIdMappingWorkflowCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
|
|
32
|
+
* // const { EntityResolutionClient, DeleteIdMappingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
|
|
33
|
+
* const client = new EntityResolutionClient(config);
|
|
34
|
+
* const input = { // DeleteIdMappingWorkflowInput
|
|
35
|
+
* workflowName: "STRING_VALUE", // required
|
|
36
|
+
* };
|
|
37
|
+
* const command = new DeleteIdMappingWorkflowCommand(input);
|
|
38
|
+
* const response = await client.send(command);
|
|
39
|
+
* // { // DeleteIdMappingWorkflowOutput
|
|
40
|
+
* // message: "STRING_VALUE", // required
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @param DeleteIdMappingWorkflowCommandInput - {@link DeleteIdMappingWorkflowCommandInput}
|
|
46
|
+
* @returns {@link DeleteIdMappingWorkflowCommandOutput}
|
|
47
|
+
* @see {@link DeleteIdMappingWorkflowCommandInput} for command's `input` shape.
|
|
48
|
+
* @see {@link DeleteIdMappingWorkflowCommandOutput} for command's `response` shape.
|
|
49
|
+
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
50
|
+
*
|
|
51
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
52
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
53
|
+
* 403</code>
|
|
54
|
+
* </p>
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InternalServerException} (server fault)
|
|
57
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
58
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
59
|
+
* </p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
62
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
63
|
+
* 429</code>
|
|
64
|
+
* </p>
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link ValidationException} (client fault)
|
|
67
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
68
|
+
* Status Code: 400</code>
|
|
69
|
+
* </p>
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link EntityResolutionServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from EntityResolution service.</p>
|
|
73
|
+
*
|
|
74
|
+
*/
|
|
75
|
+
export declare class DeleteIdMappingWorkflowCommand extends $Command<DeleteIdMappingWorkflowCommandInput, DeleteIdMappingWorkflowCommandOutput, EntityResolutionClientResolvedConfig> {
|
|
76
|
+
readonly input: DeleteIdMappingWorkflowCommandInput;
|
|
77
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
constructor(input: DeleteIdMappingWorkflowCommandInput);
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
85
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteIdMappingWorkflowCommandInput, DeleteIdMappingWorkflowCommandOutput>;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
89
|
+
private serialize;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
93
|
+
private deserialize;
|
|
94
|
+
}
|
|
@@ -23,8 +23,8 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes the <code>MatchingWorkflow</code> with a given name. This operation will succeed
|
|
27
|
-
* workflow with the given name does not exist.</p>
|
|
26
|
+
* <p>Deletes the <code>MatchingWorkflow</code> with a given name. This operation will succeed
|
|
27
|
+
* even if a workflow with the given name does not exist.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -49,19 +49,23 @@ export interface DeleteMatchingWorkflowCommandOutput extends DeleteMatchingWorkf
|
|
|
49
49
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
50
50
|
*
|
|
51
51
|
* @throws {@link AccessDeniedException} (client fault)
|
|
52
|
-
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
52
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
53
|
+
* 403</code>
|
|
53
54
|
* </p>
|
|
54
55
|
*
|
|
55
56
|
* @throws {@link InternalServerException} (server fault)
|
|
56
|
-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
57
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
58
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
57
59
|
* </p>
|
|
58
60
|
*
|
|
59
61
|
* @throws {@link ThrottlingException} (client fault)
|
|
60
|
-
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
62
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
63
|
+
* 429</code>
|
|
61
64
|
* </p>
|
|
62
65
|
*
|
|
63
66
|
* @throws {@link ValidationException} (client fault)
|
|
64
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
67
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
68
|
+
* Status Code: 400</code>
|
|
65
69
|
* </p>
|
|
66
70
|
*
|
|
67
71
|
* @throws {@link EntityResolutionServiceException}
|
|
@@ -23,9 +23,10 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes the <code>SchemaMapping</code> with a given name. This operation will succeed
|
|
27
|
-
* with the given name does not exist. This operation will fail if there is a
|
|
28
|
-
*
|
|
26
|
+
* <p>Deletes the <code>SchemaMapping</code> with a given name. This operation will succeed
|
|
27
|
+
* even if a schema with the given name does not exist. This operation will fail if there is a
|
|
28
|
+
* <code>MatchingWorkflow</code> object that references the <code>SchemaMapping</code> in
|
|
29
|
+
* the workflow's <code>InputSourceConfig</code>.</p>
|
|
29
30
|
* @example
|
|
30
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
32
|
* ```javascript
|
|
@@ -50,24 +51,29 @@ export interface DeleteSchemaMappingCommandOutput extends DeleteSchemaMappingOut
|
|
|
50
51
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
51
52
|
*
|
|
52
53
|
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
-
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
54
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
55
|
+
* 403</code>
|
|
54
56
|
* </p>
|
|
55
57
|
*
|
|
56
58
|
* @throws {@link ConflictException} (client fault)
|
|
57
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
58
|
-
*
|
|
59
|
+
* <p>The request could not be processed because of conflict in the current state of the
|
|
60
|
+
* resource. Example: Workflow already exists, Schema already exists, Workflow is currently
|
|
61
|
+
* running, etc. <code>HTTP Status Code: 400</code>
|
|
59
62
|
* </p>
|
|
60
63
|
*
|
|
61
64
|
* @throws {@link InternalServerException} (server fault)
|
|
62
|
-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
65
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
66
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
63
67
|
* </p>
|
|
64
68
|
*
|
|
65
69
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
-
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
70
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
71
|
+
* 429</code>
|
|
67
72
|
* </p>
|
|
68
73
|
*
|
|
69
74
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
75
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
76
|
+
* Status Code: 400</code>
|
|
71
77
|
* </p>
|
|
72
78
|
*
|
|
73
79
|
* @throws {@link EntityResolutionServiceException}
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
|
|
5
|
+
import { GetIdMappingJobInput, GetIdMappingJobOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetIdMappingJobCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetIdMappingJobCommandInput extends GetIdMappingJobInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetIdMappingJobCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetIdMappingJobCommandOutput extends GetIdMappingJobOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Gets the status, metrics, and errors (if there are any) that are associated with a
|
|
27
|
+
* job.</p>
|
|
28
|
+
* @example
|
|
29
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
30
|
+
* ```javascript
|
|
31
|
+
* import { EntityResolutionClient, GetIdMappingJobCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
|
|
32
|
+
* // const { EntityResolutionClient, GetIdMappingJobCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
|
|
33
|
+
* const client = new EntityResolutionClient(config);
|
|
34
|
+
* const input = { // GetIdMappingJobInput
|
|
35
|
+
* workflowName: "STRING_VALUE", // required
|
|
36
|
+
* jobId: "STRING_VALUE", // required
|
|
37
|
+
* };
|
|
38
|
+
* const command = new GetIdMappingJobCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // GetIdMappingJobOutput
|
|
41
|
+
* // jobId: "STRING_VALUE", // required
|
|
42
|
+
* // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "QUEUED", // required
|
|
43
|
+
* // startTime: new Date("TIMESTAMP"), // required
|
|
44
|
+
* // endTime: new Date("TIMESTAMP"),
|
|
45
|
+
* // metrics: { // IdMappingJobMetrics
|
|
46
|
+
* // inputRecords: Number("int"),
|
|
47
|
+
* // totalRecordsProcessed: Number("int"),
|
|
48
|
+
* // recordsNotProcessed: Number("int"),
|
|
49
|
+
* // },
|
|
50
|
+
* // errorDetails: { // ErrorDetails
|
|
51
|
+
* // errorMessage: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param GetIdMappingJobCommandInput - {@link GetIdMappingJobCommandInput}
|
|
58
|
+
* @returns {@link GetIdMappingJobCommandOutput}
|
|
59
|
+
* @see {@link GetIdMappingJobCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link GetIdMappingJobCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
65
|
+
* 403</code>
|
|
66
|
+
* </p>
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerException} (server fault)
|
|
69
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
70
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
71
|
+
* </p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
74
|
+
* <p>The resource could not be found. <code>HTTP Status Code: 404</code>
|
|
75
|
+
* </p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
78
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
79
|
+
* 429</code>
|
|
80
|
+
* </p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ValidationException} (client fault)
|
|
83
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
84
|
+
* Status Code: 400</code>
|
|
85
|
+
* </p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link EntityResolutionServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from EntityResolution service.</p>
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
export declare class GetIdMappingJobCommand extends $Command<GetIdMappingJobCommandInput, GetIdMappingJobCommandOutput, EntityResolutionClientResolvedConfig> {
|
|
92
|
+
readonly input: GetIdMappingJobCommandInput;
|
|
93
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
94
|
+
/**
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
constructor(input: GetIdMappingJobCommandInput);
|
|
98
|
+
/**
|
|
99
|
+
* @internal
|
|
100
|
+
*/
|
|
101
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIdMappingJobCommandInput, GetIdMappingJobCommandOutput>;
|
|
102
|
+
/**
|
|
103
|
+
* @internal
|
|
104
|
+
*/
|
|
105
|
+
private serialize;
|
|
106
|
+
/**
|
|
107
|
+
* @internal
|
|
108
|
+
*/
|
|
109
|
+
private deserialize;
|
|
110
|
+
}
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
|
|
5
|
+
import { GetIdMappingWorkflowInput, GetIdMappingWorkflowOutput } from "../models/models_0";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetIdMappingWorkflowCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetIdMappingWorkflowCommandInput extends GetIdMappingWorkflowInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetIdMappingWorkflowCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetIdMappingWorkflowCommandOutput extends GetIdMappingWorkflowOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Returns the <code>IdMappingWorkflow</code> with a given name, if it exists.</p>
|
|
27
|
+
* @example
|
|
28
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
29
|
+
* ```javascript
|
|
30
|
+
* import { EntityResolutionClient, GetIdMappingWorkflowCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
|
|
31
|
+
* // const { EntityResolutionClient, GetIdMappingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
|
|
32
|
+
* const client = new EntityResolutionClient(config);
|
|
33
|
+
* const input = { // GetIdMappingWorkflowInput
|
|
34
|
+
* workflowName: "STRING_VALUE", // required
|
|
35
|
+
* };
|
|
36
|
+
* const command = new GetIdMappingWorkflowCommand(input);
|
|
37
|
+
* const response = await client.send(command);
|
|
38
|
+
* // { // GetIdMappingWorkflowOutput
|
|
39
|
+
* // workflowName: "STRING_VALUE", // required
|
|
40
|
+
* // workflowArn: "STRING_VALUE", // required
|
|
41
|
+
* // description: "STRING_VALUE",
|
|
42
|
+
* // inputSourceConfig: [ // IdMappingWorkflowInputSourceConfig // required
|
|
43
|
+
* // { // IdMappingWorkflowInputSource
|
|
44
|
+
* // inputSourceARN: "STRING_VALUE", // required
|
|
45
|
+
* // schemaName: "STRING_VALUE", // required
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // outputSourceConfig: [ // IdMappingWorkflowOutputSourceConfig // required
|
|
49
|
+
* // { // IdMappingWorkflowOutputSource
|
|
50
|
+
* // outputS3Path: "STRING_VALUE", // required
|
|
51
|
+
* // KMSArn: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // idMappingTechniques: { // IdMappingTechniques
|
|
55
|
+
* // idMappingType: "PROVIDER", // required
|
|
56
|
+
* // providerProperties: { // ProviderProperties
|
|
57
|
+
* // providerServiceArn: "STRING_VALUE", // required
|
|
58
|
+
* // providerConfiguration: "DOCUMENT_VALUE",
|
|
59
|
+
* // intermediateSourceConfiguration: { // IntermediateSourceConfiguration
|
|
60
|
+
* // intermediateS3Path: "STRING_VALUE", // required
|
|
61
|
+
* // },
|
|
62
|
+
* // },
|
|
63
|
+
* // },
|
|
64
|
+
* // createdAt: new Date("TIMESTAMP"), // required
|
|
65
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
66
|
+
* // roleArn: "STRING_VALUE", // required
|
|
67
|
+
* // tags: { // TagMap
|
|
68
|
+
* // "<keys>": "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param GetIdMappingWorkflowCommandInput - {@link GetIdMappingWorkflowCommandInput}
|
|
75
|
+
* @returns {@link GetIdMappingWorkflowCommandOutput}
|
|
76
|
+
* @see {@link GetIdMappingWorkflowCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link GetIdMappingWorkflowCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
81
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
82
|
+
* 403</code>
|
|
83
|
+
* </p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerException} (server fault)
|
|
86
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
87
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
88
|
+
* </p>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>The resource could not be found. <code>HTTP Status Code: 404</code>
|
|
92
|
+
* </p>
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
95
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
96
|
+
* 429</code>
|
|
97
|
+
* </p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link ValidationException} (client fault)
|
|
100
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
101
|
+
* Status Code: 400</code>
|
|
102
|
+
* </p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link EntityResolutionServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from EntityResolution service.</p>
|
|
106
|
+
*
|
|
107
|
+
*/
|
|
108
|
+
export declare class GetIdMappingWorkflowCommand extends $Command<GetIdMappingWorkflowCommandInput, GetIdMappingWorkflowCommandOutput, EntityResolutionClientResolvedConfig> {
|
|
109
|
+
readonly input: GetIdMappingWorkflowCommandInput;
|
|
110
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
111
|
+
/**
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
constructor(input: GetIdMappingWorkflowCommandInput);
|
|
115
|
+
/**
|
|
116
|
+
* @internal
|
|
117
|
+
*/
|
|
118
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetIdMappingWorkflowCommandInput, GetIdMappingWorkflowCommandOutput>;
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
private serialize;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private deserialize;
|
|
127
|
+
}
|
|
@@ -23,7 +23,8 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the corresponding Match ID of a customer record if the record has been
|
|
26
|
+
* <p>Returns the corresponding Match ID of a customer record if the record has been
|
|
27
|
+
* processed.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -51,11 +52,13 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
|
|
|
51
52
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
52
53
|
*
|
|
53
54
|
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
-
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
55
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
56
|
+
* 403</code>
|
|
55
57
|
* </p>
|
|
56
58
|
*
|
|
57
59
|
* @throws {@link InternalServerException} (server fault)
|
|
58
|
-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
60
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
61
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
59
62
|
* </p>
|
|
60
63
|
*
|
|
61
64
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
@@ -63,11 +66,13 @@ export interface GetMatchIdCommandOutput extends GetMatchIdOutput, __MetadataBea
|
|
|
63
66
|
* </p>
|
|
64
67
|
*
|
|
65
68
|
* @throws {@link ThrottlingException} (client fault)
|
|
66
|
-
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
69
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
70
|
+
* 429</code>
|
|
67
71
|
* </p>
|
|
68
72
|
*
|
|
69
73
|
* @throws {@link ValidationException} (client fault)
|
|
70
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
74
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
75
|
+
* Status Code: 400</code>
|
|
71
76
|
* </p>
|
|
72
77
|
*
|
|
73
78
|
* @throws {@link EntityResolutionServiceException}
|
|
@@ -23,7 +23,8 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Gets the status, metrics, and errors (if there are any) that are associated with a
|
|
26
|
+
* <p>Gets the status, metrics, and errors (if there are any) that are associated with a
|
|
27
|
+
* job.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -61,11 +62,13 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
|
|
|
61
62
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
62
63
|
*
|
|
63
64
|
* @throws {@link AccessDeniedException} (client fault)
|
|
64
|
-
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
65
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
66
|
+
* 403</code>
|
|
65
67
|
* </p>
|
|
66
68
|
*
|
|
67
69
|
* @throws {@link InternalServerException} (server fault)
|
|
68
|
-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
70
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
71
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
69
72
|
* </p>
|
|
70
73
|
*
|
|
71
74
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
@@ -73,11 +76,13 @@ export interface GetMatchingJobCommandOutput extends GetMatchingJobOutput, __Met
|
|
|
73
76
|
* </p>
|
|
74
77
|
*
|
|
75
78
|
* @throws {@link ThrottlingException} (client fault)
|
|
76
|
-
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
79
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
80
|
+
* 429</code>
|
|
77
81
|
* </p>
|
|
78
82
|
*
|
|
79
83
|
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
84
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
85
|
+
* Status Code: 400</code>
|
|
81
86
|
* </p>
|
|
82
87
|
*
|
|
83
88
|
* @throws {@link EntityResolutionServiceException}
|
|
@@ -60,7 +60,7 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
|
|
|
60
60
|
* // },
|
|
61
61
|
* // ],
|
|
62
62
|
* // resolutionTechniques: { // ResolutionTechniques
|
|
63
|
-
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
|
|
63
|
+
* // resolutionType: "RULE_MATCHING" || "ML_MATCHING" || "PROVIDER", // required
|
|
64
64
|
* // ruleBasedProperties: { // RuleBasedProperties
|
|
65
65
|
* // rules: [ // RuleList // required
|
|
66
66
|
* // { // Rule
|
|
@@ -72,6 +72,13 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
|
|
|
72
72
|
* // ],
|
|
73
73
|
* // attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
|
|
74
74
|
* // },
|
|
75
|
+
* // providerProperties: { // ProviderProperties
|
|
76
|
+
* // providerServiceArn: "STRING_VALUE", // required
|
|
77
|
+
* // providerConfiguration: "DOCUMENT_VALUE",
|
|
78
|
+
* // intermediateSourceConfiguration: { // IntermediateSourceConfiguration
|
|
79
|
+
* // intermediateS3Path: "STRING_VALUE", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
75
82
|
* // },
|
|
76
83
|
* // createdAt: new Date("TIMESTAMP"), // required
|
|
77
84
|
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
@@ -93,11 +100,13 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
|
|
|
93
100
|
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
|
|
94
101
|
*
|
|
95
102
|
* @throws {@link AccessDeniedException} (client fault)
|
|
96
|
-
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
103
|
+
* <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
|
|
104
|
+
* 403</code>
|
|
97
105
|
* </p>
|
|
98
106
|
*
|
|
99
107
|
* @throws {@link InternalServerException} (server fault)
|
|
100
|
-
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
108
|
+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
|
|
109
|
+
* service. <code>HTTP Status Code: 500</code>
|
|
101
110
|
* </p>
|
|
102
111
|
*
|
|
103
112
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
@@ -105,11 +114,13 @@ export interface GetMatchingWorkflowCommandOutput extends GetMatchingWorkflowOut
|
|
|
105
114
|
* </p>
|
|
106
115
|
*
|
|
107
116
|
* @throws {@link ThrottlingException} (client fault)
|
|
108
|
-
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
117
|
+
* <p>The request was denied due to request throttling. <code>HTTP Status Code:
|
|
118
|
+
* 429</code>
|
|
109
119
|
* </p>
|
|
110
120
|
*
|
|
111
121
|
* @throws {@link ValidationException} (client fault)
|
|
112
|
-
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
122
|
+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
|
|
123
|
+
* Status Code: 400</code>
|
|
113
124
|
* </p>
|
|
114
125
|
*
|
|
115
126
|
* @throws {@link EntityResolutionServiceException}
|