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

Class: Aws::SageMaker::Types::ListTrialComponentsRequest

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

Overview

Note:

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

{
  experiment_name: "ExperimentEntityName",
  trial_name: "ExperimentEntityName",
  source_arn: "String256",
  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",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#created_after ⇒ Time

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

Returns:

  • (Time) —

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

#created_before ⇒ Time

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

Returns:

  • (Time) —

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

#experiment_name ⇒ String

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can\'t filter by SourceArn or TrialName.

Returns:

  • (String) —

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

#max_results ⇒ Integer

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

Returns:

  • (Integer) —

    The maximum number of components to return in the response.

#next_token ⇒ String

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

Returns:

  • (String) —

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

#sort_by ⇒ String

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

Possible values:

  • Name
  • CreationTime

Returns:

  • (String) —

    The property used to sort results.

#sort_order ⇒ String

The sort order. The default value is Descending.

Possible values:

  • Ascending
  • Descending

Returns:

  • (String) —

    The sort order.

#source_arn ⇒ String

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can\'t filter by ExperimentName or TrialName.

Returns:

  • (String) —

    A filter that returns only components that have the specified source Amazon Resource Name (ARN).

#trial_name ⇒ String

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can\'t filter by ExperimentName or SourceArn.

Returns:

  • (String) —

    A filter that returns only components that are part of the specified trial.