EntityResolution / Client / batch_delete_unique_id

batch_delete_unique_id

EntityResolution.Client.batch_delete_unique_id(**kwargs)

Deletes multiple unique IDs in a matching workflow.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_unique_id(
    workflowName='string',
    inputSource='string',
    uniqueIds=[
        'string',
    ]
)
Parameters:

  • workflowName (string) –

    [REQUIRED]

    The name of the workflow.

  • inputSource (string) – The input source for the batch delete unique ID operation.

  • uniqueIds (list) –

    [REQUIRED]

    The unique IDs to delete.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'status': 'COMPLETED'|'ACCEPTED',
    'errors': [
        {
            'uniqueId': 'string',
            'errorType': 'SERVICE_ERROR'|'VALIDATION_ERROR'
        },
    ],
    'deleted': [
        {
            'uniqueId': 'string'
        },
    ],
    'disconnectedUniqueIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • status (string) –

      The status of the batch delete unique ID operation.

    • errors (list) –

      The errors from deleting multiple unique IDs.

      • (dict) –

        The error information provided when the delete unique ID operation doesn’t complete.

        • uniqueId (string) –

          The unique ID that couldn’t be deleted.

        • errorType (string) –

          The error type for the delete unique ID operation.

          The SERVICE_ERROR value indicates that an internal service-side problem occurred during the deletion operation.

          The VALIDATION_ERROR value indicates that the deletion operation couldn’t complete because of invalid input parameters or data.

    • deleted (list) –

      The unique IDs that were deleted.

      • (dict) –

        The deleted unique ID.

        • uniqueId (string) –

          The unique ID of the deleted item.

    • disconnectedUniqueIds (list) –

      The unique IDs that were disconnected.

      • (string) –

Exceptions