AWS cli documentation change
Summary
Added new parameters --browser-configs and --visual-references to configure browser types and visual monitoring baselines for canary runs. Updated CLI version reference from 2.28.15 to 2.28.16.
Security assessment
The changes introduce documentation for visual monitoring capabilities and browser configuration options, which are security-adjacent features for monitoring application integrity. However, there is no evidence of addressing a specific vulnerability or security incident. The visual references feature helps detect UI changes that could indicate security breaches, but this is presented as a monitoring enhancement rather than a vulnerability fix.
Diff
diff --git a/cli/latest/reference/synthetics/start-canary-dry-run.md b/cli/latest/reference/synthetics/start-canary-dry-run.md index 371b86d59..bc0e89f3f 100644 --- a//cli/latest/reference/synthetics/start-canary-dry-run.md +++ b//cli/latest/reference/synthetics/start-canary-dry-run.md @@ -15 +15 @@ - * [AWS CLI 2.28.15 Command Reference](../../index.html) » + * [AWS CLI 2.28.16 Command Reference](../../index.html) » @@ -78,0 +79,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/synthe + [--browser-configs <value>] + [--visual-references <value>] @@ -322,0 +325,4 @@ JSON Syntax: +> +> BrowserType -> (string) +> +>> The browser type associated with this visual reference. @@ -335 +341,2 @@ JSON Syntax: - "BaseCanaryRunId": "string" + "BaseCanaryRunId": "string", + "BrowserType": "CHROME"|"FIREFOX" @@ -390,0 +398,92 @@ JSON Syntax: +`--browser-configs` (list) + +> A structure that specifies the browser type to use for a canary run. CloudWatch Synthetics supports running canaries on both `CHROME` and `FIREFOX` browsers. +> +> ### Note +> +> If not specified, `browserConfigs` defaults to Chrome. +> +> (structure) +> +>> A structure that specifies the browser type to use for a canary run. +>> +>> BrowserType -> (string) +>> +>>> The browser type associated with this browser configuration. + +Shorthand Syntax: + + + BrowserType=string ... + + +JSON Syntax: + + + [ + { + "BrowserType": "CHROME"|"FIREFOX" + } + ... + ] + + +`--visual-references` (list) + +> A list of visual reference configurations for the canary, one for each browser type that the canary is configured to run on. Visual references are used for visual monitoring comparisons. +> +>> `syn-nodejs-puppeteer-11.0` and above, and `syn-nodejs-playwright-3.0` and above, only supports `visualReferences` . `visualReference` field is not supported. +> +> Versions older than `syn-nodejs-puppeteer-11.0` supports both `visualReference` and `visualReferences` for backward compatibility. It is recommended to use `visualReferences` for consistency and future compatibility. +> +> (structure) +> +>> An object that specifies what screenshots to use as a baseline for visual monitoring by this canary. It can optionally also specify parts of the screenshots to ignore during the visual monitoring comparison. +>> +>> Visual monitoring is supported only on canaries running the **syn-puppeteer-node-3.2** runtime or later. For more information, see [Visual monitoring](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Library_SyntheticsLogger_VisualTesting.html) and [Visual monitoring blueprint](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Blueprints_VisualTesting.html) +>> +>> BaseScreenshots -> (list) +>> +>>> An array of screenshots that will be used as the baseline for visual monitoring in future runs of this canary. If there is a screenshot that you don’t want to be used for visual monitoring, remove it from this array. +>>> +>>> (structure) +>>> +>>>> A structure representing a screenshot that is used as a baseline during visual monitoring comparisons made by the canary. +>>>> +>>>> ScreenshotName -> (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. +>>>> +>>>> IgnoreCoordinates -> (list) +>>>> +>>>>> 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](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/synthetics_canaries_deletion.html) +>>>>> +>>>>> (string) +>> +>> BaseCanaryRunId -> (string) +>> +>>> Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are `nextrun` to use the screenshots from the next run after this update is made, `lastrun` to use the screenshots from the most recent run before this update was made, or the value of `Id` in the [CanaryRun](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html) from a run of this a canary in the past 31 days. If you specify the `Id` of a canary run older than 31 days, the operation returns a 400 validation exception error.. +>> +>> BrowserType -> (string) +>> +>>> The browser type associated with this visual reference. + +JSON Syntax: + + + [ + { + "BaseScreenshots": [ + { + "ScreenshotName": "string", + "IgnoreCoordinates": ["string", ...] + } + ... + ], + "BaseCanaryRunId": "string", + "BrowserType": "CHROME"|"FIREFOX" + } + ... + ] + + @@ -512 +611 @@ DryRunConfig -> (structure) - * [AWS CLI 2.28.15 Command Reference](../../index.html) » + * [AWS CLI 2.28.16 Command Reference](../../index.html) »