Provides configuration parameters for PII entity redaction.
Type: objectProperties: 3
Machine-LearningNatural Language ProcessingNLPText Analysis
RedactionConfig is a JSON Structure definition published by Amazon Comprehend, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-redaction-config-structure.json",
"name": "RedactionConfig",
"description": "Provides configuration parameters for PII entity redaction.",
"type": "object",
"properties": {
"PiiEntityTypes": {
"allOf": [
{
"$ref": "#/components/schemas/ListOfPiiEntityTypes"
},
{
"description": "An array of the types of PII entities that Amazon Comprehend detects in the input text for your request."
}
]
},
"MaskMode": {
"allOf": [
{
"$ref": "#/components/schemas/PiiEntitiesDetectionMaskMode"
},
{
"description": "Specifies whether the PII entity is redacted with the mask character or the entity type."
}
]
},
"MaskCharacter": {
"allOf": [
{
"$ref": "#/components/schemas/MaskCharacter"
},
{
"description": "A character that replaces each character in the redacted PII entity."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.