BatchDeleteUniqueIdCommand

Deletes multiple unique IDs in a matching workflow.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EntityResolutionClient, BatchDeleteUniqueIdCommand } from "@aws-sdk/client-entityresolution"; // ES Modules import
// const { EntityResolutionClient, BatchDeleteUniqueIdCommand } = require("@aws-sdk/client-entityresolution"); // CommonJS import
const client = new EntityResolutionClient(config);
const input = { // BatchDeleteUniqueIdInput
  workflowName: "STRING_VALUE", // required
  inputSource: "STRING_VALUE",
  uniqueIds: [ // UniqueIdList // required
    "STRING_VALUE",
  ],
};
const command = new BatchDeleteUniqueIdCommand(input);
const response = await client.send(command);
// { // BatchDeleteUniqueIdOutput
//   status: "COMPLETED" || "ACCEPTED", // required
//   errors: [ // DeleteUniqueIdErrorsList // required
//     { // DeleteUniqueIdError
//       uniqueId: "STRING_VALUE", // required
//       errorType: "SERVICE_ERROR" || "VALIDATION_ERROR", // required
//     },
//   ],
//   deleted: [ // DeletedUniqueIdList // required
//     { // DeletedUniqueId
//       uniqueId: "STRING_VALUE", // required
//     },
//   ],
//   disconnectedUniqueIds: [ // DisconnectedUniqueIdsList // required
//     "STRING_VALUE",
//   ],
// };

BatchDeleteUniqueIdCommand Input

See BatchDeleteUniqueIdCommandInput for more details

Parameter
Type
Description
uniqueIds
Required
string[] | undefined

The unique IDs to delete.

workflowName
Required
string | undefined

The name of the workflow.

inputSource
string | undefined

The input source for the batch delete unique ID operation.

BatchDeleteUniqueIdCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
deleted
Required
DeletedUniqueId[] | undefined

The unique IDs that were deleted.

disconnectedUniqueIds
Required
string[] | undefined

The unique IDs that were disconnected.

errors
Required
DeleteUniqueIdError[] | undefined

The errors from deleting multiple unique IDs.

status
Required
DeleteUniqueIdStatus | undefined

The status of the batch delete unique ID operation.

Throws

Name
Fault
Details
InternalServerException
server

This exception occurs when there is an internal failure in the Entity Resolution service.

ResourceNotFoundException
client

The resource could not be found.

ValidationException
client

The input fails to satisfy the constraints specified by Entity Resolution.

EntityResolutionServiceException
Base exception class for all service exceptions from EntityResolution service.