Skip to content

RedactionConfig

Used by
Source code in docs_src/capo_comprehend/types/redaction_config.py 
13
14
15
16
17
18
19
20
21
22
23
class RedactionConfig(TypedDict, closed=True):
    pii_entity_types: NotRequired[
        "capo_comprehend.types.list_of_pii_entity_types.ListOfPiiEntityTypes"
    ]
    """<p>An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.</p>"""
    mask_mode: NotRequired[
        "capo_comprehend.types.pii_entities_detection_mask_mode.PiiEntitiesDetectionMaskMode"
    ]
    """<p>Specifies whether the PII entity is redacted with the mask character or the entity type.</p>"""
    mask_character: NotRequired["capo_comprehend.types.mask_character.MaskCharacter"]
    """<p>A character that replaces each character in the redacted PII entity.</p>"""

mask_character instance-attribute 

mask_character: NotRequired[MaskCharacter]

A character that replaces each character in the redacted PII entity.

mask_mode instance-attribute 

mask_mode: NotRequired[PiiEntitiesDetectionMaskMode]

Specifies whether the PII entity is redacted with the mask character or the entity type.

pii_entity_types instance-attribute 

pii_entity_types: NotRequired[ListOfPiiEntityTypes]

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.