1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package evidently
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/evidently/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Evidently experiment. Before you create an experiment, you must
// create the feature to use for the experiment. An experiment helps you make
// feature design decisions based on evidence and data. An experiment can test as
// many as five variations at once. Evidently collects experiment data and analyzes
// it by statistical methods, and provides clear recommendations about which
// variations perform better. You can optionally specify a segment to have the
// experiment consider only certain audience types in the experiment, such as using
// only user sessions from a certain location or who use a certain internet
// browser. Don't use this operation to update an existing experiment. Instead, use
// UpdateExperiment (https://docs.aws.amazon.com/cloudwatchevidently/latest/APIReference/API_UpdateExperiment.html)
// .
func (c *Client) CreateExperiment(ctx context.Context, params *CreateExperimentInput, optFns ...func(*Options)) (*CreateExperimentOutput, error) {
if params == nil {
params = &CreateExperimentInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateExperiment", params, optFns, c.addOperationCreateExperimentMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateExperimentOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateExperimentInput struct {
// An array of structures that defines the metrics used for the experiment, and
// whether a higher or lower value for each metric is the goal.
//
// This member is required.
MetricGoals []types.MetricGoalConfig
// A name for the new experiment.
//
// This member is required.
Name *string
// The name or ARN of the project that you want to create the new experiment in.
//
// This member is required.
Project *string
// An array of structures that describe the configuration of each feature
// variation used in the experiment.
//
// This member is required.
Treatments []types.TreatmentConfig
// An optional description of the experiment.
Description *string
// A structure that contains the configuration of which variation to use as the
// "control" version. tThe "control" version is used for comparison with other
// variations. This structure also specifies how much experiment traffic is
// allocated to each variation.
OnlineAbConfig *types.OnlineAbConfig
// When Evidently assigns a particular user session to an experiment, it must use
// a randomization ID to determine which variation the user session is served. This
// randomization ID is a combination of the entity ID and randomizationSalt . If
// you omit randomizationSalt , Evidently uses the experiment name as the
// randomizationSalt .
RandomizationSalt *string
// The portion of the available audience that you want to allocate to this
// experiment, in thousandths of a percent. The available audience is the total
// audience minus the audience that you have allocated to overrides or current
// launches of this feature. This is represented in thousandths of a percent. For
// example, specify 10,000 to allocate 10% of the available audience.
SamplingRate *int64
// Specifies an audience segment to use in the experiment. When a segment is used
// in an experiment, only user sessions that match the segment pattern are used in
// the experiment.
Segment *string
// Assigns one or more tags (key-value pairs) to the experiment. Tags can help you
// organize and categorize your resources. You can also use them to scope user
// permissions by granting a user permission to access or change only resources
// with certain tag values. Tags don't have any semantic meaning to Amazon Web
// Services and are interpreted strictly as strings of characters. You can
// associate as many as 50 tags with an experiment. For more information, see
// Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)
// .
Tags map[string]string
noSmithyDocumentSerde
}
type CreateExperimentOutput struct {
// A structure containing the configuration details of the experiment that you
// created.
//
// This member is required.
Experiment *types.Experiment
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateExperimentMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateExperiment{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateExperiment{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "CreateExperiment"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpCreateExperimentValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateExperiment(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateExperiment(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "CreateExperiment",
}
}
|
