Skip to content

Start Dev Environment Session

codecatalyst_start_dev_environment_session R Documentation

Starts a session for a specified Dev Environment

Description

Starts a session for a specified Dev Environment.

Usage

codecatalyst_start_dev_environment_session(spaceName, projectName, id,
  sessionConfiguration)

Arguments

spaceName

[required] The name of the space.

projectName

[required] The name of the project in the space.

id

[required] The system-generated unique ID of the Dev Environment.

sessionConfiguration

[required]

Value

A list with the following syntax:

list(
  accessDetails = list(
    streamUrl = "string",
    tokenValue = "string"
  ),
  sessionId = "string",
  spaceName = "string",
  projectName = "string",
  id = "string"
)

Request syntax

svc$start_dev_environment_session(
  spaceName = "string",
  projectName = "string",
  id = "string",
  sessionConfiguration = list(
    sessionType = "SSM"|"SSH",
    executeCommandSessionConfiguration = list(
      command = "string",
      arguments = list(
        "string"
      )
    )
  )
)