Skip to content

CreateTrialRequest

Source code in docs_src/capo_sagemaker/types/create_trial_request.py
class CreateTrialRequest(TypedDict, closed=True):
    trial_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the trial. 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 trial as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialName</code> is displayed.</p>"""
    experiment_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the experiment to associate the trial with.</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 trial. 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 trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

experiment_name instance-attribute

experiment_name: NotRequired[ExperimentEntityName]

The name of the experiment to associate the trial with.

metadata_properties instance-attribute

metadata_properties: NotRequired[MetadataProperties]

tags instance-attribute

tags: NotRequired[TagList]

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

trial_name instance-attribute

trial_name: NotRequired[ExperimentEntityName]

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