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// Amazon SageMaker Studio or the Amazon SageMaker Python SDK, all experiments,
21// trials, and trial components are automatically tracked, logged, and indexed.
22// When you use the AWS 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, 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 AWS account and is
49	// 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
66type CreateExperimentOutput struct {
67
68	// The Amazon Resource Name (ARN) of the experiment.
69	ExperimentArn *string
70
71	// Metadata pertaining to the operation's result.
72	ResultMetadata middleware.Metadata
73}
74
75func addOperationCreateExperimentMiddlewares(stack *middleware.Stack, options Options) (err error) {
76	err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateExperiment{}, middleware.After)
77	if err != nil {
78		return err
79	}
80	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateExperiment{}, middleware.After)
81	if err != nil {
82		return err
83	}
84	if err = addSetLoggerMiddleware(stack, options); err != nil {
85		return err
86	}
87	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
88		return err
89	}
90	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
91		return err
92	}
93	if err = addResolveEndpointMiddleware(stack, options); err != nil {
94		return err
95	}
96	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
97		return err
98	}
99	if err = addRetryMiddlewares(stack, options); err != nil {
100		return err
101	}
102	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
103		return err
104	}
105	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
106		return err
107	}
108	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
109		return err
110	}
111	if err = addClientUserAgent(stack); err != nil {
112		return err
113	}
114	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
115		return err
116	}
117	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
118		return err
119	}
120	if err = addOpCreateExperimentValidationMiddleware(stack); err != nil {
121		return err
122	}
123	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateExperiment(options.Region), middleware.Before); err != nil {
124		return err
125	}
126	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
127		return err
128	}
129	if err = addResponseErrorMiddleware(stack); err != nil {
130		return err
131	}
132	if err = addRequestResponseLogging(stack, options); err != nil {
133		return err
134	}
135	return nil
136}
137
138func newServiceMetadataMiddleware_opCreateExperiment(region string) *awsmiddleware.RegisterServiceMetadata {
139	return &awsmiddleware.RegisterServiceMetadata{
140		Region:        region,
141		ServiceID:     ServiceID,
142		SigningName:   "sagemaker",
143		OperationName: "CreateExperiment",
144	}
145}
146