aws-sdk-synthetics 1.12.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a1283a3daadbe3a3958037062410f9a5a98b1b5cb653b65001e9ffb0fc82b48
-  data.tar.gz: 652ac07c0a9f08c2434509878bfadcb5653f761a334f15e9652eba7454052e64
+  metadata.gz: 66a65c42837b8e51d5b78de7c96423feb6b7fd11676689afc24ecd51ad4980b1
+  data.tar.gz: 6533e4402aaef3d3e0bd9acba7898094b3735e6c82a90b0b9716b714efcfa92d
 SHA512:
-  metadata.gz: 21e91a8c3c5343fe05a3a0184f63f33472f435eba5186387f3286c492e0d573faab33233ad5646ab318bab395debe36bf0dcdc84b63cf6727d0868b359ccf053
-  data.tar.gz: 65718bd9b946c49f59c46d8c19d6e7ea99629689801403c956ab7108ceaaa2518156819918bdfd18a99fce727ce0a2dc0667b70492a5137a0b7b51b59f935cec
+  metadata.gz: 3211f791840cffcc86db0581dbedcf10a335151174d1499bcf7ef30ed18885d1d355af138a551391736ade24692ca3b2aa5a181818e5008a765fd6ea0a70495d
+  data.tar.gz: '03559aeb71f154a69d7ceaa237780c601e2de8b2d0d4aac64ec7d04f0a04b38ae5a67409a20418c0c49cd897cb7351857c1178e242b8c2a216416af5ff9daab3'

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 Unreleased Changes
 ------------------
 
