BaseScreenshot - Amazon CloudWatch Synthetics

BaseScreenshot

A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary.

Contents

IgnoreCoordinates

Coordinates that define the part of a screen to ignore during screenshot comparisons. To obtain the coordinates to use here, use the CloudWatch console to draw the boundaries on the screen. For more information, see Editing or deleting a canary

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Pattern: ^(-?\d{1,5}\.?\d{0,2},){3}(-?\d{1,5}\.?\d{0,2}){1}$

Required: No

ScreenshotName

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.

Type: String

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

Required: Yes

See Also

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