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.
@@ -10,6 +10,19 @@
10
10
  module Aws::Synthetics
11
11
  module Types
12
12
 
13
+ # You don't have permission to perform this operation on this resource.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
13
26
  # A structure that contains the configuration for canary artifacts,
14
27
  # including the encryption-at-rest settings for artifacts that the
15
28
  # canary uploads to Amazon S3.
@@ -150,10 +163,26 @@ module Aws::Synthetics
150
163
  # @!attribute [rw] success_retention_period_in_days
151
164
  # The number of days to retain data about successful runs of this
152
165
  # canary.
166
+ #
167
+ # This setting affects the range of information returned by
168
+ # [GetCanaryRuns][1], as well as the range of information displayed in
169
+ # the Synthetics console.
170
+ #
171
+ #
172
+ #
173
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
153
174
  # @return [Integer]
154
175
  #
155
176
  # @!attribute [rw] failure_retention_period_in_days
156
177
  # The number of days to retain data about failed runs of this canary.
178
+ #
179
+ # This setting affects the range of information returned by
180
+ # [GetCanaryRuns][1], as well as the range of information displayed in
181
+ # the Synthetics console.
182
+ #
183
+ #
184
+ #
185
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
157
186
  # @return [Integer]
158
187
  #
159
188
  # @!attribute [rw] status
@@ -234,6 +263,10 @@ module Aws::Synthetics
234
263
  # canary uploads to Amazon S3.
235
264
  # @return [Types::ArtifactConfigOutput]
236
265
  #
266
+ # @!attribute [rw] dry_run_config
267
+ # Returns the dry run configurations for a canary.
268
+ # @return [Types::DryRunConfigOutput]
269
+ #
237
270
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/Canary AWS API Documentation
238
271
  #
239
272
  class Canary < Struct.new(
@@ -254,7 +287,8 @@ module Aws::Synthetics
254
287
  :visual_reference,
255
288
  :provisioned_resource_cleanup,
256
289
  :tags,
257
- :artifact_config)
290
+ :artifact_config,
291
+ :dry_run_config)
258
292
  SENSITIVE = []
259
293
  include Aws::Structure
260
294
  end
@@ -275,8 +309,9 @@ module Aws::Synthetics
275
309
  # [Packaging your Node.js canary files][1]
276
310
  #
277
311
  # * For Python canaries, the folder structure must be
278
- # `python/myCanaryFilename.p ` or `python/myFolder/myCanaryFilename.py
279
- # ` For more information, see [Packaging your Python canary files][2]
312
+ # `python/myCanaryFilename.py ` or
313
+ # `python/myFolder/myCanaryFilename.py ` For more information, see
314
+ # [Packaging your Python canary files][2]
280
315
  #
281
316
  #
282
317
  #
@@ -355,6 +390,21 @@ module Aws::Synthetics
355
390
  include Aws::Structure
356
391
  end
357
392
 
393
+ # Returns the dry run configurations set for a canary.
394
+ #
395
+ # @!attribute [rw] dry_run_id
396
+ # The DryRunId associated with an existing canary’s dry run. You can
397
+ # use this DryRunId to retrieve information about the dry run.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryDryRunConfigOutput AWS API Documentation
401
+ #
402
+ class CanaryDryRunConfigOutput < Struct.new(
403
+ :dry_run_id)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
358
408
  # This structure contains information about the most recent run of a
359
409
  # single canary.
360
410
  #
@@ -381,6 +431,14 @@ module Aws::Synthetics
381
431
  # A unique ID that identifies this canary run.
382
432
  # @return [String]
383
433
  #
434
+ # @!attribute [rw] scheduled_run_id
435
+ # The ID of the scheduled canary run.
436
+ # @return [String]
437
+ #
438
+ # @!attribute [rw] retry_attempt
439
+ # The count in number of the retry attempt.
440
+ # @return [Integer]
441
+ #
384
442
  # @!attribute [rw] name
385
443
  # The name of the canary.
386
444
  # @return [String]
@@ -398,14 +456,21 @@ module Aws::Synthetics
398
456
  # Artifacts include the log file, screenshots, and HAR files.
399
457
  # @return [String]
400
458
  #
459
+ # @!attribute [rw] dry_run_config
460
+ # Returns the dry run configurations for a canary.
461
+ # @return [Types::CanaryDryRunConfigOutput]
462
+ #
401
463
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRun AWS API Documentation
402
464
  #
