Set up Amazon Q Developer in your IDE - Amazon Q Developer

Amazon Q Developer is in preview release and is subject to change.

Set up Amazon Q Developer in your IDE

To set up Amazon Q Developer in your integrated development environment (IDE), complete the following steps. After installing the AWS Toolkit, authenticate Amazon Q through IAM Identity Center or AWS Builder ID. You can use Amazon Q for free, without an AWS account, by authenticating with Builder ID.

Step 1: Install the AWS Toolkit

AWS Toolkit is a collection of AWS extensions that you can install as a plugin in your IDE. Amazon Q is available as an extension in Visual Studio Code and JetBrains.

  • The minimum version of Visual Studio Code supported by Amazon Q is 1.68.0. For information about how to install the AWS Toolkit in Visual Studio Code, see Installing the AWS Toolkit for Visual Studio Code in the AWS Toolkit for Visual Studio Code User Guide.

  • The minimum version of IntelliJ supported by Amazon Q is 232.1. For information about how to install the AWS Toolkit for JetBrains, see Installing the AWS Toolkit for JetBrains in the AWS Toolkit for JetBrains User Guide.

Step 2a: Authenticate Amazon Q in Visual Studio Code

  1. From the edge of the IDE window, choose the AWS logo. The AWS developer tools pane opens.

  2. Under Amazon Q, choose Sign in to get started. The AWS Toolkit for VS Code tab opens.

  3. From the Amazon Q + CodeWhisperer authentication pane, choose the appropriate method, and sign in:

    Note

    If you authenticate with AWS Builder ID, you will not be able to use the Amazon Q feature development and Code Transformation features. Those features are only available with authentication through the IAM Identity Center, in accordance with an Amazon Q license or a CodeWhisperer Professional license.

    1. If your organization has provided a license to access CodeWhisperer Professional, authenticate through IAM Identity Center. Choose Sign in with IAM Identity Center (SSO) and follow the instructions given. For more information, see Setting up CodeWhisperer Professional with IAM Identity Center in the Amazon CodeWhisperer User Guide.

    2. If you don’t have a license to access CodeWhisperer Professional, you can use Amazon Q for free with AWS Builder ID. Choose Use for free with AWS Builder ID and follow the instructions given. For more information, see Sign in with AWS Builder ID in the AWS Sign-In User Guide.

    For more information on authenticating Amazon Q in VS Code, see Authentication for Amazon Q + CodeWhisperer in the AWS Toolkit for VS Code User Guide.

  4. In the Amazon Q + CodeWhisperer pane, choose Open Amazon Q chat to open the Amazon Q chat panel. You can also choose Switch to Q Chat in the AWS developer tools pane.

Step 2b: Authenticate Amazon Q in JetBrains

  1. From the edge of the IDE window, choose the AWS Toolkit. The AWS Toolkit tab opens.

  2. In the Amazon Q + CodeWhisperer tab, under Amazon Q, double-click Sign in to get started. The Setup Authentication dialog box opens.

  3. For Setup Authentication, choose the appropriate method, and sign in:

    Note

    If you authenticate with Builder ID, you will not be able to use the Amazon Q feature development and Code Transformation features. Those features are only available with authentication through the IAM Identity Center, in accordance with an Amazon Q license or a CodeWhisperer Professional license.

    1. If your organization has provided a license to access CodeWhisperer Professional, authenticate through IAM Identity Center. Choose the IAM Identity Center tab and follow the instructions given. For more information, see Setting up CodeWhisperer Professional with IAM Identity Center in the Amazon CodeWhisperer User Guide.

    2. If you don’t have a license to access CodeWhisperer Professional, you can use Amazon Q for free with AWS Builder ID. Choose the AWS Builder ID tab and follow the instructions given. For more information, see Sign in with AWS Builder ID in the AWS Sign-In User Guide.

    For more information on authenticating Amazon Q in JetBrains, see Authentication for Amazon Q + CodeWhisperer in the AWS Toolkit for JetBrains User Guide.

  4. In the AWS developer tools pane, choose Chat with Q to open the Amazon Q chat panel.