aws_sdk_sagemaker/client/
list_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 [`ListJobs`](crate::operation::list_jobs::builders::ListJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`job_category(JobCategory)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::job_category) / [`set_job_category(Option<JobCategory>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_job_category):<br>required: **true**<br><p>The category of jobs to list.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous response was truncated, this token retrieves the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of jobs to return in the response. The default value is 50.</p><br>
10    ///   - [`creation_time_after(DateTime)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only jobs created after the specified time.</p><br>
11    ///   - [`creation_time_before(DateTime)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only jobs created before the specified time.</p><br>
12    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns only jobs modified after the specified time.</p><br>
13    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns only jobs modified before the specified time.</p><br>
14    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in the job name to filter results. Only jobs whose name contains the specified string are returned.</p><br>
15    ///   - [`sort_by(SortBy)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::sort_by) / [`set_sort_by(Option<SortBy>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort results by.</p><br>
16    ///   - [`sort_order(SortOrder)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. Valid values are <code>Ascending</code> and <code>Descending</code>.</p><br>
17    ///   - [`status_equals(JobStatus)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::status_equals) / [`set_status_equals(Option<JobStatus>)`](crate::operation::list_jobs::builders::ListJobsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that returns only jobs with the specified status.</p><br>
18    /// - On success, responds with [`ListJobsOutput`](crate::operation::list_jobs::ListJobsOutput) with field(s):
19    ///   - [`next_token(Option<String>)`](crate::operation::list_jobs::ListJobsOutput::next_token): <p>If the response is truncated, this token retrieves the next set of results.</p>
20    ///   - [`job_summaries(Option<Vec::<JobSummary>>)`](crate::operation::list_jobs::ListJobsOutput::job_summaries): <p>An array of <code>JobSummary</code> objects that provide summary information about the jobs.</p>
21    /// - On failure, responds with [`SdkError<ListJobsError>`](crate::operation::list_jobs::ListJobsError)
22    pub fn list_jobs(&self) -> crate::operation::list_jobs::builders::ListJobsFluentBuilder {
23        crate::operation::list_jobs::builders::ListJobsFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_sagemaker/client/list_jobs.rs

aws_sdk_sagemaker/client/
list_jobs.rs
