EntityDetectorConfiguration

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

Data AnalyticsData PreparationETLMachine Learning

Properties

Name Type Description
EntityTypes object
AllowedStatistics object
View JSON Schema on GitHub

JSON Schema

glue-databrew-entity-detector-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-glue-databrew/refs/heads/main/json-schema/glue-databrew-entity-detector-configuration-schema.json",
  "title": "EntityDetectorConfiguration",
  "description": "Configuration of entity detection for a profile job. When undefined, entity detection is disabled.",
  "type": "object",
  "properties": {
    "EntityTypes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EntityTypeList"
        },
        {
          "description": "<p>Entity types to detect. Can be any of the following:</p> <ul> <li> <p>USA_SSN</p> </li> <li> <p>EMAIL</p> </li> <li> <p>USA_ITIN</p> </li> <li> <p>USA_PASSPORT_NUMBER</p> </li> <li> <p>PHONE_NUMBER</p> </li> <li> <p>USA_DRIVING_LICENSE</p> </li> <li> <p>BANK_ACCOUNT</p> </li> <li> <p>CREDIT_CARD</p> </li> <li> <p>IP_ADDRESS</p> </li> <li> <p>MAC_ADDRESS</p> </li> <li> <p>USA_DEA_NUMBER</p> </li> <li> <p>USA_HCPCS_CODE</p> </li> <li> <p>USA_NATIONAL_PROVIDER_IDENTIFIER</p> </li> <li> <p>USA_NATIONAL_DRUG_CODE</p> </li> <li> <p>USA_HEALTH_INSURANCE_CLAIM_NUMBER</p> </li> <li> <p>USA_MEDICARE_BENEFICIARY_IDENTIFIER</p> </li> <li> <p>USA_CPT_CODE</p> </li> <li> <p>PERSON_NAME</p> </li> <li> <p>DATE</p> </li> </ul> <p>The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.</p>"
        }
      ]
    },
    "AllowedStatistics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AllowedStatisticList"
        },
        {
          "description": "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."
        }
      ]
    }
  },
  "required": [
    "EntityTypes"
  ]
}