Skip to contents

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

Source: R/ssm_operations.R
ssm_start_session.Rd

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.

See https://www.paws-r-sdk.com/docs/ssm_start_session/ for full documentation.

Usage

ssm_start_session(
  Target,
  DocumentName = NULL,
  Reason = NULL,
  Parameters = NULL
)

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. For more information about these parameters, see Create a Session Manager preferences document in the Amazon Web Services Systems Manager User Guide.