aws_sdk_comprehend/client/
stop_key_phrases_detection_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`StopKeyPhrasesDetectionJob`](crate::operation::stop_key_phrases_detection_job::builders::StopKeyPhrasesDetectionJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::stop_key_phrases_detection_job::builders::StopKeyPhrasesDetectionJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::stop_key_phrases_detection_job::builders::StopKeyPhrasesDetectionJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The identifier of the key phrases detection job to stop.</p><br>
7    /// - On success, responds with [`StopKeyPhrasesDetectionJobOutput`](crate::operation::stop_key_phrases_detection_job::StopKeyPhrasesDetectionJobOutput) with field(s):
8    ///   - [`job_id(Option<String>)`](crate::operation::stop_key_phrases_detection_job::StopKeyPhrasesDetectionJobOutput::job_id): <p>The identifier of the key phrases detection job to stop.</p>
9    ///   - [`job_status(Option<JobStatus>)`](crate::operation::stop_key_phrases_detection_job::StopKeyPhrasesDetectionJobOutput::job_status): <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or <code>STOPPED</code> if the job was previously stopped with the <code>StopKeyPhrasesDetectionJob</code> operation.</p>
10    /// - On failure, responds with [`SdkError<StopKeyPhrasesDetectionJobError>`](crate::operation::stop_key_phrases_detection_job::StopKeyPhrasesDetectionJobError)
11    pub fn stop_key_phrases_detection_job(
12        &self,
13    ) -> crate::operation::stop_key_phrases_detection_job::builders::StopKeyPhrasesDetectionJobFluentBuilder {
14        crate::operation::stop_key_phrases_detection_job::builders::StopKeyPhrasesDetectionJobFluentBuilder::new(self.handle.clone())
15    }
16}