Class: Aws::Synthetics::Types::BaseScreenshot
- Inherits:
-
Struct
- Object
- Struct
- Aws::Synthetics::Types::BaseScreenshot
- Defined in:
- gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb
Overview
Note:
When making an API call, you may pass BaseScreenshot data as a hash:
{
screenshot_name: "String", # required
ignore_coordinates: ["BaseScreenshotConfigIgnoreCoordinate"],
}
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 Logs console to draw the boundaries on the screen. For more information, see {LINK\}
91 92 93 94 95 96 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 91 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.
91 92 93 94 95 96 |
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 91 class BaseScreenshot < Struct.new( :screenshot_name, :ignore_coordinates) SENSITIVE = [] include Aws::Structure end |