DescribeEnvironmentsResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/amazon-cloud9/json-schema/amazon-cloud9-describe-environments-result-schema.json",
  "title": "DescribeEnvironmentsResult",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-cloud9-environments-api-openapi.yml#/components/schemas/DescribeEnvironmentsResult",
  "type": "object",
  "properties": {
    "environments": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Environment"
      },
      "description": "Information about the environments that are returned."
    }
  },
  "$defs": {
    "Environment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The ID of the environment."
        },
        "name": {
          "type": "string",
          "description": "The name of the environment."
        },
        "description": {
          "type": "string",
          "description": "The description for the environment."
        },
        "type": {
          "type": "string",
          "enum": [
            "ssh",
            "ec2"
          ],
          "description": "The type of environment. Valid values include the following: ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment. ssh: Your own server connects to the environment."
        },
        "connectionType": {
          "type": "string",
          "enum": [
            "CONNECT_SSH",
            "CONNECT_SSM"
          ],
          "description": "The connection type used for connecting to an Amazon EC2 environment. CONNECT_SSH is selected by default."
        },
        "arn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the environment."
        },
        "ownerArn": {
          "type": "string",
          "description": "The Amazon Resource Name (ARN) of the environment owner."
        },
        "lifecycle": {
          "$ref": "#/$defs/EnvironmentLifecycle"
        },
        "managedCredentialsStatus": {
          "type": "string",
          "enum": [
            "ENABLED_ON_CREATE",
            "ENABLED_BY_OWNER",
            "DISABLED_BY_DEFAULT",
            "DISABLED_BY_OWNER",
            "DISABLED_BY_COLLABORATOR",
            "PENDING_REMOVAL_BY_COLLABORATOR",
            "PENDING_START_REMOVAL_BY_COLLABORATOR",
            "PENDING_REMOVAL_BY_OWNER",
            "PENDING_START_REMOVAL_BY_OWNER",
            "FAILED_REMOVAL_BY_COLLABORATOR",
            "FAILED_REMOVAL_BY_OWNER"
          ],
          "description": "Describes the status of Amazon Web Services managed temporary credentials for the Cloud9 environment. Available values are: ENABLED_ON_CREATE ENABLED_BY_OWNER DISABLED_BY_DEFAULT DISABLED_BY_OWNER DISABLED_BY_COLLABORATOR PENDING_REMOVAL_BY_COLLABORATOR PENDING_REMOVAL_BY_OWNER FAILED_REMOVAL_BY_COLLABORATOR ENABLED_BY_OWNER DISABLED_BY_DEFAULT"
        }
      },
      "required": [
        "type",
        "arn",
        "ownerArn"
      ]
    },
    "EnvironmentLifecycle": {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "enum": [
            "CREATING",
            "CREATED",
            "CREATE_FAILED",
            "DELETING",
            "DELETE_FAILED"
          ],
          "description": "The current creation or deletion lifecycle state of the environment. CREATING: The environment is in the process of being created. CREATED: The environment was successfully created. CREATE_FAILED: The environment failed to be created. DELETING: The environment is in the process of being deleted. DELETE_FAILED: The environment failed to delete."
        },
        "reason": {
          "type": "string",
          "description": "Any informational message about the lifecycle state of the environment."
        },
        "failureResource": {
          "type": "string",
          "description": "If the environment failed to delete, the Amazon Resource Name (ARN) of the related Amazon Web Services resource."
        }
      }
    }
  }
}