aws_sdk_comprehend/client/
list_key_phrases_detection_jobs.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 [`ListKeyPhrasesDetectionJobs`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`filter(KeyPhrasesDetectionJobFilter)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::filter) / [`set_filter(Option<KeyPhrasesDetectionJobFilter>)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::set_filter):<br>required: **false**<br><p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>Identifies the next page of results to return.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in each page. The default is 100.</p><br>
10    /// - On success, responds with [`ListKeyPhrasesDetectionJobsOutput`](crate::operation::list_key_phrases_detection_jobs::ListKeyPhrasesDetectionJobsOutput) with field(s):
11    ///   - [`key_phrases_detection_job_properties_list(Option<Vec::<KeyPhrasesDetectionJobProperties>>)`](crate::operation::list_key_phrases_detection_jobs::ListKeyPhrasesDetectionJobsOutput::key_phrases_detection_job_properties_list): <p>A list containing the properties of each job that is returned.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_key_phrases_detection_jobs::ListKeyPhrasesDetectionJobsOutput::next_token): <p>Identifies the next page of results to return.</p>
13    /// - On failure, responds with [`SdkError<ListKeyPhrasesDetectionJobsError>`](crate::operation::list_key_phrases_detection_jobs::ListKeyPhrasesDetectionJobsError)
14    pub fn list_key_phrases_detection_jobs(
15        &self,
16    ) -> crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder {
17        crate::operation::list_key_phrases_detection_jobs::builders::ListKeyPhrasesDetectionJobsFluentBuilder::new(self.handle.clone())
18    }
19}