Amazonka.Glue.Types.PIIDetection

Documentation

data PIIDetection

Specifies a transform that identifies, removes or masks PII data.

See: newPIIDetection smart constructor.

Constructors

PIIDetection'

Fields

• maskValue :: Maybe Text

  Indicates the value that will replace the detected entity.

• outputColumnName :: Maybe Text

  Indicates the output column name that will contain any entity type detected in that row.

• sampleFraction :: Maybe Double

  Indicates the fraction of the data to sample when scanning for PII entities.

• thresholdFraction :: Maybe Double

  Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

• name :: Text

  The name of the transform node.

• inputs :: NonEmpty Text

  The node ID inputs to the transform.

• piiType :: PiiType

  Indicates the type of PIIDetection transform.

• entityTypesToDetect :: [Text]

  Indicates the types of entities the PIIDetection transform will identify as PII data.

  PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Instances

FromJSON PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

parseJSON :: Value -> Parser PIIDetection

parseJSONList :: Value -> Parser [PIIDetection]

ToJSON PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

toJSON :: PIIDetection -> Value

toEncoding :: PIIDetection -> Encoding

toJSONList :: [PIIDetection] -> Value

toEncodingList :: [PIIDetection] -> Encoding

Generic PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Associated Types

type Rep PIIDetection :: Type -> Type

Methods

from :: PIIDetection -> Rep PIIDetection x

to :: Rep PIIDetection x -> PIIDetection

Read PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

readsPrec :: Int -> ReadS PIIDetection

readList :: ReadS [PIIDetection]

readPrec :: ReadPrec PIIDetection

readListPrec :: ReadPrec [PIIDetection]

Show PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

showsPrec :: Int -> PIIDetection -> ShowS

show :: PIIDetection -> String

showList :: [PIIDetection] -> ShowS

NFData PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

rnf :: PIIDetection -> ()

Eq PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

(==) :: PIIDetection -> PIIDetection -> Bool

(/=) :: PIIDetection -> PIIDetection -> Bool

Hashable PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

Methods

hashWithSalt :: Int -> PIIDetection -> Int

hash :: PIIDetection -> Int

type Rep PIIDetection

Defined in Amazonka.Glue.Types.PIIDetection

type Rep PIIDetection = D1 ('MetaData "PIIDetection" "Amazonka.Glue.Types.PIIDetection" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "PIIDetection'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "maskValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "outputColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sampleFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "thresholdFraction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "piiType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PiiType) :*: S1 ('MetaSel ('Just "entityTypesToDetect") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))))

newPIIDetection

Arguments

:: Text

$sel:name:PIIDetection'

-> NonEmpty Text

$sel:inputs:PIIDetection'

-> PiiType

$sel:piiType:PIIDetection'

-> PIIDetection

Create a value of PIIDetection 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:maskValue:PIIDetection', pIIDetection_maskValue - Indicates the value that will replace the detected entity.

$sel:outputColumnName:PIIDetection', pIIDetection_outputColumnName - Indicates the output column name that will contain any entity type detected in that row.

$sel:sampleFraction:PIIDetection', pIIDetection_sampleFraction - Indicates the fraction of the data to sample when scanning for PII entities.

$sel:thresholdFraction:PIIDetection', pIIDetection_thresholdFraction - Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

$sel:name:PIIDetection', pIIDetection_name - The name of the transform node.

$sel:inputs:PIIDetection', pIIDetection_inputs - The node ID inputs to the transform.

$sel:piiType:PIIDetection', pIIDetection_piiType - Indicates the type of PIIDetection transform.

$sel:entityTypesToDetect:PIIDetection', pIIDetection_entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

pIIDetection_maskValue :: Lens' PIIDetection (Maybe Text)

Indicates the value that will replace the detected entity.

pIIDetection_outputColumnName :: Lens' PIIDetection (Maybe Text)

Indicates the output column name that will contain any entity type detected in that row.

pIIDetection_sampleFraction :: Lens' PIIDetection (Maybe Double)

Indicates the fraction of the data to sample when scanning for PII entities.

pIIDetection_thresholdFraction :: Lens' PIIDetection (Maybe Double)

Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

pIIDetection_name :: Lens' PIIDetection Text

The name of the transform node.

pIIDetection_inputs :: Lens' PIIDetection (NonEmpty Text)

The node ID inputs to the transform.

pIIDetection_piiType :: Lens' PIIDetection PiiType

Indicates the type of PIIDetection transform.

pIIDetection_entityTypesToDetect :: Lens' PIIDetection [Text]

Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE