Skip to content

Start Dev Environment

codecatalyst_start_dev_environment R Documentation

Starts a specified Dev Environment and puts it into an active state

Description

Starts a specified Dev Environment and puts it into an active state.

Usage

codecatalyst_start_dev_environment(spaceName, projectName, id, ides,
  instanceType, inactivityTimeoutMinutes)

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.

ides

Information about the integrated development environment (IDE) configured for a Dev Environment.

instanceType

The Amazon EC2 instace type to use for the Dev Environment.

inactivityTimeoutMinutes

The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running.

Value

A list with the following syntax:

list(
  spaceName = "string",
  projectName = "string",
  id = "string",
  status = "PENDING"|"RUNNING"|"STARTING"|"STOPPING"|"STOPPED"|"FAILED"|"DELETING"|"DELETED"
)

Request syntax

svc$start_dev_environment(
  spaceName = "string",
  projectName = "string",
  id = "string",
  ides = list(
    list(
      runtime = "string",
      name = "string"
    )
  ),
  instanceType = "dev.standard1.small"|"dev.standard1.medium"|"dev.standard1.large"|"dev.standard1.xlarge",
  inactivityTimeoutMinutes = 123
)