@aws-sdk/client-entityresolution 3.428.0 → 3.430.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (99) hide show
  1. package/README.md +104 -17
  2. package/dist-cjs/EntityResolution.js +22 -0
  3. package/dist-cjs/commands/CreateIdMappingWorkflowCommand.js +51 -0
  4. package/dist-cjs/commands/DeleteIdMappingWorkflowCommand.js +51 -0
  5. package/dist-cjs/commands/GetIdMappingJobCommand.js +51 -0
  6. package/dist-cjs/commands/GetIdMappingWorkflowCommand.js +51 -0
  7. package/dist-cjs/commands/GetProviderServiceCommand.js +51 -0
  8. package/dist-cjs/commands/ListIdMappingJobsCommand.js +51 -0
  9. package/dist-cjs/commands/ListIdMappingWorkflowsCommand.js +51 -0
  10. package/dist-cjs/commands/ListProviderServicesCommand.js +51 -0
  11. package/dist-cjs/commands/StartIdMappingJobCommand.js +51 -0
  12. package/dist-cjs/commands/UpdateIdMappingWorkflowCommand.js +51 -0
  13. package/dist-cjs/commands/UpdateSchemaMappingCommand.js +51 -0
  14. package/dist-cjs/commands/index.js +11 -0
  15. package/dist-cjs/endpoint/ruleset.js +3 -3
  16. package/dist-cjs/models/models_0.js +29 -12
  17. package/dist-cjs/pagination/ListIdMappingJobsPaginator.js +29 -0
  18. package/dist-cjs/pagination/ListIdMappingWorkflowsPaginator.js +29 -0
  19. package/dist-cjs/pagination/ListProviderServicesPaginator.js +29 -0
  20. package/dist-cjs/pagination/index.js +3 -0
  21. package/dist-cjs/protocols/Aws_restJson1.js +917 -71
  22. package/dist-es/EntityResolution.js +22 -0
  23. package/dist-es/commands/CreateIdMappingWorkflowCommand.js +47 -0
  24. package/dist-es/commands/DeleteIdMappingWorkflowCommand.js +47 -0
  25. package/dist-es/commands/GetIdMappingJobCommand.js +47 -0
  26. package/dist-es/commands/GetIdMappingWorkflowCommand.js +47 -0
  27. package/dist-es/commands/GetProviderServiceCommand.js +47 -0
  28. package/dist-es/commands/ListIdMappingJobsCommand.js +47 -0
  29. package/dist-es/commands/ListIdMappingWorkflowsCommand.js +47 -0
  30. package/dist-es/commands/ListProviderServicesCommand.js +47 -0
  31. package/dist-es/commands/StartIdMappingJobCommand.js +47 -0
  32. package/dist-es/commands/UpdateIdMappingWorkflowCommand.js +47 -0
  33. package/dist-es/commands/UpdateSchemaMappingCommand.js +47 -0
  34. package/dist-es/commands/index.js +11 -0
  35. package/dist-es/endpoint/ruleset.js +3 -3
  36. package/dist-es/models/models_0.js +28 -11
  37. package/dist-es/pagination/ListIdMappingJobsPaginator.js +25 -0
  38. package/dist-es/pagination/ListIdMappingWorkflowsPaginator.js +25 -0
  39. package/dist-es/pagination/ListProviderServicesPaginator.js +25 -0
  40. package/dist-es/pagination/index.js +3 -0
  41. package/dist-es/protocols/Aws_restJson1.js +908 -85
  42. package/dist-types/EntityResolution.d.ts +86 -10
  43. package/dist-types/EntityResolutionClient.d.ts +22 -12
  44. package/dist-types/commands/CreateIdMappingWorkflowCommand.d.ts +160 -0
  45. package/dist-types/commands/CreateMatchingWorkflowCommand.d.ts +34 -13
  46. package/dist-types/commands/CreateSchemaMappingCommand.d.ts +18 -10
  47. package/dist-types/commands/DeleteIdMappingWorkflowCommand.d.ts +94 -0
  48. package/dist-types/commands/DeleteMatchingWorkflowCommand.d.ts +10 -6
  49. package/dist-types/commands/DeleteSchemaMappingCommand.d.ts +15 -9
  50. package/dist-types/commands/GetIdMappingJobCommand.d.ts +110 -0
  51. package/dist-types/commands/GetIdMappingWorkflowCommand.d.ts +127 -0
  52. package/dist-types/commands/GetMatchIdCommand.d.ts +10 -5
  53. package/dist-types/commands/GetMatchingJobCommand.d.ts +10 -5
  54. package/dist-types/commands/GetMatchingWorkflowCommand.d.ts +16 -5
  55. package/dist-types/commands/GetProviderServiceCommand.d.ts +121 -0
  56. package/dist-types/commands/GetSchemaMappingCommand.d.ts +11 -5
  57. package/dist-types/commands/ListIdMappingJobsCommand.d.ts +107 -0
  58. package/dist-types/commands/ListIdMappingWorkflowsCommand.d.ts +103 -0
  59. package/dist-types/commands/ListMatchingJobsCommand.d.ts +8 -4
  60. package/dist-types/commands/ListMatchingWorkflowsCommand.d.ts +11 -5
  61. package/dist-types/commands/ListProviderServicesCommand.d.ts +105 -0
  62. package/dist-types/commands/ListSchemaMappingsCommand.d.ts +11 -5
  63. package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -5
  64. package/dist-types/commands/StartIdMappingJobCommand.d.ts +110 -0
  65. package/dist-types/commands/StartMatchingJobCommand.d.ts +16 -10
  66. package/dist-types/commands/TagResourceCommand.d.ts +11 -9
  67. package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
  68. package/dist-types/commands/UpdateIdMappingWorkflowCommand.d.ts +149 -0
  69. package/dist-types/commands/UpdateMatchingWorkflowCommand.d.ts +27 -9
  70. package/dist-types/commands/UpdateSchemaMappingCommand.d.ts +128 -0
  71. package/dist-types/commands/index.d.ts +11 -0
  72. package/dist-types/index.d.ts +9 -10
  73. package/dist-types/models/models_0.d.ts +1128 -234
  74. package/dist-types/pagination/ListIdMappingJobsPaginator.d.ts +7 -0
  75. package/dist-types/pagination/ListIdMappingWorkflowsPaginator.d.ts +7 -0
  76. package/dist-types/pagination/ListProviderServicesPaginator.d.ts +7 -0
  77. package/dist-types/pagination/index.d.ts +3 -0
  78. package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
  79. package/dist-types/ts3.4/EntityResolution.d.ts +187 -0
  80. package/dist-types/ts3.4/EntityResolutionClient.d.ts +68 -2
  81. package/dist-types/ts3.4/commands/CreateIdMappingWorkflowCommand.d.ts +42 -0
  82. package/dist-types/ts3.4/commands/DeleteIdMappingWorkflowCommand.d.ts +42 -0
  83. package/dist-types/ts3.4/commands/GetIdMappingJobCommand.d.ts +38 -0
  84. package/dist-types/ts3.4/commands/GetIdMappingWorkflowCommand.d.ts +42 -0
  85. package/dist-types/ts3.4/commands/GetProviderServiceCommand.d.ts +39 -0
  86. package/dist-types/ts3.4/commands/ListIdMappingJobsCommand.d.ts +38 -0
  87. package/dist-types/ts3.4/commands/ListIdMappingWorkflowsCommand.d.ts +42 -0
  88. package/dist-types/ts3.4/commands/ListProviderServicesCommand.d.ts +42 -0
  89. package/dist-types/ts3.4/commands/StartIdMappingJobCommand.d.ts +38 -0
  90. package/dist-types/ts3.4/commands/UpdateIdMappingWorkflowCommand.d.ts +42 -0
  91. package/dist-types/ts3.4/commands/UpdateSchemaMappingCommand.d.ts +39 -0
  92. package/dist-types/ts3.4/commands/index.d.ts +11 -0
  93. package/dist-types/ts3.4/models/models_0.d.ts +268 -55
  94. package/dist-types/ts3.4/pagination/ListIdMappingJobsPaginator.d.ts +11 -0
  95. package/dist-types/ts3.4/pagination/ListIdMappingWorkflowsPaginator.d.ts +11 -0
  96. package/dist-types/ts3.4/pagination/ListProviderServicesPaginator.d.ts +11 -0
  97. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  98. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
  99. package/package.json +11 -11
