aws-sdk-synthetics 1.62.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9254f4c44730452b1a714e105afc29ec2f1096094830638758c21b3f728118dc
-  data.tar.gz: 878b653ef127c882216415da0b0014194e3e9f75a151c032a2d72e47acd0b0f8
+  metadata.gz: a6e2e604c8e69e90705a06f9a523205968bb637ade37e418bde59b995ded9961
+  data.tar.gz: fa0764ec1e04f4f56e570edbe7ee5858958fe2de39f8e964830d57a911c86f57
 SHA512:
-  metadata.gz: e9de87e2164b7047ea3790adbe7b4c13ceef5695dd702bf263b5a44ec53f3bab7d08f9453cab0c9be971280358b8cfacbf63fcd0a49fdaa9cccb0ce4052bdf81
-  data.tar.gz: fbf1d5d74af618ccfe370c011c79c506cae6c76047c076c1decd26c9c9119c702311df300fa41ef3117becfe688ec2dd559c2357e4da6c834fca27bb561d98c7
+  metadata.gz: b838784f6f386ed4f86280ae4ca3d4ea71a2de5f8df8735b52363284e86e6540e2212fd81372f859ae54c1316069a461514e5f9f765f598755f9b3dcb2088784
+  data.tar.gz: 8038523fce046a99fc49bf96a177a6907468e19935c2f94f8a17f615cdaf0b5958213293729ca622aa5ed4b71dd609c950949e91c1922a7355b55f00848bcc7b

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.63.0 (2025-05-07)
+------------------
+
+* 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.
+
 1.62.0 (2025-05-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.62.0
+1.63.0

data/lib/aws-sdk-synthetics/client.rb

@@ -580,19 +580,37 @@ module Aws::Synthetics
     #   A structure that contains the configuration for individual canary
     #   runs, such as timeout value and environment variables.
     #
-    #   The environment variables keys and values are not encrypted. Do not
-    #   store sensitive information in this field.
+    #   Environment variable keys and values are encrypted at rest using
+    #   Amazon Web Services owned KMS keys. However, the environment variables
+    #   are not encrypted on the client side. Do not store sensitive
+    #   information in them.
     #
     # @option params [Integer] :success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary. If you omit this field, the default of 31 days is used. The
     #   valid range is 1 to 455 days.
     #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
     # @option params [Integer] :failure_retention_period_in_days
     #   The number of days to retain data about failed runs of this canary. If
     #   you omit this field, the default of 31 days is used. The valid range
     #   is 1 to 455 days.
     #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
     # @option params [required, String] :runtime_version
     #   Specifies the runtime version to use for the canary. For a list of
     #   valid runtime versions and more information about runtime versions,
@@ -740,6 +758,8 @@ module Aws::Synthetics
     #   resp.canary.tags["TagKey"] #=> String
     #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
+    #   resp.canary.dry_run_config.dry_run_id #=> String
+    #   resp.canary.dry_run_config.last_dry_run_execution_status #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CreateCanary AWS API Documentation
     #
@@ -1022,6 +1042,8 @@ module Aws::Synthetics
     #   resp.canaries[0].tags["TagKey"] #=> String
     #   resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.canaries[0].artifact_config.s3_encryption.kms_key_arn #=> String
+    #   resp.canaries[0].dry_run_config.dry_run_id #=> String
+    #   resp.canaries[0].dry_run_config.last_dry_run_execution_status #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanaries AWS API Documentation
@@ -1107,6 +1129,7 @@ module Aws::Synthetics
     #   resp.canaries_last_run[0].last_run.timeline.started #=> Time
     #   resp.canaries_last_run[0].last_run.timeline.completed #=> Time
     #   resp.canaries_last_run[0].last_run.artifact_s3_location #=> String
+    #   resp.canaries_last_run[0].last_run.dry_run_config.dry_run_id #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DescribeCanariesLastRun AWS API Documentation
@@ -1207,6 +1230,10 @@ module Aws::Synthetics
     # @option params [required, String] :name
     #   The name of the canary that you want details for.
     #
+    # @option params [String] :dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can use
+    #   this DryRunId to retrieve information about the dry run.
+    #
     # @return [Types::GetCanaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetCanaryResponse#canary #canary} => Types::Canary
@@ -1215,6 +1242,7 @@ module Aws::Synthetics
     #
     #   resp = client.get_canary({
     #     name: "CanaryName", # required
+    #     dry_run_id: "UUID",
     #   })
     #
     # @example Response structure
@@ -1257,6 +1285,8 @@ module Aws::Synthetics
     #   resp.canary.tags["TagKey"] #=> String
     #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
     #   resp.canary.artifact_config.s3_encryption.kms_key_arn #=> String
+    #   resp.canary.dry_run_config.dry_run_id #=> String
+    #   resp.canary.dry_run_config.last_dry_run_execution_status #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanary AWS API Documentation
     #
@@ -1282,6 +1312,23 @@ module Aws::Synthetics
     #   you use the `GetCanaryRuns` operation. If you omit this parameter, the
     #   default of 100 is used.
     #
+    # @option params [String] :dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can use
+    #   this DryRunId to retrieve information about the dry run.
+    #
+    # @option params [String] :run_type
+    #   * When you provide `RunType=CANARY_RUN` and `dryRunId`, you will get
+    #     an exception
+    #
+    #   * When a value is not provided for `RunType`, the default value is
+    #     `CANARY_RUN`
+    #
+    #   * When `CANARY_RUN` is provided, all canary runs excluding dry runs
+    #     are returned
+    #
+    #   * When `DRY_RUN` is provided, all dry runs excluding canary runs are
+    #     returned
+    #
     # @return [Types::GetCanaryRunsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetCanaryRunsResponse#canary_runs #canary_runs} => Array<Types::CanaryRun>
@@ -1295,6 +1342,8 @@ module Aws::Synthetics
     #     name: "CanaryName", # required
     #     next_token: "Token",
     #     max_results: 1,
+    #     dry_run_id: "UUID",
+    #     run_type: "CANARY_RUN", # accepts CANARY_RUN, DRY_RUN
     #   })
     #
     # @example Response structure
@@ -1308,6 +1357,7 @@ module Aws::Synthetics
     #   resp.canary_runs[0].timeline.started #=> Time
     #   resp.canary_runs[0].timeline.completed #=> Time
     #   resp.canary_runs[0].artifact_s3_location #=> String
+    #   resp.canary_runs[0].dry_run_config.dry_run_id #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRuns AWS API Documentation
@@ -1562,6 +1612,198 @@ module Aws::Synthetics
       req.send_request(options)
     end
 
+    # Use this operation to start a dry run for a canary that has already
+    # been created
+    #
+    # @option params [required, String] :name
+    #   The name of the canary that you want to dry run. To find canary names,
+    #   use [DescribeCanaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
+    #
+    # @option params [Types::CanaryCodeInput] :code
+    #   Use this structure to input your script code for the canary. This
+    #   structure contains the Lambda handler with the location where the
+    #   canary should start running the script. If the script is stored in an
+    #   S3 bucket, the bucket name, key, and version are also included. If the
+    #   script was passed into the canary directly, the script code is
+    #   contained in the value of `Zipfile`.
+    #
+    #   If you are uploading your canary scripts with an Amazon S3 bucket,
+    #   your zip file should include your script in a certain folder
+    #   structure.
+    #
+    #   * For Node.js canaries, the folder structure must be
+    #     `nodejs/node_modules/myCanaryFilename.js ` For more information, see
+    #     [Packaging your Node.js canary files][1]
+    #
+    #   * For Python canaries, the folder structure must be
+    #     `python/myCanaryFilename.py ` or
+    #     `python/myFolder/myCanaryFilename.py ` For more information, see
+    #     [Packaging your Python canary files][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
+    #
+    # @option params [String] :runtime_version
+    #   Specifies the runtime version to use for the canary. For a list of
+    #   valid runtime versions and for more information about runtime
+    #   versions, see [ Canary Runtime Versions][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
+    #
+    # @option params [Types::CanaryRunConfigInput] :run_config
+    #   A structure that contains input information for a canary run.
+    #
+    # @option params [Types::VpcConfigInput] :vpc_config
+    #   If this canary is to test an endpoint in a VPC, this structure
+    #   contains information about the subnets and security groups of the VPC
+    #   endpoint. For more information, see [ Running a Canary in a VPC][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
+    #
+    # @option params [String] :execution_role_arn
+    #   The ARN of the IAM role to be used to run the canary. This role must
+    #   already exist, and must include `lambda.amazonaws.com` as a principal
+    #   in the trust policy. The role must also have the following
+    #   permissions:
+    #
+    # @option params [Integer] :success_retention_period_in_days
+    #   The number of days to retain data on the failed runs for this canary.
+    #   The valid range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
+    # @option params [Integer] :failure_retention_period_in_days
+    #   The number of days to retain data on the failed runs for this canary.
+    #   The valid range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
+    # @option params [Types::VisualReferenceInput] :visual_reference
+    #   An object that specifies what screenshots to use as a baseline for
+    #   visual monitoring by this canary. It can optionally also specify parts
+    #   of the screenshots to ignore during the visual monitoring comparison.
+    #
+    #   Visual monitoring is supported only on canaries running the
+    #   **syn-puppeteer-node-3.2** runtime or later. For more information, see
+    #   [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
+    #
+    # @option params [String] :artifact_s3_location
+    #   The location in Amazon S3 where Synthetics stores artifacts from the
+    #   test runs of this canary. Artifacts include the log file, screenshots,
+    #   and HAR files. The name of the Amazon S3 bucket can't include a
+    #   period (.).
+    #
+    # @option params [Types::ArtifactConfigInput] :artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #
+    # @option params [String] :provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers used
+    #   by this canary when the canary is deleted. If the value of this
+    #   parameter is `AUTOMATIC`, it means that the Lambda functions and
+    #   layers will be deleted when the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation determines
+    #   whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #
+    # @return [Types::StartCanaryDryRunResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartCanaryDryRunResponse#dry_run_config #dry_run_config} => Types::DryRunConfigOutput
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_canary_dry_run({
+    #     name: "CanaryName", # required
+    #     code: {
+    #       s3_bucket: "String",
+    #       s3_key: "String",
+    #       s3_version: "String",
+    #       zip_file: "data",
+    #       handler: "CodeHandler", # required
+    #     },
+    #     runtime_version: "String",
+    #     run_config: {
+    #       timeout_in_seconds: 1,
+    #       memory_in_mb: 1,
+    #       active_tracing: false,
+    #       environment_variables: {
+    #         "EnvironmentVariableName" => "EnvironmentVariableValue",
+    #       },
+    #     },
+    #     vpc_config: {
+    #       subnet_ids: ["SubnetId"],
+    #       security_group_ids: ["SecurityGroupId"],
+    #       ipv_6_allowed_for_dual_stack: false,
+    #     },
+    #     execution_role_arn: "RoleArn",
+    #     success_retention_period_in_days: 1,
+    #     failure_retention_period_in_days: 1,
+    #     visual_reference: {
+    #       base_screenshots: [
+    #         {
+    #           screenshot_name: "String", # required
+    #           ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #         },
+    #       ],
+    #       base_canary_run_id: "String", # required
+    #     },
+    #     artifact_s3_location: "String",
+    #     artifact_config: {
+    #       s3_encryption: {
+    #         encryption_mode: "SSE_S3", # accepts SSE_S3, SSE_KMS
+    #         kms_key_arn: "KmsKeyArn",
+    #       },
+    #     },
+    #     provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.dry_run_config.dry_run_id #=> String
+    #   resp.dry_run_config.last_dry_run_execution_status #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRun AWS API Documentation
+    #
+    # @overload start_canary_dry_run(params = {})
+    # @param [Hash] params ({})
+    def start_canary_dry_run(params = {}, options = {})
+      req = build_request(:start_canary_dry_run, params)
+      req.send_request(options)
+    end
+
     # Stops the canary to prevent all future runs. If the canary is
     # currently running,the run that is in progress completes on its own,
     # publishes metrics, and uploads artifacts, but it is not recorded in
@@ -1684,6 +1926,12 @@ module Aws::Synthetics
     # canary. To change the tags of an existing canary, use
     # [TagResource][1].
     #
+    # <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
+    # other field you can provide is the `Schedule`. Adding any other field
+    # will thrown an exception.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_TagResource.html
@@ -1740,16 +1988,34 @@ module Aws::Synthetics
     #   A structure that contains the timeout value that is used for each
     #   individual run of the canary.
     #
-    #   The environment variables keys and values are not encrypted. Do not
-    #   store sensitive information in this field.
+    #   Environment variable keys and values are encrypted at rest using
+    #   Amazon Web Services owned KMS keys. However, the environment variables
+    #   are not encrypted on the client side. Do not store sensitive
+    #   information in them.
     #
     # @option params [Integer] :success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary.
     #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
     # @option params [Integer] :failure_retention_period_in_days
     #   The number of days to retain data about failed runs of this canary.
     #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #
     # @option params [Types::VpcConfigInput] :vpc_config
     #   If this canary is to test an endpoint in a VPC, this structure
     #   contains information about the subnet and security groups of the VPC
@@ -1796,6 +2062,16 @@ module Aws::Synthetics
     #
     #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
     #
+    # @option params [String] :dry_run_id
+    #   Update the existing canary using the updated configurations from the
+    #   DryRun associated with the DryRunId.
+    #
+    #   <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
+    #   other field you can provide is the `Schedule`. Adding any other field
+    #   will thrown an exception.
+    #
+    #    </note>
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -1847,6 +2123,7 @@ module Aws::Synthetics
     #       },
     #     },
     #     provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
+    #     dry_run_id: "UUID",
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
@@ -1876,7 +2153,7 @@ module Aws::Synthetics
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.62.0'
+      context[:gem_version] = '1.63.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-synthetics/client_api.rb

@@ -14,6 +14,7 @@ module Aws::Synthetics
 
     include Seahorse::Model
 
+    AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
     ArtifactConfigInput = Shapes::StructureShape.new(name: 'ArtifactConfigInput')
     ArtifactConfigOutput = Shapes::StructureShape.new(name: 'ArtifactConfigOutput')
     AssociateResourceRequest = Shapes::StructureShape.new(name: 'AssociateResourceRequest')
@@ -30,6 +31,7 @@ module Aws::Synthetics
     CanaryArn = Shapes::StringShape.new(name: 'CanaryArn')
     CanaryCodeInput = Shapes::StructureShape.new(name: 'CanaryCodeInput')
     CanaryCodeOutput = Shapes::StructureShape.new(name: 'CanaryCodeOutput')
+    CanaryDryRunConfigOutput = Shapes::StructureShape.new(name: 'CanaryDryRunConfigOutput')
     CanaryLastRun = Shapes::StructureShape.new(name: 'CanaryLastRun')
     CanaryName = Shapes::StringShape.new(name: 'CanaryName')
     CanaryRun = Shapes::StructureShape.new(name: 'CanaryRun')
@@ -66,6 +68,7 @@ module Aws::Synthetics
     DescribeRuntimeVersionsResponse = Shapes::StructureShape.new(name: 'DescribeRuntimeVersionsResponse')
     DisassociateResourceRequest = Shapes::StructureShape.new(name: 'DisassociateResourceRequest')
     DisassociateResourceResponse = Shapes::StructureShape.new(name: 'DisassociateResourceResponse')
+    DryRunConfigOutput = Shapes::StructureShape.new(name: 'DryRunConfigOutput')
     EncryptionMode = Shapes::StringShape.new(name: 'EncryptionMode')
     EnvironmentVariableName = Shapes::StringShape.new(name: 'EnvironmentVariableName')
     EnvironmentVariableValue = Shapes::StringShape.new(name: 'EnvironmentVariableValue')
@@ -112,12 +115,15 @@ module Aws::Synthetics
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResourceToTag = Shapes::StringShape.new(name: 'ResourceToTag')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
+    RunType = Shapes::StringShape.new(name: 'RunType')
     RuntimeVersion = Shapes::StructureShape.new(name: 'RuntimeVersion')
     RuntimeVersionList = Shapes::ListShape.new(name: 'RuntimeVersionList')
     S3EncryptionConfig = Shapes::StructureShape.new(name: 'S3EncryptionConfig')
     SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
     SecurityGroupIds = Shapes::ListShape.new(name: 'SecurityGroupIds')
     ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
+    StartCanaryDryRunRequest = Shapes::StructureShape.new(name: 'StartCanaryDryRunRequest')
+    StartCanaryDryRunResponse = Shapes::StructureShape.new(name: 'StartCanaryDryRunResponse')
     StartCanaryRequest = Shapes::StructureShape.new(name: 'StartCanaryRequest')
     StartCanaryResponse = Shapes::StructureShape.new(name: 'StartCanaryResponse')
     StopCanaryRequest = Shapes::StructureShape.new(name: 'StopCanaryRequest')
@@ -148,6 +154,9 @@ module Aws::Synthetics
     VpcId = Shapes::StringShape.new(name: 'VpcId')
     boolean = Shapes::BooleanShape.new(name: 'boolean')
 
+    AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
+    AccessDeniedException.struct_class = Types::AccessDeniedException
+
     ArtifactConfigInput.add_member(:s3_encryption, Shapes::ShapeRef.new(shape: S3EncryptionConfig, location_name: "S3Encryption"))
     ArtifactConfigInput.struct_class = Types::ArtifactConfigInput
 
@@ -193,6 +202,7 @@ module Aws::Synthetics
     Canary.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
     Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     Canary.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigOutput, location_name: "ArtifactConfig"))
+    Canary.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: DryRunConfigOutput, location_name: "DryRunConfig"))
     Canary.struct_class = Types::Canary
 
     CanaryCodeInput.add_member(:s3_bucket, Shapes::ShapeRef.new(shape: String, location_name: "S3Bucket"))
