amazonka-databrew-2.0: Amazon Glue DataBrew SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DataBrew.Types.EntityDetectorConfiguration

Description

 
Synopsis

Documentation

data EntityDetectorConfiguration Source #

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

See: newEntityDetectorConfiguration smart constructor.

Constructors

EntityDetectorConfiguration' 

Fields

  • allowedStatistics :: Maybe (NonEmpty AllowedStatistics)

    Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

  • entityTypes :: NonEmpty Text

    Entity types to detect. Can be any of the following:

    • USA_SSN
    • EMAIL
    • USA_ITIN
    • USA_PASSPORT_NUMBER
    • PHONE_NUMBER
    • USA_DRIVING_LICENSE
    • BANK_ACCOUNT
    • CREDIT_CARD
    • IP_ADDRESS
    • MAC_ADDRESS
    • USA_DEA_NUMBER
    • USA_HCPCS_CODE
    • USA_NATIONAL_PROVIDER_IDENTIFIER
    • USA_NATIONAL_DRUG_CODE
    • USA_HEALTH_INSURANCE_CLAIM_NUMBER
    • USA_MEDICARE_BENEFICIARY_IDENTIFIER
    • USA_CPT_CODE
    • PERSON_NAME
    • DATE

    The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

Instances

Instances details
FromJSON EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

parseJSON :: Value -> Parser EntityDetectorConfiguration #

parseJSONList :: Value -> Parser [EntityDetectorConfiguration] #

ToJSON EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

toJSON :: EntityDetectorConfiguration -> Value #

toEncoding :: EntityDetectorConfiguration -> Encoding #

toJSONList :: [EntityDetectorConfiguration] -> Value #

toEncodingList :: [EntityDetectorConfiguration] -> Encoding #

Generic EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Associated Types

type Rep EntityDetectorConfiguration :: Type -> Type #

Methods

from :: EntityDetectorConfiguration -> Rep EntityDetectorConfiguration x #

to :: Rep EntityDetectorConfiguration x -> EntityDetectorConfiguration #

Read EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

readsPrec :: Int -> ReadS EntityDetectorConfiguration #

readList :: ReadS [EntityDetectorConfiguration] #

readPrec :: ReadPrec EntityDetectorConfiguration #

readListPrec :: ReadPrec [EntityDetectorConfiguration] #

Show EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

showsPrec :: Int -> EntityDetectorConfiguration -> ShowS #

show :: EntityDetectorConfiguration -> String #

showList :: [EntityDetectorConfiguration] -> ShowS #

NFData EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

rnf :: EntityDetectorConfiguration -> () #

Eq EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

(==) :: EntityDetectorConfiguration -> EntityDetectorConfiguration -> Bool #

(/=) :: EntityDetectorConfiguration -> EntityDetectorConfiguration -> Bool #

Hashable EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

Methods

hashWithSalt :: Int -> EntityDetectorConfiguration -> Int #

hash :: EntityDetectorConfiguration -> Int #

type Rep EntityDetectorConfiguration Source # 
Instance details

Defined in Amazonka.DataBrew.Types.EntityDetectorConfiguration

type Rep EntityDetectorConfiguration = D1 ('MetaData "EntityDetectorConfiguration" "Amazonka.DataBrew.Types.EntityDetectorConfiguration" "amazonka-databrew-2.0-GJMXoRzRb387Yq6XNY29RM" 'False) (C1 ('MetaCons "EntityDetectorConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowedStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty AllowedStatistics))) :*: S1 ('MetaSel ('Just "entityTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))

newEntityDetectorConfiguration Source #

Arguments

:: NonEmpty Text

$sel:entityTypes:EntityDetectorConfiguration'

-> EntityDetectorConfiguration 

Create a value of EntityDetectorConfiguration 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:allowedStatistics:EntityDetectorConfiguration', entityDetectorConfiguration_allowedStatistics - Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

$sel:entityTypes:EntityDetectorConfiguration', entityDetectorConfiguration_entityTypes - Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

entityDetectorConfiguration_allowedStatistics :: Lens' EntityDetectorConfiguration (Maybe (NonEmpty AllowedStatistics)) Source #

Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

entityDetectorConfiguration_entityTypes :: Lens' EntityDetectorConfiguration (NonEmpty Text) Source #

Entity types to detect. Can be any of the following:

  • USA_SSN
  • EMAIL
  • USA_ITIN
  • USA_PASSPORT_NUMBER
  • PHONE_NUMBER
  • USA_DRIVING_LICENSE
  • BANK_ACCOUNT
  • CREDIT_CARD
  • IP_ADDRESS
  • MAC_ADDRESS
  • USA_DEA_NUMBER
  • USA_HCPCS_CODE
  • USA_NATIONAL_PROVIDER_IDENTIFIER
  • USA_NATIONAL_DRUG_CODE
  • USA_HEALTH_INSURANCE_CLAIM_NUMBER
  • USA_MEDICARE_BENEFICIARY_IDENTIFIER
  • USA_CPT_CODE
  • PERSON_NAME
  • DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.