Class: Aws::SageMaker::Types::Experiment

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::Experiment

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

The properties of an experiment as returned by the [Search] API. For information about experiments, see the [CreateExperiment] API.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html [2]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateExperiment.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_by ⇒ Types::UserContext

  Who created the experiment.

• #creation_time ⇒ Time

  When the experiment was created.

• #description ⇒ String

  The description of the experiment.

• #display_name ⇒ String

  The name of the experiment as displayed.

• #experiment_arn ⇒ String

  The Amazon Resource Name (ARN) of the experiment.

• #experiment_name ⇒ String

  The name of the experiment.

• #last_modified_by ⇒ Types::UserContext

  Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

• #last_modified_time ⇒ Time

  When the experiment was last modified.

• #source ⇒ Types::ExperimentSource

  The source of the experiment.

• #tags ⇒ Array<Types::Tag>

  The list of tags that are associated with the experiment.

Instance Attribute Details

#created_by ⇒ Types::UserContext

Who created the experiment.

Returns:

• (Types::UserContext)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

When the experiment was created.

Returns:

• (Time)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the experiment.

Returns:

• (String)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The name of the experiment as displayed. If ‘DisplayName` isn’t specified, ‘ExperimentName` is displayed.

Returns:

• (String)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_arn ⇒ String

The Amazon Resource Name (ARN) of the experiment.

Returns:

• (String)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#experiment_name ⇒ String

The name of the experiment.

Returns:

• (String)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_by ⇒ Types::UserContext

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Returns:

• (Types::UserContext)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_time ⇒ Time

When the experiment was last modified.

Returns:

• (Time)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ Types::ExperimentSource

The source of the experiment.

Returns:

• (Types::ExperimentSource)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The list of tags that are associated with the experiment. You can use [Search] API to search on the tags.

[1]: docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html

Returns:

• (Array<Types::Tag>)

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

class Experiment < Struct.new(
  :experiment_name,
  :experiment_arn,
  :display_name,
  :source,
  :description,
  :creation_time,
  :created_by,
  :last_modified_time,
  :last_modified_by,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end