403
465
  class CanaryRun < Struct.new(
404
466
  :id,
467
+ :scheduled_run_id,
468
+ :retry_attempt,
405
469
  :name,
406
470
  :status,
407
471
  :timeline,
408
- :artifact_s3_location)
472
+ :artifact_s3_location,
473
+ :dry_run_config)
409
474
  SENSITIVE = []
410
475
  include Aws::Structure
411
476
  end
@@ -454,8 +519,10 @@ module Aws::Synthetics
454
519
  # for your environment variables. For more information about reserved
455
520
  # keys, see [ Runtime environment variables][1].
456
521
  #
457
- # The environment variables keys and values are not encrypted. Do not
458
- # store sensitive information in this field.
522
+ # Environment variable keys and values are encrypted at rest using
523
+ # Amazon Web Services owned KMS keys. However, the environment
524
+ # variables are not encrypted on the client side. Do not store
525
+ # sensitive information in them.
459
526
  #
460
527
  #
461
528
  #
@@ -536,11 +603,17 @@ module Aws::Synthetics
536
603
  # The end time of the run.
537
604
  # @return [Time]
538
605
  #
606
+ # @!attribute [rw] metric_timestamp_for_run_and_retries
607
+ # The time at which the metrics will be generated for this run or
608
+ # retries.
609
+ # @return [Time]
610
+ #
539
611
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunTimeline AWS API Documentation
540
612
  #
541
613
  class CanaryRunTimeline < Struct.new(
542
614
  :started,
543
- :completed)
615
+ :completed,
616
+ :metric_timestamp_for_run_and_retries)
544
617
  SENSITIVE = []
545
618
  include Aws::Structure
546
619
  end
@@ -580,11 +653,16 @@ module Aws::Synthetics
580
653
  # this field, the default of 0 is used.
581
654
  # @return [Integer]
582
655
  #
656
+ # @!attribute [rw] retry_config
657
+ # A structure that contains the retry configuration for a canary
658
+ # @return [Types::RetryConfigInput]
659
+ #
583
660
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryScheduleInput AWS API Documentation
584
661
  #
585
662
  class CanaryScheduleInput < Struct.new(
586
663
  :expression,
587
- :duration_in_seconds)
664
+ :duration_in_seconds,
665
+ :retry_config)
588
666
  SENSITIVE = []
589
667
  include Aws::Structure
590
668
  end
@@ -622,11 +700,16 @@ module Aws::Synthetics
622
700
  # schedule in the `Expression` value.
623
701
  # @return [Integer]
624
702
  #
703
+ # @!attribute [rw] retry_config
704
+ # A structure that contains the retry configuration for a canary
705
+ # @return [Types::RetryConfigOutput]
706
+ #
625
707
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryScheduleOutput AWS API Documentation
626
708
  #
627
709
  class CanaryScheduleOutput < Struct.new(
628
710
  :expression,
629
- :duration_in_seconds)
711
+ :duration_in_seconds,
712
+ :retry_config)
630
713
  SENSITIVE = []
631
714
  include Aws::Structure
632
715
  end
@@ -638,13 +721,13 @@ module Aws::Synthetics
638
721
  # @return [String]
639
722
  #
640
723
  # @!attribute [rw] state_reason
641
- # If the canary has insufficient permissions to run, this field
642
- # provides more details.
724
+ # If the canary creation or update failed, this field provides details
725
+ # on the failure.
643
726
  # @return [String]
644
727
  #
645
728
  # @!attribute [rw] state_reason_code
646
- # If the canary cannot run or has failed, this field displays the
647
- # reason.
729
+ # If the canary creation or update failed, this field displays the
730
+ # reason code.
648
731
  # @return [String]
649
732
  #
650
733
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryStatus AWS API Documentation
@@ -758,20 +841,38 @@ module Aws::Synthetics
758
841
  # A structure that contains the configuration for individual canary
759
842
  # runs, such as timeout value and environment variables.
760
843
  #
761
- # The environment variables keys and values are not encrypted. Do not
762
- # store sensitive information in this field.
844
+ # Environment variable keys and values are encrypted at rest using
845
+ # Amazon Web Services owned KMS keys. However, the environment
846
+ # variables are not encrypted on the client side. Do not store
847
+ # sensitive information in them.
763
848
  # @return [Types::CanaryRunConfigInput]
