Troubleshooting installation issues for the AWS Toolkit for Visual Studio - AWS Toolkit with Amazon Q

Troubleshooting installation issues for the AWS Toolkit for Visual Studio

The following information is known to resolve common installation issues while setting up the AWS Toolkit for Visual Studio.

If you encounter an error while installing the AWS Toolkit for Visual Studio or it's unclear whether or not the installation was complete, review the information in each of the following sections.

Administrator permissions for Visual Studio

The AWS Toolkit for Visual Studio extension requires administrator permissions to ensure that all AWS services and features are accessible.

If you have local administrator permissions it's possible that your administrator permissions don't extend directly to your Visual Studio instance.

To launch Visual Studio with administrator permissions locally:

  1. From Windows, locate the Visual Studio application launcher (icon).

  2. Open the context menu for (right-click) the Visual Studio icon to open the context menu.

  3. Select Run as administrator from the context menu.

To launch Visual Studio with administrator permissions remotely:

  1. From Windows, locate the application launcher for the application that you are using to connect to your remote instance of Visual Studio.

  2. Open the context menu for (right-click) the application to open the context menu.

  3. Select Run as administrator from the context menu.

Note

Whether you are launching the program locally or connecting remotely, Windows may prompt you to confirm your administrative credentials.

Obtaining an installation log

If you have completed the steps in the previous Administrator permissions section located above and it's confirmed that you're running or connecting to Visual Studio with administrator permissions, then obtaining an installation log file can help diagnose other issues.

To manually install the AWS Toolkit for Visual Studio from a .vsix file and generate an installation log file, complete the following steps.

  1. From the AWS Toolkit for Visual Studio landing page, follow the Download link and save the .vsix file of the AWS Toolkit for Visual Studio version you want to install.

  2. From the Visual Studio main menu, expand the Tools header, expand the Command Line sub menu, then choose Visual Studio Developer Command Prompt.

  3. From the Visual Studio Developer Command Prompt enter the vsixinstaller command with the following format:

    vsixinstaller /logFile:[file path to log file] [file path to Toolkit installation file]

  4. Replace[file path to log file] with the file name and full file path of the directory you want the installation log to be created in. An example of the vsixinstaller command with your specified file path and file name resembles the following:

    vsixinstaller /logFile:C:\Users\Documents\install-log.txt [file path to AWSToolkitPackage.vsix]

  5. Replace [file path to Toolkit installation file] with the full file path of the directory where the AWSToolkitPackage.vsix is located.

    An example of the vsixinstaller command with the full file path to the Toolkit installation file should resemble the following:

    vsixinstaller /logFile:[file path to log file] C:\Users\Downloads\AWSToolkitPackage.vsix

  6. Check to make sure your file name and paths are correct, then run the vsixinstaller command.

    An example of a complete vsixinstaller command resembles the following:

    vsixinstaller /logFile:C:\Users\Documents\install-log.txt C:\Users\Downloads\AWSToolkitPackage.vsix

Installing different Visual Studio extensions

If you've obtained an installation log file and you're still unable to determine why the installation process is failing, check to see if you're able to install other Visual Studio extensions. Installing different Visual Studio extensions can provide additional insight to your installation issues. In the event that you're unable to install any Visual Studio extensions, it may be necessary to troubleshoot issues with Visual Studio, instead of AWS Toolkit for Visual Studio.

Contacting support

If you've reviewed all of the sections contained in this guide and require additional resources or support, you can view past issues or open a new issue from the AWS Toolkit for Visual Studio Github Issues site.

To help expedite a solution to your issue:

  • Check past and current issues to see if others have encountered a similar situation.

  • Keep detailed notes of each step you've taken to address the issue.

  • Save any log files you've obtained from installing the AWS Toolkit for Visual Studio or other extensions.

  • Attach your AWS Toolkit for Visual Studio installation logfiles to the new issue.