Class: Aws::Comprehend::Types::RedactionConfig

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass RedactionConfig data as a hash:

{
  pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, DATE_TIME, PASSPORT_NUMBER, DRIVER_ID, URL, AGE, USERNAME, PASSWORD, AWS_ACCESS_KEY, AWS_SECRET_KEY, IP_ADDRESS, MAC_ADDRESS, ALL
  mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE
  mask_character: "MaskCharacter",
}

Provides configuration parameters for PII entity redaction.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#mask_character ⇒ String

A character that replaces each character in the redacted PII entity.

Returns:

  • (String) 


5006
5007
5008
5009
5010
5011
5012
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5006

class RedactionConfig < Struct.new(
  :pii_entity_types,
  :mask_mode,
  :mask_character)
  SENSITIVE = []
  include Aws::Structure
end

#mask_mode ⇒ String

Specifies whether the PII entity is redacted with the mask character or the entity type.

Returns:

  • (String) 


5006
5007
5008
5009
5010
5011
5012
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5006

class RedactionConfig < Struct.new(
  :pii_entity_types,
  :mask_mode,
  :mask_character)
  SENSITIVE = []
  include Aws::Structure
end

#pii_entity_types ⇒ Array<String>

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

Returns:

  • (Array<String>) 


5006
5007
5008
5009
5010
5011
5012
 
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5006

class RedactionConfig < Struct.new(
  :pii_entity_types,
  :mask_mode,
  :mask_character)
  SENSITIVE = []
  include Aws::Structure
end