764
849
  #
765
850
  # @!attribute [rw] success_retention_period_in_days
766
851
  # The number of days to retain data about successful runs of this
767
852
  # canary. If you omit this field, the default of 31 days is used. The
768
853
  # valid range is 1 to 455 days.
854
+ #
855
+ # This setting affects the range of information returned by
856
+ # [GetCanaryRuns][1], as well as the range of information displayed in
857
+ # the Synthetics console.
858
+ #
859
+ #
860
+ #
861
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
769
862
  # @return [Integer]
770
863
  #
771
864
  # @!attribute [rw] failure_retention_period_in_days
772
865
  # The number of days to retain data about failed runs of this canary.
773
866
  # If you omit this field, the default of 31 days is used. The valid
774
867
  # range is 1 to 455 days.
868
+ #
869
+ # This setting affects the range of information returned by
870
+ # [GetCanaryRuns][1], as well as the range of information displayed in
871
+ # the Synthetics console.
872
+ #
873
+ #
874
+ #
875
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
775
876
  # @return [Integer]
776
877
  #
777
878
  # @!attribute [rw] runtime_version
@@ -1148,14 +1249,40 @@ module Aws::Synthetics
1148
1249
  #
1149
1250
  class DisassociateResourceResponse < Aws::EmptyStructure; end
1150
1251
 
1252
+ # Returns the dry run configurations set for a canary.
1253
+ #
1254
+ # @!attribute [rw] dry_run_id
1255
+ # The DryRunId associated with an existing canary’s dry run. You can
1256
+ # use this DryRunId to retrieve information about the dry run.
1257
+ # @return [String]
1258
+ #
1259
+ # @!attribute [rw] last_dry_run_execution_status
1260
+ # Returns the last execution status for a canary's dry run.
1261
+ # @return [String]
1262
+ #
1263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DryRunConfigOutput AWS API Documentation
1264
+ #
1265
+ class DryRunConfigOutput < Struct.new(
1266
+ :dry_run_id,
1267
+ :last_dry_run_execution_status)
1268
+ SENSITIVE = []
1269
+ include Aws::Structure
1270
+ end
1271
+
1151
1272
  # @!attribute [rw] name
1152
1273
  # The name of the canary that you want details for.
1153
1274
  # @return [String]
1154
1275
  #
1276
+ # @!attribute [rw] dry_run_id
1277
+ # The DryRunId associated with an existing canary’s dry run. You can
1278
+ # use this DryRunId to retrieve information about the dry run.
1279
+ # @return [String]
1280
+ #
1155
1281
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRequest AWS API Documentation
1156
1282
  #
1157
1283
  class GetCanaryRequest < Struct.new(
1158
- :name)
1284
+ :name,
1285
+ :dry_run_id)
1159
1286
  SENSITIVE = []
1160
1287
  include Aws::Structure
1161
1288
  end
@@ -1180,6 +1307,12 @@ module Aws::Synthetics
1180
1307
  # A token that indicates that there is more data available. You can
1181
1308
  # use this token in a subsequent `GetCanaryRuns` operation to retrieve
1182
1309
  # the next set of results.
1310
+ #
1311
+ # <note markdown="1"> When auto retry is enabled for the canary, the first subsequent
1312
+ # retry is suffixed with *1 indicating its the first retry and the
1313
+ # next subsequent try is suffixed with *2.
1314
+ #
1315
+ # </note>
1183
1316
  # @return [String]
1184
1317
  #
1185
1318
  # @!attribute [rw] max_results
@@ -1188,12 +1321,33 @@ module Aws::Synthetics
1188
1321
  # the default of 100 is used.
1189
1322
  # @return [Integer]
1190
1323
  #
1324
+ # @!attribute [rw] dry_run_id
1325
+ # The DryRunId associated with an existing canary’s dry run. You can
1326
+ # use this DryRunId to retrieve information about the dry run.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] run_type
1330
+ # * When you provide `RunType=CANARY_RUN` and `dryRunId`, you will get
1331
+ # an exception
1332
+ #
1333
+ # * When a value is not provided for `RunType`, the default value is
1334
+ # `CANARY_RUN`
1335
+ #
1336
+ # * When `CANARY_RUN` is provided, all canary runs excluding dry runs
1337
+ # are returned
1338
+ #
1339
+ # * When `DRY_RUN` is provided, all dry runs excluding canary runs are
1340
+ # returned
1341
+ # @return [String]
1342
+ #
1191
1343
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRunsRequest AWS API Documentation
1192
1344
  #
