class Aws::Comprehend::Types::RedactionConfig

Provides configuration parameters for PII entity redaction.

@note When making an API call, you may pass RedactionConfig

data as a hash:

    {
      pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
      mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
      mask_character: "MaskCharacter",
    }

@!attribute [rw] pii_entity_types

An array of the types of PII entities that Amazon Comprehend detects
in the input text for your request.
@return [Array<String>]

@!attribute [rw] mask_mode

Specifies whether the PII entity is redacted with the mask character
or the entity type.
@return [String]

@!attribute [rw] mask_character

A character that replaces each character in the redacted PII entity.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/RedactionConfig AWS API Documentation

Constants

SENSITIVE