AWS amazonq documentation change
Summary
Expanded documentation for code issue remediation workflows, added Visual Studio Code specific instructions, and enhanced ignore functionality with CWE-based filtering
Security assessment
The changes document security-related code issue remediation features (CWE-based filtering for ignoring vulnerabilities) but do not address a specific security vulnerability in the product itself. The updates improve documentation of existing security capabilities rather than patching a security issue.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md b/amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md index 23337fd91..06a48efc5 100644 --- a//amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md +++ b//amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md @@ -24 +24,6 @@ You can take the following actions: -If you open a code issue and see the **Generate fix** button, complete the following procedure to update your code in-place. +Amazon Q can update your files in-place to automatically remediate a code issue it detected. + +To automatically fix a code issue: + +JetBrains IDEs + @@ -30 +35 @@ If you open a code issue and see the **Generate fix** button, complete the follo -The following image shows the wrench icon for a code issue in Visual Studio Code. +The following image shows the wrench icon for a code issue. @@ -32 +37 @@ The following image shows the wrench icon for a code issue in Visual Studio Code - + @@ -48,0 +54,20 @@ The following image shows the wrench icon for a code issue in Visual Studio Code +Visual Studio Code + + + 1. In the **Code Issues** panel, choose the code issue you want to address. + + 2. Choose the wrench glass icon. + +The following image shows the wrench icon for a code issue in Visual Studio Code. + + + + 3. In the chat panel, Amazon Q provides a brief explanation of the fix and then applies an in-place fix in your code file. + + 4. To apply the generated fix to your file, choose **Accept fix** at the bottom of the panel to replace the problematic code with the suggested code. + + 5. You will see the code change in your file, and have the option to undo the change from the chat panel. + + + + @@ -51 +76,6 @@ The following image shows the wrench icon for a code issue in Visual Studio Code -If the code issue doesn’t include the **Generate fix** button, complete the following procedure to see an in-depth explanation of the issue and steps for resolving it manually in the chat panel. +Amazon Q can provide an in-depth explanation of a code issue and provide remediation options with accompanying code for you to add to your files. + +To explain a code issue: + +JetBrains IDEs + @@ -71,0 +102,18 @@ Make sure to remove the underlined code to replace it with the new code. +Visual Studio Code + + + 1. In the **Code Issues** panel, choose the code issue you want to address. + + 2. Choose the magnifying glass icon. + +The following image shows the magnifying glass icon for a code issue in Visual Studio Code. + + + + 3. In the chat panel, Amazon Q provides details about the issue and suggest a remediation with code that you can insert into your file. + + 4. To update your file, follow Amazon Q’s instructions for where to add or replace code, and copy the provided code in the correct location in your file. + + + + @@ -74 +122,7 @@ Make sure to remove the underlined code to replace it with the new code. -If the code issue isn’t applicable, you can choose the ignore icon from the **Code Issues** tab to ignore the issue and remove it from the list of issues in the Code Issues tab. +If a detected code issue isn’t applicable, you can choose to ignore it, or ignore it and all similar issues (issues with the same CWE). The issues will be removed from the Code Issues tab. + +To ignore a code issue: + + 1. In the **Code Issues** panel, choose the code issue you want to ignore. + + 2. To ignore just that code issue, choose the ignore icon. @@ -80 +134,6 @@ The following image shows the ignore icon for a code issue in Visual Studio Code -You can also choose **Ignore** from the **Code Issue Details** panel. The issue will be ignored and removed from the list of issues in the **Code Issues** tab. If you choose **Ignore all** from the Code Issue Details panel, this and other code issues with the same CWE will be ignored. + 3. To ignore a code issue and similar ones, choose the ellipses icon, then choose **Ignore Similar Issues**. + + + + +In JetBrains IDEs, you can also choose **Ignore** from the **Code Issue Details** panel. The issue will be ignored and removed from the list of issues in the **Code Issues** tab. If you choose **Ignore all** from the Code Issue Details panel, this and other code issues with the same CWE will be ignored.