Struct aws_sdk_sagemaker::client::fluent_builders::ListTrials

pub struct ListTrials<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to ListTrials.

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

Implementations

impl<C, M, R> ListTrials<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(self) -> Result<ListTrialsOutput, SdkError<ListTrialsError>> where
    R::Policy: SmithyRetryPolicy<ListTrialsInputOperationOutputAlias, ListTrialsOutput, ListTrialsError, ListTrialsInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn experiment_name(self, inp: impl Into<String>) -> Self

A filter that returns only trials that are part of the specified experiment.

pub fn set_experiment_name(self, input: Option<String>) -> Self

A filter that returns only trials that are part of the specified experiment.

pub fn trial_component_name(self, inp: impl Into<String>) -> Self

A filter that returns only trials that are associated with the specified trial component.

pub fn set_trial_component_name(self, input: Option<String>) -> Self

A filter that returns only trials that are associated with the specified trial component.

pub fn created_after(self, inp: Instant) -> Self

A filter that returns only trials created after the specified time.

pub fn set_created_after(self, input: Option<Instant>) -> Self

A filter that returns only trials created after the specified time.

pub fn created_before(self, inp: Instant) -> Self

A filter that returns only trials created before the specified time.

pub fn set_created_before(self, input: Option<Instant>) -> Self

A filter that returns only trials created before the specified time.

pub fn sort_by(self, inp: SortTrialsBy) -> Self

The property used to sort results. The default value is CreationTime.

pub fn set_sort_by(self, input: Option<SortTrialsBy>) -> Self

The property used to sort results. The default value is CreationTime.

pub fn sort_order(self, inp: SortOrder) -> Self

The sort order. The default value is Descending.

pub fn set_sort_order(self, input: Option<SortOrder>) -> Self

The sort order. The default value is Descending.

pub fn max_results(self, inp: i32) -> Self

The maximum number of trials to return in the response. The default value is 10.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of trials to return in the response. The default value is 10.

pub fn next_token(self, inp: impl Into<String>) -> Self

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

pub fn set_next_token(self, input: Option<String>) -> Self

If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for ListTrials<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.