Struct aws_sdk_comprehend::client::fluent_builders::StartPiiEntitiesDetectionJob

pub struct StartPiiEntitiesDetectionJob { /* private fields */ }

Fluent builder constructing a request to StartPiiEntitiesDetectionJob.

Starts an asynchronous PII entity detection job for a collection of documents.

Implementations

impl StartPiiEntitiesDetectionJob

pub async fn send(
    self
) -> Result<StartPiiEntitiesDetectionJobOutput, SdkError<StartPiiEntitiesDetectionJobError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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 output_data_config(self, input: OutputDataConfig) -> Self

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

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

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.

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (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 AWS Identity and Access Management (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 language_code(self, input: LanguageCode) -> Self

The language of the input documents.

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

The language of the input documents.

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 tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Tags to be associated 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 be associated 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.

Trait Implementations

impl Clone for StartPiiEntitiesDetectionJob

fn clone(&self) -> StartPiiEntitiesDetectionJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartPiiEntitiesDetectionJob

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

Formats the value using the given formatter.