Skip to content

CreateExperimentRequest

Source code in docs_src/capo_sagemaker/types/create_experiment_request.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class CreateExperimentRequest(TypedDict, closed=True):
    experiment_name: NotRequired[
        "capo_sagemaker.types.experiment_entity_name.ExperimentEntityName"
    ]
    """<p>The name of the experiment. 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 experiment as displayed. The name doesn't need to be unique. If you don't specify <code>DisplayName</code>, the value in <code>ExperimentName</code> is displayed.</p>"""
    description: NotRequired[
        "capo_sagemaker.types.experiment_description.ExperimentDescription"
    ]
    """<p>The description of the experiment.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of tags to associate with the experiment. 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>"""

description instance-attribute 

description: NotRequired[ExperimentDescription]

The description of the experiment.

display_name instance-attribute 

display_name: NotRequired[ExperimentEntityName]

The name of the experiment as displayed. The name doesn't need to be unique. If you don't specify DisplayName, the value in ExperimentName is displayed.

experiment_name instance-attribute 

experiment_name: NotRequired[ExperimentEntityName]

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

tags instance-attribute 

tags: NotRequired[TagList]

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