Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::Synthetics::Types::VisualReferenceOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#base_canary_run_idString

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

Returns:

  • (String)

1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1957

class VisualReferenceOutput < Struct.new(
  :base_screenshots,
  :base_canary_run_id)
  SENSITIVE = []
  include Aws::Structure
end

#base_screenshotsArray<Types::BaseScreenshot>

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

Returns:


1957
1958
1959
1960
1961
1962
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 1957

class VisualReferenceOutput < Struct.new(
  :base_screenshots,
  :base_canary_run_id)
  SENSITIVE = []
  include Aws::Structure
end