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

openapi: 3.2.0
info:
  version: 1.0.0
  x-release: v4
  title: 'AWS CodeBuild Builds #X Amz Target=CodeBuild 20161006.RetryBuildBatch #X Amz Target=CodeBuild 20161006.RetryBuildBatch #X Amz Target=CodeBuild 20161006.RetryBuildBatch 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.RetryBuildBatch'
paths:
  /#X-Amz-Target=CodeBuild_20161006.RetryBuildBatch:
    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: RetryBuildBatch
      description: Restarts a failed batch build. Only batch builds that have failed can be retried.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetryBuildBatchOutput'
              examples:
                RetryBuildBatch200Example:
                  summary: Default RetryBuildBatch 200 response
                  x-microcks-default: true
                  value:
                    buildBatch:
                      id: '500123'
                      arn: arn:aws:service:us-east-1:123456789012:resource/example
                      startTime: example-value
                      endTime: example-value
                      currentPhase: example-value
                      buildBatchStatus: ACTIVE
                      sourceVersion: 1.0.0
                      resolvedSourceVersion: 1.0.0
        '480':
          description: InvalidInputException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                RetryBuildBatch480Example:
                  summary: Default RetryBuildBatch 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
              examples:
                RetryBuildBatch481Example:
                  summary: Default RetryBuildBatch 481 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetryBuildBatchInput'
            examples:
              RetryBuildBatchRequestExample:
                summary: Default RetryBuildBatch request
                x-microcks-default: true
                value:
                  id: '500123'
                  retryType: STANDARD
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CodeBuild_20161006.RetryBuildBatch
      summary: Amazon CodeBuild Retry Build Batch
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=CodeBuild 20161006.RetryBuildBatch'
components:
  schemas:
    ResolvedSecondaryArtifacts:
      type: array
      items:
        $ref: '#/components/schemas/ResolvedArtifact'
    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. '
    SecurityGroupIds:
      type: array
      items:
        $ref: '#/components/schemas/NonEmptyString'
      maxItems: 5
    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
    RetryBuildBatchOutput:
      type: object
      properties:
        buildBatch:
          $ref: '#/components/schemas/BuildBatch'
    String:
      type: string
    BuildBatchPhase:
      type: object
      properties:
        phaseType:
          allOf:
          - $ref: '#/components/schemas/BuildBatchPhaseType'
          - description: <p>The name of the batch build phase. Valid values include:</p> <dl> <dt>COMBINE_ARTIFACTS</dt> <dd> <p>Build output artifacts are being combined and uploaded to the output location.</p> </dd> <dt>DOWNLOAD_BATCHSPEC</dt> <dd> <p>The batch build specification is being downloaded.</p> </dd> <dt>FAILED</dt> <dd> <p>One or more of the builds failed.</p> </dd> <dt>IN_PROGRESS</dt> <dd> <p>The batch build is in progress.</p> </dd> <dt>STOPPED</dt> <dd> <p>The batch build was stopped.</p> </dd> <dt>SUBMITTED</dt> <dd> <p>The btach build has been submitted.</p> </dd> <dt>SUCCEEDED</dt> <dd> <p>The batch build succeeded.</p> </dd> </dl>
        phaseStatus:
          allOf:
          - $ref: '#/components/schemas/StatusType'
          - description: <p>The current status of the batch build phase. Valid values include:</p> <dl> <dt>FAILED</dt> <dd> <p>The build phase failed.</p> </dd> <dt>FAULT</dt> <dd> <p>The build phase faulted.</p> </dd> <dt>IN_PROGRESS</dt> <dd> <p>The build phase is still in progress.</p> </dd> <dt>STOPPED</dt> <dd> <p>The build phase stopped.</p> </dd> <dt>SUCCEEDED</dt> <dd> <p>The build phase succeeded.</p> </dd> <dt>TIMED_OUT</dt> <dd> <p>The build phase timed out.</p> </dd> </dl>
        startTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: When the batch build phase started, expressed in Unix time format.
        endTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: When the batch build phase ended, expressed in Unix time format.
        durationInSeconds:
          allOf:
          - $ref: '#/components/schemas/WrapperLong'
          - description: How long, in seconds, between the starting and ending times of the batch build's phase.
        contexts:
          allOf:
          - $ref: '#/components/schemas/PhaseContexts'
          - description: Additional information about the batch build phase. Especially to help troubleshoot a failed batch build.
      description: Contains information about a stage for a batch build.
    CredentialProviderType:
      type: string
      enum:
      - SECRETS_MANAGER
    SourceType:
      type: string
      enum:
      - CODECOMMIT
      - CODEPIPELINE
      - GITHUB
      - S3
      - BITBUCKET
      - GITHUB_ENTERPRISE
      - NO_SOURCE
    NonEmptyString:
      type: string
      minLength: 1
    BuildSummaries:
      type: array
      items:
        $ref: '#/components/schemas/BuildSummary'
    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 that identifies the Docker image to use for this build project. Use the following formats:</p> <ul> <li> <p>For an image tag: <code>&lt;registry&gt;/&lt;repository&gt;:&lt;tag&gt;</code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </p> </li> <li> <p>For an image digest: <code>&lt;registry&gt;/&lt;repository&gt;@&lt;digest&gt;</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>&lt;registry&gt;/&lt;repository&gt;@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html">Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</p>'
        computeType:
          allOf:
          - $ref: '#/components/schemas/ComputeType'
          - description: '<p>Information about the compute resources the build project uses. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</p> </li> <li> <p> <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.</p> </li> </ul> <p> If you use <code>BUILD_GENERAL1_LARGE</code>: </p> <ul> <li> <p> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </p> </li> <li> <p> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.</p> </li> <li> <p> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</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>'
        environmentVariables:
          allOf:
          - $ref: '#/components/schemas/EnvironmentVariables'
          - description: A set of environment variables to make available to builds for this build project.
        privilegedMode:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: <p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is <code>false</code>.</p> <p>You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:</p> <p>If the operating system's base image is Ubuntu Linux:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> </p> <p> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </p> <p>If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>:</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> </p> <p> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </p>
        certificate:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate">certificate</a> in the <i>CodeBuild User Guide</i>.
        registryCredential:
          allOf:
          - $ref: '#/components/schemas/RegistryCredential'
          - description: ' The credentials for access to a private registry.'
        imagePullCredentialsType:
          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> <ul> <li> <p> <code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </p> </li> <li> <p> <code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project''s service role. </p> </li> </ul> <p> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </p>'
      description: Information about the build environment of the build project.
    GitSubmodulesConfig:
      type: object
      required:
      - fetchSubmodules
      properties:
        fetchSubmodules:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: ' Set to true to fetch Git submodules for your CodeBuild build project. '
      description: ' Information about the Git submodules configuration for an CodeBuild build project. '
    ProjectSource:
      type: object
      required:
      - type
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/SourceType'
          - description: '<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>BITBUCKET</code>: The source code is in a Bitbucket repository.</p> </li> <li> <p> <code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud repository.</p> </li> <li> <p> <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</p> </li> <li> <p> <code>NO_SOURCE</code>: The project does not have input source code.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon S3 bucket.</p> </li> </ul>'
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.&lt;region-ID&gt;.amazonaws.com/v1/repos/&lt;repo-name&gt;</code>).</p> </li> <li> <p>For source code in an Amazon S3 input bucket, one of the following. </p> <ul> <li> <p>The path to the ZIP file that contains the source code (for example, <code>&lt;bucket-name&gt;/&lt;path&gt;/&lt;object-name&gt;.zip</code>). </p> </li> <li> <p>The path to the folder that contains the source code (for example, <code>&lt;bucket-name&gt;/&lt;path-to-source-code&gt;/&lt;folder&gt;/</code>). </p> </li> </ul> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul> <p> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </p>
        gitCloneDepth:
          allOf:
          - $ref: '#/components/schemas/GitCloneDepth'
          - description: Information about the Git clone depth for the build project.
        gitSubmodulesConfig:
          allOf:
          - $ref: '#/components/schemas/GitSubmodulesConfig'
          - description: ' Information about the Git submodules configuration for the build project. '
        buildspec:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The buildspec file declaration to use for the builds in this 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>
        auth:
          allOf:
          - $ref: '#/components/schemas/SourceAuth'
          - description: <p>Information about the authorization settings for CodeBuild to access the source code to be built.</p> <p>This information is for the CodeBuild console's use only. Your code should not get or set this information directly.</p>
        reportBuildStatus:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: <p> Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, 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> <p>The status of a build triggered by a webhook is always reported to your source provider. </p> <p>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</p>
        buildStatusConfig:
          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>.
        insecureSsl:
          allOf:
          - $ref: '#/components/schemas/WrapperBoolean'
          - description: Enable this flag to ignore SSL warnings while connecting to the project source code.
        sourceIdentifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: 'An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
      description: Information about the build input source code for the build project.
    EnvironmentVariableType:
      type: string
      enum:
      - PLAINTEXT
      - PARAMETER_STORE
      - SECRETS_MANAGER
    RetryBuildBatchType:
      type: string
      enum:
      - RETRY_ALL_BUILDS
      - RETRY_FAILED_BUILDS
    BatchRestrictions:
      type: object
      properties:
        maximumBuildsAllowed:
          allOf:
          - $ref: '#/components/schemas/WrapperInt'
          - description: Specifies the maximum number of builds allowed.
        computeTypesAllowed:
          allOf:
          - $ref: '#/components/schemas/ComputeTypesAllowed'
          - description: 'An array of strings that specify the compute types that are allowed for the batch build. 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> for these values. '
      description: Specifies restrictions for the batch build.
    ResolvedArtifact:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/ArtifactsType'
          - description: Specifies the type of artifact.
        location:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The location of the artifact.
        identifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: The identifier of the artifact.
      description: Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
    EnvironmentVariables:
      type: array
      items:
        $ref: '#/components/schemas/EnvironmentVariable'
    RetryBuildBatchInput:
      type: object
      title: RetryBuildBatchInput
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: Specifies the identifier of the batch build to restart.
        retryType:
          allOf:
          - $ref: '#/components/schemas/RetryBuildBatchType'
          - description: Specifies the type of retry to perform.
    BuildGroup:
      type: object
      properties:
        identifier:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: Contains the identifier of the build group.
        dependsOn:
          allOf:
          - $ref: '#/components/schemas/Identifiers'
          - description: An array of strings that contain the identifiers of the build groups that this build group depends on.
        ignoreFailure:
          allOf:
          - $ref: '#/components/schemas/Boolean'
          - description: Specifies if failures in this build group can be ignored.
        currentBuildSummary:
          allOf:
          - $ref: '#/components/schemas/BuildSummary'
          - description: A <code>BuildSummary</code> object that contains a summary of the current build group.
        priorBuildSummaryList:
          allOf:
          - $ref: '#/components/schemas/BuildSummaries'
          - description: An array of <code>BuildSummary</code> objects that contain summaries of previous build groups.
      description: Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups.
    Boolean:
      type: boolean
    EnvironmentVariable:
      type: object
      required:
      - name
      - value
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: The name or key of the environment variable.
        value:
          allOf:
          - $ref: '#/components/schemas/String'
          - description: <p>The value of the environment variable.</p> <important> <p>We strongly discourage the use of <code>PLAINTEXT</code> environment variables to store sensitive values, especially Amazon Web Services secret key IDs and secret access keys. <code>PLAINTEXT</code> environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type <code>PARAMETER_STORE</code

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