VisualReferenceInput - Amazon CloudWatch Synthetics

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 and Visual monitoring blueprint

Contents

BaseCanaryRunId

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 from any past run of this canary.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

BaseScreenshots

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.

Type: Array of BaseScreenshot objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: