aws-sdk-synthetics 1.64.0 → 1.66.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 +29 -18
- data/lib/aws-sdk-synthetics/client_api.rb +5 -0
- data/lib/aws-sdk-synthetics/types.rb +85 -36
- data/lib/aws-sdk-synthetics.rb +1 -1
- data/sig/client.rbs +6 -3
- data/sig/types.rbs +3 -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: 87e988cafbcceb38ec2ac4adc405ebb280ce6c7368b052d8359007b6a53a6cea
|
4
|
+
data.tar.gz: c424418e45cb6432f8e1d566f4755d5eef0d347f03ba2de06dcf534f29729b28
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d0c0bc8824bc3438d415d18fc79171c3fcc2950274c5dd3b6f8269f7a4faa92b890cd0b2b0aa7aa306b21ca12c6b7ebbb99418c7c4e62008ebdeb172b7de7e88
|
7
|
+
data.tar.gz: c1c509f44c51e019baa10629228d72df8b0fefc478e147ae377b5b66ed11219c9f186c1bcdaff923a67e9681781a0086551d3748a993484452f1fec38c62792a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.66.0 (2025-05-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Add support to change ephemeral storage. Add a new field "TestResult" under CanaryRunStatus.
|
8
|
+
|
9
|
+
1.65.0 (2025-05-12)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.64.0 (2025-05-09)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.66.0
|
@@ -200,8 +200,7 @@ module Aws::Synthetics
|
|
200
200
|
# accepted modes and the configuration defaults that are included.
|
201
201
|
#
|
202
202
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
203
|
-
#
|
204
|
-
# to default service endpoint when available.
|
203
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
205
204
|
#
|
206
205
|
# @option options [Boolean] :disable_request_compression (false)
|
207
206
|
# When set to 'true' the request body will not be compressed
|
@@ -544,13 +543,14 @@ module Aws::Synthetics
|
|
544
543
|
#
|
545
544
|
# @option params [required, Types::CanaryCodeInput] :code
|
546
545
|
# A structure that includes the entry point from which the canary should
|
547
|
-
# start running your script. If the script is stored in an S3
|
548
|
-
# the bucket name, key, and version are also included.
|
546
|
+
# start running your script. If the script is stored in an Amazon S3
|
547
|
+
# bucket, the bucket name, key, and version are also included.
|
549
548
|
#
|
550
549
|
# @option params [required, String] :artifact_s3_location
|
551
550
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
552
551
|
# test runs of this canary. Artifacts include the log file, screenshots,
|
553
|
-
# and HAR files. The name of the S3 bucket can't include a
|
552
|
+
# and HAR files. The name of the Amazon S3 bucket can't include a
|
553
|
+
# period (.).
|
554
554
|
#
|
555
555
|
# @option params [required, String] :execution_role_arn
|
556
556
|
# The ARN of the IAM role to be used to run the canary. This role must
|
@@ -699,6 +699,7 @@ module Aws::Synthetics
|
|
699
699
|
# environment_variables: {
|
700
700
|
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
701
701
|
# },
|
702
|
+
# ephemeral_storage: 1,
|
702
703
|
# },
|
703
704
|
# success_retention_period_in_days: 1,
|
704
705
|
# failure_retention_period_in_days: 1,
|
@@ -734,6 +735,7 @@ module Aws::Synthetics
|
|
734
735
|
# resp.canary.run_config.timeout_in_seconds #=> Integer
|
735
736
|
# resp.canary.run_config.memory_in_mb #=> Integer
|
736
737
|
# resp.canary.run_config.active_tracing #=> Boolean
|
738
|
+
# resp.canary.run_config.ephemeral_storage #=> Integer
|
737
739
|
# resp.canary.success_retention_period_in_days #=> Integer
|
738
740
|
# resp.canary.failure_retention_period_in_days #=> Integer
|
739
741
|
# resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
|
@@ -1019,6 +1021,7 @@ module Aws::Synthetics
|
|
1019
1021
|
# resp.canaries[0].run_config.timeout_in_seconds #=> Integer
|
1020
1022
|
# resp.canaries[0].run_config.memory_in_mb #=> Integer
|
1021
1023
|
# resp.canaries[0].run_config.active_tracing #=> Boolean
|
1024
|
+
# resp.canaries[0].run_config.ephemeral_storage #=> Integer
|
1022
1025
|
# resp.canaries[0].success_retention_period_in_days #=> Integer
|
1023
1026
|
# resp.canaries[0].failure_retention_period_in_days #=> Integer
|
1024
1027
|
# resp.canaries[0].status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
|
@@ -1133,6 +1136,7 @@ module Aws::Synthetics
|
|
1133
1136
|
# resp.canaries_last_run[0].last_run.status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
|
1134
1137
|
# resp.canaries_last_run[0].last_run.status.state_reason #=> String
|
1135
1138
|
# resp.canaries_last_run[0].last_run.status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
|
1139
|
+
# resp.canaries_last_run[0].last_run.status.test_result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
1136
1140
|
# resp.canaries_last_run[0].last_run.timeline.started #=> Time
|
1137
1141
|
# resp.canaries_last_run[0].last_run.timeline.completed #=> Time
|
1138
1142
|
# resp.canaries_last_run[0].last_run.timeline.metric_timestamp_for_run_and_retries #=> Time
|
@@ -1266,6 +1270,7 @@ module Aws::Synthetics
|
|
1266
1270
|
# resp.canary.run_config.timeout_in_seconds #=> Integer
|
1267
1271
|
# resp.canary.run_config.memory_in_mb #=> Integer
|
1268
1272
|
# resp.canary.run_config.active_tracing #=> Boolean
|
1273
|
+
# resp.canary.run_config.ephemeral_storage #=> Integer
|
1269
1274
|
# resp.canary.success_retention_period_in_days #=> Integer
|
1270
1275
|
# resp.canary.failure_retention_period_in_days #=> Integer
|
1271
1276
|
# resp.canary.status.state #=> String, one of "CREATING", "READY", "STARTING", "RUNNING", "UPDATING", "STOPPING", "STOPPED", "ERROR", "DELETING"
|
@@ -1371,6 +1376,7 @@ module Aws::Synthetics
|
|
1371
1376
|
# resp.canary_runs[0].status.state #=> String, one of "RUNNING", "PASSED", "FAILED"
|
1372
1377
|
# resp.canary_runs[0].status.state_reason #=> String
|
1373
1378
|
# resp.canary_runs[0].status.state_reason_code #=> String, one of "CANARY_FAILURE", "EXECUTION_FAILURE"
|
1379
|
+
# resp.canary_runs[0].status.test_result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
|
1374
1380
|
# resp.canary_runs[0].timeline.started #=> Time
|
1375
1381
|
# resp.canary_runs[0].timeline.completed #=> Time
|
1376
1382
|
# resp.canary_runs[0].timeline.metric_timestamp_for_run_and_retries #=> Time
|
@@ -1645,8 +1651,8 @@ module Aws::Synthetics
|
|
1645
1651
|
# Use this structure to input your script code for the canary. This
|
1646
1652
|
# structure contains the Lambda handler with the location where the
|
1647
1653
|
# 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.
|
1649
|
-
# script was passed into the canary directly, the script code is
|
1654
|
+
# Amazon S3 bucket, the bucket name, key, and version are also included.
|
1655
|
+
# If the script was passed into the canary directly, the script code is
|
1650
1656
|
# contained in the value of `Zipfile`.
|
1651
1657
|
#
|
1652
1658
|
# If you are uploading your canary scripts with an Amazon S3 bucket,
|
@@ -1695,8 +1701,9 @@ module Aws::Synthetics
|
|
1695
1701
|
# permissions:
|
1696
1702
|
#
|
1697
1703
|
# @option params [Integer] :success_retention_period_in_days
|
1698
|
-
# The number of days to retain data
|
1699
|
-
#
|
1704
|
+
# The number of days to retain data about successful runs of this
|
1705
|
+
# canary. If you omit this field, the default of 31 days is used. The
|
1706
|
+
# valid range is 1 to 455 days.
|
1700
1707
|
#
|
1701
1708
|
# This setting affects the range of information returned by
|
1702
1709
|
# [GetCanaryRuns][1], as well as the range of information displayed in
|
@@ -1707,8 +1714,9 @@ module Aws::Synthetics
|
|
1707
1714
|
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
|
1708
1715
|
#
|
1709
1716
|
# @option params [Integer] :failure_retention_period_in_days
|
1710
|
-
# The number of days to retain data
|
1711
|
-
#
|
1717
|
+
# The number of days to retain data about failed runs of this canary. If
|
1718
|
+
# you omit this field, the default of 31 days is used. The valid range
|
1719
|
+
# is 1 to 455 days.
|
1712
1720
|
#
|
1713
1721
|
# This setting affects the range of information returned by
|
1714
1722
|
# [GetCanaryRuns][1], as well as the range of information displayed in
|
@@ -1745,9 +1753,9 @@ module Aws::Synthetics
|
|
1745
1753
|
#
|
1746
1754
|
# @option params [String] :provisioned_resource_cleanup
|
1747
1755
|
# Specifies whether to also delete the Lambda functions and layers used
|
1748
|
-
# by this canary when the canary is deleted. If
|
1749
|
-
#
|
1750
|
-
# layers will be deleted when the canary is deleted.
|
1756
|
+
# by this canary when the canary is deleted. If you omit this parameter,
|
1757
|
+
# the default of `AUTOMATIC` is used, which means that the Lambda
|
1758
|
+
# functions and layers will be deleted when the canary is deleted.
|
1751
1759
|
#
|
1752
1760
|
# If the value of this parameter is `OFF`, then the value of the
|
1753
1761
|
# `DeleteLambda` parameter of the [DeleteCanary][1] operation determines
|
@@ -1780,6 +1788,7 @@ module Aws::Synthetics
|
|
1780
1788
|
# environment_variables: {
|
1781
1789
|
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
1782
1790
|
# },
|
1791
|
+
# ephemeral_storage: 1,
|
1783
1792
|
# },
|
1784
1793
|
# vpc_config: {
|
1785
1794
|
# subnet_ids: ["SubnetId"],
|
@@ -1966,8 +1975,8 @@ module Aws::Synthetics
|
|
1966
1975
|
#
|
1967
1976
|
# @option params [Types::CanaryCodeInput] :code
|
1968
1977
|
# A structure that includes the entry point from which the canary should
|
1969
|
-
# start running your script. If the script is stored in an S3
|
1970
|
-
# the bucket name, key, and version are also included.
|
1978
|
+
# start running your script. If the script is stored in an Amazon S3
|
1979
|
+
# bucket, the bucket name, key, and version are also included.
|
1971
1980
|
#
|
1972
1981
|
# @option params [String] :execution_role_arn
|
1973
1982
|
# The ARN of the IAM role to be used to run the canary. This role must
|
@@ -2061,7 +2070,8 @@ module Aws::Synthetics
|
|
2061
2070
|
# @option params [String] :artifact_s3_location
|
2062
2071
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
2063
2072
|
# test runs of this canary. Artifacts include the log file, screenshots,
|
2064
|
-
# and HAR files. The name of the S3 bucket can't include a
|
2073
|
+
# and HAR files. The name of the Amazon S3 bucket can't include a
|
2074
|
+
# period (.).
|
2065
2075
|
#
|
2066
2076
|
# @option params [Types::ArtifactConfigInput] :artifact_config
|
2067
2077
|
# A structure that contains the configuration for canary artifacts,
|
@@ -2119,6 +2129,7 @@ module Aws::Synthetics
|
|
2119
2129
|
# environment_variables: {
|
2120
2130
|
# "EnvironmentVariableName" => "EnvironmentVariableValue",
|
2121
2131
|
# },
|
2132
|
+
# ephemeral_storage: 1,
|
2122
2133
|
# },
|
2123
2134
|
# success_retention_period_in_days: 1,
|
2124
2135
|
# failure_retention_period_in_days: 1,
|
@@ -2174,7 +2185,7 @@ module Aws::Synthetics
|
|
2174
2185
|
tracer: tracer
|
2175
2186
|
)
|
2176
2187
|
context[:gem_name] = 'aws-sdk-synthetics'
|
2177
|
-
context[:gem_version] = '1.
|
2188
|
+
context[:gem_version] = '1.66.0'
|
2178
2189
|
Seahorse::Client::Request.new(handlers, context)
|
2179
2190
|
end
|
2180
2191
|
|
@@ -40,6 +40,7 @@ module Aws::Synthetics
|
|
40
40
|
CanaryRunState = Shapes::StringShape.new(name: 'CanaryRunState')
|
41
41
|
CanaryRunStateReasonCode = Shapes::StringShape.new(name: 'CanaryRunStateReasonCode')
|
42
42
|
CanaryRunStatus = Shapes::StructureShape.new(name: 'CanaryRunStatus')
|
43
|
+
CanaryRunTestResult = Shapes::StringShape.new(name: 'CanaryRunTestResult')
|
43
44
|
CanaryRunTimeline = Shapes::StructureShape.new(name: 'CanaryRunTimeline')
|
44
45
|
CanaryRuns = Shapes::ListShape.new(name: 'CanaryRuns')
|
45
46
|
CanaryScheduleInput = Shapes::StructureShape.new(name: 'CanaryScheduleInput')
|
@@ -73,6 +74,7 @@ module Aws::Synthetics
|
|
73
74
|
EnvironmentVariableName = Shapes::StringShape.new(name: 'EnvironmentVariableName')
|
74
75
|
EnvironmentVariableValue = Shapes::StringShape.new(name: 'EnvironmentVariableValue')
|
75
76
|
EnvironmentVariablesMap = Shapes::MapShape.new(name: 'EnvironmentVariablesMap')
|
77
|
+
EphemeralStorageSize = Shapes::IntegerShape.new(name: 'EphemeralStorageSize')
|
76
78
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
77
79
|
FunctionArn = Shapes::StringShape.new(name: 'FunctionArn')
|
78
80
|
GetCanaryRequest = Shapes::StructureShape.new(name: 'GetCanaryRequest')
|
@@ -241,16 +243,19 @@ module Aws::Synthetics
|
|
241
243
|
CanaryRunConfigInput.add_member(:memory_in_mb, Shapes::ShapeRef.new(shape: MaxSize3008, location_name: "MemoryInMB"))
|
242
244
|
CanaryRunConfigInput.add_member(:active_tracing, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ActiveTracing"))
|
243
245
|
CanaryRunConfigInput.add_member(:environment_variables, Shapes::ShapeRef.new(shape: EnvironmentVariablesMap, location_name: "EnvironmentVariables"))
|
246
|
+
CanaryRunConfigInput.add_member(:ephemeral_storage, Shapes::ShapeRef.new(shape: EphemeralStorageSize, location_name: "EphemeralStorage"))
|
244
247
|
CanaryRunConfigInput.struct_class = Types::CanaryRunConfigInput
|
245
248
|
|
246
249
|
CanaryRunConfigOutput.add_member(:timeout_in_seconds, Shapes::ShapeRef.new(shape: MaxFifteenMinutesInSeconds, location_name: "TimeoutInSeconds"))
|
247
250
|
CanaryRunConfigOutput.add_member(:memory_in_mb, Shapes::ShapeRef.new(shape: MaxSize3008, location_name: "MemoryInMB"))
|
248
251
|
CanaryRunConfigOutput.add_member(:active_tracing, Shapes::ShapeRef.new(shape: NullableBoolean, location_name: "ActiveTracing"))
|
252
|
+
CanaryRunConfigOutput.add_member(:ephemeral_storage, Shapes::ShapeRef.new(shape: EphemeralStorageSize, location_name: "EphemeralStorage"))
|
249
253
|
CanaryRunConfigOutput.struct_class = Types::CanaryRunConfigOutput
|
250
254
|
|
251
255
|
CanaryRunStatus.add_member(:state, Shapes::ShapeRef.new(shape: CanaryRunState, location_name: "State"))
|
252
256
|
CanaryRunStatus.add_member(:state_reason, Shapes::ShapeRef.new(shape: String, location_name: "StateReason"))
|
253
257
|
CanaryRunStatus.add_member(:state_reason_code, Shapes::ShapeRef.new(shape: CanaryRunStateReasonCode, location_name: "StateReasonCode"))
|
258
|
+
CanaryRunStatus.add_member(:test_result, Shapes::ShapeRef.new(shape: CanaryRunTestResult, location_name: "TestResult"))
|
254
259
|
CanaryRunStatus.struct_class = Types::CanaryRunStatus
|
255
260
|
|
256
261
|
CanaryRunTimeline.add_member(:started, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Started"))
|
@@ -296,8 +296,8 @@ module Aws::Synthetics
|
|
296
296
|
# Use this structure to input your script code for the canary. This
|
297
297
|
# structure contains the Lambda handler with the location where the
|
298
298
|
# canary should start running the script. If the script is stored in an
|
299
|
-
# S3 bucket, the bucket name, key, and version are also included.
|
300
|
-
# script was passed into the canary directly, the script code is
|
299
|
+
# Amazon S3 bucket, the bucket name, key, and version are also included.
|
300
|
+
# If the script was passed into the canary directly, the script code is
|
301
301
|
# contained in the value of `Zipfile`.
|
302
302
|
#
|
303
303
|
# If you are uploading your canary scripts with an Amazon S3 bucket,
|
@@ -319,13 +319,13 @@ module Aws::Synthetics
|
|
319
319
|
# [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
|
320
320
|
#
|
321
321
|
# @!attribute [rw] s3_bucket
|
322
|
-
# If your canary script is located in S3, specify the bucket
|
323
|
-
# here. Do not include `s3://` as the start of the bucket name.
|
322
|
+
# If your canary script is located in Amazon S3, specify the bucket
|
323
|
+
# name here. Do not include `s3://` as the start of the bucket name.
|
324
324
|
# @return [String]
|
325
325
|
#
|
326
326
|
# @!attribute [rw] s3_key
|
327
|
-
# The S3 key of your script. For more information, see [Working
|
328
|
-
# Amazon S3 Objects][1].
|
327
|
+
# The Amazon S3 key of your script. For more information, see [Working
|
328
|
+
# with Amazon S3 Objects][1].
|
329
329
|
#
|
330
330
|
#
|
331
331
|
#
|
@@ -333,17 +333,17 @@ module Aws::Synthetics
|
|
333
333
|
# @return [String]
|
334
334
|
#
|
335
335
|
# @!attribute [rw] s3_version
|
336
|
-
# The S3 version ID of your script.
|
336
|
+
# The Amazon S3 version ID of your script.
|
337
337
|
# @return [String]
|
338
338
|
#
|
339
339
|
# @!attribute [rw] zip_file
|
340
340
|
# If you input your canary script directly into the canary instead of
|
341
|
-
# referring to an S3 location, the value of this parameter is
|
342
|
-
# base64-encoded contents of the .zip file that contains the
|
343
|
-
# It must be smaller than 225 Kb.
|
341
|
+
# referring to an Amazon S3 location, the value of this parameter is
|
342
|
+
# the base64-encoded contents of the .zip file that contains the
|
343
|
+
# script. It must be smaller than 225 Kb.
|
344
344
|
#
|
345
|
-
# For large canary scripts, we recommend that you use an S3
|
346
|
-
# instead of inputting it directly with this parameter.
|
345
|
+
# For large canary scripts, we recommend that you use an Amazon S3
|
346
|
+
# location instead of inputting it directly with this parameter.
|
347
347
|
# @return [String]
|
348
348
|
#
|
349
349
|
# @!attribute [rw] handler
|
@@ -529,13 +529,23 @@ module Aws::Synthetics
|
|
529
529
|
# [1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
|
530
530
|
# @return [Hash<String,String>]
|
531
531
|
#
|
532
|
+
# @!attribute [rw] ephemeral_storage
|
533
|
+
# Specifies the amount of ephemeral storage (in MB) to allocate for
|
534
|
+
# the canary run during execution. This temporary storage is used for
|
535
|
+
# storing canary run artifacts (which are uploaded to an Amazon S3
|
536
|
+
# bucket at the end of the run), and any canary browser operations.
|
537
|
+
# This temporary storage is cleared after the run is completed.
|
538
|
+
# Default storage value is 1024 MB.
|
539
|
+
# @return [Integer]
|
540
|
+
#
|
532
541
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigInput AWS API Documentation
|
533
542
|
#
|
534
543
|
class CanaryRunConfigInput < Struct.new(
|
535
544
|
:timeout_in_seconds,
|
536
545
|
:memory_in_mb,
|
537
546
|
:active_tracing,
|
538
|
-
:environment_variables
|
547
|
+
:environment_variables,
|
548
|
+
:ephemeral_storage)
|
539
549
|
SENSITIVE = []
|
540
550
|
include Aws::Structure
|
541
551
|
end
|
@@ -555,12 +565,22 @@ module Aws::Synthetics
|
|
555
565
|
# Displays whether this canary run used active X-Ray tracing.
|
556
566
|
# @return [Boolean]
|
557
567
|
#
|
568
|
+
# @!attribute [rw] ephemeral_storage
|
569
|
+
# Specifies the amount of ephemeral storage (in MB) to allocate for
|
570
|
+
# the canary run during execution. This temporary storage is used for
|
571
|
+
# storing canary run artifacts (which are uploaded to an Amazon S3
|
572
|
+
# bucket at the end of the run), and any canary browser operations.
|
573
|
+
# This temporary storage is cleared after the run is completed.
|
574
|
+
# Default storage value is 1024 MB.
|
575
|
+
# @return [Integer]
|
576
|
+
#
|
558
577
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigOutput AWS API Documentation
|
559
578
|
#
|
560
579
|
class CanaryRunConfigOutput < Struct.new(
|
561
580
|
:timeout_in_seconds,
|
562
581
|
:memory_in_mb,
|
563
|
-
:active_tracing
|
582
|
+
:active_tracing,
|
583
|
+
:ephemeral_storage)
|
564
584
|
SENSITIVE = []
|
565
585
|
include Aws::Structure
|
566
586
|
end
|
@@ -577,9 +597,32 @@ module Aws::Synthetics
|
|
577
597
|
# @return [String]
|
578
598
|
#
|
579
599
|
# @!attribute [rw] state_reason_code
|
580
|
-
# If this value is `CANARY_FAILURE`,
|
581
|
-
#
|
582
|
-
#
|
600
|
+
# If this value is `CANARY_FAILURE`, either the canary script failed
|
601
|
+
# or Synthetics ran into a fatal error when running the canary. For
|
602
|
+
# example, a canary timeout misconfiguration setting can cause the
|
603
|
+
# canary to timeout before Synthetics can evaluate its status.
|
604
|
+
#
|
605
|
+
# If this value is `EXECUTION_FAILURE`, a non-critical failure
|
606
|
+
# occurred such as failing to save generated debug artifacts (for
|
607
|
+
# example, screenshots or har files).
|
608
|
+
#
|
609
|
+
# If both types of failures occurred, the `CANARY_FAILURE` takes
|
610
|
+
# precedence. To understand the exact error, use the [StateReason][1]
|
611
|
+
# API.
|
612
|
+
#
|
613
|
+
#
|
614
|
+
#
|
615
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRunStatus.html
|
616
|
+
# @return [String]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] test_result
|
619
|
+
# Specifies the status of canary script for this run. When Synthetics
|
620
|
+
# tries to determine the status but fails, the result is marked as
|
621
|
+
# `UNKNOWN`. For the overall status of canary run, see [State][1].
|
622
|
+
#
|
623
|
+
#
|
624
|
+
#
|
625
|
+
# [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRunStatus.html
|
583
626
|
# @return [String]
|
584
627
|
#
|
585
628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunStatus AWS API Documentation
|
@@ -587,7 +630,8 @@ module Aws::Synthetics
|
|
587
630
|
class CanaryRunStatus < Struct.new(
|
588
631
|
:state,
|
589
632
|
:state_reason,
|
590
|
-
:state_reason_code
|
633
|
+
:state_reason_code,
|
634
|
+
:test_result)
|
591
635
|
SENSITIVE = []
|
592
636
|
include Aws::Structure
|
593
637
|
end
|
@@ -800,15 +844,16 @@ module Aws::Synthetics
|
|
800
844
|
#
|
801
845
|
# @!attribute [rw] code
|
802
846
|
# A structure that includes the entry point from which the canary
|
803
|
-
# should start running your script. If the script is stored in an
|
804
|
-
# bucket, the bucket name, key, and version are also
|
847
|
+
# should start running your script. If the script is stored in an
|
848
|
+
# Amazon S3 bucket, the bucket name, key, and version are also
|
849
|
+
# included.
|
805
850
|
# @return [Types::CanaryCodeInput]
|
806
851
|
#
|
807
852
|
# @!attribute [rw] artifact_s3_location
|
808
853
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
809
854
|
# test runs of this canary. Artifacts include the log file,
|
810
|
-
# screenshots, and HAR files. The name of the S3 bucket can't
|
811
|
-
# a period (.).
|
855
|
+
# screenshots, and HAR files. The name of the Amazon S3 bucket can't
|
856
|
+
# include a period (.).
|
812
857
|
# @return [String]
|
813
858
|
#
|
814
859
|
# @!attribute [rw] execution_role_arn
|
@@ -1840,9 +1885,9 @@ module Aws::Synthetics
|
|
1840
1885
|
# Use this structure to input your script code for the canary. This
|
1841
1886
|
# structure contains the Lambda handler with the location where the
|
1842
1887
|
# canary should start running the script. If the script is stored in
|
1843
|
-
# an S3 bucket, the bucket name, key, and version are also
|
1844
|
-
# If the script was passed into the canary directly, the
|
1845
|
-
# is contained in the value of `Zipfile`.
|
1888
|
+
# an Amazon S3 bucket, the bucket name, key, and version are also
|
1889
|
+
# included. If the script was passed into the canary directly, the
|
1890
|
+
# script code is contained in the value of `Zipfile`.
|
1846
1891
|
#
|
1847
1892
|
# If you are uploading your canary scripts with an Amazon S3 bucket,
|
1848
1893
|
# your zip file should include your script in a certain folder
|
@@ -1896,8 +1941,9 @@ module Aws::Synthetics
|
|
1896
1941
|
# @return [String]
|
1897
1942
|
#
|
1898
1943
|
# @!attribute [rw] success_retention_period_in_days
|
1899
|
-
# The number of days to retain data
|
1900
|
-
# canary.
|
1944
|
+
# The number of days to retain data about successful runs of this
|
1945
|
+
# canary. If you omit this field, the default of 31 days is used. The
|
1946
|
+
# valid range is 1 to 455 days.
|
1901
1947
|
#
|
1902
1948
|
# This setting affects the range of information returned by
|
1903
1949
|
# [GetCanaryRuns][1], as well as the range of information displayed in
|
@@ -1909,8 +1955,9 @@ module Aws::Synthetics
|
|
1909
1955
|
# @return [Integer]
|
1910
1956
|
#
|
1911
1957
|
# @!attribute [rw] failure_retention_period_in_days
|
1912
|
-
# The number of days to retain data
|
1913
|
-
#
|
1958
|
+
# The number of days to retain data about failed runs of this canary.
|
1959
|
+
# If you omit this field, the default of 31 days is used. The valid
|
1960
|
+
# range is 1 to 455 days.
|
1914
1961
|
#
|
1915
1962
|
# This setting affects the range of information returned by
|
1916
1963
|
# [GetCanaryRuns][1], as well as the range of information displayed in
|
@@ -1952,9 +1999,10 @@ module Aws::Synthetics
|
|
1952
1999
|
#
|
1953
2000
|
# @!attribute [rw] provisioned_resource_cleanup
|
1954
2001
|
# Specifies whether to also delete the Lambda functions and layers
|
1955
|
-
# used by this canary when the canary is deleted. If
|
1956
|
-
# parameter
|
1957
|
-
# layers will be deleted when the canary is
|
2002
|
+
# used by this canary when the canary is deleted. If you omit this
|
2003
|
+
# parameter, the default of `AUTOMATIC` is used, which means that the
|
2004
|
+
# Lambda functions and layers will be deleted when the canary is
|
2005
|
+
# deleted.
|
1958
2006
|
#
|
1959
2007
|
# If the value of this parameter is `OFF`, then the value of the
|
1960
2008
|
# `DeleteLambda` parameter of the [DeleteCanary][1] operation
|
@@ -2119,8 +2167,9 @@ module Aws::Synthetics
|
|
2119
2167
|
#
|
2120
2168
|
# @!attribute [rw] code
|
2121
2169
|
# A structure that includes the entry point from which the canary
|
2122
|
-
# should start running your script. If the script is stored in an
|
2123
|
-
# bucket, the bucket name, key, and version are also
|
2170
|
+
# should start running your script. If the script is stored in an
|
2171
|
+
# Amazon S3 bucket, the bucket name, key, and version are also
|
2172
|
+
# included.
|
2124
2173
|
# @return [Types::CanaryCodeInput]
|
2125
2174
|
#
|
2126
2175
|
# @!attribute [rw] execution_role_arn
|
@@ -2223,8 +2272,8 @@ module Aws::Synthetics
|
|
2223
2272
|
# @!attribute [rw] artifact_s3_location
|
2224
2273
|
# The location in Amazon S3 where Synthetics stores artifacts from the
|
2225
2274
|
# test runs of this canary. Artifacts include the log file,
|
2226
|
-
# screenshots, and HAR files. The name of the S3 bucket can't
|
2227
|
-
# a period (.).
|
2275
|
+
# screenshots, and HAR files. The name of the Amazon S3 bucket can't
|
2276
|
+
# include a period (.).
|
2228
2277
|
# @return [String]
|
2229
2278
|
#
|
2230
2279
|
# @!attribute [rw] artifact_config
|
data/lib/aws-sdk-synthetics.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -114,7 +114,8 @@ module Aws
|
|
114
114
|
timeout_in_seconds: ::Integer?,
|
115
115
|
memory_in_mb: ::Integer?,
|
116
116
|
active_tracing: bool?,
|
117
|
-
environment_variables: Hash[::String, ::String]
|
117
|
+
environment_variables: Hash[::String, ::String]?,
|
118
|
+
ephemeral_storage: ::Integer?
|
118
119
|
},
|
119
120
|
?success_retention_period_in_days: ::Integer,
|
120
121
|
?failure_retention_period_in_days: ::Integer,
|
@@ -326,7 +327,8 @@ module Aws
|
|
326
327
|
timeout_in_seconds: ::Integer?,
|
327
328
|
memory_in_mb: ::Integer?,
|
328
329
|
active_tracing: bool?,
|
329
|
-
environment_variables: Hash[::String, ::String]
|
330
|
+
environment_variables: Hash[::String, ::String]?,
|
331
|
+
ephemeral_storage: ::Integer?
|
330
332
|
},
|
331
333
|
?vpc_config: {
|
332
334
|
subnet_ids: Array[::String]?,
|
@@ -411,7 +413,8 @@ module Aws
|
|
411
413
|
timeout_in_seconds: ::Integer?,
|
412
414
|
memory_in_mb: ::Integer?,
|
413
415
|
active_tracing: bool?,
|
414
|
-
environment_variables: Hash[::String, ::String]
|
416
|
+
environment_variables: Hash[::String, ::String]?,
|
417
|
+
ephemeral_storage: ::Integer?
|
415
418
|
},
|
416
419
|
?success_retention_period_in_days: ::Integer,
|
417
420
|
?failure_retention_period_in_days: ::Integer,
|
data/sig/types.rbs
CHANGED
@@ -109,6 +109,7 @@ module Aws::Synthetics
|
|
109
109
|
attr_accessor memory_in_mb: ::Integer
|
110
110
|
attr_accessor active_tracing: bool
|
111
111
|
attr_accessor environment_variables: ::Hash[::String, ::String]
|
112
|
+
attr_accessor ephemeral_storage: ::Integer
|
112
113
|
SENSITIVE: []
|
113
114
|
end
|
114
115
|
|
@@ -116,6 +117,7 @@ module Aws::Synthetics
|
|
116
117
|
attr_accessor timeout_in_seconds: ::Integer
|
117
118
|
attr_accessor memory_in_mb: ::Integer
|
118
119
|
attr_accessor active_tracing: bool
|
120
|
+
attr_accessor ephemeral_storage: ::Integer
|
119
121
|
SENSITIVE: []
|
120
122
|
end
|
121
123
|
|
@@ -123,6 +125,7 @@ module Aws::Synthetics
|
|
123
125
|
attr_accessor state: ("RUNNING" | "PASSED" | "FAILED")
|
124
126
|
attr_accessor state_reason: ::String
|
125
127
|
attr_accessor state_reason_code: ("CANARY_FAILURE" | "EXECUTION_FAILURE")
|
128
|
+
attr_accessor test_result: ("PASSED" | "FAILED" | "UNKNOWN")
|
126
129
|
SENSITIVE: []
|
127
130
|
end
|
128
131
|
|