1193
1345
  class GetCanaryRunsRequest < Struct.new(
1194
1346
  :name,
1195
1347
  :next_token,
1196
- :max_results)
1348
+ :max_results,
1349
+ :dry_run_id,
1350
+ :run_type)
1197
1351
  SENSITIVE = []
1198
1352
  include Aws::Structure
1199
1353
  end
@@ -1536,6 +1690,56 @@ module Aws::Synthetics
1536
1690
  include Aws::Structure
1537
1691
  end
1538
1692
 
1693
+ # This structure contains information about the canary's retry
1694
+ # configuration.
1695
+ #
1696
+ # <note markdown="1"> The default account level concurrent execution limit from Lambda is
1697
+ # 1000. When you have more than 1000 canaries, it's possible there are
1698
+ # more than 1000 Lambda invocations due to retries and the console might
1699
+ # hang. For more information on the Lambda execution limit, see
1700
+ # [Understanding Lambda function scaling][1].
1701
+ #
1702
+ # </note>
1703
+ #
1704
+ # <note markdown="1"> For canary with `MaxRetries = 2`, you need to set the
1705
+ # `CanaryRunConfigInput.TimeoutInSeconds` to less than 600 seconds to
1706
+ # avoid validation errors.
1707
+ #
1708
+ # </note>
1709
+ #
1710
+ #
1711
+ #
1712
+ # [1]: https://docs.aws.amazon.com/lambda/latest/dg/lambda-concurrency.html#:~:text=As%20your%20functions%20receive%20more,functions%20in%20an%20AWS%20Region
1713
+ #
1714
+ # @!attribute [rw] max_retries
1715
+ # The maximum number of retries. The value must be less than or equal
1716
+ # to 2.
1717
+ # @return [Integer]
1718
+ #
1719
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/RetryConfigInput AWS API Documentation
1720
+ #
1721
+ class RetryConfigInput < Struct.new(
1722
+ :max_retries)
1723
+ SENSITIVE = []
1724
+ include Aws::Structure
1725
+ end
1726
+
1727
+ # This structure contains information about the canary's retry
1728
+ # configuration.
1729
+ #
1730
+ # @!attribute [rw] max_retries
1731
+ # The maximum number of retries. The value must be less than or equal
1732
+ # to 2.
1733
+ # @return [Integer]
1734
+ #
1735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/RetryConfigOutput AWS API Documentation
1736
+ #
1737
+ class RetryConfigOutput < Struct.new(
1738
+ :max_retries)
1739
+ SENSITIVE = []
1740
+ include Aws::Structure
1741
+ end
1742
+
1539
1743
  # This structure contains information about one canary runtime version.
1540
1744
  # For more information about runtime versions, see [ Canary Runtime
1541
1745
  # Versions][1].
@@ -1623,6 +1827,175 @@ module Aws::Synthetics
1623
1827
  include Aws::Structure
1624
1828
  end
1625
1829
 
