Amazon Codebuild Build Batch Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/json-structure/amazon-codebuild-build-batch-structure.json",
  "name": "BuildBatch",
  "description": "Contains information about a batch build.",
  "type": "object",
  "properties": {
    "id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The identifier of the batch build."
        }
      ]
    },
    "arn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The ARN of the batch build."
        }
      ]
    },
    "startTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time that the batch build started."
        }
      ]
    },
    "endTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "The date and time that the batch build ended."
        }
      ]
    },
    "currentPhase": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The current phase of the batch build."
        }
      ]
    },
    "buildBatchStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusType"
        },
        {
          "description": "The status of the batch build."
        }
      ]
    },
    "sourceVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The identifier of the version of the source code to be built."
        }
      ]
    },
    "resolvedSourceVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "<p>The identifier of the resolved version of this batch build's source code.</p> <ul> <li> <p>For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.</p> </li> <li> <p>For CodePipeline, the source revision provided by CodePipeline.</p> </li> <li> <p>For Amazon S3, this does not apply.</p> </li> </ul>"
        }
      ]
    },
    "projectName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The name of the batch build project."
        }
      ]
    },
    "phases": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildBatchPhases"
        },
        {
          "description": "An array of <code>BuildBatchPhase</code> objects the specify the phases of the batch build."
        }
      ]
    },
    "source": {
      "$ref": "#/components/schemas/ProjectSource"
    },
    "secondarySources": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectSources"
        },
        {
          "description": "An array of <code>ProjectSource</code> objects that define the sources for the batch build."
        }
      ]
    },
    "secondarySourceVersions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectSecondarySourceVersions"
        },
        {
          "description": "<p>An array of <code>ProjectSourceVersion</code> objects. Each <code>ProjectSourceVersion</code> must be one of: </p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul>"
        }
      ]
    },
    "artifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildArtifacts"
        },
        {
          "description": "A <code>BuildArtifacts</code> object the defines the build artifacts for this batch build."
        }
      ]
    },
    "secondaryArtifacts": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildArtifactsList"
        },
        {
          "description": "An array of <code>BuildArtifacts</code> objects the define the build artifacts for this batch build."
        }
      ]
    },
    "cache": {
      "$ref": "#/components/schemas/ProjectCache"
    },
    "environment": {
      "$ref": "#/components/schemas/ProjectEnvironment"
    },
    "serviceRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "The name of a service role used for builds in the batch."
        }
      ]
    },
    "logConfig": {
      "$ref": "#/components/schemas/LogsConfig"
    },
    "buildTimeoutInMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperInt"
        },
        {
          "description": "Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in."
        }
      ]
    },
    "queuedTimeoutInMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperInt"
        },
        {
          "description": "Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out."
        }
      ]
    },
    "complete": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Indicates if the batch build is complete."
        }
      ]
    },
    "initiator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "<p>The entity that started the batch build. Valid values include:</p> <ul> <li> <p>If CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If an IAM user started the build, the user's name.</p> </li> <li> <p>If the Jenkins plugin for CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>"
        }
      ]
    },
    "vpcConfig": {
      "$ref": "#/components/schemas/VpcConfig"
    },
    "encryptionKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonEmptyString"
        },
        {
          "description": "<p>The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/&lt;alias-name&gt;</code>).</p>"
        }
      ]
    },
    "buildBatchNumber": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperLong"
        },
        {
          "description": "The number of the batch build. For each project, the <code>buildBatchNumber</code> of its first batch build is <code>1</code>. The <code>buildBatchNumber</code> of each subsequent batch build is incremented by <code>1</code>. If a batch build is deleted, the <code>buildBatchNumber</code> of other batch builds does not change."
        }
      ]
    },
    "fileSystemLocations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProjectFileSystemLocations"
        },
        {
          "description": "An array of <code>ProjectFileSystemLocation</code> objects for the batch build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. "
        }
      ]
    },
    "buildBatchConfig": {
      "$ref": "#/components/schemas/ProjectBuildBatchConfig"
    },
    "buildGroups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BuildGroups"
        },
        {
          "description": "An array of <code>BuildGroup</code> objects that define the build groups for the batch build."
        }
      ]
    },
    "debugSessionEnabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WrapperBoolean"
        },
        {
          "description": "Specifies if session debugging is enabled for this batch build. For more information, see <a href=\"https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html\">Viewing a running build in Session Manager</a>. Batch session debugging is not supported for matrix batch builds."
        }
      ]
    }
  }
}