Environment

Information about an AWS Cloud9 development environment.

Cloud9IDEDevelopmentBrowser-Based

Properties

Name	Type	Description
id	string	The ID of the environment.
name	string	The name of the environment.
description	string	The description for the environment.
type	string	The type of environment.
connectionType	string	The connection type for connecting to the environment.
status	string	The current status of the environment.
ownerArn	string	The Amazon Resource Name (ARN) of the environment owner.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloud9/refs/heads/main/json-schema/cloud9-environment-schema.json",
  "title": "Environment",
  "description": "Information about an AWS Cloud9 development environment.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the environment.",
      "example": "abc12345678901234567890"
    },
    "name": {
      "type": "string",
      "description": "The name of the environment.",
      "example": "my-dev-environment"
    },
    "description": {
      "type": "string",
      "description": "The description for the environment."
    },
    "type": {
      "type": "string",
      "enum": [
        "ssh",
        "ec2"
      ],
      "description": "The type of environment."
    },
    "connectionType": {
      "type": "string",
      "enum": [
        "CONNECT_SSH",
        "CONNECT_SSM"
      ],
      "description": "The connection type for connecting to the environment."
    },
    "status": {
      "type": "string",
      "enum": [
        "error",
        "creating",
        "connecting",
        "ready",
        "stopping",
        "stopped",
        "deleting"
      ],
      "description": "The current status of the environment."
    },
    "ownerArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the environment owner."
    }
  }
}