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

Description¶

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

Usage¶

sagemaker_list_hyper_parameter_tuning_jobs(NextToken, MaxResults,
  SortBy, SortOrder, NameContains, CreationTimeAfter, CreationTimeBefore,
  LastModifiedTimeAfter, LastModifiedTimeBefore, StatusEquals)

Arguments¶

NextToken

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

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

The field to sort results by. The default is Name.
SortOrder

The sort order for results. The default is Ascending.
NameContains

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

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

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

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

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

A filter that returns only tuning jobs with the specified status.

Value¶

A list with the following syntax:

list(
  HyperParameterTuningJobSummaries = list(
    list(
      HyperParameterTuningJobName = "string",
      HyperParameterTuningJobArn = "string",
      HyperParameterTuningJobStatus = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|"Deleting"|"DeleteFailed",
      Strategy = "Bayesian"|"Random"|"Hyperband"|"Grid",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      HyperParameterTuningEndTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      TrainingJobStatusCounters = list(
        Completed = 123,
        InProgress = 123,
        RetryableError = 123,
        NonRetryableError = 123,
        Stopped = 123
      ),
      ObjectiveStatusCounters = list(
        Succeeded = 123,
        Pending = 123,
        Failed = 123
      ),
      ResourceLimits = list(
        MaxNumberOfTrainingJobs = 123,
        MaxParallelTrainingJobs = 123,
        MaxRuntimeInSeconds = 123
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_hyper_parameter_tuning_jobs(
  NextToken = "string",
  MaxResults = 123,
  SortBy = "Name"|"Status"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  NameContains = "string",
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  StatusEquals = "Completed"|"InProgress"|"Failed"|"Stopped"|"Stopping"|"Deleting"|"DeleteFailed"
)