paws.management (version 0.1.6)

ssm_start_session: Initiates a connection to a target (for example, an instance) for a Session Manager session

Description

Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Usage

ssm_start_session(Target, DocumentName, Parameters)

Arguments

Target

[required] The instance to connect to for the session.

DocumentName

The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default.

Parameters

Reserved for future use.

Request syntax

svc$start_session(
  Target = "string",
  DocumentName = "string",
  Parameters = list(
    list(
      "string"
    )
  )
)

Details

AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.

AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.