Start Session

ssm_start_session

R Documentation

Initiates a connection to a target (for example, a managed node) for a Session Manager session¶

Description¶

Initiates a connection to a target (for example, a managed node) 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.

Amazon Web Services 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 Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

Usage¶

ssm_start_session(Target, DocumentName, Reason, Parameters)

Arguments¶

Target: [required] The managed node to connect to for the session.
DocumentName: The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the get_document API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.
Reason: The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.
Parameters: The values you want to specify for the parameters defined in the Session document.

Value¶

A list with the following syntax:

list(
  SessionId = "string",
  TokenValue = "string",
  StreamUrl = "string"
)

Request syntax¶

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