View a markdown version of this page

AWS::SageMaker::TrialComponent - 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::TrialComponent

The properties of a trial component as returned by the Search API.

Syntax

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

JSON

{
  "Type" : "AWS::SageMaker::TrialComponent",
  "Properties" : {
      "DisplayName" : String,
      "InputArtifacts" : {Key: Value, ...},
      "MetadataProperties" : MetadataProperties,
      "OutputArtifacts" : {Key: Value, ...},
      "Parameters" : {Key: Value, ...},
      "Status" : TrialComponentStatus,
      "Tags" : [ TagsItems, ... ],
      "TrialComponentName" : String
    }
}

YAML

Type: AWS::SageMaker::TrialComponent
Properties:
  DisplayName: String
  InputArtifacts: 
    Key: Value
  MetadataProperties: 
    MetadataProperties
  OutputArtifacts: 
    Key: Value
  Parameters: 
    Key: Value
  Status: 
    TrialComponentStatus
  Tags: 
    - TagsItems
  TrialComponentName: String

Properties

DisplayName

The name of the component as displayed. If DisplayName isn't specified, TrialComponentName 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

InputArtifacts

The input artifacts of the component.

Required: No

Type: Object of TrialComponentArtifact

Update requires: No interruption

MetadataProperties

Metadata properties of the tracking entity, trial, or trial component.

Required: No

Type: MetadataProperties

Update requires: Replacement

OutputArtifacts

The output artifacts of the component.

Required: No

Type: Object of TrialComponentArtifact

Update requires: No interruption

Parameters

The hyperparameters of the component.

Required: No

Type: Object of TrialComponentParameterValue

Update requires: No interruption

Status

The status of the component. States include:

  • InProgress

  • Completed

  • Failed

Required: No

Type: TrialComponentStatus

Update requires: No interruption

Tags

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

Required: No

Type: Array of TagsItems

Maximum: 50

Update requires: No interruption

TrialComponentName

The name of the trial component.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 120

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreationTime

When the component was created.

LastModifiedTime

When the component was last modified.

LineageGroupArn

The Amazon Resource Name (ARN) of the lineage group resource.

TrialComponentArn

The Amazon Resource Name (ARN) of the trial component.