Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Synthetics.Types.VisualReferenceOutput

Description

Documentation

data VisualReferenceOutput Source #

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.

See: newVisualReferenceOutput smart constructor.

Constructors

VisualReferenceOutput'
Fields baseCanaryRunId :: Maybe Text The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary. baseScreenshots :: Maybe [BaseScreenshot] An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Instances

Instances details

FromJSON VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods parseJSON :: Value -> Parser VisualReferenceOutput # parseJSONList :: Value -> Parser [VisualReferenceOutput] #
Generic VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Associated Types type Rep VisualReferenceOutput :: Type -> Type # Methods from :: VisualReferenceOutput -> Rep VisualReferenceOutput x # to :: Rep VisualReferenceOutput x -> VisualReferenceOutput #
Read VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods readsPrec :: Int -> ReadS VisualReferenceOutput # readList :: ReadS [VisualReferenceOutput] # readPrec :: ReadPrec VisualReferenceOutput # readListPrec :: ReadPrec [VisualReferenceOutput] #
Show VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods showsPrec :: Int -> VisualReferenceOutput -> ShowS # show :: VisualReferenceOutput -> String # showList :: [VisualReferenceOutput] -> ShowS #
NFData VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods rnf :: VisualReferenceOutput -> () #
Eq VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods (==) :: VisualReferenceOutput -> VisualReferenceOutput -> Bool # (/=) :: VisualReferenceOutput -> VisualReferenceOutput -> Bool #
Hashable VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput Methods hashWithSalt :: Int -> VisualReferenceOutput -> Int # hash :: VisualReferenceOutput -> Int #
type Rep VisualReferenceOutput Source #
Instance details Defined in Amazonka.Synthetics.Types.VisualReferenceOutput type Rep VisualReferenceOutput = D1 ('MetaData "VisualReferenceOutput" "Amazonka.Synthetics.Types.VisualReferenceOutput" "amazonka-synthetics-2.0-3I8gICXDswl2F1HDbijRHZ" 'False) (C1 ('MetaCons "VisualReferenceOutput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "baseCanaryRunId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "baseScreenshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BaseScreenshot]))))

newVisualReferenceOutput :: VisualReferenceOutput Source #

Create a value of VisualReferenceOutput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:baseCanaryRunId:VisualReferenceOutput', visualReferenceOutput_baseCanaryRunId - The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.

$sel:baseScreenshots:VisualReferenceOutput', visualReferenceOutput_baseScreenshots - An array of screenshots that are used as the baseline for comparisons during visual monitoring.

visualReferenceOutput_baseCanaryRunId :: Lens' VisualReferenceOutput (Maybe Text) Source #

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

visualReferenceOutput_baseScreenshots :: Lens' VisualReferenceOutput (Maybe [BaseScreenshot]) Source #

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