Skip to content

CreateTrialComponentRequest

Source code in docs_src/capo_sagemaker/types/create_trial_component_request.py
class CreateTrialComponentRequest(TypedDict, closed=True):
    trial_component_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.</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 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>"""
    parameters: NotRequired[
        "capo_sagemaker.types.trial_component_parameters.TrialComponentParameters"
    ]
    """<p>The hyperparameters for the component.</p>"""
    input_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.</p>"""
    output_artifacts: NotRequired[
        "capo_sagemaker.types.trial_component_artifacts.TrialComponentArtifacts"
    ]
    """<p>The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.</p>"""
    metadata_properties: NotRequired[
        "capo_sagemaker.types.metadata_properties.MetadataProperties"
    ]
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of tags to associate with the component. You can use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html">Search</a> API to search on the tags.</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]

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

metadata_properties instance-attribute

metadata_properties: NotRequired[MetadataProperties]

output_artifacts instance-attribute

output_artifacts: NotRequired[TrialComponentArtifacts]

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

parameters instance-attribute

parameters: NotRequired[TrialComponentParameters]

The hyperparameters for the component.

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

tags instance-attribute

tags: NotRequired[TagList]

A list of tags to associate with the component. You can use Search API to search on the tags.

trial_component_name instance-attribute

trial_component_name: NotRequired[ExperimentEntityName]

The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.