Class: Aws::SageMaker::Types::UpdateTrialComponentRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Note:

When making an API call, you may pass UpdateTrialComponentRequest data as a hash:

{
  trial_component_name: "ExperimentEntityName", # required
  display_name: "ExperimentEntityName",
  status: {
    primary_status: "InProgress", # accepts InProgress, Completed, Failed
    message: "TrialComponentStatusMessage",
  },
  start_time: Time.now,
  end_time: Time.now,
  parameters: {
    "TrialComponentKey256" => {
      string_value: "StringParameterValue",
      number_value: 1.0,
    },
  },
  parameters_to_remove: ["TrialComponentKey256"],
  input_artifacts: {
    "TrialComponentKey64" => {
      media_type: "MediaType",
      value: "TrialComponentArtifactValue", # required
    },
  },
  input_artifacts_to_remove: ["TrialComponentKey256"],
  output_artifacts: {
    "TrialComponentKey64" => {
      media_type: "MediaType",
      value: "TrialComponentArtifactValue", # required
    },
  },
  output_artifacts_to_remove: ["TrialComponentKey256"],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

The name of the component as displayed. The name doesn’t need to be unique. If ‘DisplayName` isn’t specified, ‘TrialComponentName` is displayed.

Returns:

  • (String) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#end_time ⇒ Time

When the component ended.

Returns:

  • (Time) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#input_artifacts ⇒ Hash<String,Types::TrialComponentArtifact>

Replaces all of the component’s input artifacts with the specified artifacts.

Returns:



20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#input_artifacts_to_remove ⇒ Array<String>

The input artifacts to remove from the component.

Returns:

  • (Array<String>) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#output_artifacts ⇒ Hash<String,Types::TrialComponentArtifact>

Replaces all of the component’s output artifacts with the specified artifacts.

Returns:



20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#output_artifacts_to_remove ⇒ Array<String>

The output artifacts to remove from the component.

Returns:

  • (Array<String>) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#parameters ⇒ Hash<String,Types::TrialComponentParameterValue>

Replaces all of the component’s hyperparameters with the specified hyperparameters.

Returns:



20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#parameters_to_remove ⇒ Array<String>

The hyperparameters to remove from the component.

Returns:

  • (Array<String>) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#start_time ⇒ Time

When the component started.

Returns:

  • (Time) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#status ⇒ Types::TrialComponentStatus

The new status of the component.

Returns:



20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end

#trial_component_name ⇒ String

The name of the component to update.

Returns:

  • (String) 


20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
 
# File 'lib/aws-sdk-sagemaker/types.rb', line 20270

class UpdateTrialComponentRequest < Struct.new(
  :trial_component_name,
  :display_name,
  :status,
  :start_time,
  :end_time,
  :parameters,
  :parameters_to_remove,
  :input_artifacts,
  :input_artifacts_to_remove,
  :output_artifacts,
  :output_artifacts_to_remove)
  include Aws::Structure
end