Struct aws_sdk_comprehend::types::builders::PiiEntitiesDetectionJobPropertiesBuilder

#[non_exhaustive]
pub struct PiiEntitiesDetectionJobPropertiesBuilder { /* private fields */ }

A builder for PiiEntitiesDetectionJobProperties.

Implementations

impl PiiEntitiesDetectionJobPropertiesBuilder

pub fn job_id(self, input: impl Into<String>) -> Self

The identifier assigned to the PII entities detection job.

pub fn set_job_id(self, input: Option<String>) -> Self

The identifier assigned to the PII entities detection job.

pub fn get_job_id(&self) -> &Option<String>

The identifier assigned to the PII entities detection job.

pub fn job_arn(self, input: impl Into<String>) -> Self

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 set_job_arn(self, input: Option<String>) -> Self

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 get_job_arn(&self) -> &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

pub fn job_name(self, input: impl Into<String>) -> Self

The name that you assigned the PII entities detection job.

pub fn set_job_name(self, input: Option<String>) -> Self

The name that you assigned the PII entities detection job.

pub fn get_job_name(&self) -> &Option<String>

The name that you assigned the PII entities detection job.

pub fn job_status(self, input: JobStatus) -> Self

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 set_job_status(self, input: Option<JobStatus>) -> Self

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 get_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, input: impl Into<String>) -> Self

A description of the status of a job.

pub fn set_message(self, input: Option<String>) -> Self

A description of the status of a job.

pub fn get_message(&self) -> &Option<String>

A description of the status of a job.

pub fn submit_time(self, input: DateTime) -> Self

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

pub fn set_submit_time(self, input: Option<DateTime>) -> Self

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

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

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

pub fn end_time(self, input: DateTime) -> Self

The time that the PII entities detection job completed.

pub fn set_end_time(self, input: Option<DateTime>) -> Self

The time that the PII entities detection job completed.

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

The time that the PII entities detection job completed.

pub fn input_data_config(self, input: InputDataConfig) -> Self

The input properties for a PII entities detection job.

pub fn set_input_data_config(self, input: Option<InputDataConfig>) -> Self

The input properties for a PII entities detection job.

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

The input properties for a PII entities detection job.

pub fn output_data_config(self, input: PiiOutputDataConfig) -> Self

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

pub fn set_output_data_config(self, input: Option<PiiOutputDataConfig>) -> Self

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

pub fn get_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, input: RedactionConfig) -> Self

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 set_redaction_config(self, input: Option<RedactionConfig>) -> Self

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 get_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, input: LanguageCode) -> Self

The language code of the input documents

pub fn set_language_code(self, input: Option<LanguageCode>) -> Self

The language code of the input documents

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

The language code of the input documents

pub fn data_access_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_data_access_role_arn(self, input: Option<String>) -> Self

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

pub fn get_data_access_role_arn(&self) -> &Option<String>

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

pub fn mode(self, input: PiiEntitiesDetectionMode) -> Self

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

pub fn set_mode(self, input: Option<PiiEntitiesDetectionMode>) -> Self

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

pub fn get_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 build(self) -> PiiEntitiesDetectionJobProperties

Consumes the builder and constructs a PiiEntitiesDetectionJobProperties.

Trait Implementations

impl Clone for PiiEntitiesDetectionJobPropertiesBuilder

fn clone(&self) -> PiiEntitiesDetectionJobPropertiesBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PiiEntitiesDetectionJobPropertiesBuilder

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

Formats the value using the given formatter.

impl Default for PiiEntitiesDetectionJobPropertiesBuilder

fn default() -> PiiEntitiesDetectionJobPropertiesBuilder

Returns the “default value” for a type.

impl PartialEq for PiiEntitiesDetectionJobPropertiesBuilder

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