Struct aws_sdk_comprehend::types::PiiEntitiesDetectionJobProperties

#[non_exhaustive]
pub struct PiiEntitiesDetectionJobProperties {

    pub job_id: Option<String>,
    pub job_arn: Option<String>,
    pub job_name: Option<String>,
    pub job_status: Option<JobStatus>,
    pub message: Option<String>,
    pub submit_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
    pub input_data_config: Option<InputDataConfig>,
    pub output_data_config: Option<PiiOutputDataConfig>,
    pub redaction_config: Option<RedactionConfig>,
    pub language_code: Option<LanguageCode>,
    pub data_access_role_arn: Option<String>,
    pub mode: Option<PiiEntitiesDetectionMode>,
}

Provides information about a PII entities detection job.

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.

job_id: Option<String>

The identifier assigned to the PII entities detection job.

job_arn: Option<String>

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :pii-entities-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

job_name: Option<String>

The name that you assigned the PII entities detection job.

job_status: Option<JobStatus>

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

message: Option<String>

A description of the status of a job.

submit_time: Option<DateTime>

The time that the PII entities detection job was submitted for processing.

end_time: Option<DateTime>

The time that the PII entities detection job completed.

input_data_config: Option<InputDataConfig>

The input properties for a PII entities detection job.

output_data_config: Option<PiiOutputDataConfig>

The output data configuration that you supplied when you created the PII entities detection job.

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.

language_code: Option<LanguageCode>

The language code of the input documents

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.

mode: Option<PiiEntitiesDetectionMode>

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

Implementations

impl PiiEntitiesDetectionJobProperties

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

The identifier assigned to the PII entities detection job.

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

The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:

arn: :comprehend: : :pii-entities-detection-job/

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

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

The name that you assigned the PII entities detection job.

pub fn job_status(&self) -> Option<&JobStatus>

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

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

A description of the status of a job.

pub fn submit_time(&self) -> Option<&DateTime>

The time that the PII entities detection job was submitted for processing.

pub fn end_time(&self) -> Option<&DateTime>

The time that the PII entities detection job completed.

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

The input properties for a PII entities detection job.

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

The output data configuration that you supplied when you created the PII entities detection job.

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 language_code(&self) -> Option<&LanguageCode>

The language code of the input documents

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 mode(&self) -> Option<&PiiEntitiesDetectionMode>

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

impl PiiEntitiesDetectionJobProperties

pub fn builder() -> PiiEntitiesDetectionJobPropertiesBuilder

Creates a new builder-style object to manufacture PiiEntitiesDetectionJobProperties.

Trait Implementations

impl Clone for PiiEntitiesDetectionJobProperties

fn clone(&self) -> PiiEntitiesDetectionJobProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PiiEntitiesDetectionJobProperties

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

Formats the value using the given formatter.

impl PartialEq for PiiEntitiesDetectionJobProperties

fn eq(&self, other: &PiiEntitiesDetectionJobProperties) -> 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 PiiEntitiesDetectionJobProperties