Struct aws_sdk_comprehend::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobInputBuilder

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

A builder for StartPiiEntitiesDetectionJobInput.

Implementations

impl StartPiiEntitiesDetectionJobInputBuilder

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

The input properties for a PII entities detection job.

This field is required.

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: OutputDataConfig) -> Self

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

This field is required.

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

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

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

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

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.

This field is required.

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 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 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.

This field is required.

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

The identifier of the job.

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

The identifier of the job.

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

The identifier of the job.

pub fn language_code(self, input: LanguageCode) -> Self

The language of the input documents. Currently, English is the only valid language.

This field is required.

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

The language of the input documents. Currently, English is the only valid language.

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

The language of the input documents. Currently, English is the only valid language.

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

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

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

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

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

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

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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.

pub fn get_tags(&self) -> &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.

pub fn build(self) -> Result<StartPiiEntitiesDetectionJobInput, BuildError>

Consumes the builder and constructs a StartPiiEntitiesDetectionJobInput.

impl StartPiiEntitiesDetectionJobInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<StartPiiEntitiesDetectionJobOutput, SdkError<StartPiiEntitiesDetectionJobError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for StartPiiEntitiesDetectionJobInputBuilder

fn clone(&self) -> StartPiiEntitiesDetectionJobInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartPiiEntitiesDetectionJobInputBuilder

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

Formats the value using the given formatter.

impl Default for StartPiiEntitiesDetectionJobInputBuilder

fn default() -> StartPiiEntitiesDetectionJobInputBuilder

Returns the “default value” for a type.

impl PartialEq for StartPiiEntitiesDetectionJobInputBuilder

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