Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use StartSession
with an Amazon SDK or CLI
The following code examples show how to use StartSession
.
- CLI
-
- Amazon CLI
-
Example 1: To start a Session Manager session
This start-session
example establishes a connection with an instance for a Session Manager session. Note that this interactive command requires the Session Manager plugin to be installed on the client machine making the call.
aws ssm start-session \
--target "i-1234567890abcdef0"
Output:
Starting session with SessionId: Jane-Roe-07a16060613c408b5
Example 2: To start a Session Manager session using SSH
This start-session
example establishes a connection with an instance for a Session Manager session using SSH. Note that this interactive command requires the Session Manager plugin to be installed on the client machine making the call, and that the command uses the default user on the instance, such as ec2-user
for EC2 instances for Linux.
ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE
Output:
Starting session with SessionId: ec2-user-07a16060613c408b5
For more information, see Start a Session and Install the Session Manager Plugin for the Amazon CLI in the Amazon Systems Manager User Guide.
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example initiates a connection to a target for a Session Manager session, enabling port forwarding.
Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' }
Output:
SessionId StreamUrl
---------- ----------
random-id0 wss://ssmmessages.amazonaws.com/v1/data-channel/random-id
For a complete list of Amazon SDK developer guides and code examples, see
Using Systems Manager with an Amazon SDK.
This topic also includes information about getting started and details about previous SDK versions.