Skip to content

TrialComponentSummary

Source code in docs_src/capo_sagemaker/types/trial_component_summary.py
class TrialComponentSummary(TypedDict, closed=True):
    trial_component_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the trial component.</p>"""
    trial_component_arn: NotRequired[
        "capo_sagemaker.types.trial_component_arn.TrialComponentArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the trial component.</p>"""
    display_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the component as displayed. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.</p>"""
    trial_component_source: NotRequired[
        "capo_sagemaker.types.trial_component_source.TrialComponentSource"
    ]
    status: NotRequired[
        "capo_sagemaker.types.trial_component_status.TrialComponentStatus"
    ]
    """<p>The status of the component. States include:</p> <ul> <li> <p>InProgress</p> </li> <li> <p>Completed</p> </li> <li> <p>Failed</p> </li> </ul>"""
    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>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component was created.</p>"""
    created_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    """<p>Who created the trial component.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>When the component was last modified.</p>"""
    last_modified_by: NotRequired["capo_sagemaker.types.user_context.UserContext"]
    """<p>Who last modified the component.</p>"""

created_by instance-attribute

created_by: NotRequired[UserContext]

Who created the trial component.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

When the component was created.

display_name instance-attribute

display_name: NotRequired[ExperimentEntityName]

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName is displayed.

end_time instance-attribute

end_time: NotRequired[Timestamp]

When the component ended.

last_modified_by instance-attribute

last_modified_by: NotRequired[UserContext]

Who last modified the component.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

When the component was last modified.

start_time instance-attribute

start_time: NotRequired[Timestamp]

When the component started.

status instance-attribute

status: NotRequired[TrialComponentStatus]

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

trial_component_arn instance-attribute

trial_component_arn: NotRequired[TrialComponentArn]

The Amazon Resource Name (ARN) of the trial component.

trial_component_name instance-attribute

trial_component_name: NotRequired[ExperimentEntityName]

The name of the trial component.

trial_component_source instance-attribute

trial_component_source: NotRequired[TrialComponentSource]