aws_sdk_comprehend/client/describe_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 [`DescribeKeyPhrasesDetectionJob`](crate::operation::describe_key_phrases_detection_job::builders::DescribeKeyPhrasesDetectionJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_id(impl Into<String>)`](crate::operation::describe_key_phrases_detection_job::builders::DescribeKeyPhrasesDetectionJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::describe_key_phrases_detection_job::builders::DescribeKeyPhrasesDetectionJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The identifier that Amazon Comprehend generated for the job. The <code>StartKeyPhrasesDetectionJob</code> operation returns this identifier in its response.</p><br>
7 /// - On success, responds with [`DescribeKeyPhrasesDetectionJobOutput`](crate::operation::describe_key_phrases_detection_job::DescribeKeyPhrasesDetectionJobOutput) with field(s):
8 /// - [`key_phrases_detection_job_properties(Option<KeyPhrasesDetectionJobProperties>)`](crate::operation::describe_key_phrases_detection_job::DescribeKeyPhrasesDetectionJobOutput::key_phrases_detection_job_properties): <p>An object that contains the properties associated with a key phrases detection job.</p>
9 /// - On failure, responds with [`SdkError<DescribeKeyPhrasesDetectionJobError>`](crate::operation::describe_key_phrases_detection_job::DescribeKeyPhrasesDetectionJobError)
10 pub fn describe_key_phrases_detection_job(
11 &self,
12 ) -> crate::operation::describe_key_phrases_detection_job::builders::DescribeKeyPhrasesDetectionJobFluentBuilder {
13 crate::operation::describe_key_phrases_detection_job::builders::DescribeKeyPhrasesDetectionJobFluentBuilder::new(self.handle.clone())
14 }
15}