Skip to content

VisualReferenceInput

Used by
Source code in docs_src/capo_synthetics/types/visual_reference_input.py 
15
16
17
18
19
20
21
22
23
class VisualReferenceInput(TypedDict, closed=True):
    base_screenshots: NotRequired[
        "capo_synthetics.types.base_screenshots.BaseScreenshots"
    ]
    """<p>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.</p>"""
    base_canary_run_id: "capo_synthetics.types.string.String"
    """<p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run before this update was made, or the value of <code>Id</code> in the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html"> CanaryRun</a> from a run of this a canary in the past 31 days. If you specify the <code>Id</code> of a canary run older than 31 days, the operation returns a 400 validation exception error..</p>"""
    browser_type: NotRequired["capo_synthetics.types.browser_type.BrowserType"]
    """<p>The browser type associated with this visual reference.</p>"""

base_canary_run_id instance-attribute 

base_canary_run_id: String

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 a run of this a canary in the past 31 days. If you specify the Id of a canary run older than 31 days, the operation returns a 400 validation exception error..

base_screenshots instance-attribute 

base_screenshots: NotRequired[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.

browser_type instance-attribute 

browser_type: NotRequired[BrowserType]

The browser type associated with this visual reference.