Connect your Remote IDE to SageMaker spaces with remote access - Amazon SageMaker AI
Key conceptsConnection methodsSupported IDEsIDE version requirementsOperating system requirementsLocal machine prerequisitesImage requirementsInstance requirements

Connect your Remote IDE to SageMaker spaces with remote access

You can remotely connect from your Remote IDE to Amazon SageMaker Studio spaces. You can use your customized local IDE setup, including AI-assisted development tools and custom extensions, with the scalable compute resources in Amazon SageMaker AI. This guide provides concepts and setup instructions for administrators and users.

A Remote IDE connection establishes a secure connection between your local IDE and SageMaker spaces. This connection lets you:

  • Access SageMaker AI compute resources — Run code on scalable SageMaker AI infrastructure from your local environment

  • Maintain security boundaries — Work within the same security framework as SageMaker AI

  • Keep your familiar IDE experience — Use compatible local extensions, themes, and configurations that support remote development

Note

Not all IDE extensions are compatible with remote development. Extensions that require local GUI components, have architecture dependencies, or need specific client-server interactions may not work properly in the remote environment. Verify that your required extensions support remote development before use.

Topics

Key concepts

  • Remote connection — A secure tunnel between your Remote IDE and a SageMaker space. This connection enables interactive development and code execution using SageMaker AI compute resources.

  • Amazon SageMaker Studio space — A dedicated environment within Amazon SageMaker Studio where you can manage your storage and resources for your Studio applications.

  • Deep link — A button (direct URL) from the SageMaker UI that initiates a remote connection to your local IDE.

Connection methods

There are three main ways to connect your Remote IDE to SageMaker spaces:

  • Deep link access — You can connect directly to a specific space by using the Open space with button available in SageMaker AI. This uses URL patterns to establish a remote connection and open your SageMaker space in your Remote IDE.

  • AWS Toolkit for Visual Studio Code — You can authenticate with AWS Toolkit for Visual Studio Code. This allows you to connect to spaces and open a remotely connected window from your Remote IDE.

  • SSH terminal connection — You can connect via command line using SSH configuration.

Supported IDEs

Remote connection to Studio spaces supports:

IDE version requirements

The following table lists the minimum version requirements for each supported Remote IDE.

IDE Minimum version

Visual Studio Code

v1.90 or greater. We recommend using the latest stable version.

Kiro

v0.10.78 or greater

Cursor

v2.6.18 or greater

The AWS Toolkit extension is required to connect your Remote IDE to Studio spaces. For Kiro and Cursor, AWS Toolkit extension version v3.100 or greater is required.

Operating system requirements

You need one of the following operating systems to remotely connect to Studio spaces:

Local machine prerequisites

Before connecting your Remote IDE to Studio spaces, ensure your local machine has the required dependencies and network access.

Important

Environments with software installation restrictions may prevent users from installing required dependencies. The AWS Toolkit for Visual Studio Code automatically searches for these dependencies when initiating remote connections and will prompt for installation if any are missing. Coordinate with your IT department to ensure these components are available.

Required local dependencies

Your local machine must have the following components installed:

  • Remote-SSH Extension — Remote development extension for your IDE (available in the extension marketplace for VS Code, Kiro, and Cursor)

  • Session Manager plugin — Required for secure session management

  • SSH Client — Standard component on most machines (OpenSSH recommended for Windows)

  • IDE CLI Command — Typically included with IDE installation (for example, code for VS Code, kiro for Kiro, cursor for Cursor)

Platform-specific requirements

  • Windows users — PowerShell 5.1 or later is required for SSH terminal connections

Network connectivity requirements

Your local machine must have network access to Session Manager endpoints. For example, in US East (N. Virginia) (us-east-1) these can be:

  • ssm.us-east-1.amazonaws.com

  • ssm.us-east-1.api.aws

  • ssmmessages.us-east-1.amazonaws.com

  • ec2messages.us-east-1.amazonaws.com

Image requirements

SageMaker Distribution images

When using SageMaker Distribution with remote access, use SageMaker Distribution version 2.7 or later.

Custom images

When you Bring your own image (BYOI) with remote access, ensure that you follow the custom image specifications and ensure the following dependencies are installed:

  • curl or wget — Required for downloading AWS CLI components

  • unzip — Required for extracting AWS CLI installation files

  • tar — Required for archive extraction

  • gzip — Required for compressed file handling

Instance requirements

  • Memory — 8GB or more

  • Instance types — Use instances with at least 8GB of memory. The following instance types are not supported due to insufficient memory (less than 8GB): ml.t3.medium, ml.c7i.large, ml.c6i.large, ml.c6id.large, and ml.c5.large. For a more complete list of instance types, see the Amazon EC2 On-Demand Pricing page.

Topics