CfnExperimentProps

class aws_cdk.aws_sagemaker.CfnExperimentProps(*, experiment_name, description=None, display_name=None, tags=None)

Bases: object

Properties for defining a CfnExperiment.

Parameters:
  • experiment_name (str) – The name of the experiment. Must be unique in your AWS account and is not case-sensitive.

  • description (Optional[str]) – The description of the experiment.

  • display_name (Optional[str]) – The name of the experiment as displayed. The name does not need to be unique.

  • tags (Optional[Sequence[Union[TagsItemsProperty, Dict[str, Any]]]]) – A list of tags to associate with the experiment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cfn_experiment_props = sagemaker.CfnExperimentProps(
    experiment_name="experimentName",

    # the properties below are optional
    description="description",
    display_name="displayName",
    tags=[sagemaker.CfnExperiment.TagsItemsProperty(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the experiment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html#cfn-sagemaker-experiment-description

display_name

The name of the experiment as displayed.

The name does not need to be unique.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html#cfn-sagemaker-experiment-displayname

experiment_name

The name of the experiment.

Must be unique in your AWS account and is not case-sensitive.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html#cfn-sagemaker-experiment-experimentname

tags

A list of tags to associate with the experiment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-experiment.html#cfn-sagemaker-experiment-tags