Skip to content

Commit 87c90f1

Browse files
author
awstools
committed
feat(client-entityresolution): Support Batch Unique IDs Deletion.
1 parent 6844bc3 commit 87c90f1

File tree

8 files changed

+531
-2
lines changed

8 files changed

+531
-2
lines changed

‎clients/client-entityresolution/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,14 @@ AddPolicyStatement
220220

221221
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/entityresolution/command/AddPolicyStatementCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/AddPolicyStatementCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/AddPolicyStatementCommandOutput/)
222222

223+
</details>
224+
<details>
225+
<summary>
226+
BatchDeleteUniqueId
227+
</summary>
228+
229+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/entityresolution/command/BatchDeleteUniqueIdCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/BatchDeleteUniqueIdCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-entityresolution/Interface/BatchDeleteUniqueIdCommandOutput/)
230+
223231
</details>
224232
<details>
225233
<summary>

‎clients/client-entityresolution/src/EntityResolution.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ import {
77
AddPolicyStatementCommandInput,
88
AddPolicyStatementCommandOutput,
99
} from "./commands/AddPolicyStatementCommand";
10+
import {
11+
BatchDeleteUniqueIdCommand,
12+
BatchDeleteUniqueIdCommandInput,
13+
BatchDeleteUniqueIdCommandOutput,
14+
} from "./commands/BatchDeleteUniqueIdCommand";
1015
import {
1116
CreateIdMappingWorkflowCommand,
1217
CreateIdMappingWorkflowCommandInput,
@@ -170,6 +175,7 @@ import { EntityResolutionClient, EntityResolutionClientConfig } from "./EntityRe
170175

171176
const commands = {
172177
AddPolicyStatementCommand,
178+
BatchDeleteUniqueIdCommand,
173179
CreateIdMappingWorkflowCommand,
174180
CreateIdNamespaceCommand,
175181
CreateMatchingWorkflowCommand,
@@ -225,6 +231,23 @@ export interface EntityResolution {
225231
cb: (err: any, data?: AddPolicyStatementCommandOutput) => void
226232
): void;
227233

234+
/**
235+
* @see {@link BatchDeleteUniqueIdCommand}
236+
*/
237+
batchDeleteUniqueId(
238+
args: BatchDeleteUniqueIdCommandInput,
239+
options?: __HttpHandlerOptions
240+
): Promise<BatchDeleteUniqueIdCommandOutput>;
241+
batchDeleteUniqueId(
242+
args: BatchDeleteUniqueIdCommandInput,
243+
cb: (err: any, data?: BatchDeleteUniqueIdCommandOutput) => void
244+
): void;
245+
batchDeleteUniqueId(
246+
args: BatchDeleteUniqueIdCommandInput,
247+
options: __HttpHandlerOptions,
248+
cb: (err: any, data?: BatchDeleteUniqueIdCommandOutput) => void
249+
): void;
250+
228251
/**
229252
* @see {@link CreateIdMappingWorkflowCommand}
230253
*/

‎clients/client-entityresolution/src/EntityResolutionClient.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ import {
5454
resolveHttpAuthSchemeConfig,
5555
} from "./auth/httpAuthSchemeProvider";
5656
import { AddPolicyStatementCommandInput, AddPolicyStatementCommandOutput } from "./commands/AddPolicyStatementCommand";
57+
import {
58+
BatchDeleteUniqueIdCommandInput,
59+
BatchDeleteUniqueIdCommandOutput,
60+
} from "./commands/BatchDeleteUniqueIdCommand";
5761
import {
5862
CreateIdMappingWorkflowCommandInput,
5963
CreateIdMappingWorkflowCommandOutput,
@@ -153,6 +157,7 @@ export { __Client };
153157
*/
154158
export type ServiceInputTypes =
155159
| AddPolicyStatementCommandInput
160+
| BatchDeleteUniqueIdCommandInput
156161
| CreateIdMappingWorkflowCommandInput
157162
| CreateIdNamespaceCommandInput
158163
| CreateMatchingWorkflowCommandInput
@@ -194,6 +199,7 @@ export type ServiceInputTypes =
194199
*/
195200
export type ServiceOutputTypes =
196201
| AddPolicyStatementCommandOutput
202+
| BatchDeleteUniqueIdCommandOutput
197203
| CreateIdMappingWorkflowCommandOutput
198204
| CreateIdNamespaceCommandOutput
199205
| CreateMatchingWorkflowCommandOutput

‎clients/client-entityresolution/src/commands/BatchDeleteUniqueIdCommand.ts

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
// smithy-typescript generated code
2+
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
3+
import { getSerdePlugin } from "@smithy/middleware-serde";
4+
import { Command as $Command } from "@smithy/smithy-client";
5+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
6+
7+
import { commonParams } from "../endpoint/EndpointParameters";
8+
import { EntityResolutionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EntityResolutionClient";
9+
import { BatchDeleteUniqueIdInput, BatchDeleteUniqueIdOutput } from "../models/models_0";
10+
import { de_BatchDeleteUniqueIdCommand, se_BatchDeleteUniqueIdCommand } from "../protocols/Aws_restJson1";
11+
12+
/**
13+
* @public
14+
*/
15+
export { __MetadataBearer, $Command };
16+
/**
17+
* @public
18+
*
19+
* The input for {@link BatchDeleteUniqueIdCommand}.
20+
*/
21+
export interface BatchDeleteUniqueIdCommandInput extends BatchDeleteUniqueIdInput {}
22+
/**
23+
* @public
24+
*
25+
* The output of {@link BatchDeleteUniqueIdCommand}.
26+
*/
27+
export interface BatchDeleteUniqueIdCommandOutput extends BatchDeleteUniqueIdOutput, __MetadataBearer {}
28+
29+
/**
30+
* <p>Deletes multiple unique IDs in a matching workflow.</p>
31+
* @example
32+
* Use a bare-bones client and the command you need to make an API call.
33+
* ```javascript
34+
* import { EntityResolutionClient, BatchDeleteUniqueIdCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
35+
* // const { EntityResolutionClient, BatchDeleteUniqueIdCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
36+
* const client = new EntityResolutionClient(config);
37+
* const input = { // BatchDeleteUniqueIdInput
38+
* workflowName: "STRING_VALUE", // required
39+
* inputSource: "STRING_VALUE",
40+
* uniqueIds: [ // UniqueIdList // required
41+
* "STRING_VALUE",
42+
* ],
43+
* };
44+
* const command = new BatchDeleteUniqueIdCommand(input);
45+
* const response = await client.send(command);
46+
* // { // BatchDeleteUniqueIdOutput
47+
* // status: "COMPLETED" || "ACCEPTED", // required
48+
* // errors: [ // DeleteUniqueIdErrorsList // required
49+
* // { // DeleteUniqueIdError
50+
* // uniqueId: "STRING_VALUE", // required
51+
* // errorType: "SERVICE_ERROR" || "VALIDATION_ERROR", // required
52+
* // },
53+
* // ],
54+
* // deleted: [ // DeletedUniqueIdList // required
55+
* // { // DeletedUniqueId
56+
* // uniqueId: "STRING_VALUE", // required
57+
* // },
58+
* // ],
59+
* // disconnectedUniqueIds: [ // DisconnectedUniqueIdsList // required
60+
* // "STRING_VALUE",
61+
* // ],
62+
* // };
63+
*
64+
* ```
65+
*
66+
* @param BatchDeleteUniqueIdCommandInput - {@link BatchDeleteUniqueIdCommandInput}
67+
* @returns {@link BatchDeleteUniqueIdCommandOutput}
68+
* @see {@link BatchDeleteUniqueIdCommandInput} for command's `input` shape.
69+
* @see {@link BatchDeleteUniqueIdCommandOutput} for command's `response` shape.
70+
* @see {@link EntityResolutionClientResolvedConfig | config} for EntityResolutionClient's `config` shape.
71+
*
72+
* @throws {@link InternalServerException} (server fault)
73+
* <p>This exception occurs when there is an internal failure in the Entity Resolution
74+
* service. <code>HTTP Status Code: 500</code>
75+
* </p>
76+
*
77+
* @throws {@link ResourceNotFoundException} (client fault)
78+
* <p>The resource could not be found. <code>HTTP Status Code: 404</code>
79+
* </p>
80+
*
81+
* @throws {@link ValidationException} (client fault)
82+
* <p>The input fails to satisfy the constraints specified by Entity Resolution. <code>HTTP
83+
* Status Code: 400</code>
84+
* </p>
85+
*
86+
* @throws {@link EntityResolutionServiceException}
87+
* <p>Base exception class for all service exceptions from EntityResolution service.</p>
88+
*
89+
* @public
90+
*/
91+
export class BatchDeleteUniqueIdCommand extends $Command
92+
.classBuilder<
93+
BatchDeleteUniqueIdCommandInput,
94+
BatchDeleteUniqueIdCommandOutput,
95+
EntityResolutionClientResolvedConfig,
96+
ServiceInputTypes,
97+
ServiceOutputTypes
98+
>()
99+
.ep({
100+
...commonParams,
101+
})
102+
.m(function (this: any, Command: any, cs: any, config: EntityResolutionClientResolvedConfig, o: any) {
103+
return [
104+
getSerdePlugin(config, this.serialize, this.deserialize),
105+
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
106+
];
107+
})
108+
.s("AWSVeniceService", "BatchDeleteUniqueId", {})
109+
.n("EntityResolutionClient", "BatchDeleteUniqueIdCommand")
110+
.f(void 0, void 0)
111+
.ser(se_BatchDeleteUniqueIdCommand)
112+
.de(de_BatchDeleteUniqueIdCommand)
113+
.build() {}

‎clients/client-entityresolution/src/commands/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// smithy-typescript generated code
22
export * from "./AddPolicyStatementCommand";
3+
export * from "./BatchDeleteUniqueIdCommand";
34
export * from "./CreateIdMappingWorkflowCommand";
45
export * from "./CreateIdNamespaceCommand";
56
export * from "./CreateMatchingWorkflowCommand";

‎clients/client-entityresolution/src/models/models_0.ts

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,116 @@ export const AttributeMatchingModel = {
240240
*/
241241
export type AttributeMatchingModel = (typeof AttributeMatchingModel)[keyof typeof AttributeMatchingModel];
242242

243+
/**
244+
* @public
245+
*/
246+
export interface BatchDeleteUniqueIdInput {
247+
/**
248+
* <p>The name of the workflow.</p>
249+
* @public
250+
*/
251+
workflowName: string | undefined;
252+
253+
/**
254+
* <p>The input source for the batch delete unique ID operation.</p>
255+
* @public
256+
*/
257+
inputSource?: string;
258+
259+
/**
260+
* <p>The unique IDs to delete.</p>
261+
* @public
262+
*/
263+
uniqueIds: string[] | undefined;
264+
}
265+
266+
/**
267+
* <p>The deleted unique ID.</p>
268+
* @public
269+
*/
270+
export interface DeletedUniqueId {
271+
/**
272+
* <p> The unique ID of the deleted item.</p>
273+
* @public
274+
*/
275+
uniqueId: string | undefined;
276+
}
277+
278+
/**
279+
* @public
280+
* @enum
281+
*/
282+
export const DeleteUniqueIdErrorType = {
283+
SERVICE_ERROR: "SERVICE_ERROR",
284+
VALIDATION_ERROR: "VALIDATION_ERROR",
285+
} as const;
286+
287+
/**
288+
* @public
289+
*/
290+
export type DeleteUniqueIdErrorType = (typeof DeleteUniqueIdErrorType)[keyof typeof DeleteUniqueIdErrorType];
291+
292+
/**
293+
* <p>The Delete Unique Id error.</p>
294+
* @public
295+
*/
296+
export interface DeleteUniqueIdError {
297+
/**
298+
* <p>The unique ID that could not be deleted.</p>
299+
* @public
300+
*/
301+
uniqueId: string | undefined;
302+
303+
/**
304+
* <p> The error type for the batch delete unique ID operation.</p>
305+
* @public
306+
*/
307+
errorType: DeleteUniqueIdErrorType | undefined;
308+
}
309+
310+
/**
311+
* @public
312+
* @enum
313+
*/
314+
export const DeleteUniqueIdStatus = {
315+
ACCEPTED: "ACCEPTED",
316+
COMPLETED: "COMPLETED",
317+
} as const;
318+
319+
/**
320+
* @public
321+
*/
322+
export type DeleteUniqueIdStatus = (typeof DeleteUniqueIdStatus)[keyof typeof DeleteUniqueIdStatus];
323+
324+
/**
325+
* @public
326+
*/
327+
export interface BatchDeleteUniqueIdOutput {
328+
/**
329+
* <p>The status of the batch delete unique ID operation.</p>
330+
* @public
331+
*/
332+
status: DeleteUniqueIdStatus | undefined;
333+
334+
/**
335+
* <p> The errors from deleting multiple unique IDs.</p>
336+
* @public
337+
*/
338+
errors: DeleteUniqueIdError[] | undefined;
339+
340+
/**
341+
* <p>The unique IDs that were deleted.</p>
342+
* @public
343+
*/
344+
deleted: DeletedUniqueId[] | undefined;
345+
346+
/**
347+
* <p>The unique IDs that were disconnected.</p>
348+
* @public
349+
*/
350+
disconnectedUniqueIds: string[] | undefined;
351+
}
352+
243353
/**
244354
* @public
245355
* @enum

0 commit comments

Comments
 (0)