Amazon CodeBuild #X Amz Target=CodeBuild 20161006.StartBuild API

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.StartBuild #X Amz Target=CodeBuild 20161006.StartBuild #X Amz Target=CodeBuild 20161006.StartBuild API'
  description: <fullname>CodeBuild</fullname> <p>CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the <i> <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/welcome.html">CodeBuild User Guide</a>.</i> </p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: codebuild
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codebuild-2016-10-06.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://codebuild.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS CodeBuild multi-region endpoint
- url: https://codebuild.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS CodeBuild multi-region endpoint
- url: http://codebuild.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
- url: https://codebuild.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS CodeBuild endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=CodeBuild 20161006.StartBuild'
paths:
  /#X-Amz-Target=CodeBuild_20161006.StartBuild:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: StartBuild
      description: Starts running a build.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartBuildOutput'
              examples:
                StartBuild200Example:
                  summary: Default StartBuild 200 response
                  x-microcks-default: true
                  value:
                    build: example-value
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                StartBuild480Example:
                  summary: Default StartBuild 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                StartBuild481Example:
                  summary: Default StartBuild 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: AccountLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountLimitExceededException'
              examples:
                StartBuild482Example:
                  summary: Default StartBuild 482 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartBuildInput'
            examples:
              StartBuildRequestExample:
                summary: Default StartBuild request
                x-microcks-default: true
                value:
                  projectName: example-resource
                  secondarySourcesOverride: '500123'
                  secondarySourcesVersionOverride: '500123'
                  sourceVersion: 1.0.0
                  artifactsOverride: '500123'
                  secondaryArtifactsOverride: '500123'
                  environmentVariablesOverride: '500123'
                  sourceTypeOverride: '500123'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeBuild_20161006.StartBuild
      summary: Amazon CodeBuild Start Build
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeBuild 20161006.StartBuild'
components:
  parameters:
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
  schemas:
    NetworkInterface:
      type: object
      properties:
        subnetId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The ID of the subnet.
        networkInterfaceId:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The ID of the network interface.
      description: Describes a network interface.
    SecurityGroupIds:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
      maxItems: 5
    LogsConfig:
      type: object
      properties:
        cloudWatchLogs:
          allOf:
          - $ref: '#/components/schemas/CloudWatchLogsConfig'
          - description: ' Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. '
        s3Logs:
          allOf:
          - $ref: '#/components/schemas/S3LogsConfig'
          - description: ' Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. '
      description: ' Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both. '
    ProjectFileSystemLocation:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/FileSystemType'
          - description: ' The type of the file system. The one supported type is <code>EFS</code>. '
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>A string that specifies the location of the file system created by Amazon EFS. Its format is <code>efs-dns-name:/directory-path</code>. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is <code>fs-abcd1234.efs.us-west-2.amazonaws.com</code>, and its mount directory is <code>my-efs-mount-directory</code>, then the <code>location</code> is <code>fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory</code>. </p> <p>The directory path in the format <code>efs-dns-name:/directory-path</code> is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. </p>
        mountPoint:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'The location in the container where you mount the file system. '
        identifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the <code>identifier</code> in all capital letters to <code>CODEBUILD_</code>. For example, if you specify <code>my_efs</code> for <code>identifier</code>, a new environment variable is create named <code>CODEBUILD_MY_EFS</code>. </p> <p> The <code>identifier</code> is used to mount your file system. </p>
        mountOptions:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are <code>nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2</code>. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html">Recommended NFS Mount Options</a>. '
      description: ' Information about a file system created by Amazon Elastic File System (EFS). For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">What Is Amazon Elastic File System?</a> '
    WrapperBoolean:
      type: boolean
    StartBuildInput:
      type: object
      required:
      - projectName
      title: StartBuildInput
      properties:
        projectName:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The name of the CodeBuild build project to start running a build.
        secondarySourcesOverride:
          allOf:
          - $ref: '#/components/schemas/ProjectSources'
          - description: ' An array of <code>ProjectSource</code> objects. '
        secondarySourcesVersionOverride:
          allOf:
          - $ref: '#/components/schemas/ProjectSecondarySourceVersions'
          - description: ' An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project''s secondary sources to be used for this build only. '
        sourceVersion:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</p> <dl> <dt>CodeCommit</dt> <dd> <p>The commit ID, branch, or Git tag to use.</p> </dd> <dt>GitHub</dt> <dd> <p>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> </dd> <dt>Bitbucket</dt> <dd> <p>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> </dd> <dt>Amazon S3</dt> <dd> <p>The version ID of the object that represents the build input ZIP file to use.</p> </dd> </dl> <p>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>CodeBuild User Guide</i>. </p>
        artifactsOverride:
          allOf:
          - $ref: '#/components/schemas/ProjectArtifacts'
          - description: Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
        secondaryArtifactsOverride:
          allOf:
          - $ref: '#/components/schemas/ProjectArtifactsList'
          - description: ' An array of <code>ProjectArtifacts</code> objects. '
        environmentVariablesOverride:
          allOf:
          - $ref: '#/components/schemas/EnvironmentVariables'
          - description: A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
        sourceTypeOverride:
          allOf:
          - $ref: '#/components/schemas/SourceType'
          - description: A source input type, for this build, that overrides the source input defined in the build project.
        sourceLocationOverride:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: A location that overrides, for this build, the source location for the one defined in the build project.
        sourceAuthOverride:
          allOf:
          - $ref: '#/components/schemas/SourceAuth'
          - description: An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
        gitCloneDepthOverride:
          allOf:
          - $ref: '#/components/schemas/GitCloneDepth'
          - description: The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
        gitSubmodulesConfigOverride:
          allOf:
          - $ref: '#/components/schemas/GitSubmodulesConfig'
          - description: ' Information about the Git submodules configuration for this build of an CodeBuild build project. '
        buildspecOverride:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.</p> <p> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </p>
        insecureSslOverride:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
        reportBuildStatusOverride:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: <p> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </p> <p>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</p> <note> <p> The status of a build triggered by a webhook is always reported to your source provider. </p> </note>
        buildStatusConfigOverride:
          allOf:
          - $ref: '#/components/schemas/BuildStatusConfig'
          - description: Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is <code>GITHUB</code>, <code>GITHUB_ENTERPRISE</code>, or <code>BITBUCKET</code>.
        environmentTypeOverride:
          allOf:
          - $ref: '#/components/schemas/EnvironmentType'
          - description: A container type for this build that overrides the one specified in the build project.
        imageOverride:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The name of an image for this build that overrides the one specified in the build project.
        computeTypeOverride:
          allOf:
          - $ref: '#/components/schemas/ComputeType'
          - description: The name of a compute type for this build that overrides the one specified in the build project.
        certificateOverride:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The name of a certificate for this build that overrides the one specified in the build project.
        cacheOverride:
          allOf:
          - $ref: '#/components/schemas/ProjectCache'
          - description: A ProjectCache object specified for this build that overrides the one defined in the build project.
        serviceRoleOverride:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The name of a service role for this build that overrides the one specified in the build project.
        privilegedModeOverride:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Enable this flag to override privileged mode in the build project.
        timeoutInMinutesOverride:
          allOf:
          - $ref: '#/components/schemas/TimeOut'
          - description: The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
        queuedTimeoutInMinutesOverride:
          allOf:
          - $ref: '#/components/schemas/TimeOut'
          - description: ' The number of minutes a build is allowed to be queued before it times out. '
        encryptionKeyOverride:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: <p>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the 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>
        logsConfigOverride:
          allOf:
          - $ref: '#/components/schemas/LogsConfig'
          - description: ' Log settings for this build that override the log settings defined in the build project. '
        registryCredentialOverride:
          allOf:
          - $ref: '#/components/schemas/RegistryCredential'
          - description: ' The credentials for access to a private registry. '
        imagePullCredentialsTypeOverride:
          allOf:
          - $ref: '#/components/schemas/ImagePullCredentialsType'
          - description: '<p>The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </p> <dl> <dt>CODEBUILD</dt> <dd> <p>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild''s service principal.</p> </dd> <dt>SERVICE_ROLE</dt> <dd> <p>Specifies that CodeBuild uses your build project''s service role. </p> </dd> </dl> <p>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </p>'
        debugSessionEnabled:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Specifies if session debugging is enabled for this 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>.
    ProjectArtifacts:
      type: object
      required:
      - type
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ArtifactsType'
          - description: '<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </p> <note> <p>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</p> </note> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project does not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project stores build output in Amazon S3.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Information about the build output artifact location:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>
        path:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>
        namespaceType:
          allOf:
          - $ref: '#/components/schemas/ArtifactNamespace'
          - description: '<p>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/&lt;build-ID&gt;/MyArtifact.zip</code>.</p>'
        name:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.</p> </li> </ul> <p>For example:</p> <ul> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/&lt;build-ID&gt;/MyArtifact.zip</code>. </p> </li> <li> <p> If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. </p> </li> <li> <p> If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/&lt;build-ID&gt;</code>. </p> </li> </ul>
        packaging:
          allOf:
          - $ref: '#/components/schemas/ArtifactPackaging'
          - description: '<p>The type of build output artifact to create:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</p> </li> </ul> </li> </ul>'
        overrideArtifactName:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. '
        encryptionDisabled:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. '
        artifactIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: ' An identifier for this artifact definition. '
        bucketOwnerAccess:
          $ref: '#/components/schemas/BucketOwnerAccess'
      description: Information about the build output artifacts for the build project.
    String:
      type: string
    LogsConfigStatusType:
      type: string
      enum:
      - ENABLED
      - DISABLED
    CredentialProviderType:
      type: string
      enum:
      - SECRETS_MANAGER
    EnvironmentVariableType:
      type: string
      enum:
      - PLAINTEXT
      - PARAMETER_STORE
      - SECRETS_MANAGER
    SourceType:
      type: string
      enum:
      - CODECOMMIT
      - CODEPIPELINE
      - GITHUB
      - S3
      - BITBUCKET
      - GITHUB_ENTERPRISE
      - NO_SOURCE
    NonEmptyString:
      type: string
      minLength: 1
    ProjectEnvironment:
      type: object
      required:
      - type
      - image
      - computeType
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/EnvironmentType'
          - description: <p>The type of build environment to use for related builds.</p> <ul> <li> <p>The environment type <code>ARM_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).</p> </li> <li> <p>The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).</p> </li> <li> <p>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).</p> </li> </ul> <ul> <li> <p>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build environment compute types</a> in the <i>CodeBuild user guide</i>.</p>
        image:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: '<p>The image tag or image digest 

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-codebuild/refs/heads/main/openapi/amazon-codebuild-x-amz-target-codebuild-20161006-startbuild-api-openapi.yml