ssm_start_session: Initiates a connection to a target (for example, an instance)...

Description Usage Arguments Value Request syntax

View source: R/ssm_operations.R

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.

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.

Usage

1
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. 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 instance is launched by default.

Parameters

Reserved for future use.

Value

A list with the following syntax:

1
2
3
4
5
list(
  SessionId = "string",
  TokenValue = "string",
  StreamUrl = "string"
)

Request syntax

1
2
3
4
5
6
7
8
9
svc$start_session(
  Target = "string",
  DocumentName = "string",
  Parameters = list(
    list(
      "string"
    )
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.