Amazon CodeStar · JSON Structure

Codestar Delete Project Request Structure

DeleteProjectRequest schema from AWS CodeStar API

Type: object Properties: 3 Required: 1
Developer ToolsDevOpsProject ManagementTeam Collaboration

DeleteProjectRequest is a JSON Structure definition published by Amazon CodeStar, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id clientRequestToken deleteStack

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-codestar/refs/heads/main/json-structure/codestar-delete-project-request-structure.json",
  "name": "DeleteProjectRequest",
  "description": "DeleteProjectRequest schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectId"
        },
        {
          "description": "The ID of the project to be deleted in AWS CodeStar."
        }
      ]
    },
    "clientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. "
        }
      ]
    },
    "deleteStack": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeleteStack"
        },
        {
          "description": "Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases."
        }
      ]
    }
  },
  "required": [
    "id"
  ]
}