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

Description

Synopsis

data BaseScreenshot = BaseScreenshot' {
- ignoreCoordinates :: Maybe [Text]
- screenshotName :: Text
}
newBaseScreenshot :: Text -> BaseScreenshot
baseScreenshot_ignoreCoordinates :: Lens' BaseScreenshot (Maybe [Text])
baseScreenshot_screenshotName :: Lens' BaseScreenshot Text

Documentation

data BaseScreenshot Source #

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

See: newBaseScreenshot smart constructor.

Constructors

BaseScreenshot'

Fields

ignoreCoordinates :: Maybe [Text]
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
screenshotName :: Text
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.

Instances

Instances details

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

newBaseScreenshot Source #

Arguments

:: Text	`$sel:screenshotName:BaseScreenshot'`
-> BaseScreenshot

Create a value of BaseScreenshot 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:ignoreCoordinates:BaseScreenshot', baseScreenshot_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

$sel:screenshotName:BaseScreenshot', baseScreenshot_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.

baseScreenshot_ignoreCoordinates :: Lens' BaseScreenshot (Maybe [Text]) Source #

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

baseScreenshot_screenshotName :: Lens' BaseScreenshot Text Source #

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.