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

Inherits:

Struct

Object
Struct
Aws::Synthetics::Types::VisualReferenceOutput

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

#base_canary_run_id ⇒ String
The ID of the canary run that produced the baseline screenshots that are used for visual monitoring comparisons by this canary.
#base_screenshots ⇒ Array<Types::BaseScreenshot>
An array of screenshots that are used as the baseline for comparisons during visual monitoring.

Instance Attribute Details

#base_canary_run_id ⇒ `String`

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

Returns:

(String)

# 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_screenshots ⇒ `Array<Types::BaseScreenshot>`

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