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

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::ListTrialsRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_after ⇒ Time

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

• #created_before ⇒ Time

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

• #experiment_name ⇒ String

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

• #max_results ⇒ Integer

  The maximum number of trials to return in the response.

• #next_token ⇒ 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_by ⇒ String

  The property used to sort results.

• #sort_order ⇒ String

  The sort order.

• #trial_component_name ⇒ String

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

Instance Attribute Details

#created_after ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#created_before ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_by ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#sort_order ⇒ String

The sort order. The default value is ‘Descending`.

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#trial_component_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 31536

class ListTrialsRequest < Struct.new(
  :experiment_name,
  :trial_component_name,
  :created_after,
  :created_before,
  :sort_by,
  :sort_order,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end