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. This operation redacts 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 operation performs a hard deletion of the specified PII and cannot be undone. There is no retention period; after the data is deleted, it cannot be recovered. Only fields that Connect Customer identifies and stores as PII are removed. Any PII that you place in fields outside the scope of this operation remains your responsibility to remove.

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. PII can be deleted 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. Valid values are CUSTOMER_ENDPOINT, ADDITIONAL_EMAIL_RECIPIENTS, and EMAIL_SUBJECT. ADDITIONAL_EMAIL_RECIPIENTS and EMAIL_SUBJECT are supported only for contacts in the email channel.
- (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Connect.Client.exceptions.InvalidRequestException
Connect.Client.exceptions.InvalidParameterException
Connect.Client.exceptions.ResourceNotFoundException
Connect.Client.exceptions.ContactNotTerminatedException
Connect.Client.exceptions.InternalServiceException
Connect.Client.exceptions.ThrottlingException