Trial - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Trial

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

Contents

CreatedBy

Who created the trial.

Type: UserContext object

Required: No

CreationTime

When the trial was created.

Type: Timestamp

Required: No

DisplayName

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

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

Required: No

ExperimentName

The name of the experiment the trial is part of.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

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

Required: No

LastModifiedBy

Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.

Type: UserContext object

Required: No

LastModifiedTime

Who last modified the trial.

Type: Timestamp

Required: No

MetadataProperties

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

Type: MetadataProperties object

Required: No

Source

The source of the trial.

Type: TrialSource object

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

TrialArn

The Amazon Resource Name (ARN) of the trial.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial/.*

Required: No

TrialComponentSummaries

A list of the components associated with the trial. For each component, a summary of the component's properties is included.

Type: Array of TrialComponentSimpleSummary objects

Required: No

TrialName

The name of the trial.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 120.

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

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: