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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package synthetics
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/synthetics/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the configuration of a canary that has already been created. You can't
// use this operation to update the tags of an existing canary. To change the tags
// of an existing canary, use TagResource (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html)
// .
func (c *Client) UpdateCanary(ctx context.Context, params *UpdateCanaryInput, optFns ...func(*Options)) (*UpdateCanaryOutput, error) {
if params == nil {
params = &UpdateCanaryInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateCanary", params, optFns, c.addOperationUpdateCanaryMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateCanaryOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateCanaryInput struct {
// The name of the canary that you want to update. To find the names of your
// canaries, use DescribeCanaries (https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html)
// . You cannot change the name of a canary that has already been created.
//
// This member is required.
Name *string
// A structure that contains the configuration for canary artifacts, including the
// encryption-at-rest settings for artifacts that the canary uploads to Amazon S3.
ArtifactConfig *types.ArtifactConfigInput
// The location in Amazon S3 where Synthetics stores artifacts from the test runs
// of this canary. Artifacts include the log file, screenshots, and HAR files. The
// name of the S3 bucket can't include a period (.).
ArtifactS3Location *string
// A structure that includes the entry point from which the canary should start
// running your script. If the script is stored in an S3 bucket, the bucket name,
// key, and version are also included.
Code *types.CanaryCodeInput
// The ARN of the IAM role to be used to run the canary. This role must already
// exist, and must include lambda.amazonaws.com as a principal in the trust
// policy. The role must also have the following permissions:
// - s3:PutObject
// - s3:GetBucketLocation
// - s3:ListAllMyBuckets
// - cloudwatch:PutMetricData
// - logs:CreateLogGroup
// - logs:CreateLogStream
// - logs:CreateLogStream
ExecutionRoleArn *string
// The number of days to retain data about failed runs of this canary.
FailureRetentionPeriodInDays *int32
// A structure that contains the timeout value that is used for each individual
// run of the canary. The environment variables keys and values are not encrypted.
// Do not store sensitive information in this field.
RunConfig *types.CanaryRunConfigInput
// Specifies the runtime version to use for the canary. For a list of valid
// runtime versions and for more information about runtime versions, see Canary
// Runtime Versions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html)
// .
RuntimeVersion *string
// A structure that contains information about how often the canary is to run, and
// when these runs are to stop.
Schedule *types.CanaryScheduleInput
// The number of days to retain data about successful runs of this canary.
SuccessRetentionPeriodInDays *int32
// Defines the screenshots to use as the baseline for comparisons during visual
// monitoring comparisons during future runs of this canary. If you omit this
// parameter, no changes are made to any baseline screenshots that the canary might
// be using already. Visual monitoring is supported only on canaries running the
// syn-puppeteer-node-3.2 runtime or later. For more information, see Visual
// monitoring (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html)
// and Visual monitoring blueprint (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html)
VisualReference *types.VisualReferenceInput
// If this canary is to test an endpoint in a VPC, this structure contains
// information about the subnet and security groups of the VPC endpoint. For more
// information, see Running a Canary in a VPC (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html)
// .
VpcConfig *types.VpcConfigInput
noSmithyDocumentSerde
}
type UpdateCanaryOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateCanaryMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateCanary{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateCanary{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "UpdateCanary"); 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 = addOpUpdateCanaryValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateCanary(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_opUpdateCanary(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "UpdateCanary",
}
}
|