@@ -206,6 +216,9 @@ module Aws::Synthetics
     CanaryCodeOutput.add_member(:handler, Shapes::ShapeRef.new(shape: String, location_name: "Handler"))
     CanaryCodeOutput.struct_class = Types::CanaryCodeOutput
 
+    CanaryDryRunConfigOutput.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "DryRunId"))
+    CanaryDryRunConfigOutput.struct_class = Types::CanaryDryRunConfigOutput
+
     CanaryLastRun.add_member(:canary_name, Shapes::ShapeRef.new(shape: CanaryName, location_name: "CanaryName"))
     CanaryLastRun.add_member(:last_run, Shapes::ShapeRef.new(shape: CanaryRun, location_name: "LastRun"))
     CanaryLastRun.struct_class = Types::CanaryLastRun
@@ -215,6 +228,7 @@ module Aws::Synthetics
     CanaryRun.add_member(:status, Shapes::ShapeRef.new(shape: CanaryRunStatus, location_name: "Status"))
     CanaryRun.add_member(:timeline, Shapes::ShapeRef.new(shape: CanaryRunTimeline, location_name: "Timeline"))
     CanaryRun.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
+    CanaryRun.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: CanaryDryRunConfigOutput, location_name: "DryRunConfig"))
     CanaryRun.struct_class = Types::CanaryRun
 
     CanaryRunConfigInput.add_member(:timeout_in_seconds, Shapes::ShapeRef.new(shape: MaxFifteenMinutesInSeconds, location_name: "TimeoutInSeconds"))
