Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListHyperParameterTuningJobs

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "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.

CreationTimeAfter

A filter that returns only tuning jobs that were created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only tuning jobs that were created before the specified time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

A filter that returns only tuning jobs that were modified after the specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

A filter that returns only tuning jobs that were modified before the specified time.

Type: Timestamp

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning 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.

Type: String

Valid Values: Name | Status | CreationTime

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 tuning jobs with the specified status.

Type: String

Required: No

Response Syntax


{
   "HyperParameterTuningJobSummaries": [ 
      { 
         "CreationTime": number,
         "HyperParameterTuningEndTime": number,
         "HyperParameterTuningJobArn": "string",
         "HyperParameterTuningJobName": "string",
         "HyperParameterTuningJobStatus": "string",
         "LastModifiedTime": number,
         "ObjectiveStatusCounters": { 
            "Failed": number,
            "Pending": number,
            "Succeeded": number
         },
         "ResourceLimits": { 
            "MaxNumberOfTrainingJobs": number,
            "MaxParallelTrainingJobs": number,
            "MaxRuntimeInSeconds": number
         },
         "Strategy": "string",
         "TrainingJobStatusCounters": { 
            "Completed": number,
            "InProgress": number,
            "NonRetryableError": number,
            "RetryableError": number,
            "Stopped": number
         }
      }
   ],
   "NextToken": "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.

HyperParameterTuningJobSummaries

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

Type: Array of HyperParameterTuningJobSummary objects

NextToken

If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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