+1.16.0 (2021-08-06)
+------------------
+
+* Feature - Documentation updates for Visual Monitoring feature and other doc ticket fixes.
+
+1.15.0 (2021-07-30)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.14.0 (2021-07-28)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.13.0 (2021-07-26)
+------------------
+
+* Feature - CloudWatch Synthetics now supports visual testing in its canaries.
+
 1.12.0 (2021-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.16.0

data/lib/aws-sdk-synthetics.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-synthetics/customizations'
 # @!group service
 module Aws::Synthetics
 
-  GEM_VERSION = '1.12.0'
+  GEM_VERSION = '1.16.0'
 
 end

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

@@ -375,7 +375,7 @@ module Aws::Synthetics
     # @option params [required, 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.
+    #   and HAR files. The name of the S3 bucket can't include a period (.).
     #
     # @option params [required, String] :execution_role_arn
     #   The ARN of the IAM role to be used to run the canary. This role must
@@ -511,6 +511,11 @@ module Aws::Synthetics
     #   resp.canary.vpc_config.subnet_ids[0] #=> String
     #   resp.canary.vpc_config.security_group_ids #=> Array
     #   resp.canary.vpc_config.security_group_ids[0] #=> String
+    #   resp.canary.visual_reference.base_screenshots #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #
@@ -637,6 +642,11 @@ module Aws::Synthetics
     #   resp.canaries[0].vpc_config.subnet_ids[0] #=> String
     #   resp.canaries[0].vpc_config.security_group_ids #=> Array
     #   resp.canaries[0].vpc_config.security_group_ids[0] #=> String
+    #   resp.canaries[0].visual_reference.base_screenshots #=> Array
+    #   resp.canaries[0].visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canaries[0].visual_reference.base_canary_run_id #=> String
     #   resp.canaries[0].tags #=> Hash
     #   resp.canaries[0].tags["TagKey"] #=> String
     #   resp.next_token #=> String
@@ -799,6 +809,11 @@ module Aws::Synthetics
     #   resp.canary.vpc_config.subnet_ids[0] #=> String
     #   resp.canary.vpc_config.security_group_ids #=> Array
     #   resp.canary.vpc_config.security_group_ids[0] #=> String
+    #   resp.canary.visual_reference.base_screenshots #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].screenshot_name #=> String
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
+    #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
+    #   resp.canary.visual_reference.base_canary_run_id #=> String
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #
@@ -968,8 +983,8 @@ module Aws::Synthetics
     # use them to scope user permissions, by granting a user permission to
     # access or change only resources with certain tag values.
     #
-    # Tags don't have any semantic meaning to AWS and are interpreted
-    # strictly as strings of characters.
+    # Tags don't have any semantic meaning to Amazon Web Services and are
+    # interpreted strictly as strings of characters.
     #
     # You can use the `TagResource` action with a canary that already has
     # tags. If you specify a new tag key for the alarm, this tag is appended
@@ -1116,6 +1131,21 @@ module Aws::Synthetics
     #
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #
+    # @option params [Types::VisualReferenceInput] :visual_reference
+    #   Defines the screenshots to use as the baseline for comparisons during
+    #   visual monitoring comparisons during future runs of this canary. If
+    #   you omit this parameter, no changes are made to any baseline
+    #   screenshots that the canary might be using already.
+    #
+    #   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 [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -1149,6 +1179,15 @@ module Aws::Synthetics
     #       subnet_ids: ["SubnetId"],
     #       security_group_ids: ["SecurityGroupId"],
     #     },
+    #     visual_reference: {
+    #       base_screenshots: [
+    #         {
+    #           screenshot_name: "String", # required
+    #           ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #         },
+    #       ],
+    #       base_canary_run_id: "String", # required
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
@@ -1173,7 +1212,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -13,6 +13,10 @@ module Aws::Synthetics
 
     include Seahorse::Model
 
+    BaseScreenshot = Shapes::StructureShape.new(name: 'BaseScreenshot')
+    BaseScreenshotConfigIgnoreCoordinate = Shapes::StringShape.new(name: 'BaseScreenshotConfigIgnoreCoordinate')
+    BaseScreenshotIgnoreCoordinates = Shapes::ListShape.new(name: 'BaseScreenshotIgnoreCoordinates')
+    BaseScreenshots = Shapes::ListShape.new(name: 'BaseScreenshots')
     Blob = Shapes::BlobShape.new(name: 'Blob')
     Canaries = Shapes::ListShape.new(name: 'Canaries')
     CanariesLastRun = Shapes::ListShape.new(name: 'CanariesLastRun')
@@ -93,10 +97,20 @@ module Aws::Synthetics
     UpdateCanaryRequest = Shapes::StructureShape.new(name: 'UpdateCanaryRequest')
     UpdateCanaryResponse = Shapes::StructureShape.new(name: 'UpdateCanaryResponse')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
+    VisualReferenceInput = Shapes::StructureShape.new(name: 'VisualReferenceInput')
+    VisualReferenceOutput = Shapes::StructureShape.new(name: 'VisualReferenceOutput')
     VpcConfigInput = Shapes::StructureShape.new(name: 'VpcConfigInput')
     VpcConfigOutput = Shapes::StructureShape.new(name: 'VpcConfigOutput')
     VpcId = Shapes::StringShape.new(name: 'VpcId')
 
+    BaseScreenshot.add_member(:screenshot_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "ScreenshotName"))
+    BaseScreenshot.add_member(:ignore_coordinates, Shapes::ShapeRef.new(shape: BaseScreenshotIgnoreCoordinates, location_name: "IgnoreCoordinates"))
+    BaseScreenshot.struct_class = Types::BaseScreenshot
+
+    BaseScreenshotIgnoreCoordinates.member = Shapes::ShapeRef.new(shape: BaseScreenshotConfigIgnoreCoordinate)
+
+    BaseScreenshots.member = Shapes::ShapeRef.new(shape: BaseScreenshot)
+
     Canaries.member = Shapes::ShapeRef.new(shape: Canary)
 
     CanariesLastRun.member = Shapes::ShapeRef.new(shape: CanaryLastRun)
@@ -115,6 +129,7 @@ module Aws::Synthetics
     Canary.add_member(:engine_arn, Shapes::ShapeRef.new(shape: FunctionArn, location_name: "EngineArn"))
     Canary.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
     Canary.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigOutput, location_name: "VpcConfig"))
+    Canary.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceOutput, location_name: "VisualReference"))
     Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     Canary.struct_class = Types::Canary
 