@@ -334,10 +348,15 @@ module Aws::Synthetics
 
     DisassociateResourceResponse.struct_class = Types::DisassociateResourceResponse
 
+    DryRunConfigOutput.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "DryRunId"))
+    DryRunConfigOutput.add_member(:last_dry_run_execution_status, Shapes::ShapeRef.new(shape: String, location_name: "LastDryRunExecutionStatus"))
+    DryRunConfigOutput.struct_class = Types::DryRunConfigOutput
+
     EnvironmentVariablesMap.key = Shapes::ShapeRef.new(shape: EnvironmentVariableName)
     EnvironmentVariablesMap.value = Shapes::ShapeRef.new(shape: EnvironmentVariableValue)
 
     GetCanaryRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
+    GetCanaryRequest.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location: "querystring", location_name: "dryRunId"))
     GetCanaryRequest.struct_class = Types::GetCanaryRequest
 
     GetCanaryResponse.add_member(:canary, Shapes::ShapeRef.new(shape: Canary, location_name: "Canary"))
@@ -346,6 +365,8 @@ module Aws::Synthetics
     GetCanaryRunsRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
     GetCanaryRunsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
     GetCanaryRunsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxSize100, location_name: "MaxResults"))
+    GetCanaryRunsRequest.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "DryRunId"))
+    GetCanaryRunsRequest.add_member(:run_type, Shapes::ShapeRef.new(shape: RunType, location_name: "RunType"))
     GetCanaryRunsRequest.struct_class = Types::GetCanaryRunsRequest
 
     GetCanaryRunsResponse.add_member(:canary_runs, Shapes::ShapeRef.new(shape: CanaryRuns, location_name: "CanaryRuns"))
