aws_sdk_comprehend/client/

start_document_classification_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartDocumentClassificationJob`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`job_name(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_job_name):<br>required: **false**<br><p>The identifier of the job.</p><br>
    ///   - [`document_classifier_arn(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::document_classifier_arn) / [`set_document_classifier_arn(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_document_classifier_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the document classifier to use to process the job.</p><br>
    ///   - [`input_data_config(InputDataConfig)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::input_data_config) / [`set_input_data_config(Option<InputDataConfig>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_input_data_config):<br>required: **true**<br><p>Specifies the format and location of the input data for the job.</p><br>
    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_output_data_config):<br>required: **true**<br><p>Specifies where to send the output files.</p><br>
    ///   - [`data_access_role_arn(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::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>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_client_request_token):<br>required: **false**<br><p>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</p><br>
    ///   - [`volume_kms_key_id(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::volume_kms_key_id) / [`set_volume_kms_key_id(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_volume_kms_key_id):<br>required: **false**<br><p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:</p> <ul>  <li>   <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code></p></li>  <li>   <p>Amazon Resource Name (ARN) of a KMS Key: <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code></p></li> </ul><br>
    ///   - [`vpc_config(VpcConfig)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::vpc_config) / [`set_vpc_config(Option<VpcConfig>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_vpc_config):<br>required: **false**<br><p>Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon VPC</a>.</p><br>
    ///   - [`tags(Tag)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_tags):<br>required: **false**<br><p>Tags to associate with the document classification 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>
    ///   - [`flywheel_arn(impl Into<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::flywheel_arn) / [`set_flywheel_arn(Option<String>)`](crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::set_flywheel_arn):<br>required: **false**<br><p>The Amazon Resource Number (ARN) of the flywheel associated with the model to use.</p><br>
    /// - On success, responds with [`StartDocumentClassificationJobOutput`](crate::operation::start_document_classification_job::StartDocumentClassificationJobOutput) with field(s):
    ///   - [`job_id(Option<String>)`](crate::operation::start_document_classification_job::StartDocumentClassificationJobOutput::job_id): <p>The identifier generated for the job. To get the status of the job, use this identifier with the <code>DescribeDocumentClassificationJob</code> operation.</p>
    ///   - [`job_arn(Option<String>)`](crate::operation::start_document_classification_job::StartDocumentClassificationJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the document classification 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>      :document-classification-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:document-classification-job/1234abcd12ab34cd56ef1234567890ab</code></p>
    ///   - [`job_status(Option<JobStatus>)`](crate::operation::start_document_classification_job::StartDocumentClassificationJobOutput::job_status): <p>The status of the job:</p> <ul>  <li>   <p>SUBMITTED - The job has been received and queued for processing.</p></li>  <li>   <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p></li>  <li>   <p>COMPLETED - The job was successfully completed and the output is available.</p></li>  <li>   <p>FAILED - The job did not complete. For details, use the <code>DescribeDocumentClassificationJob</code> operation.</p></li>  <li>   <p>STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.</p></li>  <li>   <p>STOPPED - The job was successfully stopped without completing.</p></li> </ul>
    ///   - [`document_classifier_arn(Option<String>)`](crate::operation::start_document_classification_job::StartDocumentClassificationJobOutput::document_classifier_arn): <p>The ARN of the custom classification model.</p>
    /// - On failure, responds with [`SdkError<StartDocumentClassificationJobError>`](crate::operation::start_document_classification_job::StartDocumentClassificationJobError)
    pub fn start_document_classification_job(
        &self,
    ) -> crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder {
        crate::operation::start_document_classification_job::builders::StartDocumentClassificationJobFluentBuilder::new(self.handle.clone())
    }
}