Struct aws_sdk_sagemaker::client::fluent_builders::ListTrainingJobsForHyperParameterTuningJob

pub struct ListTrainingJobsForHyperParameterTuningJob<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to ListTrainingJobsForHyperParameterTuningJob.

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

Implementations

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

pub async fn send(
    self
) -> Result<ListTrainingJobsForHyperParameterTuningJobOutput, SdkError<ListTrainingJobsForHyperParameterTuningJobError>> where
    R::Policy: SmithyRetryPolicy<ListTrainingJobsForHyperParameterTuningJobInputOperationOutputAlias, ListTrainingJobsForHyperParameterTuningJobOutput, ListTrainingJobsForHyperParameterTuningJobError, ListTrainingJobsForHyperParameterTuningJobInputOperationRetryAlias>, 

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 into_paginator(
    self
) -> ListTrainingJobsForHyperParameterTuningJobPaginator<C, M, R>

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn hyper_parameter_tuning_job_name(self, input: impl Into<String>) -> Self

The name of the tuning job whose training jobs you want to list.

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

The name of the tuning job whose training jobs you want to list.

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

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

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

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

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

The maximum number of training jobs to return. The default value is 10.

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

The maximum number of training jobs to return. The default value is 10.

pub fn status_equals(self, input: TrainingJobStatus) -> Self

A filter that returns only training jobs with the specified status.

pub fn set_status_equals(self, input: Option<TrainingJobStatus>) -> Self

A filter that returns only training jobs with the specified status.

pub fn sort_by(self, input: TrainingJobSortByOptions) -> Self

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

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

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

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

The sort order for results. The default is Ascending.

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

The sort order for results. The default is Ascending.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for ListTrainingJobsForHyperParameterTuningJob<C, M, R>

fn clone(&self) -> ListTrainingJobsForHyperParameterTuningJob<C, M, R>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.