@@ -439,6 +460,23 @@ module Aws::Synthetics
     ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
 
+    StartCanaryDryRunRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
+    StartCanaryDryRunRequest.add_member(:code, Shapes::ShapeRef.new(shape: CanaryCodeInput, location_name: "Code"))
+    StartCanaryDryRunRequest.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
+    StartCanaryDryRunRequest.add_member(:run_config, Shapes::ShapeRef.new(shape: CanaryRunConfigInput, location_name: "RunConfig"))
+    StartCanaryDryRunRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
+    StartCanaryDryRunRequest.add_member(:execution_role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "ExecutionRoleArn"))
+    StartCanaryDryRunRequest.add_member(:success_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "SuccessRetentionPeriodInDays"))
+    StartCanaryDryRunRequest.add_member(:failure_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "FailureRetentionPeriodInDays"))
+    StartCanaryDryRunRequest.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceInput, location_name: "VisualReference"))
+    StartCanaryDryRunRequest.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
+    StartCanaryDryRunRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
+    StartCanaryDryRunRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
+    StartCanaryDryRunRequest.struct_class = Types::StartCanaryDryRunRequest
+
+    StartCanaryDryRunResponse.add_member(:dry_run_config, Shapes::ShapeRef.new(shape: DryRunConfigOutput, location_name: "DryRunConfig"))
+    StartCanaryDryRunResponse.struct_class = Types::StartCanaryDryRunResponse
+
     StartCanaryRequest.add_member(:name, Shapes::ShapeRef.new(shape: CanaryName, required: true, location: "uri", location_name: "name"))
     StartCanaryRequest.struct_class = Types::StartCanaryRequest
 
