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.VisualReferenceInput

Description

Synopsis

data VisualReferenceInput = VisualReferenceInput' {
- baseScreenshots :: Maybe [BaseScreenshot]
- baseCanaryRunId :: Text
}
newVisualReferenceInput :: Text -> VisualReferenceInput
visualReferenceInput_baseScreenshots :: Lens' VisualReferenceInput (Maybe [BaseScreenshot])
visualReferenceInput_baseCanaryRunId :: Lens' VisualReferenceInput Text

Documentation

data VisualReferenceInput Source #

An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison.

Visual monitoring is supported only on canaries running the syn-puppeteer-node-3.2 runtime or later. For more information, see Visual monitoring and Visual monitoring blueprint

See: newVisualReferenceInput smart constructor.

Constructors

VisualReferenceInput'

Fields

baseScreenshots :: Maybe [BaseScreenshot]
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.
baseCanaryRunId :: Text
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 any past run of this canary.

Instances

Instances details

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

newVisualReferenceInput Source #

Arguments

:: Text	`$sel:baseCanaryRunId:VisualReferenceInput'`
-> VisualReferenceInput

Create a value of VisualReferenceInput 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:baseScreenshots:VisualReferenceInput', visualReferenceInput_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.

$sel:baseCanaryRunId:VisualReferenceInput', visualReferenceInput_baseCanaryRunId - 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 any past run of this canary.

visualReferenceInput_baseScreenshots :: Lens' VisualReferenceInput (Maybe [BaseScreenshot]) Source #

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.

visualReferenceInput_baseCanaryRunId :: Lens' VisualReferenceInput Text Source #

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 any past run of this canary.