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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package personalize
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/service/personalize/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a campaign to deploy a retrained solution version with an existing
//
// campaign, change your campaign's minProvisionedTPS , or modify your campaign's
// configuration. For example, you can set enableMetadataWithRecommendations to
// true for an existing campaign.
//
// To update a campaign to start automatically using the latest solution version,
// specify the following:
//
// - For the SolutionVersionArn parameter, specify the Amazon Resource Name (ARN)
// of your solution in SolutionArn/$LATEST format.
//
// - In the campaignConfig , set syncWithLatestSolutionVersion to true .
//
// To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
// Check the campaign status using the [DescribeCampaign]operation.
//
// You can still get recommendations from a campaign while an update is in
// progress. The campaign will use the previous solution version and campaign
// configuration to generate recommendations until the latest campaign update
// status is Active .
//
// For more information about updating a campaign, including code samples, see [Updating a campaign].
// For more information about campaigns, see [Creating a campaign].
//
// [Creating a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html
// [Updating a campaign]: https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html
// [DescribeCampaign]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
func (c *Client) UpdateCampaign(ctx context.Context, params *UpdateCampaignInput, optFns ...func(*Options)) (*UpdateCampaignOutput, error) {
if params == nil {
params = &UpdateCampaignInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateCampaign", params, optFns, c.addOperationUpdateCampaignMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateCampaignOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateCampaignInput struct {
// The Amazon Resource Name (ARN) of the campaign.
//
// This member is required.
CampaignArn *string
// The configuration details of a campaign.
CampaignConfig *types.CampaignConfig
// Specifies the requested minimum provisioned transactions (recommendations) per
// second that Amazon Personalize will support. A high minProvisionedTPS will
// increase your bill. We recommend starting with 1 for minProvisionedTPS (the
// default). Track your usage using Amazon CloudWatch metrics, and increase the
// minProvisionedTPS as necessary.
MinProvisionedTPS *int32
// The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest
// solution version of your solution, specify the ARN of your solution in
// SolutionArn/$LATEST format. You must use this format if you set
// syncWithLatestSolutionVersion to True in the [CampaignConfig].
//
// To deploy a model that isn't the latest solution version of your solution,
// specify the ARN of the solution version.
//
// For more information about automatic campaign updates, see [Enabling automatic campaign updates].
//
// [Enabling automatic campaign updates]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
// [CampaignConfig]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html
SolutionVersionArn *string
noSmithyDocumentSerde
}
type UpdateCampaignOutput struct {
// The same campaign ARN as given in the request.
CampaignArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateCampaignMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateCampaign{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateCampaign{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateCampaign"); 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 = addClientRequestID(stack); err != nil {
return err
}
if err = addComputeContentLength(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = addComputePayloadSHA256(stack); err != nil {
return err
}
if err = addRetry(stack, options); err != nil {
return err
}
if err = addRawResponseToMetadata(stack); err != nil {
return err
}
if err = 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 = addTimeOffsetBuild(stack, c); err != nil {
return err
}
if err = addUserAgentRetryMode(stack, options); err != nil {
return err
}
if err = addOpUpdateCampaignValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateCampaign(options.Region), middleware.Before); err != nil {
return err
}
if err = 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_opUpdateCampaign(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateCampaign",
}
}
|
