Amazon CodeStar · JSON Structure

Codestar Describe Project Result Structure

DescribeProjectResult schema from AWS CodeStar API

Type: object Properties: 9
Developer ToolsDevOpsProject ManagementTeam Collaboration

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

Properties

name id arn description clientRequestToken createdTimeStamp stackId projectTemplateId status

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-describe-project-result-structure.json",
  "name": "DescribeProjectResult",
  "description": "DescribeProjectResult schema from AWS CodeStar API",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectName"
        },
        {
          "description": "The display name for the project."
        }
      ]
    },
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectId"
        },
        {
          "description": "The ID of the project."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) for the project."
        }
      ]
    },
    "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. "
        }
      ]
    },
    "createdTimeStamp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatedTimestamp"
        },
        {
          "description": "The date and time the project was created, in timestamp format."
        }
      ]
    },
    "stackId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StackId"
        },
        {
          "description": "The ID of the primary stack in AWS CloudFormation used to generate resources for the project."
        }
      ]
    },
    "projectTemplateId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectTemplateId"
        },
        {
          "description": "The ID for the AWS CodeStar project template used to create the project."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectStatus"
        },
        {
          "description": "The project creation or deletion status."
        }
      ]
    }
  }
}