aws-sdk-synthetics 1.12.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-synthetics.rb +1 -1
- data/lib/aws-sdk-synthetics/client.rb +30 -4
- data/lib/aws-sdk-synthetics/client_api.rb +24 -0
- data/lib/aws-sdk-synthetics/types.rb +129 -22
- metadata +5 -6
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d858ecab059f2d57f700e477eb477dd0847ca6afe55c63a38a99d06918f07d90
|
|
4
|
+
data.tar.gz: 2c121366677d9e1e98305c27578cdf82c2f28f1b16c90e31f589b89be26a3e10
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 988cc6a0d832f617dcfe5a0435d2f64fe8cb1e74ae4d9374dd83e0bd9aff8a9552c418c5c266e4ca9b859c913443afca70fa54d90055adf59b43e0e1795e262d
|
|
7
|
+
data.tar.gz: a737c41a779fbb163cef21b0ee0c3c8149b1974a7fcae3133dd498bced6b6b43d0acc3f46f9c2e1afb6ab4e0036d58b5e52b3f5e6695edbebd2abc7947c84fa4
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.13.0
|
data/lib/aws-sdk-synthetics.rb
CHANGED
|
@@ -375,7 +375,7 @@ module Aws::Synthetics
|
|
|
375
375
|
# @option params [required, String] :artifact_s3_location
|
|
376
376
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
|
377
377
|
# test runs of this canary. Artifacts include the log file, screenshots,
|
|
378
|
-
# and HAR files.
|
|
378
|
+
# and HAR files. The name of the S3 bucket can't include a period (.).
|
|
379
379
|
#
|
|
380
380
|
# @option params [required, String] :execution_role_arn
|
|
381
381
|
# The ARN of the IAM role to be used to run the canary. This role must
|
|
@@ -511,6 +511,11 @@ module Aws::Synthetics
|
|
|
511
511
|
# resp.canary.vpc_config.subnet_ids[0] #=> String
|
|
512
512
|
# resp.canary.vpc_config.security_group_ids #=> Array
|
|
513
513
|
# resp.canary.vpc_config.security_group_ids[0] #=> String
|
|
514
|
+
# resp.canary.visual_reference.base_screenshots #=> Array
|
|
515
|
+
# resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
|
|
516
|
+
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
|
517
|
+
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
|
518
|
+
# resp.canary.visual_reference.base_canary_run_id #=> String
|
|
514
519
|
# resp.canary.tags #=> Hash
|
|
515
520
|
# resp.canary.tags["TagKey"] #=> String
|
|
516
521
|
#
|
|
@@ -637,6 +642,11 @@ module Aws::Synthetics
|
|
|
637
642
|
# resp.canaries[0].vpc_config.subnet_ids[0] #=> String
|
|
638
643
|
# resp.canaries[0].vpc_config.security_group_ids #=> Array
|
|
639
644
|
# resp.canaries[0].vpc_config.security_group_ids[0] #=> String
|
|
645
|
+
# resp.canaries[0].visual_reference.base_screenshots #=> Array
|
|
646
|
+
# resp.canaries[0].visual_reference.base_screenshots[0].screenshot_name #=> String
|
|
647
|
+
# resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
|
648
|
+
# resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
|
649
|
+
# resp.canaries[0].visual_reference.base_canary_run_id #=> String
|
|
640
650
|
# resp.canaries[0].tags #=> Hash
|
|
641
651
|
# resp.canaries[0].tags["TagKey"] #=> String
|
|
642
652
|
# resp.next_token #=> String
|
|
@@ -799,6 +809,11 @@ module Aws::Synthetics
|
|
|
799
809
|
# resp.canary.vpc_config.subnet_ids[0] #=> String
|
|
800
810
|
# resp.canary.vpc_config.security_group_ids #=> Array
|
|
801
811
|
# resp.canary.vpc_config.security_group_ids[0] #=> String
|
|
812
|
+
# resp.canary.visual_reference.base_screenshots #=> Array
|
|
813
|
+
# resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
|
|
814
|
+
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
|
815
|
+
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
|
816
|
+
# resp.canary.visual_reference.base_canary_run_id #=> String
|
|
802
817
|
# resp.canary.tags #=> Hash
|
|
803
818
|
# resp.canary.tags["TagKey"] #=> String
|
|
804
819
|
#
|
|
@@ -968,8 +983,8 @@ module Aws::Synthetics
|
|
|
968
983
|
# use them to scope user permissions, by granting a user permission to
|
|
969
984
|
# access or change only resources with certain tag values.
|
|
970
985
|
#
|
|
971
|
-
# Tags don't have any semantic meaning to
|
|
972
|
-
# strictly as strings of characters.
|
|
986
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
|
987
|
+
# interpreted strictly as strings of characters.
|
|
973
988
|
#
|
|
974
989
|
# You can use the `TagResource` action with a canary that already has
|
|
975
990
|
# tags. If you specify a new tag key for the alarm, this tag is appended
|
|
@@ -1116,6 +1131,8 @@ module Aws::Synthetics
|
|
|
1116
1131
|
#
|
|
1117
1132
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
|
1118
1133
|
#
|
|
1134
|
+
# @option params [Types::VisualReferenceInput] :visual_reference
|
|
1135
|
+
#
|
|
1119
1136
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1120
1137
|
#
|
|
1121
1138
|
# @example Request syntax with placeholder values
|
|
@@ -1149,6 +1166,15 @@ module Aws::Synthetics
|
|
|
1149
1166
|
# subnet_ids: ["SubnetId"],
|
|
1150
1167
|
# security_group_ids: ["SecurityGroupId"],
|
|
1151
1168
|
# },
|
|
1169
|
+
# visual_reference: {
|
|
1170
|
+
# base_screenshots: [
|
|
1171
|
+
# {
|
|
1172
|
+
# screenshot_name: "String", # required
|
|
1173
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
|
1174
|
+
# },
|
|
1175
|
+
# ],
|
|
1176
|
+
# base_canary_run_id: "String", # required
|
|
1177
|
+
# },
|
|
1152
1178
|
# })
|
|
1153
1179
|
#
|
|
1154
1180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
|
|
@@ -1173,7 +1199,7 @@ module Aws::Synthetics
|
|
|
1173
1199
|
params: params,
|
|
1174
1200
|
config: config)
|
|
1175
1201
|
context[:gem_name] = 'aws-sdk-synthetics'
|
|
1176
|
-
context[:gem_version] = '1.
|
|
1202
|
+
context[:gem_version] = '1.13.0'
|
|
1177
1203
|
Seahorse::Client::Request.new(handlers, context)
|
|
1178
1204
|
end
|
|
1179
1205
|
|
|
@@ -13,6 +13,10 @@ module Aws::Synthetics
|
|
|
13
13
|
|
|
14
14
|
include Seahorse::Model
|
|
15
15
|
|
|
16
|
+
BaseScreenshot = Shapes::StructureShape.new(name: 'BaseScreenshot')
|
|
17
|
+
BaseScreenshotConfigIgnoreCoordinate = Shapes::StringShape.new(name: 'BaseScreenshotConfigIgnoreCoordinate')
|
|
18
|
+
BaseScreenshotIgnoreCoordinates = Shapes::ListShape.new(name: 'BaseScreenshotIgnoreCoordinates')
|
|
19
|
+
BaseScreenshots = Shapes::ListShape.new(name: 'BaseScreenshots')
|
|
16
20
|
Blob = Shapes::BlobShape.new(name: 'Blob')
|
|
17
21
|
Canaries = Shapes::ListShape.new(name: 'Canaries')
|
|
18
22
|
CanariesLastRun = Shapes::ListShape.new(name: 'CanariesLastRun')
|
|
@@ -93,10 +97,20 @@ module Aws::Synthetics
|
|
|
93
97
|
UpdateCanaryRequest = Shapes::StructureShape.new(name: 'UpdateCanaryRequest')
|
|
94
98
|
UpdateCanaryResponse = Shapes::StructureShape.new(name: 'UpdateCanaryResponse')
|
|
95
99
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
|
100
|
+
VisualReferenceInput = Shapes::StructureShape.new(name: 'VisualReferenceInput')
|
|
101
|
+
VisualReferenceOutput = Shapes::StructureShape.new(name: 'VisualReferenceOutput')
|
|
96
102
|
VpcConfigInput = Shapes::StructureShape.new(name: 'VpcConfigInput')
|
|
97
103
|
VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
|
|
98
104
|
VpcId = Shapes::StringShape.new(name: 'VpcId')
|
|
99
105
|
|
|
106
|
+
BaseScreenshot.add_member(:screenshot_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ScreenshotName"))
|
|
107
|
+
BaseScreenshot.add_member(:ignore_coordinates, Shapes::ShapeRef.new(shape: BaseScreenshotIgnoreCoordinates, location_name: "IgnoreCoordinates"))
|
|
108
|
+
BaseScreenshot.struct_class = Types::BaseScreenshot
|
|
109
|
+
|
|
110
|
+
BaseScreenshotIgnoreCoordinates.member = Shapes::ShapeRef.new(shape: BaseScreenshotConfigIgnoreCoordinate)
|
|
111
|
+
|
|
112
|
+
BaseScreenshots.member = Shapes::ShapeRef.new(shape: BaseScreenshot)
|
|
113
|
+
|
|
100
114
|
Canaries.member = Shapes::ShapeRef.new(shape: Canary)
|
|
101
115
|
|
|
102
116
|
CanariesLastRun.member = Shapes::ShapeRef.new(shape: CanaryLastRun)
|
|
@@ -115,6 +129,7 @@ module Aws::Synthetics
|
|
|
115
129
|
Canary.add_member(:engine_arn, Shapes::ShapeRef.new(shape: FunctionArn, location_name: "EngineArn"))
|
|
116
130
|
Canary.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
|
|
117
131
|
Canary.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigOutput, location_name: "VpcConfig"))
|
|
132
|
+
Canary.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceOutput, location_name: "VisualReference"))
|
|
118
133
|
Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
|
119
134
|
Canary.struct_class = Types::Canary
|
|
120
135
|
|
|
@@ -307,6 +322,7 @@ module Aws::Synthetics
|
|
|
307
322
|
UpdateCanaryRequest.add_member(:success_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "SuccessRetentionPeriodInDays"))
|
|
308
323
|
UpdateCanaryRequest.add_member(:failure_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "FailureRetentionPeriodInDays"))
|
|
309
324
|
UpdateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
|
|
325
|
+
UpdateCanaryRequest.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceInput, location_name: "VisualReference"))
|
|
310
326
|
UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
|
|
311
327
|
|
|
312
328
|
UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
|
|
@@ -314,6 +330,14 @@ module Aws::Synthetics
|
|
|
314
330
|
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
|
315
331
|
ValidationException.struct_class = Types::ValidationException
|
|
316
332
|
|
|
333
|
+
VisualReferenceInput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
|
|
334
|
+
VisualReferenceInput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "BaseCanaryRunId"))
|
|
335
|
+
VisualReferenceInput.struct_class = Types::VisualReferenceInput
|
|
336
|
+
|
|
337
|
+
VisualReferenceOutput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
|
|
338
|
+
VisualReferenceOutput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, location_name: "BaseCanaryRunId"))
|
|
339
|
+
VisualReferenceOutput.struct_class = Types::VisualReferenceOutput
|
|
340
|
+
|
|
317
341
|
VpcConfigInput.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
|
|
318
342
|
VpcConfigInput.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
|
|
319
343
|
VpcConfigInput.struct_class = Types::VpcConfigInput
|
|
@@ -10,6 +10,29 @@
|
|
|
10
10
|
module Aws::Synthetics
|
|
11
11
|
module Types
|
|
12
12
|
|
|
13
|
+
# @note When making an API call, you may pass BaseScreenshot
|
|
14
|
+
# data as a hash:
|
|
15
|
+
#
|
|
16
|
+
# {
|
|
17
|
+
# screenshot_name: "String", # required
|
|
18
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
|
19
|
+
# }
|
|
20
|
+
#
|
|
21
|
+
# @!attribute [rw] screenshot_name
|
|
22
|
+
# @return [String]
|
|
23
|
+
#
|
|
24
|
+
# @!attribute [rw] ignore_coordinates
|
|
25
|
+
# @return [Array<String>]
|
|
26
|
+
#
|
|
27
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BaseScreenshot AWS API Documentation
|
|
28
|
+
#
|
|
29
|
+
class BaseScreenshot < Struct.new(
|
|
30
|
+
:screenshot_name,
|
|
31
|
+
:ignore_coordinates)
|
|
32
|
+
SENSITIVE = []
|
|
33
|
+
include Aws::Structure
|
|
34
|
+
end
|
|
35
|
+
|
|
13
36
|
# This structure contains all information about one canary in your
|
|
14
37
|
# account.
|
|
15
38
|
#
|
|
@@ -95,6 +118,9 @@ module Aws::Synthetics
|
|
|
95
118
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
|
96
119
|
# @return [Types::VpcConfigOutput]
|
|
97
120
|
#
|
|
121
|
+
# @!attribute [rw] visual_reference
|
|
122
|
+
# @return [Types::VisualReferenceOutput]
|
|
123
|
+
#
|
|
98
124
|
# @!attribute [rw] tags
|
|
99
125
|
# The list of key-value pairs that are associated with the canary.
|
|
100
126
|
# @return [Hash<String,String>]
|
|
@@ -116,6 +142,7 @@ module Aws::Synthetics
|
|
|
116
142
|
:engine_arn,
|
|
117
143
|
:runtime_version,
|
|
118
144
|
:vpc_config,
|
|
145
|
+
:visual_reference,
|
|
119
146
|
:tags)
|
|
120
147
|
SENSITIVE = []
|
|
121
148
|
include Aws::Structure
|
|
@@ -140,9 +167,8 @@ module Aws::Synthetics
|
|
|
140
167
|
# }
|
|
141
168
|
#
|
|
142
169
|
# @!attribute [rw] s3_bucket
|
|
143
|
-
# If your canary script is located in S3, specify the
|
|
144
|
-
# here.
|
|
145
|
-
# including `s3://` as the start of the bucket name.
|
|
170
|
+
# If your canary script is located in S3, specify the bucket name
|
|
171
|
+
# here. Do not include `s3://` as the start of the bucket name.
|
|
146
172
|
# @return [String]
|
|
147
173
|
#
|
|
148
174
|
# @!attribute [rw] s3_key
|
|
@@ -160,13 +186,15 @@ module Aws::Synthetics
|
|
|
160
186
|
#
|
|
161
187
|
# @!attribute [rw] zip_file
|
|
162
188
|
# If you input your canary script directly into the canary instead of
|
|
163
|
-
# referring to an S3 location, the value of this parameter is the
|
|
164
|
-
#
|
|
189
|
+
# referring to an S3 location, the value of this parameter is the
|
|
190
|
+
# base64-encoded contents of the .zip file that contains the script.
|
|
191
|
+
# It can be up to 5 MB.
|
|
165
192
|
# @return [String]
|
|
166
193
|
#
|
|
167
194
|
# @!attribute [rw] handler
|
|
168
195
|
# The entry point to use for the source code when running the canary.
|
|
169
|
-
# This value must end with the string `.handler`.
|
|
196
|
+
# This value must end with the string `.handler`. The string is
|
|
197
|
+
# limited to 29 characters or fewer.
|
|
170
198
|
# @return [String]
|
|
171
199
|
#
|
|
172
200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation
|
|
@@ -286,12 +314,12 @@ module Aws::Synthetics
|
|
|
286
314
|
# @return [Integer]
|
|
287
315
|
#
|
|
288
316
|
# @!attribute [rw] active_tracing
|
|
289
|
-
# Specifies whether this canary is to use active
|
|
290
|
-
#
|
|
291
|
-
#
|
|
292
|
-
#
|
|
293
|
-
#
|
|
294
|
-
#
|
|
317
|
+
# Specifies whether this canary is to use active X-Ray tracing when it
|
|
318
|
+
# runs. Active tracing enables this canary run to be displayed in the
|
|
319
|
+
# ServiceLens and X-Ray service maps even if the canary does not hit
|
|
320
|
+
# an endpoint that has X-Ray tracing enabled. Using X-Ray tracing
|
|
321
|
+
# incurs charges. For more information, see [ Canaries and X-Ray
|
|
322
|
+
# tracing][1].
|
|
295
323
|
#
|
|
296
324
|
# You can enable active tracing only for canaries that use version
|
|
297
325
|
# `syn-nodejs-2.0` or later for their canary runtime.
|
|
@@ -341,7 +369,7 @@ module Aws::Synthetics
|
|
|
341
369
|
# @return [Integer]
|
|
342
370
|
#
|
|
343
371
|
# @!attribute [rw] active_tracing
|
|
344
|
-
# Displays whether this canary run used active
|
|
372
|
+
# Displays whether this canary run used active X-Ray tracing.
|
|
345
373
|
# @return [Boolean]
|
|
346
374
|
#
|
|
347
375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigOutput AWS API Documentation
|
|
@@ -413,9 +441,11 @@ module Aws::Synthetics
|
|
|
413
441
|
# }
|
|
414
442
|
#
|
|
415
443
|
# @!attribute [rw] expression
|
|
416
|
-
# A rate expression that defines how often
|
|
417
|
-
#
|
|
418
|
-
#
|
|
444
|
+
# A `rate` expression or a `cron` expression that defines how often
|
|
445
|
+
# the canary is to run.
|
|
446
|
+
#
|
|
447
|
+
# For a rate expression, The syntax is `rate(number unit)`. *unit* can
|
|
448
|
+
# be `minute`, `minutes`, or `hour`.
|
|
419
449
|
#
|
|
420
450
|
# For example, `rate(1 minute)` runs the canary once a minute,
|
|
421
451
|
# `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
|
|
@@ -424,6 +454,15 @@ module Aws::Synthetics
|
|
|
424
454
|
#
|
|
425
455
|
# Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
|
|
426
456
|
# that causes the canary to run only once when it is started.
|
|
457
|
+
#
|
|
458
|
+
# Use `cron(expression)` to specify a cron expression. You can't
|
|
459
|
+
# schedule a canary to wait for more than a year before running. For
|
|
460
|
+
# information about the syntax for cron expressions, see [ Scheduling
|
|
461
|
+
# canary runs using cron][1].
|
|
462
|
+
#
|
|
463
|
+
#
|
|
464
|
+
#
|
|
465
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
|
|
427
466
|
# @return [String]
|
|
428
467
|
#
|
|
429
468
|
# @!attribute [rw] duration_in_seconds
|
|
@@ -446,16 +485,27 @@ module Aws::Synthetics
|
|
|
446
485
|
# according to the schedule in the `Expression` value.
|
|
447
486
|
#
|
|
448
487
|
# @!attribute [rw] expression
|
|
449
|
-
# A rate expression that defines how often
|
|
450
|
-
#
|
|
451
|
-
#
|
|
488
|
+
# A `rate` expression or a `cron` expression that defines how often
|
|
489
|
+
# the canary is to run.
|
|
490
|
+
#
|
|
491
|
+
# For a rate expression, The syntax is `rate(number unit)`. *unit* can
|
|
492
|
+
# be `minute`, `minutes`, or `hour`.
|
|
452
493
|
#
|
|
453
494
|
# For example, `rate(1 minute)` runs the canary once a minute,
|
|
454
495
|
# `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
|
|
455
|
-
# runs it once every hour.
|
|
496
|
+
# runs it once every hour. You can specify a frequency between `rate(1
|
|
497
|
+
# minute)` and `rate(1 hour)`.
|
|
456
498
|
#
|
|
457
499
|
# Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
|
|
458
500
|
# that causes the canary to run only once when it is started.
|
|
501
|
+
#
|
|
502
|
+
# Use `cron(expression)` to specify a cron expression. For information
|
|
503
|
+
# about the syntax for cron expressions, see [ Scheduling canary runs
|
|
504
|
+
# using cron][1].
|
|
505
|
+
#
|
|
506
|
+
#
|
|
507
|
+
#
|
|
508
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
|
|
459
509
|
# @return [String]
|
|
460
510
|
#
|
|
461
511
|
# @!attribute [rw] duration_in_seconds
|
|
@@ -604,7 +654,8 @@ module Aws::Synthetics
|
|
|
604
654
|
# @!attribute [rw] artifact_s3_location
|
|
605
655
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
|
606
656
|
# test runs of this canary. Artifacts include the log file,
|
|
607
|
-
# screenshots, and HAR files.
|
|
657
|
+
# screenshots, and HAR files. The name of the S3 bucket can't include
|
|
658
|
+
# a period (.).
|
|
608
659
|
# @return [String]
|
|
609
660
|
#
|
|
610
661
|
# @!attribute [rw] execution_role_arn
|
|
@@ -1227,6 +1278,15 @@ module Aws::Synthetics
|
|
|
1227
1278
|
# subnet_ids: ["SubnetId"],
|
|
1228
1279
|
# security_group_ids: ["SecurityGroupId"],
|
|
1229
1280
|
# },
|
|
1281
|
+
# visual_reference: {
|
|
1282
|
+
# base_screenshots: [
|
|
1283
|
+
# {
|
|
1284
|
+
# screenshot_name: "String", # required
|
|
1285
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
|
1286
|
+
# },
|
|
1287
|
+
# ],
|
|
1288
|
+
# base_canary_run_id: "String", # required
|
|
1289
|
+
# },
|
|
1230
1290
|
# }
|
|
1231
1291
|
#
|
|
1232
1292
|
# @!attribute [rw] name
|
|
@@ -1307,6 +1367,9 @@ module Aws::Synthetics
|
|
|
1307
1367
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
|
1308
1368
|
# @return [Types::VpcConfigInput]
|
|
1309
1369
|
#
|
|
1370
|
+
# @!attribute [rw] visual_reference
|
|
1371
|
+
# @return [Types::VisualReferenceInput]
|
|
1372
|
+
#
|
|
1310
1373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
|
|
1311
1374
|
#
|
|
1312
1375
|
class UpdateCanaryRequest < Struct.new(
|
|
@@ -1318,7 +1381,8 @@ module Aws::Synthetics
|
|
|
1318
1381
|
:run_config,
|
|
1319
1382
|
:success_retention_period_in_days,
|
|
1320
1383
|
:failure_retention_period_in_days,
|
|
1321
|
-
:vpc_config
|
|
1384
|
+
:vpc_config,
|
|
1385
|
+
:visual_reference)
|
|
1322
1386
|
SENSITIVE = []
|
|
1323
1387
|
include Aws::Structure
|
|
1324
1388
|
end
|
|
@@ -1340,6 +1404,49 @@ module Aws::Synthetics
|
|
|
1340
1404
|
include Aws::Structure
|
|
1341
1405
|
end
|
|
1342
1406
|
|
|
1407
|
+
# @note When making an API call, you may pass VisualReferenceInput
|
|
1408
|
+
# data as a hash:
|
|
1409
|
+
#
|
|
1410
|
+
# {
|
|
1411
|
+
# base_screenshots: [
|
|
1412
|
+
# {
|
|
1413
|
+
# screenshot_name: "String", # required
|
|
1414
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
|
1415
|
+
# },
|
|
1416
|
+
# ],
|
|
1417
|
+
# base_canary_run_id: "String", # required
|
|
1418
|
+
# }
|
|
1419
|
+
#
|
|
1420
|
+
# @!attribute [rw] base_screenshots
|
|
1421
|
+
# @return [Array<Types::BaseScreenshot>]
|
|
1422
|
+
#
|
|
1423
|
+
# @!attribute [rw] base_canary_run_id
|
|
1424
|
+
# @return [String]
|
|
1425
|
+
#
|
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation
|
|
1427
|
+
#
|
|
1428
|
+
class VisualReferenceInput < Struct.new(
|
|
1429
|
+
:base_screenshots,
|
|
1430
|
+
:base_canary_run_id)
|
|
1431
|
+
SENSITIVE = []
|
|
1432
|
+
include Aws::Structure
|
|
1433
|
+
end
|
|
1434
|
+
|
|
1435
|
+
# @!attribute [rw] base_screenshots
|
|
1436
|
+
# @return [Array<Types::BaseScreenshot>]
|
|
1437
|
+
#
|
|
1438
|
+
# @!attribute [rw] base_canary_run_id
|
|
1439
|
+
# @return [String]
|
|
1440
|
+
#
|
|
1441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation
|
|
1442
|
+
#
|
|
1443
|
+
class VisualReferenceOutput < Struct.new(
|
|
1444
|
+
:base_screenshots,
|
|
1445
|
+
:base_canary_run_id)
|
|
1446
|
+
SENSITIVE = []
|
|
1447
|
+
include Aws::Structure
|
|
1448
|
+
end
|
|
1449
|
+
|
|
1343
1450
|
# If this canary is to test an endpoint in a VPC, this structure
|
|
1344
1451
|
# contains information about the subnets and security groups of the VPC
|
|
1345
1452
|
# endpoint. For more information, see [ Running a Canary in a VPC][1].
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: aws-sdk-synthetics
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.13.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Amazon Web Services
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-07-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|
|
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
|
|
|
66
66
|
licenses:
|
|
67
67
|
- Apache-2.0
|
|
68
68
|
metadata:
|
|
69
|
-
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
|
70
|
-
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
|
69
|
+
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics
|
|
70
|
+
changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics/CHANGELOG.md
|
|
71
71
|
post_install_message:
|
|
72
72
|
rdoc_options: []
|
|
73
73
|
require_paths:
|
|
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
83
83
|
- !ruby/object:Gem::Version
|
|
84
84
|
version: '0'
|
|
85
85
|
requirements: []
|
|
86
|
-
|
|
87
|
-
rubygems_version: 2.7.6.2
|
|
86
|
+
rubygems_version: 3.1.6
|
|
88
87
|
signing_key:
|
|
89
88
|
specification_version: 4
|
|
90
89
|
summary: AWS SDK for Ruby - Synthetics
|