Class: Aws::Synthetics::Types::BaseScreenshot

Inherits:

Struct

Object
Struct
Aws::Synthetics::Types::BaseScreenshot

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-synthetics/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#ignore_coordinates ⇒ Array<String>

Coordinates that define the part of a screen to ignore during screenshot comparisons.
#screenshot_name ⇒ String

The name of the screenshot.

Instance Attribute Details

#ignore_coordinates ⇒ `Array<String>`

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]

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html

Returns:

(Array<String>)

# File 'lib/aws-sdk-synthetics/types.rb', line 113

class BaseScreenshot < Struct.new(
  :screenshot_name,
  :ignore_coordinates)
  SENSITIVE = []
  include Aws::Structure
end

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