@@ -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 { StartIdMappingJobInput, StartIdMappingJobOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartIdMappingJobCommand}.
14
+ */
15
+ export interface StartIdMappingJobCommandInput extends StartIdMappingJobInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartIdMappingJobCommand}.
21
+ */
22
+ export interface StartIdMappingJobCommandOutput extends StartIdMappingJobOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Starts the <code>IdMappingJob</code> of a workflow. The workflow must have previously
27
+ * been created using the <code>CreateIdMappingWorkflow</code> endpoint.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { EntityResolutionClient, StartIdMappingJobCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
32
+ * // const { EntityResolutionClient, StartIdMappingJobCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
33
+ * const client = new EntityResolutionClient(config);
34
+ * const input = { // StartIdMappingJobInput
35
+ * workflowName: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new StartIdMappingJobCommand(input);
38
+ * const response = await client.send(command);
39
+ * // { // StartIdMappingJobOutput
40
+ * // jobId: "STRING_VALUE", // required
41
+ * // };
42
+ *
43
+ * ```
44
+ *
45
+ * @param StartIdMappingJobCommandInput - {@link StartIdMappingJobCommandInput}
46
+ * @returns {@link StartIdMappingJobCommandOutput}
47
+ * @see {@link StartIdMappingJobCommandInput} for command's `input` shape.
48
+ * @see {@link StartIdMappingJobCommandOutput} 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 ConflictException} (client fault)
57
+ * <p>The request could not be processed because of conflict in the current state of the
58
+ * resource. Example: Workflow already exists, Schema already exists, Workflow is currently
59
+ * running, etc. <code>HTTP Status Code: 400</code>
60
+ * </p>
61
+ *
62
+ * @throws {@link ExceedsLimitException} (client fault)
63
+ * <p>The request was rejected because it attempted to create resources beyond the current
64
+ * Entity Resolution account limits. The error message describes the limit exceeded.
65
+ * <code>HTTP Status Code: 402</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 StartIdMappingJobCommand extends $Command<StartIdMappingJobCommandInput, StartIdMappingJobCommandOutput, EntityResolutionClientResolvedConfig> {
92
+ readonly input: StartIdMappingJobCommandInput;
93
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
94
+ /**
95
+ * @public
96
+ */
97
+ constructor(input: StartIdMappingJobCommandInput);
98
+ /**
99
+ * @internal
100
+ */
101
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartIdMappingJobCommandInput, StartIdMappingJobCommandOutput>;
102
+ /**
103
+ * @internal
104
+ */
105
+ private serialize;
106
+ /**
107
+ * @internal
108
+ */
109
+ private deserialize;
110
+ }
@@ -23,8 +23,8 @@ export interface StartMatchingJobCommandOutput extends StartMatchingJobOutput, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Starts the <code>MatchingJob</code> of a workflow. The workflow must have previously been created
27
- * using the <code>CreateMatchingWorkflow</code> endpoint.</p>
26
+ * <p>Starts the <code>MatchingJob</code> of a workflow. The workflow must have previously
27
+ * been created using the <code>CreateMatchingWorkflow</code> endpoint.</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,21 +49,25 @@ export interface StartMatchingJobCommandOutput extends StartMatchingJobOutput, _
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: 403</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 ConflictException} (client fault)
56
- * <p>The request could not be processed because of conflict in the current state of the resource. Example: Workflow already exists,
57
- * Schema already exists, Workflow is currently running, etc. <code>HTTP Status Code: 400</code>
57
+ * <p>The request could not be processed because of conflict in the current state of the
58
+ * resource. Example: Workflow already exists, Schema already exists, Workflow is currently
59
+ * running, etc. <code>HTTP Status Code: 400</code>
58
60
  * </p>
59
61
  *
60
62
  * @throws {@link ExceedsLimitException} (client fault)
61
- * <p>The request was rejected because it attempted to create resources beyond the current Entity Resolution account limits.
62
- * The error message describes the limit exceeded. <code>HTTP Status Code: 402</code>
63
+ * <p>The request was rejected because it attempted to create resources beyond the current
64
+ * Entity Resolution account limits. The error message describes the limit exceeded.
65
+ * <code>HTTP Status Code: 402</code>
63
66
  * </p>
64
67
  *
65
68
  * @throws {@link InternalServerException} (server fault)
66
- * <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
69
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
70
+ * service. <code>HTTP Status Code: 500</code>
67
71
  * </p>
68
72
  *
69
73
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -71,11 +75,13 @@ export interface StartMatchingJobCommandOutput extends StartMatchingJobOutput, _
71
75
  * </p>
72
76
  *
73
77
  * @throws {@link ThrottlingException} (client fault)
74
- * <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
78
+ * <p>The request was denied due to request throttling. <code>HTTP Status Code:
79
+ * 429</code>
75
80
  * </p>
76
81
  *
77
82
  * @throws {@link ValidationException} (client fault)
78
- * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
83
+ * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
84
+ * Status Code: 400</code>
79
85
  * </p>
80
86
  *
81
87
  * @throws {@link EntityResolutionServiceException}
@@ -23,13 +23,13 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Assigns one or more tags (key-value pairs) to the specified Entity Resolution
27
- * resource. Tags can help you organize and categorize your resources. You can also use them
28
- * to scope user permissions by granting a user permission to access or change only resources
29
- * with certain tag values. In Entity Resolution, <code>SchemaMapping</code> and
30
- * <code>MatchingWorkflow</code> can be tagged. Tags don't have any semantic meaning to Amazon Web Services
31
- * and are interpreted strictly as strings of characters. You can use the
32
- * <code>TagResource</code> action with a resource that already has tags. If you specify a
26
+ * <p>Assigns one or more tags (key-value pairs) to the specified Entity Resolution resource.
27
+ * Tags can help you organize and categorize your resources. You can also use them to scope
28
+ * user permissions by granting a user permission to access or change only resources with
29
+ * certain tag values. In Entity Resolution, <code>SchemaMapping</code> and
30
+ * <code>MatchingWorkflow</code> can be tagged. Tags don't have any semantic meaning to
31
+ * Amazon Web Services and are interpreted strictly as strings of characters. You can use
32
+ * the <code>TagResource</code> action with a resource that already has tags. If you specify a
33
33
  * new tag key, this tag is appended to the list of tags associated with the resource. If you
34
34
  * specify a tag key that is already associated with the resource, the new tag value that you
35
35
  * specify replaces the previous value for that tag.</p>
@@ -58,7 +58,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
58
58
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
59
59
  *
60
60
  * @throws {@link InternalServerException} (server fault)
61
- * <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
61
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
62
+ * service. <code>HTTP Status Code: 500</code>
62
63
  * </p>
63
64
  *
64
65
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -66,7 +67,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
66
67
  * </p>
67
68
  *
68
69
  * @throws {@link ValidationException} (client fault)
69
- * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
70
+ * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
71
+ * Status Code: 400</code>
70
72
  * </p>
71
73
  *
72
74
  * @throws {@link EntityResolutionServiceException}
@@ -23,8 +23,7 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Removes one or more tags from the specified Entity Resolution resource. In Entity
27
- * Resolution, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be
26
+ * <p>Removes one or more tags from the specified Entity Resolution resource. In Entity Resolution, <code>SchemaMapping</code>, and <code>MatchingWorkflow</code> can be
28
27
  * tagged.</p>
29
28
  * @example
30
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -51,7 +50,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
51
50
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
52
51
  *
53
52
  * @throws {@link InternalServerException} (server fault)
54
- * <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
53
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
54
+ * service. <code>HTTP Status Code: 500</code>
55
55
  * </p>
56
56
  *
57
57
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -0,0 +1,149 @@
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 { UpdateIdMappingWorkflowInput, UpdateIdMappingWorkflowOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateIdMappingWorkflowCommand}.
14
+ */
15
+ export interface UpdateIdMappingWorkflowCommandInput extends UpdateIdMappingWorkflowInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateIdMappingWorkflowCommand}.
21
+ */
22
+ export interface UpdateIdMappingWorkflowCommandOutput extends UpdateIdMappingWorkflowOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates an existing <code>IdMappingWorkflow</code>. This method is identical to
27
+ * <code>CreateIdMappingWorkflow</code>, except it uses an HTTP <code>PUT</code> request
28
+ * instead of a <code>POST</code> request, and the <code>IdMappingWorkflow</code> must already
29
+ * exist for the method to succeed.</p>
30
+ * @example
31
+ * Use a bare-bones client and the command you need to make an API call.
32
+ * ```javascript
33
+ * import { EntityResolutionClient, UpdateIdMappingWorkflowCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
34
+ * // const { EntityResolutionClient, UpdateIdMappingWorkflowCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
35
+ * const client = new EntityResolutionClient(config);
36
+ * const input = { // UpdateIdMappingWorkflowInput
37
+ * workflowName: "STRING_VALUE", // required
38
+ * description: "STRING_VALUE",
39
+ * inputSourceConfig: [ // IdMappingWorkflowInputSourceConfig // required
40
+ * { // IdMappingWorkflowInputSource
41
+ * inputSourceARN: "STRING_VALUE", // required
42
+ * schemaName: "STRING_VALUE", // required
43
+ * },
44
+ * ],
45
+ * outputSourceConfig: [ // IdMappingWorkflowOutputSourceConfig // required
46
+ * { // IdMappingWorkflowOutputSource
47
+ * outputS3Path: "STRING_VALUE", // required
48
+ * KMSArn: "STRING_VALUE",
49
+ * },
50
+ * ],
51
+ * idMappingTechniques: { // IdMappingTechniques
52
+ * idMappingType: "PROVIDER", // required
53
+ * providerProperties: { // ProviderProperties
54
+ * providerServiceArn: "STRING_VALUE", // required
55
+ * providerConfiguration: "DOCUMENT_VALUE",
56
+ * intermediateSourceConfiguration: { // IntermediateSourceConfiguration
57
+ * intermediateS3Path: "STRING_VALUE", // required
58
+ * },
59
+ * },
60
+ * },
61
+ * roleArn: "STRING_VALUE", // required
62
+ * };
63
+ * const command = new UpdateIdMappingWorkflowCommand(input);
64
+ * const response = await client.send(command);
65
+ * // { // UpdateIdMappingWorkflowOutput
66
+ * // workflowName: "STRING_VALUE", // required
67
+ * // workflowArn: "STRING_VALUE", // required
68
+ * // description: "STRING_VALUE",
69
+ * // inputSourceConfig: [ // IdMappingWorkflowInputSourceConfig // required
70
+ * // { // IdMappingWorkflowInputSource
71
+ * // inputSourceARN: "STRING_VALUE", // required
72
+ * // schemaName: "STRING_VALUE", // required
73
+ * // },
74
+ * // ],
75
+ * // outputSourceConfig: [ // IdMappingWorkflowOutputSourceConfig // required
76
+ * // { // IdMappingWorkflowOutputSource
77
+ * // outputS3Path: "STRING_VALUE", // required
78
+ * // KMSArn: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // idMappingTechniques: { // IdMappingTechniques
82
+ * // idMappingType: "PROVIDER", // required
83
+ * // providerProperties: { // ProviderProperties
84
+ * // providerServiceArn: "STRING_VALUE", // required
85
+ * // providerConfiguration: "DOCUMENT_VALUE",
86
+ * // intermediateSourceConfiguration: { // IntermediateSourceConfiguration
87
+ * // intermediateS3Path: "STRING_VALUE", // required
88
+ * // },
89
+ * // },
90
+ * // },
91
+ * // roleArn: "STRING_VALUE", // required
92
+ * // };
93
+ *
94
+ * ```
95
+ *
96
+ * @param UpdateIdMappingWorkflowCommandInput - {@link UpdateIdMappingWorkflowCommandInput}
97
+ * @returns {@link UpdateIdMappingWorkflowCommandOutput}
98
+ * @see {@link UpdateIdMappingWorkflowCommandInput} for command's `input` shape.
99
+ * @see {@link UpdateIdMappingWorkflowCommandOutput} for command's `response` shape.
100
+ * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
101
+ *
102
+ * @throws {@link AccessDeniedException} (client fault)
103
+ * <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
104
+ * 403</code>
105
+ * </p>
106
+ *
107
+ * @throws {@link InternalServerException} (server fault)
108
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
109
+ * service. <code>HTTP Status Code: 500</code>
110
+ * </p>
111
+ *
112
+ * @throws {@link ResourceNotFoundException} (client fault)
113
+ * <p>The resource could not be found. <code>HTTP Status Code: 404</code>
114
+ * </p>
115
+ *
116
+ * @throws {@link ThrottlingException} (client fault)
117
+ * <p>The request was denied due to request throttling. <code>HTTP Status Code:
118
+ * 429</code>
119
+ * </p>
120
+ *
121
+ * @throws {@link ValidationException} (client fault)
122
+ * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
123
+ * Status Code: 400</code>
124
+ * </p>
125
+ *
126
+ * @throws {@link EntityResolutionServiceException}
127
+ * <p>Base exception class for all service exceptions from EntityResolution service.</p>
128
+ *
129
+ */
130
+ export declare class UpdateIdMappingWorkflowCommand extends $Command<UpdateIdMappingWorkflowCommandInput, UpdateIdMappingWorkflowCommandOutput, EntityResolutionClientResolvedConfig> {
131
+ readonly input: UpdateIdMappingWorkflowCommandInput;
132
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
133
+ /**
134
+ * @public
135
+ */
136
+ constructor(input: UpdateIdMappingWorkflowCommandInput);
137
+ /**
138
+ * @internal
139
+ */
140
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIdMappingWorkflowCommandInput, UpdateIdMappingWorkflowCommandOutput>;
141
+ /**
142
+ * @internal
143
+ */
144
+ private serialize;
145
+ /**
146
+ * @internal
147
+ */
148
+ private deserialize;
149
+ }
@@ -24,9 +24,9 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
24
24
  /**
25
25
  * @public
26
26
  * <p>Updates an existing <code>MatchingWorkflow</code>. This method is identical to
27
- * <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request instead of
28
- * a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already exist for the
29
- * method to succeed.</p>
27
+ * <code>CreateMatchingWorkflow</code>, except it uses an HTTP <code>PUT</code> request
28
+ * instead of a <code>POST</code> request, and the <code>MatchingWorkflow</code> must already
29
+ * exist for the method to succeed.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -57,7 +57,7 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
57
57
  * },
58
58
  * ],
59
59
  * resolutionTechniques: { // ResolutionTechniques
60
- * resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
60
+ * resolutionType: "RULE_MATCHING" || "ML_MATCHING" || "PROVIDER", // required
61
61
  * ruleBasedProperties: { // RuleBasedProperties
62
62
  * rules: [ // RuleList // required
63
63
  * { // Rule
@@ -69,6 +69,13 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
69
69
  * ],
70
70
  * attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
71
71
  * },
72
+ * providerProperties: { // ProviderProperties
73
+ * providerServiceArn: "STRING_VALUE", // required
74
+ * providerConfiguration: "DOCUMENT_VALUE",
75
+ * intermediateSourceConfiguration: { // IntermediateSourceConfiguration
76
+ * intermediateS3Path: "STRING_VALUE", // required
77
+ * },
78
+ * },
72
79
  * },
73
80
  * incrementalRunConfig: { // IncrementalRunConfig
74
81
  * incrementalRunType: "IMMEDIATE",
@@ -101,7 +108,7 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
101
108
  * // },
102
109
  * // ],
103
110
  * // resolutionTechniques: { // ResolutionTechniques
104
- * // resolutionType: "RULE_MATCHING" || "ML_MATCHING", // required
111
+ * // resolutionType: "RULE_MATCHING" || "ML_MATCHING" || "PROVIDER", // required
105
112
  * // ruleBasedProperties: { // RuleBasedProperties
106
113
  * // rules: [ // RuleList // required
107
114
  * // { // Rule
@@ -113,6 +120,13 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
113
120
  * // ],
114
121
  * // attributeMatchingModel: "ONE_TO_ONE" || "MANY_TO_MANY", // required
115
122
  * // },
123
+ * // providerProperties: { // ProviderProperties
124
+ * // providerServiceArn: "STRING_VALUE", // required
125
+ * // providerConfiguration: "DOCUMENT_VALUE",
126
+ * // intermediateSourceConfiguration: { // IntermediateSourceConfiguration
127
+ * // intermediateS3Path: "STRING_VALUE", // required
128
+ * // },
129
+ * // },
116
130
  * // },
117
131
  * // incrementalRunConfig: { // IncrementalRunConfig
118
132
  * // incrementalRunType: "IMMEDIATE",
@@ -129,11 +143,13 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
129
143
  * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
130
144
  *
131
145
  * @throws {@link AccessDeniedException} (client fault)
132
- * <p>You do not have sufficient access to perform this action. <code>HTTP Status Code: 403</code>
146
+ * <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
147
+ * 403</code>
133
148
  * </p>
134
149
  *
135
150
  * @throws {@link InternalServerException} (server fault)
136
- * <p>This exception occurs when there is an internal failure in the Entity Resolution service. <code>HTTP Status Code: 500</code>
151
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
152
+ * service. <code>HTTP Status Code: 500</code>
137
153
  * </p>
138
154
  *
139
155
  * @throws {@link ResourceNotFoundException} (client fault)
@@ -141,11 +157,13 @@ export interface UpdateMatchingWorkflowCommandOutput extends UpdateMatchingWorkf
141
157
  * </p>
142
158
  *
143
159
  * @throws {@link ThrottlingException} (client fault)
144
- * <p>The request was denied due to request throttling. <code>HTTP Status Code: 429</code>
160
+ * <p>The request was denied due to request throttling. <code>HTTP Status Code:
161
+ * 429</code>
145
162
  * </p>
146
163
  *
147
164
  * @throws {@link ValidationException} (client fault)
148
- * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP Status Code: 400</code>
165
+ * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
166
+ * Status Code: 400</code>
149
167
  * </p>
150
168
  *
151
169
  * @throws {@link EntityResolutionServiceException}
@@ -0,0 +1,128 @@
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 { UpdateSchemaMappingInput, UpdateSchemaMappingOutput } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateSchemaMappingCommand}.
14
+ */
15
+ export interface UpdateSchemaMappingCommandInput extends UpdateSchemaMappingInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateSchemaMappingCommand}.
21
+ */
22
+ export interface UpdateSchemaMappingCommandOutput extends UpdateSchemaMappingOutput, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Updates a schema mapping.</p>
27
+ * <note>
28
+ * <p>A schema is immutable if it is being used by a workflow. Therefore, you can't update
29
+ * a schema mapping if it's associated with a workflow. </p>
30
+ * </note>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { EntityResolutionClient, UpdateSchemaMappingCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
35
+ * // const { EntityResolutionClient, UpdateSchemaMappingCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
36
+ * const client = new EntityResolutionClient(config);
37
+ * const input = { // UpdateSchemaMappingInput
38
+ * schemaName: "STRING_VALUE", // required
39
+ * description: "STRING_VALUE",
40
+ * mappedInputFields: [ // SchemaInputAttributes // required
41
+ * { // SchemaInputAttribute
42
+ * fieldName: "STRING_VALUE", // required
43
+ * type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
44
+ * groupName: "STRING_VALUE",
45
+ * matchKey: "STRING_VALUE",
46
+ * subType: "STRING_VALUE",
47
+ * },
48
+ * ],
49
+ * };
50
+ * const command = new UpdateSchemaMappingCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // UpdateSchemaMappingOutput
53
+ * // schemaName: "STRING_VALUE", // required
54
+ * // schemaArn: "STRING_VALUE", // required
55
+ * // description: "STRING_VALUE",
56
+ * // mappedInputFields: [ // SchemaInputAttributes // required
57
+ * // { // SchemaInputAttribute
58
+ * // fieldName: "STRING_VALUE", // required
59
+ * // type: "NAME" || "NAME_FIRST" || "NAME_MIDDLE" || "NAME_LAST" || "ADDRESS" || "ADDRESS_STREET1" || "ADDRESS_STREET2" || "ADDRESS_STREET3" || "ADDRESS_CITY" || "ADDRESS_STATE" || "ADDRESS_COUNTRY" || "ADDRESS_POSTALCODE" || "PHONE" || "PHONE_NUMBER" || "PHONE_COUNTRYCODE" || "EMAIL_ADDRESS" || "UNIQUE_ID" || "DATE" || "STRING" || "PROVIDER_ID", // required
60
+ * // groupName: "STRING_VALUE",
61
+ * // matchKey: "STRING_VALUE",
62
+ * // subType: "STRING_VALUE",
63
+ * // },
64
+ * // ],
65
+ * // };
66
+ *
67
+ * ```
68
+ *
69
+ * @param UpdateSchemaMappingCommandInput - {@link UpdateSchemaMappingCommandInput}
70
+ * @returns {@link UpdateSchemaMappingCommandOutput}
71
+ * @see {@link UpdateSchemaMappingCommandInput} for command's `input` shape.
72
+ * @see {@link UpdateSchemaMappingCommandOutput} for command's `response` shape.
73
+ * @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
74
+ *
75
+ * @throws {@link AccessDeniedException} (client fault)
76
+ * <p>You do not have sufficient access to perform this action. <code>HTTP Status Code:
77
+ * 403</code>
78
+ * </p>
79
+ *
80
+ * @throws {@link ConflictException} (client fault)
81
+ * <p>The request could not be processed because of conflict in the current state of the
82
+ * resource. Example: Workflow already exists, Schema already exists, Workflow is currently
83
+ * running, etc. <code>HTTP Status Code: 400</code>
84
+ * </p>
85
+ *
86
+ * @throws {@link InternalServerException} (server fault)
87
+ * <p>This exception occurs when there is an internal failure in the Entity Resolution
88
+ * service. <code>HTTP Status Code: 500</code>
89
+ * </p>
90
+ *
91
+ * @throws {@link ResourceNotFoundException} (client fault)
92
+ * <p>The resource could not be found. <code>HTTP Status Code: 404</code>
93
+ * </p>
94
+ *
95
+ * @throws {@link ThrottlingException} (client fault)
96
+ * <p>The request was denied due to request throttling. <code>HTTP Status Code:
97
+ * 429</code>
98
+ * </p>
99
+ *
100
+ * @throws {@link ValidationException} (client fault)
101
+ * <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
102
+ * Status Code: 400</code>
103
+ * </p>
104
+ *
105
+ * @throws {@link EntityResolutionServiceException}
106
+ * <p>Base exception class for all service exceptions from EntityResolution service.</p>
107
+ *
108
+ */
109
+ export declare class UpdateSchemaMappingCommand extends $Command<UpdateSchemaMappingCommandInput, UpdateSchemaMappingCommandOutput, EntityResolutionClientResolvedConfig> {
110
+ readonly input: UpdateSchemaMappingCommandInput;
111
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
112
+ /**
113
+ * @public
114
+ */
115
+ constructor(input: UpdateSchemaMappingCommandInput);
116
+ /**
117
+ * @internal
118
+ */
119
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: EntityResolutionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSchemaMappingCommandInput, UpdateSchemaMappingCommandOutput>;
120
+ /**
121
+ * @internal
122
+ */
123
+ private serialize;
124
+ /**
125
+ * @internal
126
+ */
127
+ private deserialize;
128
+ }
@@ -1,16 +1,27 @@
1
+ export * from "./CreateIdMappingWorkflowCommand";
1
2
  export * from "./CreateMatchingWorkflowCommand";
2
3
  export * from "./CreateSchemaMappingCommand";
4
+ export * from "./DeleteIdMappingWorkflowCommand";
3
5
  export * from "./DeleteMatchingWorkflowCommand";
4
6
  export * from "./DeleteSchemaMappingCommand";
7
+ export * from "./GetIdMappingJobCommand";
8
+ export * from "./GetIdMappingWorkflowCommand";
5
9
  export * from "./GetMatchIdCommand";
6
10
  export * from "./GetMatchingJobCommand";
7
11
  export * from "./GetMatchingWorkflowCommand";
12
+ export * from "./GetProviderServiceCommand";
8
13
  export * from "./GetSchemaMappingCommand";
14
+ export * from "./ListIdMappingJobsCommand";
15
+ export * from "./ListIdMappingWorkflowsCommand";
9
16
  export * from "./ListMatchingJobsCommand";
10
17
  export * from "./ListMatchingWorkflowsCommand";
18
+ export * from "./ListProviderServicesCommand";
11
19
  export * from "./ListSchemaMappingsCommand";
12
20
  export * from "./ListTagsForResourceCommand";
21
+ export * from "./StartIdMappingJobCommand";
13
22
  export * from "./StartMatchingJobCommand";
14
23
  export * from "./TagResourceCommand";
15
24
  export * from "./UntagResourceCommand";
25
+ export * from "./UpdateIdMappingWorkflowCommand";
16
26
  export * from "./UpdateMatchingWorkflowCommand";
27
+ export * from "./UpdateSchemaMappingCommand";
@@ -1,16 +1,15 @@
1
1
  /**
2
2
  * <p>Welcome to the <i>Entity Resolution API Reference</i>.</p>
3
- * <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity resolution capabilities
4
- * that enable developers and analysts at advertising and marketing companies to build an accurate and
5
- * complete view of their consumers.</p>
6
- * <p>
7
- * With Entity Resolution, you can match source records containing consumer identifiers, such as name, email address,
8
- * and phone number. This is true even when these records have incomplete or conflicting identifiers. For example,
9
- * Entity Resolution can effectively match a source record from a customer relationship management (CRM) system
10
- * with a source record from a marketing system containing campaign information.</p>
3
+ * <p>Entity Resolution is an Amazon Web Services service that provides pre-configured entity
4
+ * resolution capabilities that enable developers and analysts at advertising and marketing
5
+ * companies to build an accurate and complete view of their consumers.</p>
6
+ * <p> With Entity Resolution, you can match source records containing consumer identifiers,
7
+ * such as name, email address, and phone number. This is true even when these records have
8
+ * incomplete or conflicting identifiers. For example, Entity Resolution can effectively match
9
+ * a source record from a customer relationship management (CRM) system with a source record
10
+ * from a marketing system containing campaign information.</p>
11
11
  * <p>To learn more about Entity Resolution concepts, procedures, and best practices, see the
12
- * <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution
13
- * User Guide</a>.</p>
12
+ * <a href="https://docs.aws.amazon.com/entityresolution/latest/userguide/what-is-service.html">Entity Resolution User Guide</a>.</p>
14
13
  *
15
14
  * @packageDocumentation
16
15
  */