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

aws_sdk_sagemaker/client/
list_trials.rs
