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(
    inputSource='string',
    uniqueIds=[
        'string',
    ],
    workflowName='string'
)
Parameters:

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

  • uniqueIds (list) –

    [REQUIRED]

    The unique IDs to delete.

    • (string) –

  • workflowName (string) –

    [REQUIRED]

    The name of the workflow.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • 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) –

    • errors (list) –

      The errors from deleting multiple unique IDs.

      • (dict) –

        The Delete Unique Id error.

        • errorType (string) –

          The error type for the batch delete unique ID operation.

        • uniqueId (string) –

          The unique ID that could not be deleted.

    • status (string) –

      The status of the batch delete unique ID operation.

Exceptions

  • EntityResolution.Client.exceptions.InternalServerException

  • EntityResolution.Client.exceptions.ResourceNotFoundException

  • EntityResolution.Client.exceptions.ValidationException