1830
+ # @!attribute [rw] name
1831
+ # The name of the canary that you want to dry run. To find canary
1832
+ # names, use [DescribeCanaries][1].
1833
+ #
1834
+ #
1835
+ #
1836
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
1837
+ # @return [String]
1838
+ #
1839
+ # @!attribute [rw] code
1840
+ # Use this structure to input your script code for the canary. This
1841
+ # structure contains the Lambda handler with the location where the
1842
+ # canary should start running the script. If the script is stored in
1843
+ # an S3 bucket, the bucket name, key, and version are also included.
1844
+ # If the script was passed into the canary directly, the script code
1845
+ # is contained in the value of `Zipfile`.
1846
+ #
1847
+ # If you are uploading your canary scripts with an Amazon S3 bucket,
1848
+ # your zip file should include your script in a certain folder
1849
+ # structure.
1850
+ #
1851
+ # * For Node.js canaries, the folder structure must be
1852
+ # `nodejs/node_modules/myCanaryFilename.js ` For more information,
1853
+ # see [Packaging your Node.js canary files][1]
1854
+ #
1855
+ # * For Python canaries, the folder structure must be
1856
+ # `python/myCanaryFilename.py ` or
1857
+ # `python/myFolder/myCanaryFilename.py ` For more information, see
1858
+ # [Packaging your Python canary files][2]
1859
+ #
1860
+ #
1861
+ #
1862
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package
1863
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
1864
+ # @return [Types::CanaryCodeInput]
1865
+ #
1866
+ # @!attribute [rw] runtime_version
1867
+ # Specifies the runtime version to use for the canary. For a list of
1868
+ # valid runtime versions and for more information about runtime
1869
+ # versions, see [ Canary Runtime Versions][1].
1870
+ #
1871
+ #
1872
+ #
1873
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] run_config
1877
+ # A structure that contains input information for a canary run.
1878
+ # @return [Types::CanaryRunConfigInput]
1879
+ #
1880
+ # @!attribute [rw] vpc_config
1881
+ # If this canary is to test an endpoint in a VPC, this structure
1882
+ # contains information about the subnets and security groups of the
1883
+ # VPC endpoint. For more information, see [ Running a Canary in a
1884
+ # VPC][1].
1885
+ #
1886
+ #
1887
+ #
1888
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
1889
+ # @return [Types::VpcConfigInput]
1890
+ #
1891
+ # @!attribute [rw] execution_role_arn
1892
+ # The ARN of the IAM role to be used to run the canary. This role must
1893
+ # already exist, and must include `lambda.amazonaws.com` as a
1894
+ # principal in the trust policy. The role must also have the following
1895
+ # permissions:
1896
+ # @return [String]
1897
+ #
1898
+ # @!attribute [rw] success_retention_period_in_days
1899
+ # The number of days to retain data on the failed runs for this
1900
+ # canary. The valid range is 1 to 455 days.
1901
+ #
1902
+ # This setting affects the range of information returned by
1903
+ # [GetCanaryRuns][1], as well as the range of information displayed in
1904
+ # the Synthetics console.
1905
+ #
1906
+ #
1907
+ #
1908
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
1909
+ # @return [Integer]
1910
+ #
1911
+ # @!attribute [rw] failure_retention_period_in_days
1912
+ # The number of days to retain data on the failed runs for this
1913
+ # canary. The valid range is 1 to 455 days.
1914
+ #
1915
+ # This setting affects the range of information returned by
1916
+ # [GetCanaryRuns][1], as well as the range of information displayed in
1917
+ # the Synthetics console.
1918
+ #
1919
+ #
1920
+ #
1921
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
1922
+ # @return [Integer]
1923
+ #
1924
+ # @!attribute [rw] visual_reference
1925
+ # An object that specifies what screenshots to use as a baseline for
1926
+ # visual monitoring by this canary. It can optionally also specify
1927
+ # parts of the screenshots to ignore during the visual monitoring
1928
+ # comparison.
1929
+ #
1930
+ # Visual monitoring is supported only on canaries running the
1931
+ # **syn-puppeteer-node-3.2** runtime or later. For more information,
1932
+ # see [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
1933
+ #
1934
+ #
1935
+ #
1936
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
1937
+ # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
1938
+ # @return [Types::VisualReferenceInput]
1939
+ #
1940
+ # @!attribute [rw] artifact_s3_location
1941
+ # The location in Amazon S3 where Synthetics stores artifacts from the
1942
+ # test runs of this canary. Artifacts include the log file,
1943
+ # screenshots, and HAR files. The name of the Amazon S3 bucket can't
1944
+ # include a period (.).
1945
+ # @return [String]
1946
+ #
1947
+ # @!attribute [rw] artifact_config
1948
+ # A structure that contains the configuration for canary artifacts,
1949
+ # including the encryption-at-rest settings for artifacts that the
1950
+ # canary uploads to Amazon S3.
1951
+ # @return [Types::ArtifactConfigInput]
1952
+ #
1953
+ # @!attribute [rw] provisioned_resource_cleanup
1954
+ # Specifies whether to also delete the Lambda functions and layers
1955
+ # used by this canary when the canary is deleted. If the value of this
1956
+ # parameter is `AUTOMATIC`, it means that the Lambda functions and
1957
+ # layers will be deleted when the canary is deleted.
1958
+ #
1959
+ # If the value of this parameter is `OFF`, then the value of the
1960
+ # `DeleteLambda` parameter of the [DeleteCanary][1] operation
1961
+ # determines whether the Lambda functions and layers will be deleted.
1962
+ #
1963
+ #
1964
+ #
1965
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
1966
+ # @return [String]
1967
+ #
1968
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRunRequest AWS API Documentation
1969
+ #
1970
+ class StartCanaryDryRunRequest < Struct.new(
1971
+ :name,
1972
+ :code,
1973
+ :runtime_version,
1974
+ :run_config,
1975
+ :vpc_config,
1976
+ :execution_role_arn,
1977
+ :success_retention_period_in_days,
1978
+ :failure_retention_period_in_days,
1979
+ :visual_reference,
1980
+ :artifact_s3_location,
1981
+ :artifact_config,
1982
+ :provisioned_resource_cleanup)
1983
+ SENSITIVE = []
1984
+ include Aws::Structure
1985
+ end
1986
+
1987
+ # @!attribute [rw] dry_run_config
1988
+ # Returns the dry run configurations for a canary.
1989
+ # @return [Types::DryRunConfigOutput]
1990
+ #
1991
+ # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRunResponse AWS API Documentation
1992
+ #
1993
+ class StartCanaryDryRunResponse < Struct.new(
1994
+ :dry_run_config)
1995
+ SENSITIVE = []
1996
+ include Aws::Structure
1997
+ end
1998
+
1626
1999
  # @!attribute [rw] name
