aws_sdk_sagemaker/client/list_experiments.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 [`ListExperiments`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`created_after(DateTime)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::created_after) / [`set_created_after(Option<DateTime>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_created_after):<br>required: **false**<br><p>A filter that returns only experiments created after the specified time.</p><br>
8 /// - [`created_before(DateTime)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::created_before) / [`set_created_before(Option<DateTime>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_created_before):<br>required: **false**<br><p>A filter that returns only experiments created before the specified time.</p><br>
9 /// - [`sort_by(SortExperimentsBy)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::sort_by) / [`set_sort_by(Option<SortExperimentsBy>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_sort_by):<br>required: **false**<br><p>The property used to sort results. The default value is <code>CreationTime</code>.</p><br>
10 /// - [`sort_order(SortOrder)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::sort_order) / [`set_sort_order(Option<SortOrder>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_sort_order):<br>required: **false**<br><p>The sort order. The default value is <code>Descending</code>.</p><br>
11 /// - [`next_token(impl Into<String>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_next_token):<br>required: **false**<br><p>If the previous call to <code>ListExperiments</code> didn't return the full set of experiments, the call returns a token for getting the next set of experiments.</p><br>
12 /// - [`max_results(i32)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of experiments to return in the response. The default value is 10.</p><br>
13 /// - On success, responds with [`ListExperimentsOutput`](crate::operation::list_experiments::ListExperimentsOutput) with field(s):
14 /// - [`experiment_summaries(Option<Vec::<ExperimentSummary>>)`](crate::operation::list_experiments::ListExperimentsOutput::experiment_summaries): <p>A list of the summaries of your experiments.</p>
15 /// - [`next_token(Option<String>)`](crate::operation::list_experiments::ListExperimentsOutput::next_token): <p>A token for getting the next set of experiments, if there are any.</p>
16 /// - On failure, responds with [`SdkError<ListExperimentsError>`](crate::operation::list_experiments::ListExperimentsError)
17 pub fn list_experiments(&self) -> crate::operation::list_experiments::builders::ListExperimentsFluentBuilder {
18 crate::operation::list_experiments::builders::ListExperimentsFluentBuilder::new(self.handle.clone())
19 }
20}