Skip to content

UpdateTrialComponentRequest

Source code in docs_src/capo_sagemaker/types/update_trial_component_request.py
class UpdateTrialComponentRequest(TypedDict, closed=True):
    trial_component_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the component to update.</p>"""
    display_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>"""
    status: NotRequired[
        "capo_sagemaker.types.trial_component_status.TrialComponentStatus"
    ]
    """<p>The new status of the component.</p>"""
    start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component started.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component ended.</p>"""
    parameters: NotRequired[
        "capo_sagemaker.types.trial_component_parameters.TrialComponentParameters"
    ]
    """<p>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.</p>"""
    parameters_to_remove: NotRequired[
        "capo_sagemaker.types.list_trial_component_key256.ListTrialComponentKey256"
    ]
    """<p>The hyperparameters to remove from the component.</p>"""
    input_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>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.</p>"""
    input_artifacts_to_remove: NotRequired[
        "capo_sagemaker.types.list_trial_component_key256.ListTrialComponentKey256"
    ]
    """<p>The input artifacts to remove from the component.</p>"""
    output_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>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.</p>"""
    output_artifacts_to_remove: NotRequired[
        "capo_sagemaker.types.list_trial_component_key256.ListTrialComponentKey256"
    ]
    """<p>The output artifacts to remove from the component.</p>"""

display_name instance-attribute

display_name: NotRequired[ExperimentEntityName]

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

end_time instance-attribute

end_time: NotRequired[Timestamp]

When the component ended.

input_artifacts instance-attribute

input_artifacts: NotRequired[TrialComponentArtifacts]

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.

input_artifacts_to_remove instance-attribute

input_artifacts_to_remove: NotRequired[ListTrialComponentKey256]

The input artifacts to remove from the component.

output_artifacts instance-attribute

output_artifacts: NotRequired[TrialComponentArtifacts]

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.

output_artifacts_to_remove instance-attribute

output_artifacts_to_remove: NotRequired[ListTrialComponentKey256]

The output artifacts to remove from the component.

parameters instance-attribute

parameters: NotRequired[TrialComponentParameters]

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.

parameters_to_remove instance-attribute

parameters_to_remove: NotRequired[ListTrialComponentKey256]

The hyperparameters to remove from the component.

start_time instance-attribute

start_time: NotRequired[Timestamp]

When the component started.

status instance-attribute

status: NotRequired[TrialComponentStatus]

The new status of the component.

trial_component_name instance-attribute

trial_component_name: NotRequired[ExperimentEntityName]

The name of the component to update.