AWS amazonq documentation change
Summary
Updated IDE setup documentation with revised authentication flow, added multi-profile selection guidance, and restructured Visual Studio setup instructions
Security assessment
Changes focus on authentication workflow improvements and profile management but do not address specific vulnerabilities. Added references to IAM Identity Center and profile-based access control demonstrate security feature documentation rather than vulnerability fixes.
Diff
diff --git a/amazonq/latest/qdeveloper-ug/q-in-IDE-setup.md b/amazonq/latest/qdeveloper-ug/q-in-IDE-setup.md index f1d2f9de4..0e1869924 100644 --- a//amazonq/latest/qdeveloper-ug/q-in-IDE-setup.md +++ b//amazonq/latest/qdeveloper-ug/q-in-IDE-setup.md @@ -5 +5 @@ -Choose a supported version of your IDEIn Eclipse IDEsIn JetBrains IDEsIn Visual Studio CodeIn Visual StudioIAM principals in your AWS console +Supported IDE versionsIn Eclipse IDEsIn JetBrains IDEsIn Visual Studio CodeIn Visual StudioIAM principals in your AWS console @@ -32 +32 @@ To sign in and authenticate, complete the steps in this section. - * Prerequisite: Choose a supported version of your IDE + * Prerequisite: Supported IDE versions @@ -47 +47 @@ To sign in and authenticate, complete the steps in this section. -## Prerequisite: Choose a supported version of your IDE +## Prerequisite: Supported IDE versions @@ -165 +165 @@ The icon will be on the side of the interface by default. - 7. Follow the instructions in your browser to authenticate with IAM Identity Center. + 7. Follow the instructions in your browser to authenticate with IAM Identity Center, and then return to the IDE. @@ -167 +167,7 @@ The icon will be on the side of the interface by default. - 8. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose **Amazon Q** from the navigation bar at the bottom of your IDE. + 8. If your administrator has configured more than one Amazon Q Developer profile, you will see the profiles you have access to. Choose the profile that meets your current working needs, or that your administrator has instructed you to use. For more information about profiles, see [Amazon Q Developer profiles](./subscribe-understanding-profile.html). + +If there is only one profile available, that profile will automatically be chosen and you can begin using Amazon Q. + +To change your Amazon Q Developer profile, choose **Amazon Q** from the bottom of the IDE, and then choose **Change profile**. From the window that appears, choose the profile you'd like to use. + + 9. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose **Amazon Q** from the navigation bar at the bottom of your IDE. @@ -222 +228,3 @@ The icon will be on the side of the interface by default. - 7. Follow the instructions in your browser to authenticate with IAM Identity Center. + 7. Follow the instructions in your browser to authenticate with IAM Identity Center, and then return to the IDE. + + 8. If your administrator has configured more than one Amazon Q Developer profile, you will see the profiles you have access to. Choose the profile that meets your current working needs, or that your administrator has instructed you to use. For more information about profiles, see [Amazon Q Developer profiles](./subscribe-understanding-profile.html). @@ -224 +232,5 @@ The icon will be on the side of the interface by default. - 8. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose **Amazon Q** from the navigation bar at the bottom of your IDE. +If there is only one profile available, that profile will automatically be chosen and you can begin using Amazon Q. + +To change your Amazon Q Developer profile, choose **Amazon Q** from the bottom of the IDE, and then choose **Change profile**. From the command palette, choose the profile you'd like to use. + + 9. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose **Amazon Q** from the navigation bar at the bottom of your IDE. @@ -247 +259,5 @@ Builder ID - 1. From the **Getting Started with the AWS Toolkit** connection UI, select the **Amazon Q Developer** radial to expand the Amazon Q Developer authentication options. + 1. From Visual Studio, expand **Extensions** from the main menu and then expand the **AWS Toolkit** sub-menu. + + 2. Choose **Getting started**. The **Getting Started** tab opens in the Visual Studio editor window. + + 3. In the **Amazon Q** section, choose **Enable**. @@ -249 +265 @@ Builder ID - 2. From the **I'm using Amazon Q Developer on my own** section, choose the **Sign up or Sign in** button to open the **Log in with AWS Builder ID** dialog. + 4. From the **Free Tier** section, choose the **Sign up or Sign in** button. @@ -251 +267 @@ Builder ID - 3. Choose the **Proceed to Browser** button to open the AWS **Authorize request** site in your default web browser. + 5. Confirm that you want to open the AWS Authorize request portal in your default web browser. @@ -253 +269 @@ Builder ID - 4. Follow the prompts in your default web browser. You're notified when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. + 6. Follow the prompts in your default web browser. You're notified when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. @@ -261 +277 @@ Amazon Q Developer Pro license - 1. From the **Getting Started with the AWS Toolkit** connection UI, select the **Amazon Q Developer** radial to expand the Amazon Q Developer authentication options. + 1. From Visual Studio, expand **Extensions** from the main menu and then expand the **AWS Toolkit** sub-menu. @@ -263 +279,13 @@ Amazon Q Developer Pro license -###### Note + 2. Choose **Getting started**. The **Getting Started** tab opens in the Visual Studio editor window. + + 3. In the **Amazon Q** section, choose **Enable**. You will fill out the Professional Tier section to authenticate. + + 4. The credentials profile is made up of the Profile Name, Start URL, Profile Region, or SSO Region provided by an administrator at your company or organization. For detailed information about IAM Identity Center credentials, see [What is IAM Identity Center?](https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) in the _IAM Identity Center User Guide_. + +If you have an existing credentials profile, choose it from the dropdown menu in the Professional tier panel, and then choose **Connect**. + +To create a new credentials profile, fill out the following fields from the Professional tier section: + + 1. In the **Profile Name** text field, enter the name of the IAM Identity Center profile you want to authenticate with. + + 2. In the **Start URL** text field, enter the start URL that's attached to your IAM Identity Center credentials. @@ -265 +293 @@ Amazon Q Developer Pro license -If no stored credentials exist, proceed to **Step 3** to add or update your IAM Identity Center credentials. + 3. From the **Profile Region (defaults to us-east-1)** drop-down menu, choose the AWS Region that's defined by the IAM Identity Center user profile you're authenticating with. @@ -267 +295 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 2. From the **My organization has enabled Amazon Q Developer** section, expand the **Choose from an existing Profile or add new** drop-down menu to choose from your list of stored credentials. + 4. From the **SSO Region (defaults to us-east-1)** drop-down menu, choose the **SSO Region** that's defined by your IAM Identity Center credentials, then choose the **Connect** button to open the **Log in with AWS IAM Identity Center** dialog. @@ -269 +297 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 3. From the **Profile Type** drop-down menu, choose **AWS IAM Identity Center**. + 5. Confirm that you want to open the AWS Authorize request portal in your default web browser. @@ -271 +299 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 4. In the **Profile Name** text field, enter the `Profile Name` of the IAM Identity Center profile you want to authenticate with. + 6. Follow the prompts in your default web browser. You're notified when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. @@ -273 +301 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 5. In the **Start URL** text field, enter the `Start URL` that's attached to your IAM Identity Center credentials. + 7. A **Sign into Amazon Q** window appears. In the credentials profile dropdown, choose the profile you used to authenticate in the previous steps. @@ -275 +303 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 6. From the **Profile Region (defaults to us-east-1)** drop-down menu, choose the **Profile Region** that's defined by the IAM Identity Center user profile you're authenticating with. + 8. If your administrator has configured more than one Amazon Q Developer profile, you are then prompted to choose a Q Developer profile from the dropdown menu. Choose the profile that meets your current working needs, or that your administrator has instructed you to use. For more information about profiles, see [Amazon Q Developer profiles](./subscribe-understanding-profile.html). @@ -277 +305 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 7. From the **SSO Region (defaults to us-east-1)** drop-down menu, choose the **SSO Region** that's defined by your IAM Identity Center credentials, then choose the **Connect** button to open the **Log in with AWS IAM Identity Center** dialog. +If there is only one profile available, that profile will automatically be chosen and you can begin using Amazon Q. @@ -279 +307 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 8. From the **Log in with AWS IAM Identity Center** dialog, choose the **Proceed to Browser** button to open the AWS **Authorize request** site in your default web browser. +To change your Amazon Q Developer profile, choose **Amazon Q** from the bottom of the IDE, and then choose **Change Q Developer Profile**. From the window that appears, choose the profile you'd like to use. @@ -281 +309 @@ If no stored credentials exist, proceed to **Step 3** to add or update your IAM - 9. Follow the prompts in your default web browser. You're notified when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. +You can also change your profile by choosing the overflow menu at the top right corner of the chat window, and then choosing **Change Q Developer Profile**.