Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Comprehend.Types.RedactionConfig

Description

Documentation

data RedactionConfig Source #

Provides configuration parameters for PII entity redaction.

See: newRedactionConfig smart constructor.

Constructors

RedactionConfig'
Fields maskCharacter :: Maybe Text A character that replaces each character in the redacted PII entity. maskMode :: Maybe PiiEntitiesDetectionMaskMode Specifies whether the PII entity is redacted with the mask character or the entity type. piiEntityTypes :: Maybe [PiiEntityType] An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

Instances

Instances details

Eq RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods (==) :: RedactionConfig -> RedactionConfig -> Bool # (/=) :: RedactionConfig -> RedactionConfig -> Bool #
Read RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods readsPrec :: Int -> ReadS RedactionConfig # readList :: ReadS [RedactionConfig] # readPrec :: ReadPrec RedactionConfig # readListPrec :: ReadPrec [RedactionConfig] #
Show RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods showsPrec :: Int -> RedactionConfig -> ShowS # show :: RedactionConfig -> String # showList :: [RedactionConfig] -> ShowS #
Generic RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Associated Types type Rep RedactionConfig :: Type -> Type # Methods from :: RedactionConfig -> Rep RedactionConfig x # to :: Rep RedactionConfig x -> RedactionConfig #
NFData RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods rnf :: RedactionConfig -> () #
Hashable RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods hashWithSalt :: Int -> RedactionConfig -> Int # hash :: RedactionConfig -> Int #
ToJSON RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods toJSON :: RedactionConfig -> Value # toEncoding :: RedactionConfig -> Encoding # toJSONList :: [RedactionConfig] -> Value # toEncodingList :: [RedactionConfig] -> Encoding #
FromJSON RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig Methods parseJSON :: Value -> Parser RedactionConfig # parseJSONList :: Value -> Parser [RedactionConfig] #
type Rep RedactionConfig Source #
Instance details Defined in Amazonka.Comprehend.Types.RedactionConfig type Rep RedactionConfig = D1 ('MetaData "RedactionConfig" "Amazonka.Comprehend.Types.RedactionConfig" "libZSservicesZSamazonka-comprehendZSamazonka-comprehend" 'False) (C1 ('MetaCons "RedactionConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maskCharacter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maskMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PiiEntitiesDetectionMaskMode)) :: S1 ('MetaSel ('Just "piiEntityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PiiEntityType])))))

newRedactionConfig :: RedactionConfig Source #

Create a value of RedactionConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:maskCharacter:RedactionConfig', redactionConfig_maskCharacter - A character that replaces each character in the redacted PII entity.

$sel:maskMode:RedactionConfig', redactionConfig_maskMode - Specifies whether the PII entity is redacted with the mask character or the entity type.

$sel:piiEntityTypes:RedactionConfig', redactionConfig_piiEntityTypes - An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

redactionConfig_maskCharacter :: Lens' RedactionConfig (Maybe Text) Source #

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

redactionConfig_maskMode :: Lens' RedactionConfig (Maybe PiiEntitiesDetectionMaskMode) Source #

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

redactionConfig_piiEntityTypes :: Lens' RedactionConfig (Maybe [PiiEntityType]) Source #

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