aws_sdk_sagemaker/client/
list_hyper_parameter_tuning_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 [`ListHyperParameterTuningJobs`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`next_token(impl Into<String>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the result of the previous <code>ListHyperParameterTuningJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of tuning jobs, use the token in the next request.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of tuning jobs to return. The default value is 10.</p><br>
9    ///   - [`sort_by(HyperParameterTuningJobSortByOptions)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::sort_by) / [`set_sort_by(Option<HyperParameterTuningJobSortByOptions>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The field to sort results by. The default is <code>Name</code>.</p><br>
10    ///   - [`sort_order(SortOrder)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order for results. The default is <code>Ascending</code>.</p><br>
11    ///   - [`name_contains(impl Into<String>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::name_contains) / [`set_name_contains(Option<String>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_name_contains):<br>required: **false**<br><p>A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.</p><br>
12    ///   - [`creation_time_after(DateTime)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::creation_time_after) / [`set_creation_time_after(Option<DateTime>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_creation_time_after):<br>required: **false**<br><p>A filter that returns only tuning jobs that were created after the specified time.</p><br>
13    ///   - [`creation_time_before(DateTime)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::creation_time_before) / [`set_creation_time_before(Option<DateTime>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_creation_time_before):<br>required: **false**<br><p>A filter that returns only tuning jobs that were created before the specified time.</p><br>
14    ///   - [`last_modified_time_after(DateTime)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::last_modified_time_after) / [`set_last_modified_time_after(Option<DateTime>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_last_modified_time_after):<br>required: **false**<br><p>A filter that returns only tuning jobs that were modified after the specified time.</p><br>
15    ///   - [`last_modified_time_before(DateTime)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::last_modified_time_before) / [`set_last_modified_time_before(Option<DateTime>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_last_modified_time_before):<br>required: **false**<br><p>A filter that returns only tuning jobs that were modified before the specified time.</p><br>
16    ///   - [`status_equals(HyperParameterTuningJobStatus)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::status_equals) / [`set_status_equals(Option<HyperParameterTuningJobStatus>)`](crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::set_status_equals):<br>required: **false**<br><p>A filter that returns only tuning jobs with the specified status.</p><br>
17    /// - On success, responds with [`ListHyperParameterTuningJobsOutput`](crate::operation::list_hyper_parameter_tuning_jobs::ListHyperParameterTuningJobsOutput) with field(s):
18    ///   - [`hyper_parameter_tuning_job_summaries(Option<Vec::<HyperParameterTuningJobSummary>>)`](crate::operation::list_hyper_parameter_tuning_jobs::ListHyperParameterTuningJobsOutput::hyper_parameter_tuning_job_summaries): <p>A list of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobSummary.html">HyperParameterTuningJobSummary</a> objects that describe the tuning jobs that the <code>ListHyperParameterTuningJobs</code> request returned.</p>
19    ///   - [`next_token(Option<String>)`](crate::operation::list_hyper_parameter_tuning_jobs::ListHyperParameterTuningJobsOutput::next_token): <p>If the result of this <code>ListHyperParameterTuningJobs</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of tuning jobs, use the token in the next request.</p>
20    /// - On failure, responds with [`SdkError<ListHyperParameterTuningJobsError>`](crate::operation::list_hyper_parameter_tuning_jobs::ListHyperParameterTuningJobsError)
21    pub fn list_hyper_parameter_tuning_jobs(
22        &self,
23    ) -> crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder {
24        crate::operation::list_hyper_parameter_tuning_jobs::builders::ListHyperParameterTuningJobsFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_sagemaker/client/list_hyper_parameter_tuning_jobs.rs

aws_sdk_sagemaker/client/
list_hyper_parameter_tuning_jobs.rs
