Struct StartPiiEntitiesDetectionJobInput

#[non_exhaustive]
pub struct StartPiiEntitiesDetectionJobInput {
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<OutputDataConfig>,
    pub mode: Option<PiiEntitiesDetectionMode>,
    pub redaction_config: Option<RedactionConfig>,
    pub data_access_role_arn: Option<String>,
    pub job_name: Option<String>,
    pub language_code: Option<LanguageCode>,
    pub client_request_token: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

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.

input_data_config: Option<InputDataConfig>

The input properties for a PII entities detection job.

output_data_config: Option<OutputDataConfig>

Provides configuration parameters for the output of PII entity detection jobs.

mode: Option<PiiEntitiesDetectionMode>

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

redaction_config: Option<RedactionConfig>

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

data_access_role_arn: Option<String>

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

job_name: Option<String>

The identifier of the job.

language_code: Option<LanguageCode>

The language of the input documents. Enter the language code for English (en) or Spanish (es).

client_request_token: Option<String>

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

tags: Option<Vec<Tag>>

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Implementations

impl StartPiiEntitiesDetectionJobInput

pub fn input_data_config(&self) -> Option<&InputDataConfig>

The input properties for a PII entities detection job.

pub fn output_data_config(&self) -> Option<&OutputDataConfig>

Provides configuration parameters for the output of PII entity detection jobs.

pub fn mode(&self) -> Option<&PiiEntitiesDetectionMode>

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

pub fn redaction_config(&self) -> Option<&RedactionConfig>

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

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

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

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

The identifier of the job.

pub fn language_code(&self) -> Option<&LanguageCode>

The language of the input documents. Enter the language code for English (en) or Spanish (es).

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

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

pub fn tags(&self) -> &[Tag]

Tags to associate with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

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

impl StartPiiEntitiesDetectionJobInput

pub fn builder() -> StartPiiEntitiesDetectionJobInputBuilder

Creates a new builder-style object to manufacture StartPiiEntitiesDetectionJobInput.

Trait Implementations

impl Clone for StartPiiEntitiesDetectionJobInput

fn clone(&self) -> StartPiiEntitiesDetectionJobInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartPiiEntitiesDetectionJobInput

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

Formats the value using the given formatter.

impl PartialEq for StartPiiEntitiesDetectionJobInput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for StartPiiEntitiesDetectionJobInput