class Aws::Synthetics::Types::VisualReferenceInput

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]

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html [2]: 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 docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/VisualReferenceInput AWS API Documentation

Constants

SENSITIVE