AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Class: Aws::SageMaker::Types::ListTrialsRequest

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

Overview

Note:

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

{
  experiment_name: "ExperimentEntityName",
  trial_component_name: "ExperimentEntityName",
  created_after: Time.now,
  created_before: Time.now,
  sort_by: "Name", # accepts Name, CreationTime
  sort_order: "Ascending", # accepts Ascending, Descending
  max_results: 1,
  next_token: "NextToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#created_afterTime

A filter that returns only trials created after the specified time.

Returns:

  • (Time)

    A filter that returns only trials created after the specified time.

#created_beforeTime

A filter that returns only trials created before the specified time.

Returns:

  • (Time)

    A filter that returns only trials created before the specified time.

#experiment_nameString

A filter that returns only trials that are part of the specified experiment.

Returns:

  • (String)

    A filter that returns only trials that are part of the specified experiment.

#max_resultsInteger

The maximum number of trials to return in the response. The default value is 10.

Returns:

  • (Integer)

    The maximum number of trials to return in the response.

#next_tokenString

If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

Returns:

  • (String)

    If the previous call to ListTrials didn\'t return the full set of trials, the call returns a token for getting the next set of trials.

#sort_byString

The property used to sort results. The default value is CreationTime.

Possible values:

  • Name
  • CreationTime

Returns:

  • (String)

    The property used to sort results.

#sort_orderString

The sort order. The default value is Descending.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String)

    The sort order.

#trial_component_nameString

A filter that returns only trials that are associated with the specified trial component.

Returns:

  • (String)

    A filter that returns only trials that are associated with the specified trial component.