@@ -486,6 +524,7 @@ module Aws::Synthetics
     UpdateCanaryRequest.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
     UpdateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
     UpdateCanaryRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
+    UpdateCanaryRequest.add_member(:dry_run_id, Shapes::ShapeRef.new(shape: UUID, location_name: "DryRunId"))
     UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
 
     UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
@@ -768,6 +807,19 @@ module Aws::Synthetics
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
       end)
 
+      api.add_operation(:start_canary_dry_run, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartCanaryDryRun"
+        o.http_method = "POST"
+        o.http_request_uri = "/canary/{name}/dry-run/start"
+        o.input = Shapes::ShapeRef.new(shape: StartCanaryDryRunRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartCanaryDryRunResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:stop_canary, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StopCanary"
         o.http_method = "POST"
@@ -817,6 +869,7 @@ module Aws::Synthetics
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
         o.errors << Shapes::ShapeRef.new(shape: RequestEntityTooLargeException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
     end
 

data/lib/aws-sdk-synthetics/errors.rb

@@ -27,6 +27,7 @@ module Aws::Synthetics
   # See {Seahorse::Client::RequestContext} for more information.
   #
   # ## Error Classes
+  # * {AccessDeniedException}
   # * {BadRequestException}
   # * {ConflictException}
   # * {InternalFailureException}
@@ -44,6 +45,21 @@ module Aws::Synthetics
 
     extend Aws::Errors::DynamicErrors
 
+    class AccessDeniedException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::Synthetics::Types::AccessDeniedException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class BadRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context

data/lib/aws-sdk-synthetics/types.rb

@@ -10,6 +10,19 @@
 module Aws::Synthetics
   module Types
 
+    # You don't have permission to perform this operation on this resource.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/AccessDeniedException AWS API Documentation
+    #
+    class AccessDeniedException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A structure that contains the configuration for canary artifacts,
     # including the encryption-at-rest settings for artifacts that the
     # canary uploads to Amazon S3.
@@ -150,10 +163,26 @@ module Aws::Synthetics
     # @!attribute [rw] success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] failure_retention_period_in_days
     #   The number of days to retain data about failed runs of this canary.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] status
@@ -234,6 +263,10 @@ module Aws::Synthetics
     #   canary uploads to Amazon S3.
     #   @return [Types::ArtifactConfigOutput]
     #
+    # @!attribute [rw] dry_run_config
+    #   Returns the dry run configurations for a canary.
+    #   @return [Types::DryRunConfigOutput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/Canary AWS API Documentation
     #
     class Canary < Struct.new(
@@ -254,7 +287,8 @@ module Aws::Synthetics
       :visual_reference,
       :provisioned_resource_cleanup,
       :tags,
-      :artifact_config)
+      :artifact_config,
+      :dry_run_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -275,8 +309,9 @@ module Aws::Synthetics
     #   [Packaging your Node.js canary files][1]
     #
     # * For Python canaries, the folder structure must be
-    #   `python/myCanaryFilename.p ` or `python/myFolder/myCanaryFilename.py
-    #   ` For more information, see [Packaging your Python canary files][2]
+    #   `python/myCanaryFilename.py ` or
+    #   `python/myFolder/myCanaryFilename.py ` For more information, see
+    #   [Packaging your Python canary files][2]
     #
     #
     #
@@ -355,6 +390,21 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # Returns the dry run configurations set for a canary.
+    #
+    # @!attribute [rw] dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can
+    #   use this DryRunId to retrieve information about the dry run.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryDryRunConfigOutput AWS API Documentation
+    #
+    class CanaryDryRunConfigOutput < Struct.new(
+      :dry_run_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This structure contains information about the most recent run of a
     # single canary.
     #
@@ -398,6 +448,10 @@ module Aws::Synthetics
     #   Artifacts include the log file, screenshots, and HAR files.
     #   @return [String]
     #
+    # @!attribute [rw] dry_run_config
+    #   Returns the dry run configurations for a canary.
+    #   @return [Types::CanaryDryRunConfigOutput]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRun AWS API Documentation
     #
     class CanaryRun < Struct.new(
@@ -405,7 +459,8 @@ module Aws::Synthetics
       :name,
       :status,
       :timeline,
-      :artifact_s3_location)
+      :artifact_s3_location,
+      :dry_run_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -454,8 +509,10 @@ module Aws::Synthetics
     #   for your environment variables. For more information about reserved
     #   keys, see [ Runtime environment variables][1].
     #
-    #   The environment variables keys and values are not encrypted. Do not
-    #   store sensitive information in this field.
+    #   Environment variable keys and values are encrypted at rest using
+    #   Amazon Web Services owned KMS keys. However, the environment
+    #   variables are not encrypted on the client side. Do not store
+    #   sensitive information in them.
     #
     #
     #
@@ -758,20 +815,38 @@ module Aws::Synthetics
     #   A structure that contains the configuration for individual canary
     #   runs, such as timeout value and environment variables.
     #
-    #   The environment variables keys and values are not encrypted. Do not
-    #   store sensitive information in this field.
+    #   Environment variable keys and values are encrypted at rest using
+    #   Amazon Web Services owned KMS keys. However, the environment
+    #   variables are not encrypted on the client side. Do not store
+    #   sensitive information in them.
     #   @return [Types::CanaryRunConfigInput]
     #
     # @!attribute [rw] success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary. If you omit this field, the default of 31 days is used. The
     #   valid range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] failure_retention_period_in_days
     #   The number of days to retain data about failed runs of this canary.
     #   If you omit this field, the default of 31 days is used. The valid
     #   range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] runtime_version
@@ -1148,14 +1223,40 @@ module Aws::Synthetics
     #
     class DisassociateResourceResponse < Aws::EmptyStructure; end
 
+    # Returns the dry run configurations set for a canary.
+    #
+    # @!attribute [rw] dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can
+    #   use this DryRunId to retrieve information about the dry run.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_dry_run_execution_status
+    #   Returns the last execution status for a canary's dry run.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/DryRunConfigOutput AWS API Documentation
+    #
+    class DryRunConfigOutput < Struct.new(
+      :dry_run_id,
+      :last_dry_run_execution_status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   The name of the canary that you want details for.
     #   @return [String]
     #
+    # @!attribute [rw] dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can
+    #   use this DryRunId to retrieve information about the dry run.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRequest AWS API Documentation
     #
     class GetCanaryRequest < Struct.new(
-      :name)
+      :name,
+      :dry_run_id)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1188,12 +1289,33 @@ module Aws::Synthetics
     #   the default of 100 is used.
     #   @return [Integer]
     #
+    # @!attribute [rw] dry_run_id
+    #   The DryRunId associated with an existing canary’s dry run. You can
+    #   use this DryRunId to retrieve information about the dry run.
+    #   @return [String]
+    #
+    # @!attribute [rw] run_type
+    #   * When you provide `RunType=CANARY_RUN` and `dryRunId`, you will get
+    #     an exception
+    #
+    #   * When a value is not provided for `RunType`, the default value is
+    #     `CANARY_RUN`
+    #
+    #   * When `CANARY_RUN` is provided, all canary runs excluding dry runs
+    #     are returned
+    #
+    #   * When `DRY_RUN` is provided, all dry runs excluding canary runs are
+    #     returned
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/GetCanaryRunsRequest AWS API Documentation
     #
     class GetCanaryRunsRequest < Struct.new(
       :name,
       :next_token,
-      :max_results)
+      :max_results,
+      :dry_run_id,
+      :run_type)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1623,6 +1745,175 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # @!attribute [rw] name
+    #   The name of the canary that you want to dry run. To find canary
+    #   names, use [DescribeCanaries][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html
+    #   @return [String]
+    #
+    # @!attribute [rw] code
+    #   Use this structure to input your script code for the canary. This
+    #   structure contains the Lambda handler with the location where the
+    #   canary should start running the script. If the script is stored in
+    #   an S3 bucket, the bucket name, key, and version are also included.
+    #   If the script was passed into the canary directly, the script code
+    #   is contained in the value of `Zipfile`.
+    #
+    #   If you are uploading your canary scripts with an Amazon S3 bucket,
+    #   your zip file should include your script in a certain folder
+    #   structure.
+    #
+    #   * For Node.js canaries, the folder structure must be
+    #     `nodejs/node_modules/myCanaryFilename.js ` For more information,
+    #     see [Packaging your Node.js canary files][1]
+    #
+    #   * For Python canaries, the folder structure must be
+    #     `python/myCanaryFilename.py ` or
+    #     `python/myFolder/myCanaryFilename.py ` For more information, see
+    #     [Packaging your Python canary files][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Nodejs.html#CloudWatch_Synthetics_Canaries_package
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_WritingCanary_Python.html#CloudWatch_Synthetics_Canaries_WritingCanary_Python_package
+    #   @return [Types::CanaryCodeInput]
+    #
+    # @!attribute [rw] runtime_version
+    #   Specifies the runtime version to use for the canary. For a list of
+    #   valid runtime versions and for more information about runtime
+    #   versions, see [ Canary Runtime Versions][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html
+    #   @return [String]
+    #
+    # @!attribute [rw] run_config
+    #   A structure that contains input information for a canary run.
+    #   @return [Types::CanaryRunConfigInput]
+    #
+    # @!attribute [rw] vpc_config
+    #   If this canary is to test an endpoint in a VPC, this structure
+    #   contains information about the subnets and security groups of the
+    #   VPC endpoint. For more information, see [ Running a Canary in a
+    #   VPC][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
+    #   @return [Types::VpcConfigInput]
+    #
+    # @!attribute [rw] execution_role_arn
+    #   The ARN of the IAM role to be used to run the canary. This role must
+    #   already exist, and must include `lambda.amazonaws.com` as a
+    #   principal in the trust policy. The role must also have the following
+    #   permissions:
+    #   @return [String]
+    #
+    # @!attribute [rw] success_retention_period_in_days
+    #   The number of days to retain data on the failed runs for this
+    #   canary. The valid range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #   @return [Integer]
+    #
+    # @!attribute [rw] failure_retention_period_in_days
+    #   The number of days to retain data on the failed runs for this
+    #   canary. The valid range is 1 to 455 days.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
+    #   @return [Integer]
+    #
+    # @!attribute [rw] visual_reference
+    #   An object that specifies what screenshots to use as a baseline for
+    #   visual monitoring by this canary. It can optionally also specify
+    #   parts of the screenshots to ignore during the visual monitoring
+    #   comparison.
+    #
+    #   Visual monitoring is supported only on canaries running the
+    #   **syn-puppeteer-node-3.2** runtime or later. For more information,
+    #   see [ Visual monitoring][1] and [ Visual monitoring blueprint][2]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html
+    #   [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html
+    #   @return [Types::VisualReferenceInput]
+    #
+    # @!attribute [rw] artifact_s3_location
+    #   The location in Amazon S3 where Synthetics stores artifacts from the
+    #   test runs of this canary. Artifacts include the log file,
+    #   screenshots, and HAR files. The name of the Amazon S3 bucket can't
+    #   include a period (.).
+    #   @return [String]
+    #
+    # @!attribute [rw] artifact_config
+    #   A structure that contains the configuration for canary artifacts,
+    #   including the encryption-at-rest settings for artifacts that the
+    #   canary uploads to Amazon S3.
+    #   @return [Types::ArtifactConfigInput]
+    #
+    # @!attribute [rw] provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers
+    #   used by this canary when the canary is deleted. If the value of this
+    #   parameter is `AUTOMATIC`, it means that the Lambda functions and
+    #   layers will be deleted when the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation
+    #   determines whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRunRequest AWS API Documentation
+    #
+    class StartCanaryDryRunRequest < Struct.new(
+      :name,
+      :code,
+      :runtime_version,
+      :run_config,
+      :vpc_config,
+      :execution_role_arn,
+      :success_retention_period_in_days,
+      :failure_retention_period_in_days,
+      :visual_reference,
+      :artifact_s3_location,
+      :artifact_config,
+      :provisioned_resource_cleanup)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] dry_run_config
+    #   Returns the dry run configurations for a canary.
+    #   @return [Types::DryRunConfigOutput]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/StartCanaryDryRunResponse AWS API Documentation
+    #
+    class StartCanaryDryRunResponse < Struct.new(
+      :dry_run_config)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   The name of the canary that you want to run. To find canary names,
     #   use [DescribeCanaries][1].
@@ -1790,17 +2081,35 @@ module Aws::Synthetics
     #   A structure that contains the timeout value that is used for each
     #   individual run of the canary.
     #
-    #   The environment variables keys and values are not encrypted. Do not
-    #   store sensitive information in this field.
+    #   Environment variable keys and values are encrypted at rest using
+    #   Amazon Web Services owned KMS keys. However, the environment
+    #   variables are not encrypted on the client side. Do not store
+    #   sensitive information in them.
     #   @return [Types::CanaryRunConfigInput]
     #
     # @!attribute [rw] success_retention_period_in_days
     #   The number of days to retain data about successful runs of this
     #   canary.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] failure_retention_period_in_days
     #   The number of days to retain data about failed runs of this canary.
+    #
+    #   This setting affects the range of information returned by
+    #   [GetCanaryRuns][1], as well as the range of information displayed in
+    #   the Synthetics console.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_GetCanaryRuns.html
     #   @return [Integer]
     #
     # @!attribute [rw] vpc_config
@@ -1855,6 +2164,17 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
     #   @return [String]
     #
+    # @!attribute [rw] dry_run_id
+    #   Update the existing canary using the updated configurations from the
+    #   DryRun associated with the DryRunId.
+    #
+    #   <note markdown="1"> When you use the `dryRunId` field when updating a canary, the only
+    #   other field you can provide is the `Schedule`. Adding any other
+    #   field will thrown an exception.
+    #
+    #    </note>
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
     #
     class UpdateCanaryRequest < Struct.new(
@@ -1870,7 +2190,8 @@ module Aws::Synthetics
       :visual_reference,
       :artifact_s3_location,
       :artifact_config,
-      :provisioned_resource_cleanup)
+      :provisioned_resource_cleanup,
+      :dry_run_id)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-synthetics.rb

@@ -54,7 +54,7 @@ module Aws::Synthetics
   autoload :EndpointProvider, 'aws-sdk-synthetics/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-synthetics/endpoints'
 
-  GEM_VERSION = '1.62.0'
+  GEM_VERSION = '1.63.0'
 
 end
 

data/sig/client.rbs

@@ -217,7 +217,8 @@ module Aws
       end
       # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Synthetics/Client.html#get_canary-instance_method
       def get_canary: (
-                        name: ::String
+                        name: ::String,
+                        ?dry_run_id: ::String
                       ) -> _GetCanaryResponseSuccess
                     | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCanaryResponseSuccess
 
@@ -230,7 +231,9 @@ module Aws
       def get_canary_runs: (
                              name: ::String,
                              ?next_token: ::String,
-                             ?max_results: ::Integer
+                             ?max_results: ::Integer,
+                             ?dry_run_id: ::String,
+                             ?run_type: ("CANARY_RUN" | "DRY_RUN")
                            ) -> _GetCanaryRunsResponseSuccess
                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCanaryRunsResponseSuccess
 
@@ -301,6 +304,55 @@ module Aws
                         ) -> _StartCanaryResponseSuccess
                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCanaryResponseSuccess
 
