Supported sensitive data entity types
When you configure sensitive data detection,
PiiEntitiesConfiguration.PiiEntityTypes controls which entity types Amazon Textract
Insights acts on. You can pass ALL to act on every supported type, or a
list of specific type names. For how detection and redaction work, see Detecting and redacting sensitive data.
Requesting entity types
Set PiiEntityTypes to one of:
-
ALL— detect and (if redaction is enabled) mask every supported entity type. -
A list of specific type names — act only on those types.
"PiiEntitiesConfiguration": { "PiiEntityTypes": ["US_SOCIAL_SECURITY_NUMBER", "NAME", "ADDRESS"], "RedactionMaskMode": "ENTITY_TYPE" }
Passing a specific list rather than ALL reduces the chance of over-masking
form boilerplate and labels that resemble sensitive values.
Entity types
Pass ALL, or a list of 1 to 32 of the following values. Use these
spellings exactly.
Entity type |
Description |
|---|---|
|
A physical address, such as a street address, city, state, or ZIP code. |
|
An individual's age. |
|
An individual's name. |
|
An email address. |
|
A phone number. |
|
A user name that identifies an account. |
|
A password. |
|
A driver's license number. |
|
A vehicle license plate number. |
|
A vehicle identification number (VIN). |
Entity type |
Description |
|---|---|
|
A card verification value (CVV). |
|
A card expiration date. |
|
A credit or debit card number. |
|
A personal identification number. |
|
An international bank account number (IBAN). |
|
A SWIFT/BIC bank identifier code. |
Entity type |
Description |
|---|---|
|
An IPv4 or IPv6 address. |
|
A network interface MAC address. |
|
A web address. |
|
An AWS access key ID. |
|
An AWS secret access key. |
Entity type |
Description |
|---|---|
|
A US bank account number. |
|
A US bank routing number. |
|
A US Individual Taxpayer Identification Number (ITIN). |
|
A US passport number. |
|
A US Social Security number (SSN). |
Entity type |
Description |
|---|---|
|
A Canadian health service number. |
|
A Canadian Social Insurance Number (SIN). |
Entity type |
Description |
|---|---|
|
A UK National Health Service (NHS) number. |
|
A UK National Insurance number. |
|
A UK Unique Taxpayer Reference (UTR) number. |
Mask tokens
When redaction is enabled with RedactionMaskMode set to
ENTITY_TYPE, each masked span is replaced with its type label in brackets —
for example [NAME], [ADDRESS], [EMAIL], [PHONE], and [URL]. With
RedactionMaskMode set to PII, spans are replaced with a single
generic marker regardless of type.