Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Creates a trial component, which is a stage of a machine learning trial. A trial is composed of one or more trial components. A trial component can be used in multiple trials.

Trial components include pre-processing jobs, training jobs, and batch transform jobs.

When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.

You can add tags to a trial component and then use the Search API to search for the tags.

post/#X-Amz-Target=SageMaker.CreateTrialComponent

Headers

X-Amz-Target'SageMaker.CreateTrialComponent' required

Request body

TrialComponentNamestring required

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

DisplayNamestring

The name of the component as displayed. The name doesn't need to be unique. If <code>DisplayName</code> isn't specified, <code>TrialComponentName</code> is displayed.

StartTimestring date-time

When the component started.

EndTimestring date-time

When the component ended.

Parametersobject

The hyperparameters for the component.

InputArtifactsobject

The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.

OutputArtifactsobject

The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.

Response

Success

TrialComponentArnstring

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