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 [`StartTargetedSentimentDetectionJob`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`input_data_config(InputDataConfig)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::input_data_config) / [`set_input_data_config(Option<InputDataConfig>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::set_input_data_config):<br>required: **true**<br><p>The input properties for an inference job. The document reader config field applies only to non-text inputs for custom analysis.</p><br>
    ///   - [`output_data_config(OutputDataConfig)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::output_data_config) / [`set_output_data_config(Option<OutputDataConfig>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::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_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::data_access_role_arn) / [`set_data_access_role_arn(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::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. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p><br>
    ///   - [`job_name(impl Into<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::set_job_name):<br>required: **false**<br><p>The identifier of the job.</p><br>
    ///   - [`language_code(LanguageCode)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::language_code) / [`set_language_code(Option<LanguageCode>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::set_language_code):<br>required: **true**<br><p>The language of the input documents. Currently, English is the only supported language.</p><br>
    ///   - [`client_request_token(impl Into<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::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>
    ///   - [`volume_kms_key_id(impl Into<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::volume_kms_key_id) / [`set_volume_kms_key_id(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::set_volume_kms_key_id):<br>required: **false**<br><p>ID for the 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_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::vpc_config) / [`set_vpc_config(Option<VpcConfig>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::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 the 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_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::set_tags):<br>required: **false**<br><p>Tags to associate with the targeted sentiment 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 [`StartTargetedSentimentDetectionJobOutput`](crate::operation::start_targeted_sentiment_detection_job::StartTargetedSentimentDetectionJobOutput) with field(s):
    ///   - [`job_id(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::StartTargetedSentimentDetectionJobOutput::job_id): <p>The identifier generated for the job. To get the status of a job, use this identifier with the <code>DescribeTargetedSentimentDetectionJob</code> operation.</p>
    ///   - [`job_arn(Option<String>)`](crate::operation::start_targeted_sentiment_detection_job::StartTargetedSentimentDetectionJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the targeted sentiment 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>      :targeted-sentiment-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:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab</code> </p>
    ///   - [`job_status(Option<JobStatus>)`](crate::operation::start_targeted_sentiment_detection_job::StartTargetedSentimentDetectionJobOutput::job_status): <p>The status of the job. </p>  <ul>   <li> <p>SUBMITTED - The job has been received and is 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. To get details, use the <code>DescribeTargetedSentimentDetectionJob</code> operation.</p> </li>  </ul>
    /// - On failure, responds with [`SdkError<StartTargetedSentimentDetectionJobError>`](crate::operation::start_targeted_sentiment_detection_job::StartTargetedSentimentDetectionJobError)
    pub fn start_targeted_sentiment_detection_job(
        &self,
    ) -> crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder {
        crate::operation::start_targeted_sentiment_detection_job::builders::StartTargetedSentimentDetectionJobFluentBuilder::new(self.handle.clone())
    }
}