You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SageMaker::Types::ListHyperParameterTuningJobsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListHyperParameterTuningJobsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  next_token: "NextToken",
  max_results: 1,
  sort_by: "Name", # accepts Name, Status, CreationTime
  sort_order: "Ascending", # accepts Ascending, Descending
  name_contains: "NameContains",
  creation_time_after: Time.now,
  creation_time_before: Time.now,
  last_modified_time_after: Time.now,
  last_modified_time_before: Time.now,
  status_equals: "Completed", # accepts Completed, InProgress, Failed, Stopped, Stopping
}

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time_afterTime

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

Returns:

  • (Time)

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

#creation_time_beforeTime

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

Returns:

  • (Time)

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

#last_modified_time_afterTime

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

Returns:

  • (Time)

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

#last_modified_time_beforeTime

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

Returns:

  • (Time)

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

#max_resultsInteger

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

Returns:

  • (Integer)

    The maximum number of tuning jobs to return.

#name_containsString

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

Returns:

  • (String)

    A string in the tuning job name.

#next_tokenString

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.

Returns:

  • (String)

    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken.

#sort_byString

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

Possible values:

  • Name
  • Status
  • CreationTime

Returns:

  • (String)

    The field to sort results by.

#sort_orderString

The sort order for results. The default is Ascending.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String)

    The sort order for results.

#status_equalsString

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

Possible values:

  • Completed
  • InProgress
  • Failed
  • Stopped
  • Stopping

Returns:

  • (String)

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