@@ -307,6 +322,7 @@ module Aws::Synthetics
     UpdateCanaryRequest.add_member(:success_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "SuccessRetentionPeriodInDays"))
     UpdateCanaryRequest.add_member(:failure_retention_period_in_days, Shapes::ShapeRef.new(shape: MaxSize1024, location_name: "FailureRetentionPeriodInDays"))
     UpdateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
+    UpdateCanaryRequest.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceInput, location_name: "VisualReference"))
     UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
 
     UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse
@@ -314,6 +330,14 @@ module Aws::Synthetics
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
     ValidationException.struct_class = Types::ValidationException
 
+    VisualReferenceInput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
+    VisualReferenceInput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "BaseCanaryRunId"))
+    VisualReferenceInput.struct_class = Types::VisualReferenceInput
+
+    VisualReferenceOutput.add_member(:base_screenshots, Shapes::ShapeRef.new(shape: BaseScreenshots, location_name: "BaseScreenshots"))
+    VisualReferenceOutput.add_member(:base_canary_run_id, Shapes::ShapeRef.new(shape: String, location_name: "BaseCanaryRunId"))
+    VisualReferenceOutput.struct_class = Types::VisualReferenceOutput
+
     VpcConfigInput.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, location_name: "SubnetIds"))
     VpcConfigInput.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, location_name: "SecurityGroupIds"))
     VpcConfigInput.struct_class = Types::VpcConfigInput

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

@@ -10,6 +10,39 @@
 module Aws::Synthetics
   module Types
 
+    # A structure representing a screenshot that is used as a baseline
+    # during visual monitoring comparisons made by the canary.
+    #
+    # @note When making an API call, you may pass BaseScreenshot
+    #   data as a hash:
+    #
+    #       {
+    #         screenshot_name: "String", # required
+    #         ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #       }
+    #
+    # @!attribute [rw] screenshot_name
+    #   The name of the screenshot. This is generated the first time the
+    #   canary is run after the `UpdateCanary` operation that specified for
+    #   this canary to perform visual monitoring.
+    #   @return [String]
+    #
+    # @!attribute [rw] ignore_coordinates
+    #   Coordinates that define the part of a screen to ignore during
+    #   screenshot comparisons. To obtain the coordinates to use here, use
+    #   the CloudWatch Logs console to draw the boundaries on the screen.
+    #   For more information, see \\\{LINK\\}
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/BaseScreenshot AWS API Documentation
+    #
+    class BaseScreenshot < Struct.new(
+      :screenshot_name,
+      :ignore_coordinates)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # This structure contains all information about one canary in your
     # account.
     #
@@ -95,6 +128,13 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #   @return [Types::VpcConfigOutput]
     #
+    # @!attribute [rw] visual_reference
+    #   If this canary performs visual monitoring by comparing screenshots,
+    #   this structure contains the ID of the canary run to use as the
+    #   baseline for screenshots, and the coordinates of any parts of the
+    #   screen to ignore during the visual monitoring comparison.
+    #   @return [Types::VisualReferenceOutput]
+    #
     # @!attribute [rw] tags
     #   The list of key-value pairs that are associated with the canary.
     #   @return [Hash<String,String>]
@@ -116,6 +156,7 @@ module Aws::Synthetics
       :engine_arn,
       :runtime_version,
       :vpc_config,
+      :visual_reference,
       :tags)
       SENSITIVE = []
       include Aws::Structure
@@ -140,9 +181,8 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] s3_bucket
-    #   If your canary script is located in S3, specify the full bucket name
-    #   here. The bucket must already exist. Specify the full bucket name,
-    #   including `s3://` as the start of the bucket name.
+    #   If your canary script is located in S3, specify the bucket name
+    #   here. Do not include `s3://` as the start of the bucket name.
     #   @return [String]
     #
     # @!attribute [rw] s3_key
@@ -160,13 +200,15 @@ module Aws::Synthetics
     #
     # @!attribute [rw] zip_file
     #   If you input your canary script directly into the canary instead of
-    #   referring to an S3 location, the value of this parameter is the .zip
-    #   file that contains the script. It can be up to 5 MB.
+    #   referring to an S3 location, the value of this parameter is the
+    #   base64-encoded contents of the .zip file that contains the script.
+    #   It must be smaller than 256 Kb.
     #   @return [String]
     #
     # @!attribute [rw] handler
     #   The entry point to use for the source code when running the canary.
