1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package sagemaker
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/sagemaker/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// Creates an SageMaker experiment. An experiment is a collection of trials that
15// are observed, compared and evaluated as a group. A trial is a set of steps,
16// called trial components, that produce a machine learning model. The goal of an
17// experiment is to determine the components that produce the best model. Multiple
18// trials are performed, each one isolating and measuring the impact of a change to
19// one or more inputs, while keeping the remaining inputs constant. When you use
20// SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial
21// components are automatically tracked, logged, and indexed. When you use the
22// Amazon Web Services SDK for Python (Boto), you must use the logging APIs
23// provided by the SDK. You can add tags to experiments, trials, trial components
24// and then use the Search API to search for the tags. To add a description to an
25// experiment, specify the optional Description parameter. To add a description
26// later, or to change the description, call the UpdateExperiment API. To get a
27// list of all your experiments, call the ListExperiments API. To view an
28// experiment's properties, call the DescribeExperiment API. To get a list of all
29// the trials associated with an experiment, call the ListTrials API. To create a
30// trial call the CreateTrial API.
31func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error) {
32	if params == nil {
33		params = &CreateExperimentInput{}
34	}
35
36	result, metadata, err := c.invokeOperation(ctx, "CreateExperiment", params, optFns, c.addOperationCreateExperimentMiddlewares)
37	if err != nil {
38		return nil, err
39	}
40
41	out := result.(*CreateExperimentOutput)
42	out.ResultMetadata = metadata
43	return out, nil
44}
45
46type CreateExperimentInput struct {
47
48	// The name of the experiment. The name must be unique in your Amazon Web Services
49	// account and is not case-sensitive.
50	//
51	// This member is required.
52	ExperimentName *string
53
54	// The description of the experiment.
55	Description *string
56
57	// The name of the experiment as displayed. The name doesn't need to be unique. If
58	// you don't specify DisplayName, the value in ExperimentName is displayed.
59	DisplayName *string
60
61	// A list of tags to associate with the experiment. You can use Search API to
62	// search on the tags.
63	Tags []types.Tag
64
65	noSmithyDocumentSerde
66}
67
68type CreateExperimentOutput struct {
69
70	// The Amazon Resource Name (ARN) of the experiment.
71	ExperimentArn *string
72
73	// Metadata pertaining to the operation's result.
74	ResultMetadata middleware.Metadata
75
76	noSmithyDocumentSerde
77}
78
79func (c *Client) addOperationCreateExperimentMiddlewares(stack *middleware.Stack, options Options) (err error) {
80	err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateExperiment{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateExperiment{}, middleware.After)
85	if err != nil {
86		return err
87	}
88	if err = addSetLoggerMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
92		return err
93	}
94	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
95		return err
96	}
97	if err = addResolveEndpointMiddleware(stack, options); err != nil {
98		return err
99	}
100	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
101		return err
102	}
103	if err = addRetryMiddlewares(stack, options); err != nil {
104		return err
105	}
106	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
107		return err
108	}
109	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
113		return err
114	}
115	if err = addClientUserAgent(stack); err != nil {
116		return err
117	}
118	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addOpCreateExperimentValidationMiddleware(stack); err != nil {
125		return err
126	}
127	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateExperiment(options.Region), middleware.Before); err != nil {
128		return err
129	}
130	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
131		return err
132	}
133	if err = addResponseErrorMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addRequestResponseLogging(stack, options); err != nil {
137		return err
138	}
139	return nil
140}
141
142func newServiceMetadataMiddleware_opCreateExperiment(region string) *awsmiddleware.RegisterServiceMetadata {
143	return &awsmiddleware.RegisterServiceMetadata{
144		Region:        region,
145		ServiceID:     ServiceID,
146		SigningName:   "sagemaker",
147		OperationName: "CreateExperiment",
148	}
149}
150