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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2664
2665
2666
2667
2668
2669
2670
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 2664

class VisualReferenceOutput < Struct.new(
  :base_screenshots,
  :base_canary_run_id,
  :browser_type)
  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.

Returns:



2664
2665
2666
2667
2668
2669
2670
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 2664

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

#browser_type ⇒ String

The browser type associated with this visual reference.

Returns:

  • (String) 


2664
2665
2666
2667
2668
2669
2670
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 2664

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