aws-sdk-synthetics 1.70.0 → 1.72.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-synthetics/client.rb +173 -13
- data/lib/aws-sdk-synthetics/client_api.rb +34 -0
- data/lib/aws-sdk-synthetics/types.rb +181 -6
- data/lib/aws-sdk-synthetics.rb +1 -1
- data/sig/client.rbs +47 -5
- data/sig/types.rbs +23 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce9eea410ee03fc680b8d61740ad6e04c3946f7404edc87a946ee03c7e4fb665
|
4
|
+
data.tar.gz: a2f40a0c1aa30fe73dbabe787040f145d234a67ce4c8dd7e09f12f8f5983a6be
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 548d15216dafbc033c290d0a4ee1e881556e3bbd6bfc57e7f4225bcb8352cc86e5bf35a1ee967ab1e5aa9d61fcd1dd07622c15e097ea4bd780497cb170e8a2bb
|
7
|
+
data.tar.gz: 65dccb920aab63471cc69efdca16864ec3af56f06f002f05da3a35378a11a009650f408bccd820296cc486c984801a05fa18d5df5f92948d2e9d2c3c952ecab1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.72.0 (2025-08-22)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added multi browser support for synthetics canaries, Increased ephemeral storage limit from 5GB to 10GB
|
8
|
+
|
9
|
+
1.71.0 (2025-08-04)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.70.0 (2025-07-31)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.72.0
|
@@ -95,8 +95,8 @@ module Aws::Synthetics
|
|
95
95
|
# class name or an instance of a plugin class.
|
96
96
|
#
|
97
97
|
# @option options [required, Aws::CredentialProvider] :credentials
|
98
|
-
# Your AWS credentials used for authentication. This can be
|
99
|
-
# following classes:
|
98
|
+
# Your AWS credentials used for authentication. This can be any class that includes and implements
|
99
|
+
# `Aws::CredentialProvider`, or instance of any one of the following classes:
|
100
100
|
#
|
101
101
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
102
102
|
# credentials.
|
@@ -124,8 +124,7 @@ module Aws::Synthetics
|
|
124
124
|
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
125
125
|
# from the Cognito Identity service.
|
126
126
|
#
|
127
|
-
# When `:credentials` are not configured directly, the following
|
128
|
-
# locations will be searched for credentials:
|
127
|
+
# When `:credentials` are not configured directly, the following locations will be searched for credentials:
|
129
128
|
#
|
130
129
|
# * `Aws.config[:credentials]`
|
131
130
|
#
|
@@ -139,12 +138,10 @@ module Aws::Synthetics
|
|
139
138
|
#
|
140
139
|
# * `~/.aws/config`
|
141
140
|
#
|
142
|
-
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
147
|
-
# to `true`.
|
141
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive.
|
142
|
+
# Construct and pass an instance of `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
143
|
+
# enable retries and extended timeouts. Instance profile credential fetching can be disabled by
|
144
|
+
# setting `ENV['AWS_EC2_METADATA_DISABLED']` to `true`.
|
148
145
|
#
|
149
146
|
# @option options [required, String] :region
|
150
147
|
# The AWS region to connect to. The configured `:region` is
|
@@ -377,8 +374,8 @@ module Aws::Synthetics
|
|
377
374
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
378
375
|
#
|
379
376
|
# @option options [Aws::TokenProvider] :token_provider
|
380
|
-
# Your Bearer token used for authentication. This can be
|
381
|
-
# following classes:
|
377
|
+
# Your Bearer token used for authentication. This can be any class that includes and implements
|
378
|
+
# `Aws::TokenProvider`, or instance of any one of the following classes:
|
382
379
|
#
|
383
380
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
384
381
|
# tokens.
|
@@ -661,6 +658,17 @@ module Aws::Synthetics
|
|
661
658
|
#
|
662
659
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
663
660
|
#
|
661
|
+
# @option params [Array<Types::BrowserConfig>] :browser_configs
|
662
|
+
# CloudWatch Synthetics now supports multibrowser canaries for
|
663
|
+
# `syn-nodejs-puppeteer-11.0` and `syn-nodejs-playwright-3.0` runtimes.
|
664
|
+
# This feature allows you to run your canaries on both Firefox and
|
665
|
+
# Chrome browsers. To create a multibrowser canary, you need to specify
|
666
|
+
# the BrowserConfigs with a list of browsers you want to use.
|
667
|
+
#
|
668
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
669
|
+
#
|
670
|
+
# </note>
|
671
|
+
#
|
664
672
|
# @option params [Hash<String,String>] :tags
|
665
673
|
# A list of key-value pairs to associate with the canary. You can
|
666
674
|
# associate as many as 50 tags with a canary.
|
@@ -727,6 +735,11 @@ module Aws::Synthetics
|
|
727
735
|
# },
|
728
736
|
# resources_to_replicate_tags: ["lambda-function"], # accepts lambda-function
|
729
737
|
# provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
|
738
|
+
# browser_configs: [
|
739
|
+
# {
|
740
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
741
|
+
# },
|
742
|
+
# ],
|
730
743
|
# tags: {
|
731
744
|
# "TagKey" => "TagValue",
|
732
745
|
# },
|
@@ -778,7 +791,20 @@ module Aws::Synthetics
|
|
778
791
|
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
779
792
|
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
780
793
|
# resp.canary.visual_reference.base_canary_run_id #=> String
|
794
|
+
# resp.canary.visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
|
781
795
|
# resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
|
796
|
+
# resp.canary.browser_configs #=> Array
|
797
|
+
# resp.canary.browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
798
|
+
# resp.canary.engine_configs #=> Array
|
799
|
+
# resp.canary.engine_configs[0].engine_arn #=> String
|
800
|
+
# resp.canary.engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
801
|
+
# resp.canary.visual_references #=> Array
|
802
|
+
# resp.canary.visual_references[0].base_screenshots #=> Array
|
803
|
+
# resp.canary.visual_references[0].base_screenshots[0].screenshot_name #=> String
|
804
|
+
# resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
|
805
|
+
# resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
|
806
|
+
# resp.canary.visual_references[0].base_canary_run_id #=> String
|
807
|
+
# resp.canary.visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
782
808
|
# resp.canary.tags #=> Hash
|
783
809
|
# resp.canary.tags["TagKey"] #=> String
|
784
810
|
# resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
@@ -1067,7 +1093,20 @@ module Aws::Synthetics
|
|
1067
1093
|
# resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
1068
1094
|
# resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
1069
1095
|
# resp.canaries[0].visual_reference.base_canary_run_id #=> String
|
1096
|
+
# resp.canaries[0].visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
|
1070
1097
|
# resp.canaries[0].provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
|
1098
|
+
# resp.canaries[0].browser_configs #=> Array
|
1099
|
+
# resp.canaries[0].browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1100
|
+
# resp.canaries[0].engine_configs #=> Array
|
1101
|
+
# resp.canaries[0].engine_configs[0].engine_arn #=> String
|
1102
|
+
# resp.canaries[0].engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1103
|
+
# resp.canaries[0].visual_references #=> Array
|
1104
|
+
# resp.canaries[0].visual_references[0].base_screenshots #=> Array
|
1105
|
+
# resp.canaries[0].visual_references[0].base_screenshots[0].screenshot_name #=> String
|
1106
|
+
# resp.canaries[0].visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
|
1107
|
+
# resp.canaries[0].visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
|
1108
|
+
# resp.canaries[0].visual_references[0].base_canary_run_id #=> String
|
1109
|
+
# resp.canaries[0].visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1071
1110
|
# resp.canaries[0].tags #=> Hash
|
1072
1111
|
# resp.canaries[0].tags["TagKey"] #=> String
|
1073
1112
|
# resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
@@ -1132,6 +1171,9 @@ module Aws::Synthetics
|
|
1132
1171
|
#
|
1133
1172
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
|
1134
1173
|
#
|
1174
|
+
# @option params [String] :browser_type
|
1175
|
+
# The type of browser to use for the canary run.
|
1176
|
+
#
|
1135
1177
|
# @return [Types::DescribeCanariesLastRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1136
1178
|
#
|
1137
1179
|
# * {Types::DescribeCanariesLastRunResponse#canaries_last_run #canaries_last_run} => Array<Types::CanaryLastRun>
|
@@ -1145,6 +1187,7 @@ module Aws::Synthetics
|
|
1145
1187
|
# next_token: "Token",
|
1146
1188
|
# max_results: 1,
|
1147
1189
|
# names: ["CanaryName"],
|
1190
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
1148
1191
|
# })
|
1149
1192
|
#
|
1150
1193
|
# @example Response structure
|
@@ -1164,6 +1207,7 @@ module Aws::Synthetics
|
|
1164
1207
|
# resp.canaries_last_run[0].last_run.timeline.metric_timestamp_for_run_and_retries #=> Time
|
1165
1208
|
# resp.canaries_last_run[0].last_run.artifact_s3_location #=> String
|
1166
1209
|
# resp.canaries_last_run[0].last_run.dry_run_config.dry_run_id #=> String
|
1210
|
+
# resp.canaries_last_run[0].last_run.browser_type #=> String, one of "CHROME", "FIREFOX"
|
1167
1211
|
# resp.next_token #=> String
|
1168
1212
|
#
|
1169
1213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun AWS API Documentation
|
@@ -1319,7 +1363,20 @@ module Aws::Synthetics
|
|
1319
1363
|
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
|
1320
1364
|
# resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
|
1321
1365
|
# resp.canary.visual_reference.base_canary_run_id #=> String
|
1366
|
+
# resp.canary.visual_reference.browser_type #=> String, one of "CHROME", "FIREFOX"
|
1322
1367
|
# resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
|
1368
|
+
# resp.canary.browser_configs #=> Array
|
1369
|
+
# resp.canary.browser_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1370
|
+
# resp.canary.engine_configs #=> Array
|
1371
|
+
# resp.canary.engine_configs[0].engine_arn #=> String
|
1372
|
+
# resp.canary.engine_configs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1373
|
+
# resp.canary.visual_references #=> Array
|
1374
|
+
# resp.canary.visual_references[0].base_screenshots #=> Array
|
1375
|
+
# resp.canary.visual_references[0].base_screenshots[0].screenshot_name #=> String
|
1376
|
+
# resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates #=> Array
|
1377
|
+
# resp.canary.visual_references[0].base_screenshots[0].ignore_coordinates[0] #=> String
|
1378
|
+
# resp.canary.visual_references[0].base_canary_run_id #=> String
|
1379
|
+
# resp.canary.visual_references[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1323
1380
|
# resp.canary.tags #=> Hash
|
1324
1381
|
# resp.canary.tags["TagKey"] #=> String
|
1325
1382
|
# resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
@@ -1407,6 +1464,7 @@ module Aws::Synthetics
|
|
1407
1464
|
# resp.canary_runs[0].timeline.metric_timestamp_for_run_and_retries #=> Time
|
1408
1465
|
# resp.canary_runs[0].artifact_s3_location #=> String
|
1409
1466
|
# resp.canary_runs[0].dry_run_config.dry_run_id #=> String
|
1467
|
+
# resp.canary_runs[0].browser_type #=> String, one of "CHROME", "FIREFOX"
|
1410
1468
|
# resp.next_token #=> String
|
1411
1469
|
#
|
1412
1470
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns AWS API Documentation
|
@@ -1790,6 +1848,29 @@ module Aws::Synthetics
|
|
1790
1848
|
#
|
1791
1849
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
1792
1850
|
#
|
1851
|
+
# @option params [Array<Types::BrowserConfig>] :browser_configs
|
1852
|
+
# A structure that specifies the browser type to use for a canary run.
|
1853
|
+
# CloudWatch Synthetics supports running canaries on both `CHROME` and
|
1854
|
+
# `FIREFOX` browsers.
|
1855
|
+
#
|
1856
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
1857
|
+
#
|
1858
|
+
# </note>
|
1859
|
+
#
|
1860
|
+
# @option params [Array<Types::VisualReferenceInput>] :visual_references
|
1861
|
+
# A list of visual reference configurations for the canary, one for each
|
1862
|
+
# browser type that the canary is configured to run on. Visual
|
1863
|
+
# references are used for visual monitoring comparisons.
|
1864
|
+
#
|
1865
|
+
# `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0`
|
1866
|
+
# and above, only supports `visualReferences`. `visualReference` field
|
1867
|
+
# is not supported.
|
1868
|
+
#
|
1869
|
+
# Versions older than `syn-nodejs-puppeteer-11.0` supports both
|
1870
|
+
# `visualReference` and `visualReferences` for backward compatibility.
|
1871
|
+
# It is recommended to use `visualReferences` for consistency and future
|
1872
|
+
# compatibility.
|
1873
|
+
#
|
1793
1874
|
# @return [Types::StartCanaryDryRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1794
1875
|
#
|
1795
1876
|
# * {Types::StartCanaryDryRunResponse#dry_run_config #dry_run_config} => Types::DryRunConfigOutput
|
@@ -1837,6 +1918,7 @@ module Aws::Synthetics
|
|
1837
1918
|
# },
|
1838
1919
|
# ],
|
1839
1920
|
# base_canary_run_id: "String", # required
|
1921
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
1840
1922
|
# },
|
1841
1923
|
# artifact_s3_location: "String",
|
1842
1924
|
# artifact_config: {
|
@@ -1846,6 +1928,23 @@ module Aws::Synthetics
|
|
1846
1928
|
# },
|
1847
1929
|
# },
|
1848
1930
|
# provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
|
1931
|
+
# browser_configs: [
|
1932
|
+
# {
|
1933
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
1934
|
+
# },
|
1935
|
+
# ],
|
1936
|
+
# visual_references: [
|
1937
|
+
# {
|
1938
|
+
# base_screenshots: [
|
1939
|
+
# {
|
1940
|
+
# screenshot_name: "String", # required
|
1941
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
1942
|
+
# },
|
1943
|
+
# ],
|
1944
|
+
# base_canary_run_id: "String", # required
|
1945
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
1946
|
+
# },
|
1947
|
+
# ],
|
1849
1948
|
# })
|
1850
1949
|
#
|
1851
1950
|
# @example Response structure
|
@@ -1980,6 +2079,15 @@ module Aws::Synthetics
|
|
1980
2079
|
|
1981
2080
|
# Updates the configuration of a canary that has already been created.
|
1982
2081
|
#
|
2082
|
+
# For multibrowser canaries, you can add or remove browsers by updating
|
2083
|
+
# the browserConfig list in the update call. For example:
|
2084
|
+
#
|
2085
|
+
# * To add Firefox to a canary that currently uses Chrome, specify
|
2086
|
+
# browserConfigs as \[CHROME, FIREFOX\]
|
2087
|
+
#
|
2088
|
+
# * To remove Firefox and keep only Chrome, specify browserConfigs as
|
2089
|
+
# \[CHROME\]
|
2090
|
+
#
|
1983
2091
|
# You can't use this operation to update the tags of an existing
|
1984
2092
|
# canary. To change the tags of an existing canary, use
|
1985
2093
|
# [TagResource][1].
|
@@ -2131,6 +2239,40 @@ module Aws::Synthetics
|
|
2131
2239
|
#
|
2132
2240
|
# </note>
|
2133
2241
|
#
|
2242
|
+
# @option params [Array<Types::VisualReferenceInput>] :visual_references
|
2243
|
+
# A list of visual reference configurations for the canary, one for each
|
2244
|
+
# browser type that the canary is configured to run on. Visual
|
2245
|
+
# references are used for visual monitoring comparisons.
|
2246
|
+
#
|
2247
|
+
# `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0`
|
2248
|
+
# and above, only supports `visualReferences`. `visualReference` field
|
2249
|
+
# is not supported.
|
2250
|
+
#
|
2251
|
+
# Versions older than `syn-nodejs-puppeteer-11.0` supports both
|
2252
|
+
# `visualReference` and `visualReferences` for backward compatibility.
|
2253
|
+
# It is recommended to use `visualReferences` for consistency and future
|
2254
|
+
# compatibility.
|
2255
|
+
#
|
2256
|
+
# For multibrowser visual monitoring, you can update the baseline for
|
2257
|
+
# all configured browsers in a single update call by specifying a list
|
2258
|
+
# of VisualReference objects, one per browser. Each VisualReference
|
2259
|
+
# object maps to a specific browser configuration, allowing you to
|
2260
|
+
# manage visual baselines for multiple browsers simultaneously.
|
2261
|
+
#
|
2262
|
+
# For single configuration canaries using Chrome browser (default
|
2263
|
+
# browser), use visualReferences for `syn-nodejs-puppeteer-11.0` and
|
2264
|
+
# above, and `syn-nodejs-playwright-3.0` and above canaries. The
|
2265
|
+
# browserType in the visualReference object is not mandatory.
|
2266
|
+
#
|
2267
|
+
# @option params [Array<Types::BrowserConfig>] :browser_configs
|
2268
|
+
# A structure that specifies the browser type to use for a canary run.
|
2269
|
+
# CloudWatch Synthetics supports running canaries on both `CHROME` and
|
2270
|
+
# `FIREFOX` browsers.
|
2271
|
+
#
|
2272
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
2273
|
+
#
|
2274
|
+
# </note>
|
2275
|
+
#
|
2134
2276
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2135
2277
|
#
|
2136
2278
|
# @example Request syntax with placeholder values
|
@@ -2183,6 +2325,7 @@ module Aws::Synthetics
|
|
2183
2325
|
# },
|
2184
2326
|
# ],
|
2185
2327
|
# base_canary_run_id: "String", # required
|
2328
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
2186
2329
|
# },
|
2187
2330
|
# artifact_s3_location: "String",
|
2188
2331
|
# artifact_config: {
|
@@ -2193,6 +2336,23 @@ module Aws::Synthetics
|
|
2193
2336
|
# },
|
2194
2337
|
# provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
|
2195
2338
|
# dry_run_id: "UUID",
|
2339
|
+
# visual_references: [
|
2340
|
+
# {
|
2341
|
+
# base_screenshots: [
|
2342
|
+
# {
|
2343
|
+
# screenshot_name: "String", # required
|
2344
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
2345
|
+
# },
|
2346
|
+
# ],
|
2347
|
+
# base_canary_run_id: "String", # required
|
2348
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
2349
|
+
# },
|
2350
|
+
# ],
|
2351
|
+
# browser_configs: [
|
2352
|
+
# {
|
2353
|
+
# browser_type: "CHROME", # accepts CHROME, FIREFOX
|
2354
|
+
# },
|
2355
|
+
# ],
|
2196
2356
|
# })
|
2197
2357
|
#
|
2198
2358
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
|
@@ -2222,7 +2382,7 @@ module Aws::Synthetics
|
|
2222
2382
|
tracer: tracer
|
2223
2383
|
)
|
2224
2384
|
context[:gem_name] = 'aws-sdk-synthetics'
|
2225
|
-
context[:gem_version] = '1.
|
2385
|
+
context[:gem_version] = '1.72.0'
|
2226
2386
|
Seahorse::Client::Request.new(handlers, context)
|
2227
2387
|
end
|
2228
2388
|
|
@@ -25,6 +25,9 @@ module Aws::Synthetics
|
|
25
25
|
BaseScreenshotIgnoreCoordinates = Shapes::ListShape.new(name: 'BaseScreenshotIgnoreCoordinates')
|
26
26
|
BaseScreenshots = Shapes::ListShape.new(name: 'BaseScreenshots')
|
27
27
|
Blob = Shapes::BlobShape.new(name: 'Blob')
|
28
|
+
BrowserConfig = Shapes::StructureShape.new(name: 'BrowserConfig')
|
29
|
+
BrowserConfigs = Shapes::ListShape.new(name: 'BrowserConfigs')
|
30
|
+
BrowserType = Shapes::StringShape.new(name: 'BrowserType')
|
28
31
|
Canaries = Shapes::ListShape.new(name: 'Canaries')
|
29
32
|
CanariesLastRun = Shapes::ListShape.new(name: 'CanariesLastRun')
|
30
33
|
Canary = Shapes::StructureShape.new(name: 'Canary')
|
@@ -74,6 +77,8 @@ module Aws::Synthetics
|
|
74
77
|
DisassociateResourceResponse = Shapes::StructureShape.new(name: 'DisassociateResourceResponse')
|
75
78
|
DryRunConfigOutput = Shapes::StructureShape.new(name: 'DryRunConfigOutput')
|
76
79
|
EncryptionMode = Shapes::StringShape.new(name: 'EncryptionMode')
|
80
|
+
EngineConfig = Shapes::StructureShape.new(name: 'EngineConfig')
|
81
|
+
EngineConfigs = Shapes::ListShape.new(name: 'EngineConfigs')
|
77
82
|
EnvironmentVariableName = Shapes::StringShape.new(name: 'EnvironmentVariableName')
|
78
83
|
EnvironmentVariableValue = Shapes::StringShape.new(name: 'EnvironmentVariableValue')
|
79
84
|
EnvironmentVariablesMap = Shapes::MapShape.new(name: 'EnvironmentVariablesMap')
|
@@ -158,6 +163,8 @@ module Aws::Synthetics
|
|
158
163
|
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
159
164
|
VisualReferenceInput = Shapes::StructureShape.new(name: 'VisualReferenceInput')
|
160
165
|
VisualReferenceOutput = Shapes::StructureShape.new(name: 'VisualReferenceOutput')
|
166
|
+
VisualReferences = Shapes::ListShape.new(name: 'VisualReferences')
|
167
|
+
VisualReferencesOutput = Shapes::ListShape.new(name: 'VisualReferencesOutput')
|
161
168
|
VpcConfigInput = Shapes::StructureShape.new(name: 'VpcConfigInput')
|
162
169
|
VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
|
163
170
|
VpcId = Shapes::StringShape.new(name: 'VpcId')
|
@@ -189,6 +196,11 @@ module Aws::Synthetics
|
|
189
196
|
|
190
197
|
BaseScreenshots.member = Shapes::ShapeRef.new(shape: BaseScreenshot)
|
191
198
|
|
199
|
+
BrowserConfig.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
200
|
+
BrowserConfig.struct_class = Types::BrowserConfig
|
201
|
+
|
202
|
+
BrowserConfigs.member = Shapes::ShapeRef.new(shape: BrowserConfig)
|
203
|
+
|
192
204
|
Canaries.member = Shapes::ShapeRef.new(shape: Canary)
|
193
205
|
|
194
206
|
CanariesLastRun.member = Shapes::ShapeRef.new(shape: CanaryLastRun)
|
@@ -209,6 +221,9 @@ module Aws::Synthetics
|
|
209
221
|
Canary.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigOutput, location_name: "VpcConfig"))
|
210
222
|
Canary.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceOutput, location_name: "VisualReference"))
|
211
223
|
Canary.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
|
224
|
+
Canary.add_member(:browser_configs, Shapes::ShapeRef.new(shape: BrowserConfigs, location_name: "BrowserConfigs"))
|
225
|
+
Canary.add_member(:engine_configs, Shapes::ShapeRef.new(shape: EngineConfigs, location_name: "EngineConfigs"))
|
226
|
+
Canary.add_member(:visual_references, Shapes::ShapeRef.new(shape: VisualReferencesOutput, location_name: "VisualReferences"))
|
212
227
|
Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
213
228
|
Canary.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigOutput, location_name: "ArtifactConfig"))
|
214
229
|
Canary.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: DryRunConfigOutput, location_name: "DryRunConfig"))
|
@@ -242,6 +257,7 @@ module Aws::Synthetics
|
|
242
257
|
CanaryRun.add_member(:timeline, Shapes::ShapeRef.new(shape: CanaryRunTimeline, location_name: "Timeline"))
|
243
258
|
CanaryRun.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
|
244
259
|
CanaryRun.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: CanaryDryRunConfigOutput, location_name: "DryRunConfig"))
|
260
|
+
CanaryRun.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
245
261
|
CanaryRun.struct_class = Types::CanaryRun
|
246
262
|
|
247
263
|
CanaryRunConfigInput.add_member(:timeout_in_seconds, Shapes::ShapeRef.new(shape: MaxFifteenMinutesInSeconds, location_name: "TimeoutInSeconds"))
|
@@ -306,6 +322,7 @@ module Aws::Synthetics
|
|
306
322
|
CreateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
|
307
323
|
CreateCanaryRequest.add_member(:resources_to_replicate_tags, Shapes::ShapeRef.new(shape: ResourceList, location_name: "ResourcesToReplicateTags"))
|
308
324
|
CreateCanaryRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
|
325
|
+
CreateCanaryRequest.add_member(:browser_configs, Shapes::ShapeRef.new(shape: BrowserConfigs, location_name: "BrowserConfigs"))
|
309
326
|
CreateCanaryRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
|
310
327
|
CreateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
|
311
328
|
CreateCanaryRequest.struct_class = Types::CreateCanaryRequest
|
@@ -342,6 +359,7 @@ module Aws::Synthetics
|
|
342
359
|
DescribeCanariesLastRunRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
|
343
360
|
DescribeCanariesLastRunRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize100, location_name: "MaxResults"))
|
344
361
|
DescribeCanariesLastRunRequest.add_member(:names, Shapes::ShapeRef.new(shape: DescribeCanariesLastRunNameFilter, location_name: "Names"))
|
362
|
+
DescribeCanariesLastRunRequest.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
345
363
|
DescribeCanariesLastRunRequest.struct_class = Types::DescribeCanariesLastRunRequest
|
346
364
|
|
347
365
|
DescribeCanariesLastRunResponse.add_member(:canaries_last_run, Shapes::ShapeRef.new(shape: CanariesLastRun, location_name: "CanariesLastRun"))
|
@@ -377,6 +395,12 @@ module Aws::Synthetics
|
|
377
395
|
DryRunConfigOutput.add_member(:last_dry_run_execution_status, Shapes::ShapeRef.new(shape: String, location_name: "LastDryRunExecutionStatus"))
|
378
396
|
DryRunConfigOutput.struct_class = Types::DryRunConfigOutput
|
379
397
|
|
398
|
+
EngineConfig.add_member(:engine_arn, Shapes::ShapeRef.new(shape: FunctionArn, location_name: "EngineArn"))
|
399
|
+
EngineConfig.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
400
|
+
EngineConfig.struct_class = Types::EngineConfig
|
401
|
+
|
402
|
+
EngineConfigs.member = Shapes::ShapeRef.new(shape: EngineConfig)
|
403
|
+
|
380
404
|
EnvironmentVariablesMap.key = Shapes::ShapeRef.new(shape: EnvironmentVariableName)
|
381
405
|
EnvironmentVariablesMap.value = Shapes::ShapeRef.new(shape: EnvironmentVariableValue)
|
382
406
|
|
@@ -503,6 +527,8 @@ module Aws::Synthetics
|
|
503
527
|
StartCanaryDryRunRequest.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
|
504
528
|
StartCanaryDryRunRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
|
505
529
|
StartCanaryDryRunRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
|
530
|
+
StartCanaryDryRunRequest.add_member(:browser_configs, Shapes::ShapeRef.new(shape: BrowserConfigs, location_name: "BrowserConfigs"))
|
531
|
+
StartCanaryDryRunRequest.add_member(:visual_references, Shapes::ShapeRef.new(shape: VisualReferences, location_name: "VisualReferences"))
|
506
532
|
StartCanaryDryRunRequest.struct_class = Types::StartCanaryDryRunRequest
|
507
533
|
|
508
534
|
StartCanaryDryRunResponse.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: DryRunConfigOutput, location_name: "DryRunConfig"))
|
@@ -556,6 +582,8 @@ module Aws::Synthetics
|
|
556
582
|
UpdateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
|
557
583
|
UpdateCanaryRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
|
558
584
|
UpdateCanaryRequest.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "DryRunId"))
|
585
|
+
UpdateCanaryRequest.add_member(:visual_references, Shapes::ShapeRef.new(shape: VisualReferences, location_name: "VisualReferences"))
|
586
|
+
UpdateCanaryRequest.add_member(:browser_configs, Shapes::ShapeRef.new(shape: BrowserConfigs, location_name: "BrowserConfigs"))
|
559
587
|
UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
|
560
588
|
|
561
589
|
UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
|
@@ -565,12 +593,18 @@ module Aws::Synthetics
|
|
565
593
|
|
566
594
|
VisualReferenceInput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
|
567
595
|
VisualReferenceInput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "BaseCanaryRunId"))
|
596
|
+
VisualReferenceInput.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
568
597
|
VisualReferenceInput.struct_class = Types::VisualReferenceInput
|
569
598
|
|
570
599
|
VisualReferenceOutput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
|
571
600
|
VisualReferenceOutput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, location_name: "BaseCanaryRunId"))
|
601
|
+
VisualReferenceOutput.add_member(:browser_type, Shapes::ShapeRef.new(shape: BrowserType, location_name: "BrowserType"))
|
572
602
|
VisualReferenceOutput.struct_class = Types::VisualReferenceOutput
|
573
603
|
|
604
|
+
VisualReferences.member = Shapes::ShapeRef.new(shape: VisualReferenceInput)
|
605
|
+
|
606
|
+
VisualReferencesOutput.member = Shapes::ShapeRef.new(shape: VisualReferenceOutput)
|
607
|
+
|
574
608
|
VpcConfigInput.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
|
575
609
|
VpcConfigInput.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
|
576
610
|
VpcConfigInput.add_member(:ipv_6_allowed_for_dual_stack, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "Ipv6AllowedForDualStack"))
|
@@ -130,6 +130,20 @@ module Aws::Synthetics
|
|
130
130
|
include Aws::Structure
|
131
131
|
end
|
132
132
|
|
133
|
+
# A structure that specifies the browser type to use for a canary run.
|
134
|
+
#
|
135
|
+
# @!attribute [rw] browser_type
|
136
|
+
# The browser type associated with this browser configuration.
|
137
|
+
# @return [String]
|
138
|
+
#
|
139
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BrowserConfig AWS API Documentation
|
140
|
+
#
|
141
|
+
class BrowserConfig < Struct.new(
|
142
|
+
:browser_type)
|
143
|
+
SENSITIVE = []
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
133
147
|
# This structure contains all information about one canary in your
|
134
148
|
# account.
|
135
149
|
#
|
@@ -253,6 +267,44 @@ module Aws::Synthetics
|
|
253
267
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
254
268
|
# @return [String]
|
255
269
|
#
|
270
|
+
# @!attribute [rw] browser_configs
|
271
|
+
# A structure that specifies the browser type to use for a canary run.
|
272
|
+
# CloudWatch Synthetics supports running canaries on both `CHROME` and
|
273
|
+
# `FIREFOX` browsers.
|
274
|
+
#
|
275
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
276
|
+
#
|
277
|
+
# </note>
|
278
|
+
# @return [Array<Types::BrowserConfig>]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] engine_configs
|
281
|
+
# A list of engine configurations for the canary, one for each browser
|
282
|
+
# type that the canary is configured to run on.
|
283
|
+
#
|
284
|
+
# All runtime versions `syn-nodejs-puppeteer-11.0` and above, and
|
285
|
+
# `syn-nodejs-playwright-3.0` and above, use `engineConfigs` only. You
|
286
|
+
# can no longer use `engineArn` in these versions.
|
287
|
+
#
|
288
|
+
# Runtime versions older than `syn-nodejs-puppeteer-11.0` and
|
289
|
+
# `syn-nodejs-playwright-3.0` continue to support `engineArn` to
|
290
|
+
# ensure backward compatibility.
|
291
|
+
# @return [Array<Types::EngineConfig>]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] visual_references
|
294
|
+
# A list of visual reference configurations for the canary, one for
|
295
|
+
# each browser type that the canary is configured to run on. Visual
|
296
|
+
# references are used for visual monitoring comparisons.
|
297
|
+
#
|
298
|
+
# `syn-nodejs-puppeteer-11.0` and above, and
|
299
|
+
# `syn-nodejs-playwright-3.0` and above, only supports
|
300
|
+
# `visualReferences`. `visualReference` field is not supported.
|
301
|
+
#
|
302
|
+
# Versions older than `syn-nodejs-puppeteer-11.0` supports both
|
303
|
+
# `visualReference` and `visualReferences` for backward compatibility.
|
304
|
+
# It is recommended to use `visualReferences` for consistency and
|
305
|
+
# future compatibility.
|
306
|
+
# @return [Array<Types::VisualReferenceOutput>]
|
307
|
+
#
|
256
308
|
# @!attribute [rw] tags
|
257
309
|
# The list of key-value pairs that are associated with the canary.
|
258
310
|
# @return [Hash<String,String>]
|
@@ -286,6 +338,9 @@ module Aws::Synthetics
|
|
286
338
|
:vpc_config,
|
287
339
|
:visual_reference,
|
288
340
|
:provisioned_resource_cleanup,
|
341
|
+
:browser_configs,
|
342
|
+
:engine_configs,
|
343
|
+
:visual_references,
|
289
344
|
:tags,
|
290
345
|
:artifact_config,
|
291
346
|
:dry_run_config)
|
@@ -474,6 +529,10 @@ module Aws::Synthetics
|
|
474
529
|
# Returns the dry run configurations for a canary.
|
475
530
|
# @return [Types::CanaryDryRunConfigOutput]
|
476
531
|
#
|
532
|
+
# @!attribute [rw] browser_type
|
533
|
+
# The browser type associated with this canary run.
|
534
|
+
# @return [String]
|
535
|
+
#
|
477
536
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRun AWS API Documentation
|
478
537
|
#
|
479
538
|
class CanaryRun < Struct.new(
|
@@ -484,7 +543,8 @@ module Aws::Synthetics
|
|
484
543
|
:status,
|
485
544
|
:timeline,
|
486
545
|
:artifact_s3_location,
|
487
|
-
:dry_run_config
|
546
|
+
:dry_run_config,
|
547
|
+
:browser_type)
|
488
548
|
SENSITIVE = []
|
489
549
|
include Aws::Structure
|
490
550
|
end
|
@@ -979,6 +1039,19 @@ module Aws::Synthetics
|
|
979
1039
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
980
1040
|
# @return [String]
|
981
1041
|
#
|
1042
|
+
# @!attribute [rw] browser_configs
|
1043
|
+
# CloudWatch Synthetics now supports multibrowser canaries for
|
1044
|
+
# `syn-nodejs-puppeteer-11.0` and `syn-nodejs-playwright-3.0`
|
1045
|
+
# runtimes. This feature allows you to run your canaries on both
|
1046
|
+
# Firefox and Chrome browsers. To create a multibrowser canary, you
|
1047
|
+
# need to specify the BrowserConfigs with a list of browsers you want
|
1048
|
+
# to use.
|
1049
|
+
#
|
1050
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
1051
|
+
#
|
1052
|
+
# </note>
|
1053
|
+
# @return [Array<Types::BrowserConfig>]
|
1054
|
+
#
|
982
1055
|
# @!attribute [rw] tags
|
983
1056
|
# A list of key-value pairs to associate with the canary. You can
|
984
1057
|
# associate as many as 50 tags with a canary.
|
@@ -1014,6 +1087,7 @@ module Aws::Synthetics
|
|
1014
1087
|
:vpc_config,
|
1015
1088
|
:resources_to_replicate_tags,
|
1016
1089
|
:provisioned_resource_cleanup,
|
1090
|
+
:browser_configs,
|
1017
1091
|
:tags,
|
1018
1092
|
:artifact_config)
|
1019
1093
|
SENSITIVE = []
|
@@ -1178,12 +1252,17 @@ module Aws::Synthetics
|
|
1178
1252
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Restricted.html
|
1179
1253
|
# @return [Array<String>]
|
1180
1254
|
#
|
1255
|
+
# @!attribute [rw] browser_type
|
1256
|
+
# The type of browser to use for the canary run.
|
1257
|
+
# @return [String]
|
1258
|
+
#
|
1181
1259
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRunRequest AWS API Documentation
|
1182
1260
|
#
|
1183
1261
|
class DescribeCanariesLastRunRequest < Struct.new(
|
1184
1262
|
:next_token,
|
1185
1263
|
:max_results,
|
1186
|
-
:names
|
1264
|
+
:names,
|
1265
|
+
:browser_type)
|
1187
1266
|
SENSITIVE = []
|
1188
1267
|
include Aws::Structure
|
1189
1268
|
end
|
@@ -1353,6 +1432,27 @@ module Aws::Synthetics
|
|
1353
1432
|
include Aws::Structure
|
1354
1433
|
end
|
1355
1434
|
|
1435
|
+
# A structure of engine configurations for the canary, one for each
|
1436
|
+
# browser type that the canary is configured to run on.
|
1437
|
+
#
|
1438
|
+
# @!attribute [rw] engine_arn
|
1439
|
+
# Each engine configuration contains the ARN of the Lambda function
|
1440
|
+
# that is used as the canary's engine for a specific browser type.
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] browser_type
|
1444
|
+
# The browser type associated with this engine configuration.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/EngineConfig AWS API Documentation
|
1448
|
+
#
|
1449
|
+
class EngineConfig < Struct.new(
|
1450
|
+
:engine_arn,
|
1451
|
+
:browser_type)
|
1452
|
+
SENSITIVE = []
|
1453
|
+
include Aws::Structure
|
1454
|
+
end
|
1455
|
+
|
1356
1456
|
# @!attribute [rw] name
|
1357
1457
|
# The name of the canary that you want details for.
|
1358
1458
|
# @return [String]
|
@@ -2052,6 +2152,31 @@ module Aws::Synthetics
|
|
2052
2152
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
2053
2153
|
# @return [String]
|
2054
2154
|
#
|
2155
|
+
# @!attribute [rw] browser_configs
|
2156
|
+
# A structure that specifies the browser type to use for a canary run.
|
2157
|
+
# CloudWatch Synthetics supports running canaries on both `CHROME` and
|
2158
|
+
# `FIREFOX` browsers.
|
2159
|
+
#
|
2160
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
2161
|
+
#
|
2162
|
+
# </note>
|
2163
|
+
# @return [Array<Types::BrowserConfig>]
|
2164
|
+
#
|
2165
|
+
# @!attribute [rw] visual_references
|
2166
|
+
# A list of visual reference configurations for the canary, one for
|
2167
|
+
# each browser type that the canary is configured to run on. Visual
|
2168
|
+
# references are used for visual monitoring comparisons.
|
2169
|
+
#
|
2170
|
+
# `syn-nodejs-puppeteer-11.0` and above, and
|
2171
|
+
# `syn-nodejs-playwright-3.0` and above, only supports
|
2172
|
+
# `visualReferences`. `visualReference` field is not supported.
|
2173
|
+
#
|
2174
|
+
# Versions older than `syn-nodejs-puppeteer-11.0` supports both
|
2175
|
+
# `visualReference` and `visualReferences` for backward compatibility.
|
2176
|
+
# It is recommended to use `visualReferences` for consistency and
|
2177
|
+
# future compatibility.
|
2178
|
+
# @return [Array<Types::VisualReferenceInput>]
|
2179
|
+
#
|
2055
2180
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRunRequest AWS API Documentation
|
2056
2181
|
#
|
2057
2182
|
class StartCanaryDryRunRequest < Struct.new(
|
@@ -2066,7 +2191,9 @@ module Aws::Synthetics
|
|
2066
2191
|
:visual_reference,
|
2067
2192
|
:artifact_s3_location,
|
2068
2193
|
:artifact_config,
|
2069
|
-
:provisioned_resource_cleanup
|
2194
|
+
:provisioned_resource_cleanup,
|
2195
|
+
:browser_configs,
|
2196
|
+
:visual_references)
|
2070
2197
|
SENSITIVE = []
|
2071
2198
|
include Aws::Structure
|
2072
2199
|
end
|
@@ -2345,6 +2472,42 @@ module Aws::Synthetics
|
|
2345
2472
|
# </note>
|
2346
2473
|
# @return [String]
|
2347
2474
|
#
|
2475
|
+
# @!attribute [rw] visual_references
|
2476
|
+
# A list of visual reference configurations for the canary, one for
|
2477
|
+
# each browser type that the canary is configured to run on. Visual
|
2478
|
+
# references are used for visual monitoring comparisons.
|
2479
|
+
#
|
2480
|
+
# `syn-nodejs-puppeteer-11.0` and above, and
|
2481
|
+
# `syn-nodejs-playwright-3.0` and above, only supports
|
2482
|
+
# `visualReferences`. `visualReference` field is not supported.
|
2483
|
+
#
|
2484
|
+
# Versions older than `syn-nodejs-puppeteer-11.0` supports both
|
2485
|
+
# `visualReference` and `visualReferences` for backward compatibility.
|
2486
|
+
# It is recommended to use `visualReferences` for consistency and
|
2487
|
+
# future compatibility.
|
2488
|
+
#
|
2489
|
+
# For multibrowser visual monitoring, you can update the baseline for
|
2490
|
+
# all configured browsers in a single update call by specifying a list
|
2491
|
+
# of VisualReference objects, one per browser. Each VisualReference
|
2492
|
+
# object maps to a specific browser configuration, allowing you to
|
2493
|
+
# manage visual baselines for multiple browsers simultaneously.
|
2494
|
+
#
|
2495
|
+
# For single configuration canaries using Chrome browser (default
|
2496
|
+
# browser), use visualReferences for `syn-nodejs-puppeteer-11.0` and
|
2497
|
+
# above, and `syn-nodejs-playwright-3.0` and above canaries. The
|
2498
|
+
# browserType in the visualReference object is not mandatory.
|
2499
|
+
# @return [Array<Types::VisualReferenceInput>]
|
2500
|
+
#
|
2501
|
+
# @!attribute [rw] browser_configs
|
2502
|
+
# A structure that specifies the browser type to use for a canary run.
|
2503
|
+
# CloudWatch Synthetics supports running canaries on both `CHROME` and
|
2504
|
+
# `FIREFOX` browsers.
|
2505
|
+
#
|
2506
|
+
# <note markdown="1"> If not specified, `browserConfigs` defaults to Chrome.
|
2507
|
+
#
|
2508
|
+
# </note>
|
2509
|
+
# @return [Array<Types::BrowserConfig>]
|
2510
|
+
#
|
2348
2511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
|
2349
2512
|
#
|
2350
2513
|
class UpdateCanaryRequest < Struct.new(
|
@@ -2361,7 +2524,9 @@ module Aws::Synthetics
|
|
2361
2524
|
:artifact_s3_location,
|
2362
2525
|
:artifact_config,
|
2363
2526
|
:provisioned_resource_cleanup,
|
2364
|
-
:dry_run_id
|
2527
|
+
:dry_run_id,
|
2528
|
+
:visual_references,
|
2529
|
+
:browser_configs)
|
2365
2530
|
SENSITIVE = []
|
2366
2531
|
include Aws::Structure
|
2367
2532
|
end
|
@@ -2418,11 +2583,16 @@ module Aws::Synthetics
|
|
2418
2583
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html
|
2419
2584
|
# @return [String]
|
2420
2585
|
#
|
2586
|
+
# @!attribute [rw] browser_type
|
2587
|
+
# The browser type associated with this visual reference.
|
2588
|
+
# @return [String]
|
2589
|
+
#
|
2421
2590
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation
|
2422
2591
|
#
|
2423
2592
|
class VisualReferenceInput < Struct.new(
|
2424
2593
|
:base_screenshots,
|
2425
|
-
:base_canary_run_id
|
2594
|
+
:base_canary_run_id,
|
2595
|
+
:browser_type)
|
2426
2596
|
SENSITIVE = []
|
2427
2597
|
include Aws::Structure
|
2428
2598
|
end
|
@@ -2445,11 +2615,16 @@ module Aws::Synthetics
|
|
2445
2615
|
# are used for visual monitoring comparisons by this canary.
|
2446
2616
|
# @return [String]
|
2447
2617
|
#
|
2618
|
+
# @!attribute [rw] browser_type
|
2619
|
+
# The browser type associated with this visual reference.
|
2620
|
+
# @return [String]
|
2621
|
+
#
|
2448
2622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation
|
2449
2623
|
#
|
2450
2624
|
class VisualReferenceOutput < Struct.new(
|
2451
2625
|
:base_screenshots,
|
2452
|
-
:base_canary_run_id
|
2626
|
+
:base_canary_run_id,
|
2627
|
+
:browser_type)
|
2453
2628
|
SENSITIVE = []
|
2454
2629
|
include Aws::Structure
|
2455
2630
|
end
|
data/lib/aws-sdk-synthetics.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -134,6 +134,11 @@ module Aws
|
|
134
134
|
},
|
135
135
|
?resources_to_replicate_tags: Array[("lambda-function")],
|
136
136
|
?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF"),
|
137
|
+
?browser_configs: Array[
|
138
|
+
{
|
139
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
140
|
+
},
|
141
|
+
],
|
137
142
|
?tags: Hash[::String, ::String],
|
138
143
|
?artifact_config: {
|
139
144
|
s3_encryption: {
|
@@ -196,7 +201,8 @@ module Aws
|
|
196
201
|
def describe_canaries_last_run: (
|
197
202
|
?next_token: ::String,
|
198
203
|
?max_results: ::Integer,
|
199
|
-
?names: Array[::String]
|
204
|
+
?names: Array[::String],
|
205
|
+
?browser_type: ("CHROME" | "FIREFOX")
|
200
206
|
) -> _DescribeCanariesLastRunResponseSuccess
|
201
207
|
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCanariesLastRunResponseSuccess
|
202
208
|
|
@@ -358,7 +364,8 @@ module Aws
|
|
358
364
|
ignore_coordinates: Array[::String]?
|
359
365
|
},
|
360
366
|
]?,
|
361
|
-
base_canary_run_id: ::String
|
367
|
+
base_canary_run_id: ::String,
|
368
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
362
369
|
},
|
363
370
|
?artifact_s3_location: ::String,
|
364
371
|
?artifact_config: {
|
@@ -367,7 +374,24 @@ module Aws
|
|
367
374
|
kms_key_arn: ::String?
|
368
375
|
}?
|
369
376
|
},
|
370
|
-
?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
|
377
|
+
?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF"),
|
378
|
+
?browser_configs: Array[
|
379
|
+
{
|
380
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
381
|
+
},
|
382
|
+
],
|
383
|
+
?visual_references: Array[
|
384
|
+
{
|
385
|
+
base_screenshots: Array[
|
386
|
+
{
|
387
|
+
screenshot_name: ::String,
|
388
|
+
ignore_coordinates: Array[::String]?
|
389
|
+
},
|
390
|
+
]?,
|
391
|
+
base_canary_run_id: ::String,
|
392
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
393
|
+
},
|
394
|
+
]
|
371
395
|
) -> _StartCanaryDryRunResponseSuccess
|
372
396
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCanaryDryRunResponseSuccess
|
373
397
|
|
@@ -449,7 +473,8 @@ module Aws
|
|
449
473
|
ignore_coordinates: Array[::String]?
|
450
474
|
},
|
451
475
|
]?,
|
452
|
-
base_canary_run_id: ::String
|
476
|
+
base_canary_run_id: ::String,
|
477
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
453
478
|
},
|
454
479
|
?artifact_s3_location: ::String,
|
455
480
|
?artifact_config: {
|
@@ -459,7 +484,24 @@ module Aws
|
|
459
484
|
}?
|
460
485
|
},
|
461
486
|
?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF"),
|
462
|
-
?dry_run_id: ::String
|
487
|
+
?dry_run_id: ::String,
|
488
|
+
?visual_references: Array[
|
489
|
+
{
|
490
|
+
base_screenshots: Array[
|
491
|
+
{
|
492
|
+
screenshot_name: ::String,
|
493
|
+
ignore_coordinates: Array[::String]?
|
494
|
+
},
|
495
|
+
]?,
|
496
|
+
base_canary_run_id: ::String,
|
497
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
498
|
+
},
|
499
|
+
],
|
500
|
+
?browser_configs: Array[
|
501
|
+
{
|
502
|
+
browser_type: ("CHROME" | "FIREFOX")?
|
503
|
+
},
|
504
|
+
]
|
463
505
|
) -> _UpdateCanaryResponseSuccess
|
464
506
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCanaryResponseSuccess
|
465
507
|
end
|
data/sig/types.rbs
CHANGED
@@ -43,6 +43,11 @@ module Aws::Synthetics
|
|
43
43
|
SENSITIVE: []
|
44
44
|
end
|
45
45
|
|
46
|
+
class BrowserConfig
|
47
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
48
|
+
SENSITIVE: []
|
49
|
+
end
|
50
|
+
|
46
51
|
class Canary
|
47
52
|
attr_accessor id: ::String
|
48
53
|
attr_accessor name: ::String
|
@@ -60,6 +65,9 @@ module Aws::Synthetics
|
|
60
65
|
attr_accessor vpc_config: Types::VpcConfigOutput
|
61
66
|
attr_accessor visual_reference: Types::VisualReferenceOutput
|
62
67
|
attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
|
68
|
+
attr_accessor browser_configs: ::Array[Types::BrowserConfig]
|
69
|
+
attr_accessor engine_configs: ::Array[Types::EngineConfig]
|
70
|
+
attr_accessor visual_references: ::Array[Types::VisualReferenceOutput]
|
63
71
|
attr_accessor tags: ::Hash[::String, ::String]
|
64
72
|
attr_accessor artifact_config: Types::ArtifactConfigOutput
|
65
73
|
attr_accessor dry_run_config: Types::DryRunConfigOutput
|
@@ -103,6 +111,7 @@ module Aws::Synthetics
|
|
103
111
|
attr_accessor timeline: Types::CanaryRunTimeline
|
104
112
|
attr_accessor artifact_s3_location: ::String
|
105
113
|
attr_accessor dry_run_config: Types::CanaryDryRunConfigOutput
|
114
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
106
115
|
SENSITIVE: []
|
107
116
|
end
|
108
117
|
|
@@ -185,6 +194,7 @@ module Aws::Synthetics
|
|
185
194
|
attr_accessor vpc_config: Types::VpcConfigInput
|
186
195
|
attr_accessor resources_to_replicate_tags: ::Array[("lambda-function")]
|
187
196
|
attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
|
197
|
+
attr_accessor browser_configs: ::Array[Types::BrowserConfig]
|
188
198
|
attr_accessor tags: ::Hash[::String, ::String]
|
189
199
|
attr_accessor artifact_config: Types::ArtifactConfigInput
|
190
200
|
SENSITIVE: []
|
@@ -233,6 +243,7 @@ module Aws::Synthetics
|
|
233
243
|
attr_accessor next_token: ::String
|
234
244
|
attr_accessor max_results: ::Integer
|
235
245
|
attr_accessor names: ::Array[::String]
|
246
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
236
247
|
SENSITIVE: []
|
237
248
|
end
|
238
249
|
|
@@ -282,6 +293,12 @@ module Aws::Synthetics
|
|
282
293
|
SENSITIVE: []
|
283
294
|
end
|
284
295
|
|
296
|
+
class EngineConfig
|
297
|
+
attr_accessor engine_arn: ::String
|
298
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
299
|
+
SENSITIVE: []
|
300
|
+
end
|
301
|
+
|
285
302
|
class GetCanaryRequest
|
286
303
|
attr_accessor name: ::String
|
287
304
|
attr_accessor dry_run_id: ::String
|
@@ -450,6 +467,8 @@ module Aws::Synthetics
|
|
450
467
|
attr_accessor artifact_s3_location: ::String
|
451
468
|
attr_accessor artifact_config: Types::ArtifactConfigInput
|
452
469
|
attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
|
470
|
+
attr_accessor browser_configs: ::Array[Types::BrowserConfig]
|
471
|
+
attr_accessor visual_references: ::Array[Types::VisualReferenceInput]
|
453
472
|
SENSITIVE: []
|
454
473
|
end
|
455
474
|
|
@@ -512,6 +531,8 @@ module Aws::Synthetics
|
|
512
531
|
attr_accessor artifact_config: Types::ArtifactConfigInput
|
513
532
|
attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
|
514
533
|
attr_accessor dry_run_id: ::String
|
534
|
+
attr_accessor visual_references: ::Array[Types::VisualReferenceInput]
|
535
|
+
attr_accessor browser_configs: ::Array[Types::BrowserConfig]
|
515
536
|
SENSITIVE: []
|
516
537
|
end
|
517
538
|
|
@@ -526,12 +547,14 @@ module Aws::Synthetics
|
|
526
547
|
class VisualReferenceInput
|
527
548
|
attr_accessor base_screenshots: ::Array[Types::BaseScreenshot]
|
528
549
|
attr_accessor base_canary_run_id: ::String
|
550
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
529
551
|
SENSITIVE: []
|
530
552
|
end
|
531
553
|
|
532
554
|
class VisualReferenceOutput
|
533
555
|
attr_accessor base_screenshots: ::Array[Types::BaseScreenshot]
|
534
556
|
attr_accessor base_canary_run_id: ::String
|
557
|
+
attr_accessor browser_type: ("CHROME" | "FIREFOX")
|
535
558
|
SENSITIVE: []
|
536
559
|
end
|
537
560
|
|