Skip to content

DeleteContactDataRequest

Source code in docs_src/capo_connect/types/delete_contact_data_request.py 
15
16
17
18
19
20
21
class DeleteContactDataRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>"""
    contact_id: "capo_connect.types.contact_id.ContactId"
    """<p>The identifier of the contact. You can delete PII only from a contact that has been disconnected (is in a terminated state).</p>"""
    contact_fields: "capo_connect.types.contact_fields.ContactFields"
    """<p>The categories of PII to redact from the contact. Specify one or more of the following values:</p> <ul> <li> <p> <code>CUSTOMER_ENDPOINT</code> – The customer's contact endpoint.</p> </li> <li> <p> <code>ADDITIONAL_EMAIL_RECIPIENTS</code> – Additional recipients on an email contact (email channel only).</p> </li> <li> <p> <code>EMAIL_SUBJECT</code> – The subject line of an email contact (email channel only).</p> </li> </ul>"""

contact_fields instance-attribute 

contact_fields: ContactFields

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).

contact_id instance-attribute 

contact_id: ContactId

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

instance_id instance-attribute 

instance_id: InstanceId

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