VisualReferenceOutput - Amazon CloudWatch Synthetics

VisualReferenceOutput

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.

Contents

BaseCanaryRunId

The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

Type: String

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

Required: No

BaseScreenshots

An array of screenshots that are used as the baseline for comparisons during visual monitoring.

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: