aws-sdk-synthetics 1.62.0 → 1.64.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 +303 -5
- data/lib/aws-sdk-synthetics/client_api.rb +68 -0
- data/lib/aws-sdk-synthetics/errors.rb +16 -0
- data/lib/aws-sdk-synthetics/types.rb +423 -20
- data/lib/aws-sdk-synthetics.rb +1 -1
- data/sig/client.rbs +64 -5
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +58 -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: f2f10eca2913a43646fb0d7dad579d5fbbb8ff68317f9f4fccd3e4dab3f6225e
|
4
|
+
data.tar.gz: bd07a39420ada92596e0352cddfb0468c8c151189c5740cb558083ea446362dd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9cea5297a6b133f3ebaa010239ae2ac36f0b7dcdced52069a84633d4c9080f7e6492d4e430642c20f25e87d954b7e2aa56f6c51988bf494983be3e644c201fa5
|
7
|
+
data.tar.gz: 91dc833ef6609777aeaa7fe6546501b57c087dcc9ad3bf50d2d814b467e7db4fbe13393028f8ffc45fdd3d753f99b8881f7941b4fcbf192ef55b684145758b21
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.64.0 (2025-05-09)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add support to retry a canary automatically after schedule run failures. Users can enable this feature by configuring the RetryConfig field when calling the CreateCanary or UpdateCanary API. Also includes changes in GetCanary and GetCanaryRuns to support retrieving retry configurations.
|
8
|
+
|
9
|
+
1.63.0 (2025-05-07)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Add support to test a canary update by invoking a dry run of a canary. This behavior can be used via the new StartCanaryDryRun API along with new fields in UpdateCanary to apply dry run changes. Also includes changes in GetCanary and GetCanaryRuns to support retrieving dry run configurations.
|
13
|
+
|
4
14
|
1.62.0 (2025-05-01)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.64.0
|
@@ -580,19 +580,37 @@ module Aws::Synthetics
|
|
580
580
|
# A structure that contains the configuration for individual canary
|
581
581
|
# runs, such as timeout value and environment variables.
|
582
582
|
#
|
583
|
-
#
|
584
|
-
#
|
583
|
+
# Environment variable keys and values are encrypted at rest using
|
584
|
+
# Amazon Web Services owned KMS keys. However, the environment variables
|
585
|
+
# are not encrypted on the client side. Do not store sensitive
|
586
|
+
# information in them.
|
585
587
|
#
|
586
588
|
# @option params [Integer] :success_retention_period_in_days
|
587
589
|
# The number of days to retain data about successful runs of this
|
588
590
|
# canary. If you omit this field, the default of 31 days is used. The
|
589
591
|
# valid range is 1 to 455 days.
|
590
592
|
#
|
593
|
+
# This setting affects the range of information returned by
|
594
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
595
|
+
# the Synthetics console.
|
596
|
+
#
|
597
|
+
#
|
598
|
+
#
|
599
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
600
|
+
#
|
591
601
|
# @option params [Integer] :failure_retention_period_in_days
|
592
602
|
# The number of days to retain data about failed runs of this canary. If
|
593
603
|
# you omit this field, the default of 31 days is used. The valid range
|
594
604
|
# is 1 to 455 days.
|
595
605
|
#
|
606
|
+
# This setting affects the range of information returned by
|
607
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
608
|
+
# the Synthetics console.
|
609
|
+
#
|
610
|
+
#
|
611
|
+
#
|
612
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
613
|
+
#
|
596
614
|
# @option params [required, String] :runtime_version
|
597
615
|
# Specifies the runtime version to use for the canary. For a list of
|
598
616
|
# valid runtime versions and more information about runtime versions,
|
@@ -670,6 +688,9 @@ module Aws::Synthetics
|
|
670
688
|
# schedule: { # required
|
671
689
|
# expression: "String", # required
|
672
690
|
# duration_in_seconds: 1,
|
691
|
+
# retry_config: {
|
692
|
+
# max_retries: 1, # required
|
693
|
+
# },
|
673
694
|
# },
|
674
695
|
# run_config: {
|
675
696
|
# timeout_in_seconds: 1,
|
@@ -709,6 +730,7 @@ module Aws::Synthetics
|
|
709
730
|
# resp.canary.execution_role_arn #=> String
|
710
731
|
# resp.canary.schedule.expression #=> String
|
711
732
|
# resp.canary.schedule.duration_in_seconds #=> Integer
|
733
|
+
# resp.canary.schedule.retry_config.max_retries #=> Integer
|
712
734
|
# resp.canary.run_config.timeout_in_seconds #=> Integer
|
713
735
|
# resp.canary.run_config.memory_in_mb #=> Integer
|
714
736
|
# resp.canary.run_config.active_tracing #=> Boolean
|
@@ -740,6 +762,8 @@ module Aws::Synthetics
|
|
740
762
|
# resp.canary.tags["TagKey"] #=> String
|
741
763
|
# resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
742
764
|
# resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
|
765
|
+
# resp.canary.dry_run_config.dry_run_id #=> String
|
766
|
+
# resp.canary.dry_run_config.last_dry_run_execution_status #=> String
|
743
767
|
#
|
744
768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary AWS API Documentation
|
745
769
|
#
|
@@ -991,6 +1015,7 @@ module Aws::Synthetics
|
|
991
1015
|
# resp.canaries[0].execution_role_arn #=> String
|
992
1016
|
# resp.canaries[0].schedule.expression #=> String
|
993
1017
|
# resp.canaries[0].schedule.duration_in_seconds #=> Integer
|
1018
|
+
# resp.canaries[0].schedule.retry_config.max_retries #=> Integer
|
994
1019
|
# resp.canaries[0].run_config.timeout_in_seconds #=> Integer
|
995
1020
|
# resp.canaries[0].run_config.memory_in_mb #=> Integer
|
996
1021
|
# resp.canaries[0].run_config.active_tracing #=> Boolean
|
@@ -1022,6 +1047,8 @@ module Aws::Synthetics
|
|
1022
1047
|
# resp.canaries[0].tags["TagKey"] #=> String
|
1023
1048
|
# resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
1024
1049
|
# resp.canaries[0].artifact_config.s3_encryption.kms_key_arn #=> String
|
1050
|
+
# resp.canaries[0].dry_run_config.dry_run_id #=> String
|
1051
|
+
# resp.canaries[0].dry_run_config.last_dry_run_execution_status #=> String
|
1025
1052
|
# resp.next_token #=> String
|
1026
1053
|
#
|
1027
1054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries AWS API Documentation
|
@@ -1100,13 +1127,17 @@ module Aws::Synthetics
|
|
1100
1127
|
# resp.canaries_last_run #=> Array
|
1101
1128
|
# resp.canaries_last_run[0].canary_name #=> String
|
1102
1129
|
# resp.canaries_last_run[0].last_run.id #=> String
|
1130
|
+
# resp.canaries_last_run[0].last_run.scheduled_run_id #=> String
|
1131
|
+
# resp.canaries_last_run[0].last_run.retry_attempt #=> Integer
|
1103
1132
|
# resp.canaries_last_run[0].last_run.name #=> String
|
1104
1133
|
# resp.canaries_last_run[0].last_run.status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
|
1105
1134
|
# resp.canaries_last_run[0].last_run.status.state_reason #=> String
|
1106
1135
|
# resp.canaries_last_run[0].last_run.status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
|
1107
1136
|
# resp.canaries_last_run[0].last_run.timeline.started #=> Time
|
1108
1137
|
# resp.canaries_last_run[0].last_run.timeline.completed #=> Time
|
1138
|
+
# resp.canaries_last_run[0].last_run.timeline.metric_timestamp_for_run_and_retries #=> Time
|
1109
1139
|
# resp.canaries_last_run[0].last_run.artifact_s3_location #=> String
|
1140
|
+
# resp.canaries_last_run[0].last_run.dry_run_config.dry_run_id #=> String
|
1110
1141
|
# resp.next_token #=> String
|
1111
1142
|
#
|
1112
1143
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun AWS API Documentation
|
@@ -1207,6 +1238,10 @@ module Aws::Synthetics
|
|
1207
1238
|
# @option params [required, String] :name
|
1208
1239
|
# The name of the canary that you want details for.
|
1209
1240
|
#
|
1241
|
+
# @option params [String] :dry_run_id
|
1242
|
+
# The DryRunId associated with an existing canary’s dry run. You can use
|
1243
|
+
# this DryRunId to retrieve information about the dry run.
|
1244
|
+
#
|
1210
1245
|
# @return [Types::GetCanaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1211
1246
|
#
|
1212
1247
|
# * {Types::GetCanaryResponse#canary #canary} => Types::Canary
|
@@ -1215,6 +1250,7 @@ module Aws::Synthetics
|
|
1215
1250
|
#
|
1216
1251
|
# resp = client.get_canary({
|
1217
1252
|
# name: "CanaryName", # required
|
1253
|
+
# dry_run_id: "UUID",
|
1218
1254
|
# })
|
1219
1255
|
#
|
1220
1256
|
# @example Response structure
|
@@ -1226,6 +1262,7 @@ module Aws::Synthetics
|
|
1226
1262
|
# resp.canary.execution_role_arn #=> String
|
1227
1263
|
# resp.canary.schedule.expression #=> String
|
1228
1264
|
# resp.canary.schedule.duration_in_seconds #=> Integer
|
1265
|
+
# resp.canary.schedule.retry_config.max_retries #=> Integer
|
1229
1266
|
# resp.canary.run_config.timeout_in_seconds #=> Integer
|
1230
1267
|
# resp.canary.run_config.memory_in_mb #=> Integer
|
1231
1268
|
# resp.canary.run_config.active_tracing #=> Boolean
|
@@ -1257,6 +1294,8 @@ module Aws::Synthetics
|
|
1257
1294
|
# resp.canary.tags["TagKey"] #=> String
|
1258
1295
|
# resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
|
1259
1296
|
# resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
|
1297
|
+
# resp.canary.dry_run_config.dry_run_id #=> String
|
1298
|
+
# resp.canary.dry_run_config.last_dry_run_execution_status #=> String
|
1260
1299
|
#
|
1261
1300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary AWS API Documentation
|
1262
1301
|
#
|
@@ -1277,11 +1316,34 @@ module Aws::Synthetics
|
|
1277
1316
|
# this token in a subsequent `GetCanaryRuns` operation to retrieve the
|
1278
1317
|
# next set of results.
|
1279
1318
|
#
|
1319
|
+
# <note markdown="1"> When auto retry is enabled for the canary, the first subsequent retry
|
1320
|
+
# is suffixed with *1 indicating its the first retry and the next
|
1321
|
+
# subsequent try is suffixed with *2.
|
1322
|
+
#
|
1323
|
+
# </note>
|
1324
|
+
#
|
1280
1325
|
# @option params [Integer] :max_results
|
1281
1326
|
# Specify this parameter to limit how many runs are returned each time
|
1282
1327
|
# you use the `GetCanaryRuns` operation. If you omit this parameter, the
|
1283
1328
|
# default of 100 is used.
|
1284
1329
|
#
|
1330
|
+
# @option params [String] :dry_run_id
|
1331
|
+
# The DryRunId associated with an existing canary’s dry run. You can use
|
1332
|
+
# this DryRunId to retrieve information about the dry run.
|
1333
|
+
#
|
1334
|
+
# @option params [String] :run_type
|
1335
|
+
# * When you provide `RunType=CANARY_RUN` and `dryRunId`, you will get
|
1336
|
+
# an exception
|
1337
|
+
#
|
1338
|
+
# * When a value is not provided for `RunType`, the default value is
|
1339
|
+
# `CANARY_RUN`
|
1340
|
+
#
|
1341
|
+
# * When `CANARY_RUN` is provided, all canary runs excluding dry runs
|
1342
|
+
# are returned
|
1343
|
+
#
|
1344
|
+
# * When `DRY_RUN` is provided, all dry runs excluding canary runs are
|
1345
|
+
# returned
|
1346
|
+
#
|
1285
1347
|
# @return [Types::GetCanaryRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1286
1348
|
#
|
1287
1349
|
# * {Types::GetCanaryRunsResponse#canary_runs #canary_runs} => Array<Types::CanaryRun>
|
@@ -1295,19 +1357,25 @@ module Aws::Synthetics
|
|
1295
1357
|
# name: "CanaryName", # required
|
1296
1358
|
# next_token: "Token",
|
1297
1359
|
# max_results: 1,
|
1360
|
+
# dry_run_id: "UUID",
|
1361
|
+
# run_type: "CANARY_RUN", # accepts CANARY_RUN, DRY_RUN
|
1298
1362
|
# })
|
1299
1363
|
#
|
1300
1364
|
# @example Response structure
|
1301
1365
|
#
|
1302
1366
|
# resp.canary_runs #=> Array
|
1303
1367
|
# resp.canary_runs[0].id #=> String
|
1368
|
+
# resp.canary_runs[0].scheduled_run_id #=> String
|
1369
|
+
# resp.canary_runs[0].retry_attempt #=> Integer
|
1304
1370
|
# resp.canary_runs[0].name #=> String
|
1305
1371
|
# resp.canary_runs[0].status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
|
1306
1372
|
# resp.canary_runs[0].status.state_reason #=> String
|
1307
1373
|
# resp.canary_runs[0].status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
|
1308
1374
|
# resp.canary_runs[0].timeline.started #=> Time
|
1309
1375
|
# resp.canary_runs[0].timeline.completed #=> Time
|
1376
|
+
# resp.canary_runs[0].timeline.metric_timestamp_for_run_and_retries #=> Time
|
1310
1377
|
# resp.canary_runs[0].artifact_s3_location #=> String
|
1378
|
+
# resp.canary_runs[0].dry_run_config.dry_run_id #=> String
|
1311
1379
|
# resp.next_token #=> String
|
1312
1380
|
#
|
1313
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns AWS API Documentation
|
@@ -1562,6 +1630,198 @@ module Aws::Synthetics
|
|
1562
1630
|
req.send_request(options)
|
1563
1631
|
end
|
1564
1632
|
|
1633
|
+
# Use this operation to start a dry run for a canary that has already
|
1634
|
+
# been created
|
1635
|
+
#
|
1636
|
+
# @option params [required, String] :name
|
1637
|
+
# The name of the canary that you want to dry run. To find canary names,
|
1638
|
+
# use [DescribeCanaries][1].
|
1639
|
+
#
|
1640
|
+
#
|
1641
|
+
#
|
1642
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
|
1643
|
+
#
|
1644
|
+
# @option params [Types::CanaryCodeInput] :code
|
1645
|
+
# Use this structure to input your script code for the canary. This
|
1646
|
+
# structure contains the Lambda handler with the location where the
|
1647
|
+
# canary should start running the script. If the script is stored in an
|
1648
|
+
# S3 bucket, the bucket name, key, and version are also included. If the
|
1649
|
+
# script was passed into the canary directly, the script code is
|
1650
|
+
# contained in the value of `Zipfile`.
|
1651
|
+
#
|
1652
|
+
# If you are uploading your canary scripts with an Amazon S3 bucket,
|
1653
|
+
# your zip file should include your script in a certain folder
|
1654
|
+
# structure.
|
1655
|
+
#
|
1656
|
+
# * For Node.js canaries, the folder structure must be
|
1657
|
+
# `nodejs/node_modules/myCanaryFilename.js ` For more information, see
|
1658
|
+
# [Packaging your Node.js canary files][1]
|
1659
|
+
#
|
1660
|
+
# * For Python canaries, the folder structure must be
|
1661
|
+
# `python/myCanaryFilename.py ` or
|
1662
|
+
# `python/myFolder/myCanaryFilename.py ` For more information, see
|
1663
|
+
# [Packaging your Python canary files][2]
|
1664
|
+
#
|
1665
|
+
#
|
1666
|
+
#
|
1667
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package
|
1668
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
|
1669
|
+
#
|
1670
|
+
# @option params [String] :runtime_version
|
1671
|
+
# Specifies the runtime version to use for the canary. For a list of
|
1672
|
+
# valid runtime versions and for more information about runtime
|
1673
|
+
# versions, see [ Canary Runtime Versions][1].
|
1674
|
+
#
|
1675
|
+
#
|
1676
|
+
#
|
1677
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
|
1678
|
+
#
|
1679
|
+
# @option params [Types::CanaryRunConfigInput] :run_config
|
1680
|
+
# A structure that contains input information for a canary run.
|
1681
|
+
#
|
1682
|
+
# @option params [Types::VpcConfigInput] :vpc_config
|
1683
|
+
# If this canary is to test an endpoint in a VPC, this structure
|
1684
|
+
# contains information about the subnets and security groups of the VPC
|
1685
|
+
# endpoint. For more information, see [ Running a Canary in a VPC][1].
|
1686
|
+
#
|
1687
|
+
#
|
1688
|
+
#
|
1689
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
|
1690
|
+
#
|
1691
|
+
# @option params [String] :execution_role_arn
|
1692
|
+
# The ARN of the IAM role to be used to run the canary. This role must
|
1693
|
+
# already exist, and must include `lambda.amazonaws.com` as a principal
|
1694
|
+
# in the trust policy. The role must also have the following
|
1695
|
+
# permissions:
|
1696
|
+
#
|
1697
|
+
# @option params [Integer] :success_retention_period_in_days
|
1698
|
+
# The number of days to retain data on the failed runs for this canary.
|
1699
|
+
# The valid range is 1 to 455 days.
|
1700
|
+
#
|
1701
|
+
# This setting affects the range of information returned by
|
1702
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
1703
|
+
# the Synthetics console.
|
1704
|
+
#
|
1705
|
+
#
|
1706
|
+
#
|
1707
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
1708
|
+
#
|
1709
|
+
# @option params [Integer] :failure_retention_period_in_days
|
1710
|
+
# The number of days to retain data on the failed runs for this canary.
|
1711
|
+
# The valid range is 1 to 455 days.
|
1712
|
+
#
|
1713
|
+
# This setting affects the range of information returned by
|
1714
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
1715
|
+
# the Synthetics console.
|
1716
|
+
#
|
1717
|
+
#
|
1718
|
+
#
|
1719
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
1720
|
+
#
|
1721
|
+
# @option params [Types::VisualReferenceInput] :visual_reference
|
1722
|
+
# An object that specifies what screenshots to use as a baseline for
|
1723
|
+
# visual monitoring by this canary. It can optionally also specify parts
|
1724
|
+
# of the screenshots to ignore during the visual monitoring comparison.
|
1725
|
+
#
|
1726
|
+
# Visual monitoring is supported only on canaries running the
|
1727
|
+
# **syn-puppeteer-node-3.2** runtime or later. For more information, see
|
1728
|
+
# [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
|
1729
|
+
#
|
1730
|
+
#
|
1731
|
+
#
|
1732
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
|
1733
|
+
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
|
1734
|
+
#
|
1735
|
+
# @option params [String] :artifact_s3_location
|
1736
|
+
# The location in Amazon S3 where Synthetics stores artifacts from the
|
1737
|
+
# test runs of this canary. Artifacts include the log file, screenshots,
|
1738
|
+
# and HAR files. The name of the Amazon S3 bucket can't include a
|
1739
|
+
# period (.).
|
1740
|
+
#
|
1741
|
+
# @option params [Types::ArtifactConfigInput] :artifact_config
|
1742
|
+
# A structure that contains the configuration for canary artifacts,
|
1743
|
+
# including the encryption-at-rest settings for artifacts that the
|
1744
|
+
# canary uploads to Amazon S3.
|
1745
|
+
#
|
1746
|
+
# @option params [String] :provisioned_resource_cleanup
|
1747
|
+
# Specifies whether to also delete the Lambda functions and layers used
|
1748
|
+
# by this canary when the canary is deleted. If the value of this
|
1749
|
+
# parameter is `AUTOMATIC`, it means that the Lambda functions and
|
1750
|
+
# layers will be deleted when the canary is deleted.
|
1751
|
+
#
|
1752
|
+
# If the value of this parameter is `OFF`, then the value of the
|
1753
|
+
# `DeleteLambda` parameter of the [DeleteCanary][1] operation determines
|
1754
|
+
# whether the Lambda functions and layers will be deleted.
|
1755
|
+
#
|
1756
|
+
#
|
1757
|
+
#
|
1758
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
1759
|
+
#
|
1760
|
+
# @return [Types::StartCanaryDryRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1761
|
+
#
|
1762
|
+
# * {Types::StartCanaryDryRunResponse#dry_run_config #dry_run_config} => Types::DryRunConfigOutput
|
1763
|
+
#
|
1764
|
+
# @example Request syntax with placeholder values
|
1765
|
+
#
|
1766
|
+
# resp = client.start_canary_dry_run({
|
1767
|
+
# name: "CanaryName", # required
|
1768
|
+
# code: {
|
1769
|
+
# s3_bucket: "String",
|
1770
|
+
# s3_key: "String",
|
1771
|
+
# s3_version: "String",
|
1772
|
+
# zip_file: "data",
|
1773
|
+
# handler: "CodeHandler", # required
|
1774
|
+
# },
|
1775
|
+
# runtime_version: "String",
|
1776
|
+
# run_config: {
|
1777
|
+
# timeout_in_seconds: 1,
|
1778
|
+
# memory_in_mb: 1,
|
1779
|
+
# active_tracing: false,
|
1780
|
+
# environment_variables: {
|
1781
|
+
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
1782
|
+
# },
|
1783
|
+
# },
|
1784
|
+
# vpc_config: {
|
1785
|
+
# subnet_ids: ["SubnetId"],
|
1786
|
+
# security_group_ids: ["SecurityGroupId"],
|
1787
|
+
# ipv_6_allowed_for_dual_stack: false,
|
1788
|
+
# },
|
1789
|
+
# execution_role_arn: "RoleArn",
|
1790
|
+
# success_retention_period_in_days: 1,
|
1791
|
+
# failure_retention_period_in_days: 1,
|
1792
|
+
# visual_reference: {
|
1793
|
+
# base_screenshots: [
|
1794
|
+
# {
|
1795
|
+
# screenshot_name: "String", # required
|
1796
|
+
# ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
|
1797
|
+
# },
|
1798
|
+
# ],
|
1799
|
+
# base_canary_run_id: "String", # required
|
1800
|
+
# },
|
1801
|
+
# artifact_s3_location: "String",
|
1802
|
+
# artifact_config: {
|
1803
|
+
# s3_encryption: {
|
1804
|
+
# encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
|
1805
|
+
# kms_key_arn: "KmsKeyArn",
|
1806
|
+
# },
|
1807
|
+
# },
|
1808
|
+
# provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
|
1809
|
+
# })
|
1810
|
+
#
|
1811
|
+
# @example Response structure
|
1812
|
+
#
|
1813
|
+
# resp.dry_run_config.dry_run_id #=> String
|
1814
|
+
# resp.dry_run_config.last_dry_run_execution_status #=> String
|
1815
|
+
#
|
1816
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRun AWS API Documentation
|
1817
|
+
#
|
1818
|
+
# @overload start_canary_dry_run(params = {})
|
1819
|
+
# @param [Hash] params ({})
|
1820
|
+
def start_canary_dry_run(params = {}, options = {})
|
1821
|
+
req = build_request(:start_canary_dry_run, params)
|
1822
|
+
req.send_request(options)
|
1823
|
+
end
|
1824
|
+
|
1565
1825
|
# Stops the canary to prevent all future runs. If the canary is
|
1566
1826
|
# currently running,the run that is in progress completes on its own,
|
1567
1827
|
# publishes metrics, and uploads artifacts, but it is not recorded in
|
@@ -1684,6 +1944,12 @@ module Aws::Synthetics
|
|
1684
1944
|
# canary. To change the tags of an existing canary, use
|
1685
1945
|
# [TagResource][1].
|
1686
1946
|
#
|
1947
|
+
# <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
|
1948
|
+
# other field you can provide is the `Schedule`. Adding any other field
|
1949
|
+
# will thrown an exception.
|
1950
|
+
#
|
1951
|
+
# </note>
|
1952
|
+
#
|
1687
1953
|
#
|
1688
1954
|
#
|
1689
1955
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html
|
@@ -1740,16 +2006,34 @@ module Aws::Synthetics
|
|
1740
2006
|
# A structure that contains the timeout value that is used for each
|
1741
2007
|
# individual run of the canary.
|
1742
2008
|
#
|
1743
|
-
#
|
1744
|
-
#
|
2009
|
+
# Environment variable keys and values are encrypted at rest using
|
2010
|
+
# Amazon Web Services owned KMS keys. However, the environment variables
|
2011
|
+
# are not encrypted on the client side. Do not store sensitive
|
2012
|
+
# information in them.
|
1745
2013
|
#
|
1746
2014
|
# @option params [Integer] :success_retention_period_in_days
|
1747
2015
|
# The number of days to retain data about successful runs of this
|
1748
2016
|
# canary.
|
1749
2017
|
#
|
2018
|
+
# This setting affects the range of information returned by
|
2019
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
2020
|
+
# the Synthetics console.
|
2021
|
+
#
|
2022
|
+
#
|
2023
|
+
#
|
2024
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
2025
|
+
#
|
1750
2026
|
# @option params [Integer] :failure_retention_period_in_days
|
1751
2027
|
# The number of days to retain data about failed runs of this canary.
|
1752
2028
|
#
|
2029
|
+
# This setting affects the range of information returned by
|
2030
|
+
# [GetCanaryRuns][1], as well as the range of information displayed in
|
2031
|
+
# the Synthetics console.
|
2032
|
+
#
|
2033
|
+
#
|
2034
|
+
#
|
2035
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
2036
|
+
#
|
1753
2037
|
# @option params [Types::VpcConfigInput] :vpc_config
|
1754
2038
|
# If this canary is to test an endpoint in a VPC, this structure
|
1755
2039
|
# contains information about the subnet and security groups of the VPC
|
@@ -1796,6 +2080,16 @@ module Aws::Synthetics
|
|
1796
2080
|
#
|
1797
2081
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
|
1798
2082
|
#
|
2083
|
+
# @option params [String] :dry_run_id
|
2084
|
+
# Update the existing canary using the updated configurations from the
|
2085
|
+
# DryRun associated with the DryRunId.
|
2086
|
+
#
|
2087
|
+
# <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
|
2088
|
+
# other field you can provide is the `Schedule`. Adding any other field
|
2089
|
+
# will thrown an exception.
|
2090
|
+
#
|
2091
|
+
# </note>
|
2092
|
+
#
|
1799
2093
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1800
2094
|
#
|
1801
2095
|
# @example Request syntax with placeholder values
|
@@ -1814,6 +2108,9 @@ module Aws::Synthetics
|
|
1814
2108
|
# schedule: {
|
1815
2109
|
# expression: "String", # required
|
1816
2110
|
# duration_in_seconds: 1,
|
2111
|
+
# retry_config: {
|
2112
|
+
# max_retries: 1, # required
|
2113
|
+
# },
|
1817
2114
|
# },
|
1818
2115
|
# run_config: {
|
1819
2116
|
# timeout_in_seconds: 1,
|
@@ -1847,6 +2144,7 @@ module Aws::Synthetics
|
|
1847
2144
|
# },
|
1848
2145
|
# },
|
1849
2146
|
# provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
|
2147
|
+
# dry_run_id: "UUID",
|
1850
2148
|
# })
|
1851
2149
|
#
|
1852
2150
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
|
@@ -1876,7 +2174,7 @@ module Aws::Synthetics
|
|
1876
2174
|
tracer: tracer
|
1877
2175
|
)
|
1878
2176
|
context[:gem_name] = 'aws-sdk-synthetics'
|
1879
|
-
context[:gem_version] = '1.
|
2177
|
+
context[:gem_version] = '1.64.0'
|
1880
2178
|
Seahorse::Client::Request.new(handlers, context)
|
1881
2179
|
end
|
1882
2180
|
|