Skip to content

Get Dev Environment

codecatalyst_get_dev_environment R Documentation

Returns information about a Dev Environment for a source repository in a project

Description

Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.

Usage

codecatalyst_get_dev_environment(spaceName, projectName, id)

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 for which you want to view information. To retrieve a list of Dev Environment IDs, use list_dev_environments.

Value

A list with the following syntax:

list(
  spaceName = "string",
  projectName = "string",
  id = "string",
  lastUpdatedTime = as.POSIXct(
    "2015-01-01"
  ),
  creatorId = "string",
  status = "PENDING"|"RUNNING"|"STARTING"|"STOPPING"|"STOPPED"|"FAILED"|"DELETING"|"DELETED",
  statusReason = "string",
  repositories = list(
    list(
      repositoryName = "string",
      branchName = "string"
    )
  ),
  alias = "string",
  ides = list(
    list(
      runtime = "string",
      name = "string"
    )
  ),
  instanceType = "dev.standard1.small"|"dev.standard1.medium"|"dev.standard1.large"|"dev.standard1.xlarge",
  inactivityTimeoutMinutes = 123,
  persistentStorage = list(
    sizeInGiB = 123
  ),
  vpcConnectionName = "string"
)

Request syntax

svc$get_dev_environment(
  spaceName = "string",
  projectName = "string",
  id = "string"
)