Connect / Client / delete_contact_data

delete_contact_data

Connect.Client.delete_contact_data(**kwargs)

Deletes the specified fields containing personally identifiable information (PII) from a contact in the specified Connect Customer instance. We redact PII (such as customer endpoints, additional email recipients, and the email subject) from the contact and its associated contact trace record (CTR). The contact must be in a terminated state.

Warning

This deletion is permanent and cannot be undone. Performing this operation permanently deletes the specified PII. There is no retention period; you cannot recover the data after deletion. We remove only the fields that Connect Customer identifies and stores as PII. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove.

See also: AWS API Documentation

Request Syntax

response = client.delete_contact_data(
    InstanceId='string',
    ContactId='string',
    ContactFields=[
        'CUSTOMER_ENDPOINT'|'ADDITIONAL_EMAIL_RECIPIENTS'|'EMAIL_SUBJECT',
    ]
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • ContactId (string) –

    [REQUIRED]

    The identifier of the contact. You can delete PII only from a contact that has been disconnected (is in a terminated state).

  • ContactFields (list) –

    [REQUIRED]

    The categories of PII to redact from the contact. Specify one or more of the following values:

    • CUSTOMER_ENDPOINT – The customer’s contact endpoint.

    • ADDITIONAL_EMAIL_RECIPIENTS – Additional recipients on an email contact (email channel only).

    • EMAIL_SUBJECT – The subject line of an email contact (email channel only).

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions