Amazon CodeCatalyst · JSON Structure

Amazon Codecatalyst Update Dev Environment Request Structure

UpdateDevEnvironmentRequest schema from Amazon CodeCatalyst

Type: object Properties: 5
AmazonDeveloper ToolsCI/CDCollaborationDevOpsSource Control

UpdateDevEnvironmentRequest is a JSON Structure definition published by Amazon CodeCatalyst, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

alias ides instanceType inactivityTimeoutMinutes clientToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codecatalyst/refs/heads/main/json-structure/amazon-codecatalyst-update-dev-environment-request-structure.json",
  "name": "UpdateDevEnvironmentRequest",
  "description": "UpdateDevEnvironmentRequest schema from Amazon CodeCatalyst",
  "type": "object",
  "properties": {
    "alias": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UpdateDevEnvironmentRequestAliasString"
        },
        {
          "description": "The user-specified alias for the Dev Environment. Changing this value will not cause a restart."
        }
      ]
    },
    "ides": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdeConfigurationList"
        },
        {
          "description": "Information about the integrated development environment (IDE) configured for a Dev Environment."
        }
      ]
    },
    "instanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceType"
        },
        {
          "description": "<p>The Amazon EC2 instace type to use for the Dev Environment. </p> <note> <p>Changing this value will cause a restart of the Dev Environment if it is running.</p> </note>"
        }
      ]
    },
    "inactivityTimeoutMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InactivityTimeoutMinutes"
        },
        {
          "description": "<p>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.</p> <note> <p>Changing this value will cause a restart of the Dev Environment if it is running.</p> </note>"
        }
      ]
    },
    "clientToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientToken"
        },
        {
          "description": "A user-specified idempotency token. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries return the result from the original successful request and have no additional effect."
        }
      ]
    }
  }
}