+      interface _StartCanaryDryRunResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::StartCanaryDryRunResponse]
+        def dry_run_config: () -> Types::DryRunConfigOutput
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Synthetics/Client.html#start_canary_dry_run-instance_method
+      def start_canary_dry_run: (
+                                  name: ::String,
+                                  ?code: {
+                                    s3_bucket: ::String?,
+                                    s3_key: ::String?,
+                                    s3_version: ::String?,
+                                    zip_file: ::String?,
+                                    handler: ::String
+                                  },
+                                  ?runtime_version: ::String,
+                                  ?run_config: {
+                                    timeout_in_seconds: ::Integer?,
+                                    memory_in_mb: ::Integer?,
+                                    active_tracing: bool?,
+                                    environment_variables: Hash[::String, ::String]?
+                                  },
+                                  ?vpc_config: {
+                                    subnet_ids: Array[::String]?,
+                                    security_group_ids: Array[::String]?,
+                                    ipv_6_allowed_for_dual_stack: bool?
+                                  },
+                                  ?execution_role_arn: ::String,
+                                  ?success_retention_period_in_days: ::Integer,
+                                  ?failure_retention_period_in_days: ::Integer,
+                                  ?visual_reference: {
+                                    base_screenshots: Array[
+                                      {
+                                        screenshot_name: ::String,
+                                        ignore_coordinates: Array[::String]?
+                                      },
+                                    ]?,
+                                    base_canary_run_id: ::String
+                                  },
+                                  ?artifact_s3_location: ::String,
+                                  ?artifact_config: {
+                                    s3_encryption: {
+                                      encryption_mode: ("SSE_S3" | "SSE_KMS")?,
+                                      kms_key_arn: ::String?
+                                    }?
+                                  },
+                                  ?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
+                                ) -> _StartCanaryDryRunResponseSuccess
+                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCanaryDryRunResponseSuccess
+
       interface _StopCanaryResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::StopCanaryResponse]
       end
