aws-sdk-synthetics 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db80a522c3f6d7168b445efac5e7539a72b6029263d374ce9110a7e640fd740
-  data.tar.gz: b16a936acc0d399d54f67dfd7cb2639fa52e869601af1f6e30137fa3e1024e18
+  metadata.gz: 66a65c42837b8e51d5b78de7c96423feb6b7fd11676689afc24ecd51ad4980b1
+  data.tar.gz: 6533e4402aaef3d3e0bd9acba7898094b3735e6c82a90b0b9716b714efcfa92d
 SHA512:
-  metadata.gz: dc04bce407c6caa14ce796576f0e1007b5330337c6c02ce058227eba25cba42efe5c9884e95b51d88941af9171ccb13aa567523e3b163e16e82527246be83813
-  data.tar.gz: a93d2cb12e090cf0bc1b9e3781dd3e06dd9e1b440f5d176ac35fdf2d7e278e8675a107e63af8f27f65a4b6c0455e65ae4e40fba9ee4fad8238517174aa61793c
+  metadata.gz: 3211f791840cffcc86db0581dbedcf10a335151174d1499bcf7ef30ed18885d1d355af138a551391736ade24692ca3b2aa5a181818e5008a765fd6ea0a70495d
+  data.tar.gz: '03559aeb71f154a69d7ceaa237780c601e2de8b2d0d4aac64ec7d04f0a04b38ae5a67409a20418c0c49cd897cb7351857c1178e242b8c2a216416af5ff9daab3'

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 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)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.15.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.15.0'
+  GEM_VERSION = '1.16.0'
 
 end

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

@@ -1132,6 +1132,19 @@ 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}.
     #
@@ -1199,7 +1212,7 @@ module Aws::Synthetics
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.15.0'
+      context[:gem_version] = '1.16.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -10,6 +10,9 @@
 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:
     #
@@ -19,9 +22,16 @@ module Aws::Synthetics
     #       }
     #
     # @!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
@@ -119,6 +129,10 @@ module Aws::Synthetics
     #   @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
@@ -188,7 +202,7 @@ module Aws::Synthetics
     #   If you input your canary script directly into the canary instead of
     #   referring to an S3 location, the value of this parameter is the
     #   base64-encoded contents of the .zip file that contains the script.
-    #   It can be up to 5 MB.
+    #   It must be smaller than 256 Kb.
     #   @return [String]
     #
     # @!attribute [rw] handler
@@ -1368,6 +1382,19 @@ module Aws::Synthetics
     #   @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
@@ -1404,6 +1431,19 @@ 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:
     #
@@ -1418,9 +1458,23 @@ module Aws::Synthetics
     #       }
     #
     # @!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
@@ -1432,10 +1486,23 @@ module Aws::Synthetics
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core