-    #   This value must end with the string `.handler`.
+    #   This value must end with the string `.handler`. The string is
+    #   limited to 29 characters or fewer.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryCodeInput AWS API Documentation
@@ -286,12 +328,12 @@ module Aws::Synthetics
     #   @return [Integer]
     #
     # @!attribute [rw] active_tracing
-    #   Specifies whether this canary is to use active AWS X-Ray tracing
-    #   when it runs. Active tracing enables this canary run to be displayed
-    #   in the ServiceLens and X-Ray service maps even if the canary does
-    #   not hit an endpoint that has X-ray tracing enabled. Using X-Ray
-    #   tracing incurs charges. For more information, see [ Canaries and
-    #   X-Ray tracing][1].
+    #   Specifies whether this canary is to use active X-Ray tracing when it
+    #   runs. Active tracing enables this canary run to be displayed in the
+    #   ServiceLens and X-Ray service maps even if the canary does not hit
+    #   an endpoint that has X-Ray tracing enabled. Using X-Ray tracing
+    #   incurs charges. For more information, see [ Canaries and X-Ray
+    #   tracing][1].
     #
     #   You can enable active tracing only for canaries that use version
     #   `syn-nodejs-2.0` or later for their canary runtime.
@@ -341,7 +383,7 @@ module Aws::Synthetics
     #   @return [Integer]
     #
     # @!attribute [rw] active_tracing
-    #   Displays whether this canary run used active AWS X-Ray tracing.
+    #   Displays whether this canary run used active X-Ray tracing.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/CanaryRunConfigOutput AWS API Documentation
@@ -413,9 +455,11 @@ module Aws::Synthetics
     #       }
     #
     # @!attribute [rw] expression
-    #   A rate expression that defines how often the canary is to run. The
-    #   syntax is `rate(number unit)`. *unit* can be `minute`, `minutes`, or
-    #   `hour`.
+    #   A `rate` expression or a `cron` expression that defines how often
+    #   the canary is to run.
+    #
+    #   For a rate expression, The syntax is `rate(number unit)`. *unit* can
+    #   be `minute`, `minutes`, or `hour`.
     #
     #   For example, `rate(1 minute)` runs the canary once a minute,
     #   `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
@@ -424,6 +468,15 @@ module Aws::Synthetics
     #
     #   Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
     #   that causes the canary to run only once when it is started.
+    #
+    #   Use `cron(expression)` to specify a cron expression. You can't
+    #   schedule a canary to wait for more than a year before running. For
+    #   information about the syntax for cron expressions, see [ Scheduling
+    #   canary runs using cron][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
     #   @return [String]
     #
     # @!attribute [rw] duration_in_seconds
@@ -446,16 +499,27 @@ module Aws::Synthetics
     # according to the schedule in the `Expression` value.
     #
     # @!attribute [rw] expression
-    #   A rate expression that defines how often the canary is to run. The
-    #   syntax is `rate(number unit)`. *unit* can be `minute`, `minutes`, or
-    #   `hour`.
+    #   A `rate` expression or a `cron` expression that defines how often
+    #   the canary is to run.
+    #
+    #   For a rate expression, The syntax is `rate(number unit)`. *unit* can
+    #   be `minute`, `minutes`, or `hour`.
     #
     #   For example, `rate(1 minute)` runs the canary once a minute,
     #   `rate(10 minutes)` runs it once every 10 minutes, and `rate(1 hour)`
-    #   runs it once every hour.
+    #   runs it once every hour. You can specify a frequency between `rate(1
+    #   minute)` and `rate(1 hour)`.
     #
     #   Specifying `rate(0 minute)` or `rate(0 hour)` is a special value
     #   that causes the canary to run only once when it is started.
+    #
+    #   Use `cron(expression)` to specify a cron expression. For information
+    #   about the syntax for cron expressions, see [ Scheduling canary runs
+    #   using cron][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_cron.html
     #   @return [String]
     #
     # @!attribute [rw] duration_in_seconds
@@ -604,7 +668,8 @@ module Aws::Synthetics
     # @!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.
