# ListTrainingJobsForHyperParameterTuningJob
<a name="API_ListTrainingJobsForHyperParameterTuningJob"></a>

Gets a list of [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) objects that describe the training jobs that a hyperparameter tuning job launched.

## Request Syntax
<a name="API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax"></a>

```
{
   "HyperParameterTuningJobName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StatusEquals": "string"
}
```

## Request Parameters
<a name="API_ListTrainingJobsForHyperParameterTuningJob_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HyperParameterTuningJobName](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-HyperParameterTuningJobName"></a>
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]){0,31}`   
Required: Yes

 ** [MaxResults](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-MaxResults"></a>
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](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-NextToken"></a>
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: Minimum length of 0. Maximum length of 8192.  
Pattern: `.*`   
Required: No

 ** [SortBy](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-SortBy"></a>
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](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-SortOrder"></a>
The sort order for results. The default is `Ascending`.  
Type: String  
Valid Values: `Ascending | Descending`   
Required: No

 ** [StatusEquals](#API_ListTrainingJobsForHyperParameterTuningJob_RequestSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-request-StatusEquals"></a>
A filter that returns only training jobs with the specified status.  
Type: String  
Valid Values: `InProgress | Completed | Failed | Stopping | Stopped | Deleting`   
Required: No

## Response Syntax
<a name="API_ListTrainingJobsForHyperParameterTuningJob_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "TrainingJobSummaries": [ 
      { 
         "CreationTime": number,
         "FailureReason": "string",
         "FinalHyperParameterTuningJobObjectiveMetric": { 
            "MetricName": "string",
            "Type": "string",
            "Value": number
         },
         "ObjectiveStatus": "string",
         "TrainingEndTime": number,
         "TrainingJobArn": "string",
         "TrainingJobDefinitionName": "string",
         "TrainingJobName": "string",
         "TrainingJobStatus": "string",
         "TrainingStartTime": number,
         "TunedHyperParameters": { 
            "string" : "string" 
         },
         "TuningJobName": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTrainingJobsForHyperParameterTuningJob_ResponseElements"></a>

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](#API_ListTrainingJobsForHyperParameterTuningJob_ResponseSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-response-NextToken"></a>
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: Minimum length of 0. Maximum length of 8192.  
Pattern: `.*` 

 ** [TrainingJobSummaries](#API_ListTrainingJobsForHyperParameterTuningJob_ResponseSyntax) **   <a name="sagemaker-ListTrainingJobsForHyperParameterTuningJob-response-TrainingJobSummaries"></a>
A list of [TrainingJobSummary](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html) objects that describe the training jobs that the `ListTrainingJobsForHyperParameterTuningJob` request returned.  
Type: Array of [HyperParameterTrainingJobSummary](API_HyperParameterTrainingJobSummary.md) objects

## Errors
<a name="API_ListTrainingJobsForHyperParameterTuningJob_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

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

## See Also
<a name="API_ListTrainingJobsForHyperParameterTuningJob_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/sagemaker-2017-07-24/ListTrainingJobsForHyperParameterTuningJob)