@@ -378,7 +430,8 @@ module Aws
                                kms_key_arn: ::String?
                              }?
                            },
-                           ?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
+                           ?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF"),
+                           ?dry_run_id: ::String
                          ) -> _UpdateCanaryResponseSuccess
                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCanaryResponseSuccess
     end

data/sig/errors.rbs

@@ -11,6 +11,9 @@ module Aws
       class ServiceError < ::Aws::Errors::ServiceError
       end
 
+      class AccessDeniedException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
       class BadRequestException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end

data/sig/types.rbs

@@ -8,6 +8,11 @@
 module Aws::Synthetics
   module Types
 
+    class AccessDeniedException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class ArtifactConfigInput
       attr_accessor s3_encryption: Types::S3EncryptionConfig
       SENSITIVE: []
@@ -57,6 +62,7 @@ module Aws::Synthetics
       attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
       attr_accessor tags: ::Hash[::String, ::String]
       attr_accessor artifact_config: Types::ArtifactConfigOutput
+      attr_accessor dry_run_config: Types::DryRunConfigOutput
       SENSITIVE: []
     end
 
@@ -75,6 +81,11 @@ module Aws::Synthetics
       SENSITIVE: []
     end
 
+    class CanaryDryRunConfigOutput
+      attr_accessor dry_run_id: ::String
+      SENSITIVE: []
+    end
+
     class CanaryLastRun
       attr_accessor canary_name: ::String
       attr_accessor last_run: Types::CanaryRun