+    #   screenshots, and HAR files. The name of the S3 bucket can't include
+    #   a period (.).
     #   @return [String]
     #
     # @!attribute [rw] execution_role_arn
@@ -1227,6 +1292,15 @@ module Aws::Synthetics
     #           subnet_ids: ["SubnetId"],
     #           security_group_ids: ["SecurityGroupId"],
     #         },
+    #         visual_reference: {
+    #           base_screenshots: [
+    #             {
+    #               screenshot_name: "String", # required
+    #               ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #             },
+    #           ],
+    #           base_canary_run_id: "String", # required
+    #         },
     #       }
     #
     # @!attribute [rw] name
@@ -1307,6 +1381,22 @@ module Aws::Synthetics
     #   [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_VPC.html
     #   @return [Types::VpcConfigInput]
     #
+    # @!attribute [rw] visual_reference
+    #   Defines the screenshots to use as the baseline for comparisons
+    #   during visual monitoring comparisons during future runs of this
+    #   canary. If you omit this parameter, no changes are made to any
+    #   baseline screenshots that the canary might be using already.
+    #
+    #   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]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
     #
     class UpdateCanaryRequest < Struct.new(
@@ -1318,7 +1408,8 @@ module Aws::Synthetics
       :run_config,
       :success_retention_period_in_days,
       :failure_retention_period_in_days,
-      :vpc_config)
+      :vpc_config,
+      :visual_reference)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1340,6 +1431,89 @@ module Aws::Synthetics
       include Aws::Structure
     end
 
+    # An object that specifies what screenshots to use as a baseline for
+    # visual monitoring by this canary, and optionally the 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
+    #
+    # @note When making an API call, you may pass VisualReferenceInput
+    #   data as a hash:
+    #
+    #       {
+    #         base_screenshots: [
+    #           {
+    #             screenshot_name: "String", # required
+    #             ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
+    #           },
+    #         ],
+    #         base_canary_run_id: "String", # required
+    #       }
+    #
+    # @!attribute [rw] base_screenshots
+    #   An array of screenshots that will be used as the baseline for visual
+    #   monitoring in future runs of this canary. If there is a screenshot
+    #   that you don't want to be used for visual monitoring, remove it
+    #   from this array.
+    #   @return [Array<Types::BaseScreenshot>]
+    #
+    # @!attribute [rw] base_canary_run_id
+    #   Specifies which canary run to use the screenshots from as the
+    #   baseline for future visual monitoring with this canary. Valid values
+    #   are `nextrun` to use the screenshots from the next run after this
+    #   update is made, `lastrun` to use the screenshots from the most
+    #   recent run before this update was made, or the value of `Id` in the
+    #   [ CanaryRun][1] from any past run of this canary.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation
+    #
+    class VisualReferenceInput < Struct.new(
+      :base_screenshots,
+      :base_canary_run_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # If this canary performs visual monitoring by comparing screenshots,
+    # this structure contains the ID of the canary run that is used as the
+    # baseline for screenshots, and the coordinates of any parts of those
+    # screenshots that are ignored during visual monitoring comparison.
+    #
+    # Visual monitoring is supported only on canaries running the
+    # **syn-puppeteer-node-3.2** runtime or later.
+    #
+    # @!attribute [rw] base_screenshots
+    #   An array of screenshots that are used as the baseline for
+    #   comparisons during visual monitoring.
+    #   @return [Array<Types::BaseScreenshot>]
+    #
+    # @!attribute [rw] base_canary_run_id
+    #   The ID of the canary run that produced the screenshots that are used
+    #   as the baseline for visual monitoring comparisons during future runs
+    #   of this canary.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceOutput AWS API Documentation
+    #
+    class VisualReferenceOutput < Struct.new(
+      :base_screenshots,
+      :base_canary_run_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # 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].

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.112.0
+        version: 3.119.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.112.0
+        version: 3.119.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ homepage: https://github.com/aws/aws-sdk-ruby
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-synthetics
-  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-synthetics/CHANGELOG.md
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/version-3/gems/aws-sdk-synthetics/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -83,8 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - Synthetics