Updates one or more properties of a trial component¶

Description¶

Updates one or more properties of a trial component.

Usage¶

sagemaker_update_trial_component(TrialComponentName, DisplayName,
  Status, StartTime, EndTime, Parameters, ParametersToRemove,
  InputArtifacts, InputArtifactsToRemove, OutputArtifacts,
  OutputArtifactsToRemove)

Arguments¶

• TrialComponentName

  [required] The name of the component to update.

• DisplayName

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

• Status

  The new status of the component.

• StartTime

  When the component started.

• EndTime

  When the component ended.

• Parameters

  Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.

• ParametersToRemove

  The hyperparameters to remove from the component.

• InputArtifacts

  Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.

• InputArtifactsToRemove

  The input artifacts to remove from the component.

• OutputArtifacts

  Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.

• OutputArtifactsToRemove

  The output artifacts to remove from the component.

Value¶

A list with the following syntax:

list(
  TrialComponentArn = "string"
)

Request syntax¶

svc$update_trial_component(
  TrialComponentName = "string",
  DisplayName = "string",
  Status = list(
    PrimaryStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
    Message = "string"
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Parameters = list(
    list(
      StringValue = "string",
      NumberValue = 123.0
    )
  ),
  ParametersToRemove = list(
    "string"
  ),
  InputArtifacts = list(
    list(
      MediaType = "string",
      Value = "string"
    )
  ),
  InputArtifactsToRemove = list(
    "string"
  ),
  OutputArtifacts = list(
    list(
      MediaType = "string",
      Value = "string"
    )
  ),
  OutputArtifactsToRemove = list(
    "string"
  )
)