aws-sdk-synthetics 1.9.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +78 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-synthetics.rb +2 -2
- data/lib/aws-sdk-synthetics/client.rb +43 -13
- data/lib/aws-sdk-synthetics/client_api.rb +32 -1
- data/lib/aws-sdk-synthetics/errors.rb +1 -1
- data/lib/aws-sdk-synthetics/resource.rb +1 -1
- data/lib/aws-sdk-synthetics/types.rb +173 -38
- metadata +11 -9
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
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.13.0 (2021-07-26)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - CloudWatch Synthetics now supports visual testing in its canaries.
|
8
|
+
|
9
|
+
1.12.0 (2021-03-10)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.11.0 (2021-02-02)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.10.0 (2020-11-16)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS Synthetics now supports Environment Variables to assign runtime parameters in the canary scripts.
|
23
|
+
|
24
|
+
1.9.0 (2020-09-30)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.8.0 (2020-09-24)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - AWS Synthetics now supports AWS X-Ray Active Tracing feature. RunConfig is now an optional parameter with timeout updated from (60 - 900 seconds) to (3 - 840 seconds).
|
33
|
+
|
34
|
+
1.7.0 (2020-09-15)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.6.0 (2020-08-25)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.5.0 (2020-06-23)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
48
|
+
|
49
|
+
1.4.1 (2020-06-11)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
53
|
+
|
54
|
+
1.4.0 (2020-06-10)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Issue - This version has been yanked. (#2327).
|
58
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
59
|
+
|
60
|
+
1.3.0 (2020-05-28)
|
61
|
+
------------------
|
62
|
+
|
63
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
64
|
+
|
65
|
+
1.2.0 (2020-05-21)
|
66
|
+
------------------
|
67
|
+
|
68
|
+
* Feature - AWS CloudWatch Synthetics now supports configuration of allocated memory for a canary.
|
69
|
+
|
70
|
+
1.1.0 (2020-05-07)
|
71
|
+
------------------
|
72
|
+
|
73
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
74
|
+
|
75
|
+
1.0.0 (2020-04-20)
|
76
|
+
------------------
|
77
|
+
|
78
|
+
* Feature - Initial release of `aws-sdk-synthetics`.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.13.0
|
data/lib/aws-sdk-synthetics.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-synthetics/customizations'
|
|
48
48
|
# @!group service
|
49
49
|
module Aws::Synthetics
|
50
50
|
|
51
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.13.0'
|
52
52
|
|
53
53
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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
|
@@ -416,10 +416,9 @@ module Aws::Synthetics
|
|
416
416
|
# is 1 to 455 days.
|
417
417
|
#
|
418
418
|
# @option params [required, String] :runtime_version
|
419
|
-
# Specifies the runtime version to use for the canary.
|
420
|
-
#
|
421
|
-
#
|
422
|
-
# Runtime Versions][1].
|
419
|
+
# Specifies the runtime version to use for the canary. For a list of
|
420
|
+
# valid runtime versions and more information about runtime versions,
|
421
|
+
# see [ Canary Runtime Versions][1].
|
423
422
|
#
|
424
423
|
#
|
425
424
|
#
|
@@ -467,6 +466,9 @@ module Aws::Synthetics
|
|
467
466
|
# timeout_in_seconds: 1,
|
468
467
|
# memory_in_mb: 1,
|
469
468
|
# active_tracing: false,
|
469
|
+
# environment_variables: {
|
470
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
471
|
+
# },
|
470
472
|
# },
|
471
473
|
# success_retention_period_in_days: 1,
|
472
474
|
# failure_retention_period_in_days: 1,
|
@@ -509,6 +511,11 @@ module Aws::Synthetics
|
|
509
511
|
# resp.canary.vpc_config.subnet_ids[0] #=> String
|
510
512
|
# resp.canary.vpc_config.security_group_ids #=> Array
|
511
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
|
512
519
|
# resp.canary.tags #=> Hash
|
513
520
|
# resp.canary.tags["TagKey"] #=> String
|
514
521
|
#
|
@@ -635,6 +642,11 @@ module Aws::Synthetics
|
|
635
642
|
# resp.canaries[0].vpc_config.subnet_ids[0] #=> String
|
636
643
|
# resp.canaries[0].vpc_config.security_group_ids #=> Array
|
637
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
|
638
650
|
# resp.canaries[0].tags #=> Hash
|
639
651
|
# resp.canaries[0].tags["TagKey"] #=> String
|
640
652
|
# resp.next_token #=> String
|
@@ -797,6 +809,11 @@ module Aws::Synthetics
|
|
797
809
|
# resp.canary.vpc_config.subnet_ids[0] #=> String
|
798
810
|
# resp.canary.vpc_config.security_group_ids #=> Array
|
799
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
|
800
817
|
# resp.canary.tags #=> Hash
|
801
818
|
# resp.canary.tags["TagKey"] #=> String
|
802
819
|
#
|
@@ -966,8 +983,8 @@ module Aws::Synthetics
|
|
966
983
|
# use them to scope user permissions, by granting a user permission to
|
967
984
|
# access or change only resources with certain tag values.
|
968
985
|
#
|
969
|
-
# Tags don't have any semantic meaning to
|
970
|
-
# 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.
|
971
988
|
#
|
972
989
|
# You can use the `TagResource` action with a canary that already has
|
973
990
|
# tags. If you specify a new tag key for the alarm, this tag is appended
|
@@ -1082,10 +1099,9 @@ module Aws::Synthetics
|
|
1082
1099
|
# * `logs:CreateLogStream`
|
1083
1100
|
#
|
1084
1101
|
# @option params [String] :runtime_version
|
1085
|
-
# Specifies the runtime version to use for the canary.
|
1086
|
-
#
|
1087
|
-
#
|
1088
|
-
# Runtime Versions][1].
|
1102
|
+
# Specifies the runtime version to use for the canary. For a list of
|
1103
|
+
# valid runtime versions and for more information about runtime
|
1104
|
+
# versions, see [ Canary Runtime Versions][1].
|
1089
1105
|
#
|
1090
1106
|
#
|
1091
1107
|
#
|
@@ -1115,6 +1131,8 @@ module Aws::Synthetics
|
|
1115
1131
|
#
|
1116
1132
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
1117
1133
|
#
|
1134
|
+
# @option params [Types::VisualReferenceInput] :visual_reference
|
1135
|
+
#
|
1118
1136
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1119
1137
|
#
|
1120
1138
|
# @example Request syntax with placeholder values
|
@@ -1138,6 +1156,9 @@ module Aws::Synthetics
|
|
1138
1156
|
# timeout_in_seconds: 1,
|
1139
1157
|
# memory_in_mb: 1,
|
1140
1158
|
# active_tracing: false,
|
1159
|
+
# environment_variables: {
|
1160
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
1161
|
+
# },
|
1141
1162
|
# },
|
1142
1163
|
# success_retention_period_in_days: 1,
|
1143
1164
|
# failure_retention_period_in_days: 1,
|
@@ -1145,6 +1166,15 @@ module Aws::Synthetics
|
|
1145
1166
|
# subnet_ids: ["SubnetId"],
|
1146
1167
|
# security_group_ids: ["SecurityGroupId"],
|
1147
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
|
+
# },
|
1148
1178
|
# })
|
1149
1179
|
#
|
1150
1180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
|
@@ -1169,7 +1199,7 @@ module Aws::Synthetics
|
|
1169
1199
|
params: params,
|
1170
1200
|
config: config)
|
1171
1201
|
context[:gem_name] = 'aws-sdk-synthetics'
|
1172
|
-
context[:gem_version] = '1.
|
1202
|
+
context[:gem_version] = '1.13.0'
|
1173
1203
|
Seahorse::Client::Request.new(handlers, context)
|
1174
1204
|
end
|
1175
1205
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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')
|
@@ -47,6 +51,9 @@ module Aws::Synthetics
|
|
47
51
|
DescribeCanariesResponse = Shapes::StructureShape.new(name: 'DescribeCanariesResponse')
|
48
52
|
DescribeRuntimeVersionsRequest = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsRequest')
|
49
53
|
DescribeRuntimeVersionsResponse = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsResponse')
|
54
|
+
EnvironmentVariableName = Shapes::StringShape.new(name: 'EnvironmentVariableName')
|
55
|
+
EnvironmentVariableValue = Shapes::StringShape.new(name: 'EnvironmentVariableValue')
|
56
|
+
EnvironmentVariablesMap = Shapes::MapShape.new(name: 'EnvironmentVariablesMap')
|
50
57
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
51
58
|
FunctionArn = Shapes::StringShape.new(name: 'FunctionArn')
|
52
59
|
GetCanaryRequest = Shapes::StructureShape.new(name: 'GetCanaryRequest')
|
@@ -90,10 +97,20 @@ module Aws::Synthetics
|
|
90
97
|
UpdateCanaryRequest = Shapes::StructureShape.new(name: 'UpdateCanaryRequest')
|
91
98
|
UpdateCanaryResponse = Shapes::StructureShape.new(name: 'UpdateCanaryResponse')
|
92
99
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
100
|
+
VisualReferenceInput = Shapes::StructureShape.new(name: 'VisualReferenceInput')
|
101
|
+
VisualReferenceOutput = Shapes::StructureShape.new(name: 'VisualReferenceOutput')
|
93
102
|
VpcConfigInput = Shapes::StructureShape.new(name: 'VpcConfigInput')
|
94
103
|
VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
|
95
104
|
VpcId = Shapes::StringShape.new(name: 'VpcId')
|
96
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
|
+
|
97
114
|
Canaries.member = Shapes::ShapeRef.new(shape: Canary)
|
98
115
|
|
99
116
|
CanariesLastRun.member = Shapes::ShapeRef.new(shape: CanaryLastRun)
|
@@ -112,6 +129,7 @@ module Aws::Synthetics
|
|
112
129
|
Canary.add_member(:engine_arn, Shapes::ShapeRef.new(shape: FunctionArn, location_name: "EngineArn"))
|
113
130
|
Canary.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
|
114
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"))
|
115
133
|
Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
116
134
|
Canary.struct_class = Types::Canary
|
117
135
|
|
@@ -140,6 +158,7 @@ module Aws::Synthetics
|
|
140
158
|
CanaryRunConfigInput.add_member(:timeout_in_seconds, Shapes::ShapeRef.new(shape: MaxFifteenMinutesInSeconds, location_name: "TimeoutInSeconds"))
|
141
159
|
CanaryRunConfigInput.add_member(:memory_in_mb, Shapes::ShapeRef.new(shape: MaxSize3008, location_name: "MemoryInMB"))
|
142
160
|
CanaryRunConfigInput.add_member(:active_tracing, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ActiveTracing"))
|
161
|
+
CanaryRunConfigInput.add_member(:environment_variables, Shapes::ShapeRef.new(shape: EnvironmentVariablesMap, location_name: "EnvironmentVariables"))
|
143
162
|
CanaryRunConfigInput.struct_class = Types::CanaryRunConfigInput
|
144
163
|
|
145
164
|
CanaryRunConfigOutput.add_member(:timeout_in_seconds, Shapes::ShapeRef.new(shape: MaxFifteenMinutesInSeconds, location_name: "TimeoutInSeconds"))
|
@@ -225,6 +244,9 @@ module Aws::Synthetics
|
|
225
244
|
DescribeRuntimeVersionsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
|
226
245
|
DescribeRuntimeVersionsResponse.struct_class = Types::DescribeRuntimeVersionsResponse
|
227
246
|
|
247
|
+
EnvironmentVariablesMap.key = Shapes::ShapeRef.new(shape: EnvironmentVariableName)
|
248
|
+
EnvironmentVariablesMap.value = Shapes::ShapeRef.new(shape: EnvironmentVariableValue)
|
249
|
+
|
228
250
|
GetCanaryRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
|
229
251
|
GetCanaryRequest.struct_class = Types::GetCanaryRequest
|
230
252
|
|
@@ -300,6 +322,7 @@ module Aws::Synthetics
|
|
300
322
|
UpdateCanaryRequest.add_member(:success_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "SuccessRetentionPeriodInDays"))
|
301
323
|
UpdateCanaryRequest.add_member(:failure_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "FailureRetentionPeriodInDays"))
|
302
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"))
|
303
326
|
UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
|
304
327
|
|
305
328
|
UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
|
@@ -307,6 +330,14 @@ module Aws::Synthetics
|
|
307
330
|
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
308
331
|
ValidationException.struct_class = Types::ValidationException
|
309
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
|
+
|
310
341
|
VpcConfigInput.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
|
311
342
|
VpcConfigInput.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
|
312
343
|
VpcConfigInput.struct_class = Types::VpcConfigInput
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -3,13 +3,36 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
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
|
#
|
@@ -75,10 +98,9 @@ module Aws::Synthetics
|
|
75
98
|
# @return [String]
|
76
99
|
#
|
77
100
|
# @!attribute [rw] runtime_version
|
78
|
-
# Specifies the runtime version to use for the canary.
|
79
|
-
#
|
80
|
-
#
|
81
|
-
# Runtime Versions][1].
|
101
|
+
# Specifies the runtime version to use for the canary. For more
|
102
|
+
# information about runtime versions, see [ Canary Runtime
|
103
|
+
# Versions][1].
|
82
104
|
#
|
83
105
|
#
|
84
106
|
#
|
@@ -96,6 +118,9 @@ module Aws::Synthetics
|
|
96
118
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
97
119
|
# @return [Types::VpcConfigOutput]
|
98
120
|
#
|
121
|
+
# @!attribute [rw] visual_reference
|
122
|
+
# @return [Types::VisualReferenceOutput]
|
123
|
+
#
|
99
124
|
# @!attribute [rw] tags
|
100
125
|
# The list of key-value pairs that are associated with the canary.
|
101
126
|
# @return [Hash<String,String>]
|
@@ -117,6 +142,7 @@ module Aws::Synthetics
|
|
117
142
|
:engine_arn,
|
118
143
|
:runtime_version,
|
119
144
|
:vpc_config,
|
145
|
+
:visual_reference,
|
120
146
|
:tags)
|
121
147
|
SENSITIVE = []
|
122
148
|
include Aws::Structure
|
@@ -141,9 +167,8 @@ module Aws::Synthetics
|
|
141
167
|
# }
|
142
168
|
#
|
143
169
|
# @!attribute [rw] s3_bucket
|
144
|
-
# If your canary script is located in S3, specify the
|
145
|
-
# here.
|
146
|
-
# 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.
|
147
172
|
# @return [String]
|
148
173
|
#
|
149
174
|
# @!attribute [rw] s3_key
|
@@ -161,13 +186,15 @@ module Aws::Synthetics
|
|
161
186
|
#
|
162
187
|
# @!attribute [rw] zip_file
|
163
188
|
# If you input your canary script directly into the canary instead of
|
164
|
-
# referring to an S3 location, the value of this parameter is the
|
165
|
-
#
|
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.
|
166
192
|
# @return [String]
|
167
193
|
#
|
168
194
|
# @!attribute [rw] handler
|
169
195
|
# The entry point to use for the source code when running the canary.
|
170
|
-
# 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.
|
171
198
|
# @return [String]
|
172
199
|
#
|
173
200
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation
|
@@ -267,6 +294,9 @@ module Aws::Synthetics
|
|
267
294
|
# timeout_in_seconds: 1,
|
268
295
|
# memory_in_mb: 1,
|
269
296
|
# active_tracing: false,
|
297
|
+
# environment_variables: {
|
298
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
299
|
+
# },
|
270
300
|
# }
|
271
301
|
#
|
272
302
|
# @!attribute [rw] timeout_in_seconds
|
@@ -284,12 +314,12 @@ module Aws::Synthetics
|
|
284
314
|
# @return [Integer]
|
285
315
|
#
|
286
316
|
# @!attribute [rw] active_tracing
|
287
|
-
# Specifies whether this canary is to use active
|
288
|
-
#
|
289
|
-
#
|
290
|
-
#
|
291
|
-
#
|
292
|
-
#
|
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].
|
293
323
|
#
|
294
324
|
# You can enable active tracing only for canaries that use version
|
295
325
|
# `syn-nodejs-2.0` or later for their canary runtime.
|
@@ -299,12 +329,30 @@ module Aws::Synthetics
|
|
299
329
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_tracing.html
|
300
330
|
# @return [Boolean]
|
301
331
|
#
|
332
|
+
# @!attribute [rw] environment_variables
|
333
|
+
# Specifies the keys and values to use for any environment variables
|
334
|
+
# used in the canary script. Use the following format:
|
335
|
+
#
|
336
|
+
# \\\{ "key1" : "value1", "key2" : "value2", ...\\}
|
337
|
+
#
|
338
|
+
# Keys must start with a letter and be at least two characters. The
|
339
|
+
# total size of your environment variables cannot exceed 4 KB. You
|
340
|
+
# can't specify any Lambda reserved environment variables as the keys
|
341
|
+
# for your environment variables. For more information about reserved
|
342
|
+
# keys, see [ Runtime environment variables][1].
|
343
|
+
#
|
344
|
+
#
|
345
|
+
#
|
346
|
+
# [1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
|
347
|
+
# @return [Hash<String,String>]
|
348
|
+
#
|
302
349
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigInput AWS API Documentation
|
303
350
|
#
|
304
351
|
class CanaryRunConfigInput < Struct.new(
|
305
352
|
:timeout_in_seconds,
|
306
353
|
:memory_in_mb,
|
307
|
-
:active_tracing
|
354
|
+
:active_tracing,
|
355
|
+
:environment_variables)
|
308
356
|
SENSITIVE = []
|
309
357
|
include Aws::Structure
|
310
358
|
end
|
@@ -321,7 +369,7 @@ module Aws::Synthetics
|
|
321
369
|
# @return [Integer]
|
322
370
|
#
|
323
371
|
# @!attribute [rw] active_tracing
|
324
|
-
# Displays whether this canary run used active
|
372
|
+
# Displays whether this canary run used active X-Ray tracing.
|
325
373
|
# @return [Boolean]
|
326
374
|
#
|
327
375
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigOutput AWS API Documentation
|
@@ -393,9 +441,11 @@ module Aws::Synthetics
|
|
393
441
|
# }
|
394
442
|
#
|
395
443
|
# @!attribute [rw] expression
|
396
|
-
# A rate expression that defines how often
|
397
|
-
#
|
398
|
-
#
|
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`.
|
399
449
|
#
|
400
450
|
# For example, `rate(1 minute)` runs the canary once a minute,
|
401
451
|
# `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
|
@@ -404,6 +454,15 @@ module Aws::Synthetics
|
|
404
454
|
#
|
405
455
|
# Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
|
406
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
|
407
466
|
# @return [String]
|
408
467
|
#
|
409
468
|
# @!attribute [rw] duration_in_seconds
|
@@ -426,16 +485,27 @@ module Aws::Synthetics
|
|
426
485
|
# according to the schedule in the `Expression` value.
|
427
486
|
#
|
428
487
|
# @!attribute [rw] expression
|
429
|
-
# A rate expression that defines how often
|
430
|
-
#
|
431
|
-
#
|
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`.
|
432
493
|
#
|
433
494
|
# For example, `rate(1 minute)` runs the canary once a minute,
|
434
495
|
# `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
|
435
|
-
# 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)`.
|
436
498
|
#
|
437
499
|
# Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
|
438
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
|
439
509
|
# @return [String]
|
440
510
|
#
|
441
511
|
# @!attribute [rw] duration_in_seconds
|
@@ -544,6 +614,9 @@ module Aws::Synthetics
|
|
544
614
|
# timeout_in_seconds: 1,
|
545
615
|
# memory_in_mb: 1,
|
546
616
|
# active_tracing: false,
|
617
|
+
# environment_variables: {
|
618
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
619
|
+
# },
|
547
620
|
# },
|
548
621
|
# success_retention_period_in_days: 1,
|
549
622
|
# failure_retention_period_in_days: 1,
|
@@ -581,7 +654,8 @@ module Aws::Synthetics
|
|
581
654
|
# @!attribute [rw] artifact_s3_location
|
582
655
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
583
656
|
# test runs of this canary. Artifacts include the log file,
|
584
|
-
# screenshots, and HAR files.
|
657
|
+
# screenshots, and HAR files. The name of the S3 bucket can't include
|
658
|
+
# a period (.).
|
585
659
|
# @return [String]
|
586
660
|
#
|
587
661
|
# @!attribute [rw] execution_role_arn
|
@@ -628,10 +702,9 @@ module Aws::Synthetics
|
|
628
702
|
# @return [Integer]
|
629
703
|
#
|
630
704
|
# @!attribute [rw] runtime_version
|
631
|
-
# Specifies the runtime version to use for the canary.
|
632
|
-
#
|
633
|
-
#
|
634
|
-
# Runtime Versions][1].
|
705
|
+
# Specifies the runtime version to use for the canary. For a list of
|
706
|
+
# valid runtime versions and more information about runtime versions,
|
707
|
+
# see [ Canary Runtime Versions][1].
|
635
708
|
#
|
636
709
|
#
|
637
710
|
#
|
@@ -1019,8 +1092,12 @@ module Aws::Synthetics
|
|
1019
1092
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
|
1020
1093
|
#
|
1021
1094
|
# @!attribute [rw] version_name
|
1022
|
-
# The name of the runtime version.
|
1023
|
-
#
|
1095
|
+
# The name of the runtime version. For a list of valid runtime
|
1096
|
+
# versions, see [ Canary Runtime Versions][1].
|
1097
|
+
#
|
1098
|
+
#
|
1099
|
+
#
|
1100
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
|
1024
1101
|
# @return [String]
|
1025
1102
|
#
|
1026
1103
|
# @!attribute [rw] description
|
@@ -1191,6 +1268,9 @@ module Aws::Synthetics
|
|
1191
1268
|
# timeout_in_seconds: 1,
|
1192
1269
|
# memory_in_mb: 1,
|
1193
1270
|
# active_tracing: false,
|
1271
|
+
# environment_variables: {
|
1272
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
1273
|
+
# },
|
1194
1274
|
# },
|
1195
1275
|
# success_retention_period_in_days: 1,
|
1196
1276
|
# failure_retention_period_in_days: 1,
|
@@ -1198,6 +1278,15 @@ module Aws::Synthetics
|
|
1198
1278
|
# subnet_ids: ["SubnetId"],
|
1199
1279
|
# security_group_ids: ["SecurityGroupId"],
|
1200
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
|
+
# },
|
1201
1290
|
# }
|
1202
1291
|
#
|
1203
1292
|
# @!attribute [rw] name
|
@@ -1240,10 +1329,9 @@ module Aws::Synthetics
|
|
1240
1329
|
# @return [String]
|
1241
1330
|
#
|
1242
1331
|
# @!attribute [rw] runtime_version
|
1243
|
-
# Specifies the runtime version to use for the canary.
|
1244
|
-
#
|
1245
|
-
#
|
1246
|
-
# Runtime Versions][1].
|
1332
|
+
# Specifies the runtime version to use for the canary. For a list of
|
1333
|
+
# valid runtime versions and for more information about runtime
|
1334
|
+
# versions, see [ Canary Runtime Versions][1].
|
1247
1335
|
#
|
1248
1336
|
#
|
1249
1337
|
#
|
@@ -1279,6 +1367,9 @@ module Aws::Synthetics
|
|
1279
1367
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
1280
1368
|
# @return [Types::VpcConfigInput]
|
1281
1369
|
#
|
1370
|
+
# @!attribute [rw] visual_reference
|
1371
|
+
# @return [Types::VisualReferenceInput]
|
1372
|
+
#
|
1282
1373
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
|
1283
1374
|
#
|
1284
1375
|
class UpdateCanaryRequest < Struct.new(
|
@@ -1290,7 +1381,8 @@ module Aws::Synthetics
|
|
1290
1381
|
:run_config,
|
1291
1382
|
:success_retention_period_in_days,
|
1292
1383
|
:failure_retention_period_in_days,
|
1293
|
-
:vpc_config
|
1384
|
+
:vpc_config,
|
1385
|
+
:visual_reference)
|
1294
1386
|
SENSITIVE = []
|
1295
1387
|
include Aws::Structure
|
1296
1388
|
end
|
@@ -1312,6 +1404,49 @@ module Aws::Synthetics
|
|
1312
1404
|
include Aws::Structure
|
1313
1405
|
end
|
1314
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
|
+
|
1315
1450
|
# If this canary is to test an endpoint in a VPC, this structure
|
1316
1451
|
# contains information about the subnets and security groups of the VPC
|
1317
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:
|
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
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.112.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.112.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -47,11 +47,14 @@ dependencies:
|
|
47
47
|
description: Official AWS Ruby gem for Synthetics. This gem is part of the AWS SDK
|
48
48
|
for Ruby.
|
49
49
|
email:
|
50
|
-
-
|
50
|
+
- aws-dr-rubygems@amazon.com
|
51
51
|
executables: []
|
52
52
|
extensions: []
|
53
53
|
extra_rdoc_files: []
|
54
54
|
files:
|
55
|
+
- CHANGELOG.md
|
56
|
+
- LICENSE.txt
|
57
|
+
- VERSION
|
55
58
|
- lib/aws-sdk-synthetics.rb
|
56
59
|
- lib/aws-sdk-synthetics/client.rb
|
57
60
|
- lib/aws-sdk-synthetics/client_api.rb
|
@@ -63,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
|
|
63
66
|
licenses:
|
64
67
|
- Apache-2.0
|
65
68
|
metadata:
|
66
|
-
source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/
|
67
|
-
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
|
68
71
|
post_install_message:
|
69
72
|
rdoc_options: []
|
70
73
|
require_paths:
|
@@ -80,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
80
83
|
- !ruby/object:Gem::Version
|
81
84
|
version: '0'
|
82
85
|
requirements: []
|
83
|
-
|
84
|
-
rubygems_version: 2.7.6.2
|
86
|
+
rubygems_version: 3.1.6
|
85
87
|
signing_key:
|
86
88
|
specification_version: 4
|
87
89
|
summary: AWS SDK for Ruby - Synthetics
|