AWS amazonq medium security documentation change
Summary
Updated documentation for addressing code issues in JetBrains and Visual Studio Code, including revised steps for fixing, explaining, and ignoring issues. Added references to 'vulnerable code' and CWE (Common Weakness Enumeration) in remediation instructions.
Security assessment
The changes explicitly mention handling 'vulnerable code' and CWE-based issues, which are security-related terms. Instructions to 'remove the vulnerable code' and ignore issues by CWE (a security weakness taxonomy) indicate the documentation now covers security vulnerability remediation features.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md b/amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md index 06a48efc5..f87e58da4 100644 --- a//amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md +++ b//amazonq/latest/qdeveloper-ug/address-issues-jetbrains-visualstudiocode.md @@ -26 +26 @@ Amazon Q can update your files in-place to automatically remediate a code issue -To automatically fix a code issue: +To automatically fix a code issue in your file: @@ -28,10 +28 @@ To automatically fix a code issue: -JetBrains IDEs - - - 1. In the **Code Issues** tab, choose the code issue you want to address. - - 2. Choose the wrench glass icon to open the **Code Issue Details** panel, where Amazon Q will start generating a fix. - -The following image shows the wrench icon for a code issue. - - +JetBrains @@ -39 +29,0 @@ The following image shows the wrench icon for a code issue. - 3. Updated code appears in the **Code Issue Details** panel. You can perform the following actions: @@ -41 +31 @@ The following image shows the wrench icon for a code issue. - 1. Below the suggested code, choose **Open diff** to see a diff of the suggested code changes in the file where the code originated. + 1. In the **Problems** tool window, in the **Amazon Q Code Issues** tab, choose the code issue you want to address. @@ -43 +33 @@ The following image shows the wrench icon for a code issue. - 2. Below the suggested code, choose **Copy** to copy the code to your clipboard. + 2. A panel opens with more information about the code issue. If applicable, you'll see details about the Amazon Q detector that was used to identify the code issue. @@ -45 +35 @@ The following image shows the wrench icon for a code issue. - 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. + 3. Along the bottom of the panel, choose **Fix**. @@ -47 +37 @@ The following image shows the wrench icon for a code issue. - 1. If the suggested code doesn’t satisfy your requirements, you can choose **Regenerate fix** to see an alternate solution. + 4. In the chat panel, Amazon Q provides a brief explanation of the fix and then applies an in-place fix in your code file. @@ -49 +39 @@ The following image shows the wrench icon for a code issue. - 2. When you apply the fix, the **Code Issue Details** panel closes, and the issue is automatically resolved and removed from the list of issues in the **Code Issues** tab. + 5. You will see the code change in your file, and have the option to undo the change from the chat panel. @@ -57 +47 @@ Visual Studio Code - 1. In the **Code Issues** panel, choose the code issue you want to address. + 1. In the **Code Issues** tab, choose the code issue you want to address. @@ -59 +49 @@ Visual Studio Code - 2. Choose the wrench glass icon. + 2. Choose the wrench icon. @@ -63 +53 @@ The following image shows the wrench icon for a code issue in Visual Studio Code - + @@ -67,3 +57 @@ The following image shows the wrench icon for a code issue in Visual Studio Code - 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. + 4. You will see the code change in your file, and have the option to undo the change from the chat panel. @@ -78 +66 @@ Amazon Q can provide an in-depth explanation of a code issue and provide remedia -To explain a code issue: +To get an explanation of a code issue: @@ -83,7 +71 @@ JetBrains IDEs - 1. In the **Code Issues** tab, choose the code issue you want to address. - - 2. Choose the magnifying glass icon to open the **Code Issue Details** panel. - -The following image shows the magnifying glass icon for a code issue in Visual Studio Code. - - + 1. In the **Problems** tool window, in the **Amazon Q Code Issues** tab, choose the code issue you want to address. @@ -91 +73 @@ The following image shows the magnifying glass icon for a code issue in Visual S - 3. At the bottom of the **Code Issue Details** panel, choose **Explain**. + 2. A panel opens with more information about the code issue. If applicable, you'll see details about the Amazon Q detector that was used to identify the code issue. @@ -93 +75 @@ The following image shows the magnifying glass icon for a code issue in Visual S - 4. The type of code issue and associated code are sent to Amazon Q in the chat panel. Amazon Q provides an explanation of the issue and suggests new code you can use to replace the problematic code. + 3. Along the bottom of the panel, choose **Explain**. @@ -95 +77 @@ The following image shows the magnifying glass icon for a code issue in Visual S - 5. To add the code to your file, you can choose **Insert at cursor** to add the new code where your cursor is in the file. You can also choose **Copy** and paste the code to your file yourself. + 4. In the chat panel, Amazon Q provides details about the issue and suggests how to fix it, with code that you can insert into your file. @@ -97 +79 @@ The following image shows the magnifying glass icon for a code issue in Visual S -Make sure to remove the underlined code to replace it with the new code. + 5. 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. Make sure to remove the vulnerable code when adding the updated code. @@ -105 +87 @@ Visual Studio Code - 1. In the **Code Issues** panel, choose the code issue you want to address. + 1. In the **Code Issues** tab, choose the code issue you want to address. @@ -111 +93 @@ The following image shows the magnifying glass icon for a code issue in Visual S - + @@ -113 +95 @@ The following image shows the magnifying glass icon for a code issue in Visual S - 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. + 3. In the chat panel, Amazon Q provides details about the issue and suggests how to fix it, with code that you can insert into your file. @@ -115 +97 @@ The following image shows the magnifying glass icon for a code issue in Visual S - 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. + 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. Make sure to remove the vulnerable code when adding the updated code. @@ -126 +108,16 @@ To ignore a code issue: - 1. In the **Code Issues** panel, choose the code issue you want to ignore. +JetBrains + + + 1. In the **Problems** tool window, in the **Amazon Q Code Issues** tab, choose the code issue you want to ignore. + + 2. A panel opens with more information about the code issue. Along the bottom of the panel, choose **Ignore**. The code issue is removed from the Code Issue panel. + + 3. You can also choose **Ignore All** to ignore this and other code issues with the same CWE. + + + + +Visual Studio Code + + + 1. In the **Code Issues** tab, choose the code issue you want to ignore. @@ -128 +125 @@ To ignore a code issue: - 2. To ignore just that code issue, choose the ignore icon. + 2. Choose the ignore icon. @@ -132 +129 @@ The following image shows the ignore icon for a code issue in Visual Studio Code - + @@ -134 +131 @@ The following image shows the ignore icon for a code issue in Visual Studio Code - 3. To ignore a code issue and similar ones, choose the ellipses icon, then choose **Ignore Similar Issues**. + 3. The code issue is removed from the Code Issue panel. @@ -135,0 +133 @@ The following image shows the ignore icon for a code issue in Visual Studio Code + 4. To ignore similar issues, choose the elipses icon, and then the choose **Ignore Similar Issues** button that appears. @@ -139 +136,0 @@ The following image shows the ignore icon for a code issue in Visual Studio Code -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.