1627
2000
  # The name of the canary that you want to run. To find canary names,
1628
2001
  # use [DescribeCanaries][1].
@@ -1790,17 +2163,35 @@ module Aws::Synthetics
1790
2163
  # A structure that contains the timeout value that is used for each
1791
2164
  # individual run of the canary.
1792
2165
  #
1793
- # The environment variables keys and values are not encrypted. Do not
1794
- # store sensitive information in this field.
2166
+ # Environment variable keys and values are encrypted at rest using
2167
+ # Amazon Web Services owned KMS keys. However, the environment
2168
+ # variables are not encrypted on the client side. Do not store
2169
+ # sensitive information in them.
1795
2170
  # @return [Types::CanaryRunConfigInput]
1796
2171
  #
1797
2172
  # @!attribute [rw] success_retention_period_in_days
1798
2173
  # The number of days to retain data about successful runs of this
1799
2174
  # canary.
2175
+ #
2176
+ # This setting affects the range of information returned by
2177
+ # [GetCanaryRuns][1], as well as the range of information displayed in
2178
+ # the Synthetics console.
2179
+ #
2180
+ #
2181
+ #
2182
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
1800
2183
  # @return [Integer]
1801
2184
  #
1802
2185
  # @!attribute [rw] failure_retention_period_in_days
1803
2186
  # The number of days to retain data about failed runs of this canary.
2187
+ #
2188
+ # This setting affects the range of information returned by
2189
+ # [GetCanaryRuns][1], as well as the range of information displayed in
2190
+ # the Synthetics console.
2191
+ #
2192
+ #
2193
+ #
2194
+ # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
1804
2195
  # @return [Integer]
1805
2196
  #
1806
2197
  # @!attribute [rw] vpc_config
@@ -1855,6 +2246,17 @@ module Aws::Synthetics
1855
2246
  # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
1856
2247
  # @return [String]
1857
2248
  #
2249
+ # @!attribute [rw] dry_run_id
2250
+ # Update the existing canary using the updated configurations from the
2251
+ # DryRun associated with the DryRunId.
2252
+ #
2253
+ # <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
2254
+ # other field you can provide is the `Schedule`. Adding any other
2255
+ # field will thrown an exception.
2256
+ #
2257
+ # </note>
2258
+ # @return [String]
2259
+ #
1858
2260
  # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
1859
2261
  #
1860
2262
  class UpdateCanaryRequest < Struct.new(
@@ -1870,7 +2272,8 @@ module Aws::Synthetics
1870
2272
  :visual_reference,
1871
2273
  :artifact_s3_location,
1872
2274
  :artifact_config,
1873
- :provisioned_resource_cleanup)
2275
+ :provisioned_resource_cleanup,
2276
+ :dry_run_id)
1874
2277
  SENSITIVE = []
1875
2278
  include Aws::Structure
1876
2279
  end
@@ -54,7 +54,7 @@ module Aws::Synthetics
54
54
  autoload :EndpointProvider, 'aws-sdk-synthetics/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-synthetics/endpoints'
56
56
 
57
- GEM_VERSION = '1.62.0'
57
+ GEM_VERSION = '1.64.0'
58
58
 
59
59
  end
60
60