How to Use Amazon Q Developer

Getting started with Amazon Q Developer

In this guide, you’ll learn how to set up Amazon Q Developer, use it for code completion and debugging, and enhance your coding experience within the AWS ecosystem. By the end, you’ll be ready to integrate this AI assistant into your development workflow.

Step 1: Sign up and set up

1. Go to the Amazon Q Developer website.
2. Click on the “Get Started” button to begin the sign-up process.
3. Sign in with your AWS account or create a new one if you don’t have an account yet.
4. Follow the on-screen instructions to configure your preferences and permissions, ensuring you grant access to the necessary AWS services.

Step 2: Your first task

1. Once logged in, navigate to the "Code Assistant" section from the main dashboard.
2. Select the "New Project" button to create a new coding environment.
3. Choose the programming language you are working with from the dropdown menu (e.g., Python, Java).
4. Start typing your code in the code editor. Amazon Q Developer will automatically suggest completions as you type.
5. For debugging, click on the “Debug” button located at the top right of the editor. This will run the code and highlight any errors, providing suggestions for fixes.

Step 3: Get better results

1. Use the “Architecture Assistant” feature by clicking on the “Architecture” tab. Here, you can input your project requirements, and Q Developer will suggest optimal AWS services and configurations.
2. Customise your coding environment by clicking on the “Settings” gear icon. Adjust preferences for code style, language-specific settings, and debugging options.
3. Take advantage of the built-in documentation links that appear alongside code suggestions to quickly find relevant information.

Pro tip

Use keyboard shortcuts to speed up your workflow. For example, pressing Ctrl + Space (or Cmd + Space on Mac) will trigger code suggestions without needing to pause typing.

Common mistake to avoid

Don’t skip the permissions setup during the initial configuration. Failing to grant the necessary access to AWS services can limit the functionality of Amazon Q Developer and hinder your coding experience.