@@ -87,6 +98,7 @@ module Aws::Synthetics
       attr_accessor status: Types::CanaryRunStatus
       attr_accessor timeline: Types::CanaryRunTimeline
       attr_accessor artifact_s3_location: ::String
+      attr_accessor dry_run_config: Types::CanaryDryRunConfigOutput
       SENSITIVE: []
     end
 
@@ -248,8 +260,15 @@ module Aws::Synthetics
     class DisassociateResourceResponse < Aws::EmptyStructure
     end
 
+    class DryRunConfigOutput
+      attr_accessor dry_run_id: ::String
+      attr_accessor last_dry_run_execution_status: ::String
+      SENSITIVE: []
+    end
+
     class GetCanaryRequest
       attr_accessor name: ::String
+      attr_accessor dry_run_id: ::String
       SENSITIVE: []
     end
 
@@ -262,6 +281,8 @@ module Aws::Synthetics
       attr_accessor name: ::String
       attr_accessor next_token: ::String
       attr_accessor max_results: ::Integer
+      attr_accessor dry_run_id: ::String
+      attr_accessor run_type: ("CANARY_RUN" | "DRY_RUN")
       SENSITIVE: []
     end
 
@@ -390,6 +411,27 @@ module Aws::Synthetics
       SENSITIVE: []
     end
 
+    class StartCanaryDryRunRequest
+      attr_accessor name: ::String
+      attr_accessor code: Types::CanaryCodeInput
+      attr_accessor runtime_version: ::String
+      attr_accessor run_config: Types::CanaryRunConfigInput
+      attr_accessor vpc_config: Types::VpcConfigInput
+      attr_accessor execution_role_arn: ::String
+      attr_accessor success_retention_period_in_days: ::Integer
+      attr_accessor failure_retention_period_in_days: ::Integer
+      attr_accessor visual_reference: Types::VisualReferenceInput
+      attr_accessor artifact_s3_location: ::String
+      attr_accessor artifact_config: Types::ArtifactConfigInput
+      attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
+      SENSITIVE: []
+    end
+
+    class StartCanaryDryRunResponse
+      attr_accessor dry_run_config: Types::DryRunConfigOutput
+      SENSITIVE: []
+    end
+
     class StartCanaryRequest
       attr_accessor name: ::String
       SENSITIVE: []
@@ -443,6 +485,7 @@ module Aws::Synthetics
       attr_accessor artifact_s3_location: ::String
       attr_accessor artifact_config: Types::ArtifactConfigInput
       attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
+      attr_accessor dry_run_id: ::String
       SENSITIVE: []
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.62.0
+  version: 1.63.0
 platform: ruby
 authors:
 - Amazon Web Services