Amazon CodeStar · JSON Structure

Codestar Create Project Request Structure

CreateProjectRequest schema from AWS CodeStar API

Type: object Properties: 7 Required: 2
Developer ToolsDevOpsProject ManagementTeam Collaboration

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

Properties

name id description clientRequestToken sourceCode toolchain tags

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-create-project-request-structure.json",
  "name": "CreateProjectRequest",
  "description": "CreateProjectRequest schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectName"
        },
        {
          "description": "The display name for the project to be created in AWS CodeStar."
        }
      ]
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectId"
        },
        {
          "description": "The ID of the project to be created in AWS CodeStar."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectDescription"
        },
        {
          "description": "The description of the project, if any."
        }
      ]
    },
    "clientRequestToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ClientRequestToken"
        },
        {
          "description": "A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request."
        }
      ]
    },
    "sourceCode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SourceCode"
        },
        {
          "description": "A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter."
        }
      ]
    },
    "toolchain": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Toolchain"
        },
        {
          "description": "The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter."
        }
      ]
    },
    "tags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Tags"
        },
        {
          "description": "The tags created for the project."
        }
      ]
    }
  },
  "required": [
    "name",
    "id"
  ]
}