Struct aws_sdk_comprehend::types::RedactionConfig

#[non_exhaustive]
pub struct RedactionConfig {
    pub pii_entity_types: Option<Vec<PiiEntityType>>,
    pub mask_mode: Option<PiiEntitiesDetectionMaskMode>,
    pub mask_character: Option<String>,
}

Provides configuration parameters for PII entity redaction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pii_entity_types: Option<Vec<PiiEntityType>>

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

mask_mode: Option<PiiEntitiesDetectionMaskMode>

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

mask_character: Option<String>

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

Implementations

impl RedactionConfig

pub fn pii_entity_types(&self) -> &[PiiEntityType]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .pii_entity_types.is_none().

pub fn mask_mode(&self) -> Option<&PiiEntitiesDetectionMaskMode>

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

pub fn mask_character(&self) -> Option<&str>

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

impl RedactionConfig

pub fn builder() -> RedactionConfigBuilder

Creates a new builder-style object to manufacture RedactionConfig.

Trait Implementations

impl Clone for RedactionConfig

fn clone(&self) -> RedactionConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RedactionConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RedactionConfig

fn eq(&self, other: &RedactionConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RedactionConfig