Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

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

{
   "[HyperParameterTuningJobName](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-HyperParameterTuningJobName)": "string",
   "[MaxResults](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-MaxResults)": number,
   "[NextToken](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-SortOrder)": "string",
   "[StatusEquals](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-request-StatusEquals)": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** HyperParameterTuningJobName ** The name of the tuning job whose training jobs you want to list.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: Yes

** MaxResults ** The maximum number of training jobs to return. The default value is 10.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No

** NextToken ** 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.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** 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.
Type: String
Valid Values:Name | CreationTime | Status | FinalObjectiveMetricValue
Required: No

** SortOrder ** The sort order for results. The default is Ascending.
Type: String
Valid Values:Ascending | Descending
Required: No

** StatusEquals ** A filter that returns only training jobs with the specified status.
Type: String
Valid Values:InProgress | Completed | Failed | Stopping | Stopped
Required: No

{
   "[NextToken](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-response-NextToken)": "string",
   "[TrainingJobSummaries](#SageMaker-ListTrainingJobsForHyperParameterTuningJob-response-TrainingJobSummaries)": [ 
      { 
         "[CreationTime](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-CreationTime)": number,
         "[FailureReason](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-FailureReason)": "string",
         "[FinalHyperParameterTuningJobObjectiveMetric](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-FinalHyperParameterTuningJobObjectiveMetric)": { 
            "[MetricName](API_FinalHyperParameterTuningJobObjectiveMetric.md#SageMaker-Type-FinalHyperParameterTuningJobObjectiveMetric-MetricName)": "string",
            "[Type](API_FinalHyperParameterTuningJobObjectiveMetric.md#SageMaker-Type-FinalHyperParameterTuningJobObjectiveMetric-Type)": "string",
            "[Value](API_FinalHyperParameterTuningJobObjectiveMetric.md#SageMaker-Type-FinalHyperParameterTuningJobObjectiveMetric-Value)": number
         },
         "[ObjectiveStatus](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-ObjectiveStatus)": "string",
         "[TrainingEndTime](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TrainingEndTime)": number,
         "[TrainingJobArn](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TrainingJobArn)": "string",
         "[TrainingJobName](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TrainingJobName)": "string",
         "[TrainingJobStatus](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TrainingJobStatus)": "string",
         "[TrainingStartTime](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TrainingStartTime)": number,
         "[TunedHyperParameters](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TunedHyperParameters)": { 
            "string" : "string" 
         },
         "[TuningJobName](API_HyperParameterTrainingJobSummary.md#SageMaker-Type-HyperParameterTrainingJobSummary-TuningJobName)": "string"
      }
   ]
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** NextToken ** If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*

** TrainingJobSummaries ** A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.
Type: Array of HyperParameterTrainingJobSummary objects

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound
Resource being access is not found.
HTTP Status Code: 400

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2