Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.
Request Syntax
{
"HyperParameterTuningJobName": "string",
"MaxResults": number,
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "string"
}Request Parameters
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]){0,31}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
ListTrainingJobsForHyperParameterTuningJobrequest was truncated, the response includes aNextToken. 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 | FinalObjectiveMetricValueRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that returns only training jobs with the specified status.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | StoppedRequired: No
Response Syntax
{
"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
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
ListTrainingJobsForHyperParameterTuningJobrequest was truncated, the response includes aNextToken. 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
ListTrainingJobsForHyperParameterTuningJobrequest returned.Type: Array of HyperParameterTrainingJobSummary objects
Errors
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
