View a markdown version of this page

AWS::SageMaker::Experiment - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::Experiment

The properties of an experiment as returned by the Search API. For information about experiments, see the CreateExperiment API.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SageMaker::Experiment",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "ExperimentName" : String,
      "Tags" : [ TagsItems, ... ]
    }
}

YAML

Type: AWS::SageMaker::Experiment
Properties:
  Description: String
  DisplayName: String
  ExperimentName: String
  Tags: 
    - TagsItems

Properties

Description

The description of the experiment.

Required: No

Type: String

Minimum: 0

Maximum: 3072

Update requires: No interruption

DisplayName

The name of the experiment as displayed. If DisplayName isn't specified, ExperimentName is displayed.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$

Minimum: 1

Maximum: 120

Update requires: No interruption

ExperimentName

The name of the experiment.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}$

Minimum: 1

Maximum: 120

Update requires: Replacement

Tags

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

Required: No

Type: Array of TagsItems

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreationTime

When the experiment was created.

LastModifiedTime

When the experiment was last modified.