aws_sdk_sagemaker/client/

describe_hyper_parameter_tuning_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeHyperParameterTuningJob`](crate::operation::describe_hyper_parameter_tuning_job::builders::DescribeHyperParameterTuningJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`hyper_parameter_tuning_job_name(impl Into<String>)`](crate::operation::describe_hyper_parameter_tuning_job::builders::DescribeHyperParameterTuningJobFluentBuilder::hyper_parameter_tuning_job_name) / [`set_hyper_parameter_tuning_job_name(Option<String>)`](crate::operation::describe_hyper_parameter_tuning_job::builders::DescribeHyperParameterTuningJobFluentBuilder::set_hyper_parameter_tuning_job_name):<br>required: **true**<br><p>The name of the tuning job.</p><br>
    /// - On success, responds with [`DescribeHyperParameterTuningJobOutput`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput) with field(s):
    ///   - [`hyper_parameter_tuning_job_name(Option<String>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::hyper_parameter_tuning_job_name): <p>The name of the hyperparameter tuning job.</p>
    ///   - [`hyper_parameter_tuning_job_arn(Option<String>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::hyper_parameter_tuning_job_arn): <p>The Amazon Resource Name (ARN) of the tuning job.</p>
    ///   - [`hyper_parameter_tuning_job_config(Option<HyperParameterTuningJobConfig>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::hyper_parameter_tuning_job_config): <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html">HyperParameterTuningJobConfig</a> object that specifies the configuration of the tuning job.</p>
    ///   - [`training_job_definition(Option<HyperParameterTrainingJobDefinition>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::training_job_definition): <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> object that specifies the definition of the training jobs that this tuning job launches.</p>
    ///   - [`training_job_definitions(Option<Vec::<HyperParameterTrainingJobDefinition>>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::training_job_definitions): <p>A list of the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html">HyperParameterTrainingJobDefinition</a> objects launched for this tuning job.</p>
    ///   - [`hyper_parameter_tuning_job_status(Option<HyperParameterTuningJobStatus>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::hyper_parameter_tuning_job_status): <p>The status of the tuning job.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::creation_time): <p>The date and time that the tuning job started.</p>
    ///   - [`hyper_parameter_tuning_end_time(Option<DateTime>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::hyper_parameter_tuning_end_time): <p>The date and time that the tuning job ended.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::last_modified_time): <p>The date and time that the status of the tuning job was modified.</p>
    ///   - [`training_job_status_counters(Option<TrainingJobStatusCounters>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::training_job_status_counters): <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobStatusCounters.html">TrainingJobStatusCounters</a> object that specifies the number of training jobs, categorized by status, that this tuning job launched.</p>
    ///   - [`objective_status_counters(Option<ObjectiveStatusCounters>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::objective_status_counters): <p>The <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ObjectiveStatusCounters.html">ObjectiveStatusCounters</a> object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.</p>
    ///   - [`best_training_job(Option<HyperParameterTrainingJobSummary>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::best_training_job): <p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> object that describes the training job that completed with the best current <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html">HyperParameterTuningJobObjective</a>.</p>
    ///   - [`overall_best_training_job(Option<HyperParameterTrainingJobSummary>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::overall_best_training_job): <p>If the hyperparameter tuning job is an warm start tuning job with a <code>WarmStartType</code> of <code>IDENTICAL_DATA_AND_ALGORITHM</code>, this is the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html">TrainingJobSummary</a> for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.</p>
    ///   - [`warm_start_config(Option<HyperParameterTuningJobWarmStartConfig>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::warm_start_config): <p>The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.</p>
    ///   - [`autotune(Option<Autotune>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::autotune): <p>A flag to indicate if autotune is enabled for the hyperparameter tuning job.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::failure_reason): <p>If the tuning job failed, the reason it failed.</p>
    ///   - [`tuning_job_completion_details(Option<HyperParameterTuningJobCompletionDetails>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::tuning_job_completion_details): <p>Tuning job completion information returned as the response from a hyperparameter tuning job. This information tells if your tuning job has or has not converged. It also includes the number of training jobs that have not improved model performance as evaluated against the objective function.</p>
    ///   - [`consumed_resources(Option<HyperParameterTuningJobConsumedResources>)`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobOutput::consumed_resources): <p>The total resources consumed by your hyperparameter tuning job.</p>
    /// - On failure, responds with [`SdkError<DescribeHyperParameterTuningJobError>`](crate::operation::describe_hyper_parameter_tuning_job::DescribeHyperParameterTuningJobError)
    pub fn describe_hyper_parameter_tuning_job(
        &self,
    ) -> crate::operation::describe_hyper_parameter_tuning_job::builders::DescribeHyperParameterTuningJobFluentBuilder {
        crate::operation::describe_hyper_parameter_tuning_job::builders::DescribeHyperParameterTuningJobFluentBuilder::new(self.handle.clone())
    }
}