Struct aws_sdk_sagemaker::input::ListTrainingJobsForHyperParameterTuningJobInput

#[non_exhaustive]
pub struct ListTrainingJobsForHyperParameterTuningJobInput {
    pub hyper_parameter_tuning_job_name: Option<String>,
    pub next_token: Option<String>,
    pub max_results: Option<i32>,
    pub status_equals: Option<TrainingJobStatus>,
    pub sort_by: Option<TrainingJobSortByOptions>,
    pub sort_order: Option<SortOrder>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hyper_parameter_tuning_job_name: Option<String>

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

next_token: Option<String>

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.

max_results: Option<i32>

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

status_equals: Option<TrainingJobStatus>

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

sort_by: Option<TrainingJobSortByOptions>

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.

sort_order: Option<SortOrder>

The sort order for results. The default is Ascending.

Implementations

impl ListTrainingJobsForHyperParameterTuningJobInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<ListTrainingJobsForHyperParameterTuningJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<ListTrainingJobsForHyperParameterTuningJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListTrainingJobsForHyperParameterTuningJobInput

impl ListTrainingJobsForHyperParameterTuningJobInput

pub fn hyper_parameter_tuning_job_name(&self) -> Option<&str>

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

pub fn next_token(&self) -> Option<&str>

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) -> Option<i32>

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

pub fn status_equals(&self) -> Option<&TrainingJobStatus>

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

pub fn sort_by(&self) -> Option<&TrainingJobSortByOptions>

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) -> Option<&SortOrder>

The sort order for results. The default is Ascending.

Trait Implementations

impl Clone for ListTrainingJobsForHyperParameterTuningJobInput

fn clone(&self) -> ListTrainingJobsForHyperParameterTuningJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListTrainingJobsForHyperParameterTuningJobInput

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

Formats the value using the given formatter.

impl PartialEq<ListTrainingJobsForHyperParameterTuningJobInput> for ListTrainingJobsForHyperParameterTuningJobInput

fn eq(&self, other: &ListTrainingJobsForHyperParameterTuningJobInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListTrainingJobsForHyperParameterTuningJobInput) -> bool

This method tests for !=.

impl StructuralPartialEq for ListTrainingJobsForHyperParameterTuningJobInput