1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartPiiEntitiesDetectionJob`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`input_data_config(InputDataConfig)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::input_data_config) / [`set_input_data_config(Option<InputDataConfig>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_input_data_config):<br>required: **true**<br><p>The input properties for a PII entities detection job.</p><br>
    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_output_data_config):<br>required: **true**<br><p>Provides configuration parameters for the output of PII entity detection jobs.</p><br>
    ///   - [`mode(PiiEntitiesDetectionMode)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::mode) / [`set_mode(Option<PiiEntitiesDetectionMode>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_mode):<br>required: **true**<br><p>Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.</p><br>
    ///   - [`redaction_config(RedactionConfig)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::redaction_config) / [`set_redaction_config(Option<RedactionConfig>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_redaction_config):<br>required: **false**<br><p>Provides configuration parameters for PII entity redaction.</p>  <p>This parameter is required if you set the <code>Mode</code> parameter to <code>ONLY_REDACTION</code>. In that case, you must provide a <code>RedactionConfig</code> definition that includes the <code>PiiEntityTypes</code> parameter.</p><br>
    ///   - [`data_access_role_arn(impl Into<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_data_access_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.</p><br>
    ///   - [`job_name(impl Into<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_job_name):<br>required: **false**<br><p>The identifier of the job.</p><br>
    ///   - [`language_code(LanguageCode)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::language_code) / [`set_language_code(Option<LanguageCode>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_language_code):<br>required: **true**<br><p>The language of the input documents. Currently, English is the only valid language.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.</p><br>
    ///   - [`tags(Tag)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::set_tags):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`StartPiiEntitiesDetectionJobOutput`](crate::operation::start_pii_entities_detection_job::StartPiiEntitiesDetectionJobOutput) with field(s):
    ///   - [`job_id(Option<String>)`](crate::operation::start_pii_entities_detection_job::StartPiiEntitiesDetectionJobOutput::job_id): <p>The identifier generated for the job.</p>
    ///   - [`job_arn(Option<String>)`](crate::operation::start_pii_entities_detection_job::StartPiiEntitiesDetectionJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the PII entity 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:</p>  <p> <code>arn:   <partition>    :comprehend:    <region>     :     <account-id>      :pii-entities-detection-job/      <job-id></job-id>     </account-id>    </region>   </partition></code> </p>  <p>The following is an example job ARN:</p>  <p> <code>arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>
    ///   - [`job_status(Option<JobStatus>)`](crate::operation::start_pii_entities_detection_job::StartPiiEntitiesDetectionJobOutput::job_status): <p>The status of the job.</p>
    /// - On failure, responds with [`SdkError<StartPiiEntitiesDetectionJobError>`](crate::operation::start_pii_entities_detection_job::StartPiiEntitiesDetectionJobError)
    pub fn start_pii_entities_detection_job(
        &self,
    ) -> crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder {
        crate::operation::start_pii_entities_detection_job::builders::StartPiiEntitiesDetectionJobFluentBuilder::new(self.handle.clone())
    }
}