Skip to content

BaseScreenshot

Source code in docs_src/capo_synthetics/types/base_screenshot.py 
14
15
16
17
18
19
20
class BaseScreenshot(TypedDict, closed=True):
    screenshot_name: "capo_synthetics.types.string.String"
    """<p>The name of the screenshot. This is generated the first time the canary is run after the <code>UpdateCanary</code> operation that specified for this canary to perform visual monitoring.</p>"""
    ignore_coordinates: NotRequired[
        "capo_synthetics.types.base_screenshot_ignore_coordinates.BaseScreenshotIgnoreCoordinates"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html"> Editing or deleting a canary</a> </p>"""

ignore_coordinates instance-attribute 

ignore_coordinates: NotRequired[BaseScreenshotIgnoreCoordinates]

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

screenshot_name instance-attribute 

screenshot_name: String

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.