openapi: 3.2.0
info:
  title: Amazon CodeBuild Projects API
  description: AWS CodeBuild is a fully managed continuous integration service that compiles source code, runs tests, and produces software packages that are ready to deploy. With CodeBuild, you don't need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently.
  version: '2016-10-06'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  termsOfService: https://aws.amazon.com/service-terms/
servers:
- url: https://codebuild.{region}.amazonaws.com
  description: Amazon CodeBuild Regional Endpoint
  variables:
    region:
      default: us-east-1
      description: AWS Region
tags:
- name: Projects
  description: Operations for creating and managing build projects
paths:
  /projects:
    post:
      operationId: CreateProject
      summary: Amazon CodeBuild Create a Build Project
      description: Creates a build project. A build project includes information about how to run a build, including where to get the source code, which build environment to use, which build commands to run, and where to store the build output.
      tags:
      - Projects
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProjectRequest'
            examples:
              CreateProjectRequestExample:
                summary: Default CreateProject request
                x-microcks-default: true
                value:
                  name: example-resource
                  description: Example description
                  source:
                    type: CODECOMMIT
                    location: example-value
                    buildspec: example-value
                  environment:
                    type: WINDOWS_CONTAINER
                    image: example-value
                    computeType: BUILD_GENERAL1_SMALL
                    environmentVariables:
                    - {}
                  serviceRole: example-value
                  timeoutInMinutes: 1718153645993
      responses:
        '200':
          description: Project created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProjectResponse'
              examples:
                CreateProject200Example:
                  summary: Default CreateProject 200 response
                  x-microcks-default: true
                  value:
                    project:
                      name: example-resource
                      arn: arn:aws:service:us-east-1:123456789012:resource/example
                      description: Example description
                      created: example-value
                      lastModified: example-value
                      serviceRole: example-value
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                CreateProject400Example:
                  summary: Default CreateProject 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceAlreadyExistsException'
              examples:
                CreateProject409Example:
                  summary: Default CreateProject 409 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                CreateProject500Example:
                  summary: Default CreateProject 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    get:
      operationId: ListProjects
      summary: Amazon CodeBuild List Build Projects
      description: Gets a list of build project names, with each build project name representing a single build project.
      tags:
      - Projects
      parameters:
      - name: sortBy
        in: query
        description: The criterion to sort the list of build projects.
        schema:
          type: string
          enum:
          - NAME
          - CREATED_TIME
          - LAST_MODIFIED_TIME
      - name: sortOrder
        in: query
        description: The order to sort the list.
        schema:
          type: string
          enum:
          - ASCENDING
          - DESCENDING
      - name: nextToken
        in: query
        description: Token for pagination.
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProjectsResponse'
              examples:
                ListProjects200Example:
                  summary: Default ListProjects 200 response
                  x-microcks-default: true
                  value:
                    projects:
                    - example-value
                    nextToken: example-value
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                ListProjects400Example:
                  summary: Default ListProjects 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                ListProjects500Example:
                  summary: Default ListProjects 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /projects/{projectName}:
    delete:
      operationId: DeleteProject
      summary: Amazon CodeBuild Delete a Build Project
      description: Deletes a build project. When you delete a project, its builds are not deleted.
      tags:
      - Projects
      parameters:
      - name: projectName
        in: path
        required: true
        description: The name of the build project.
        schema:
          type: string
      responses:
        '200':
          description: Project deleted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidInputException'
              examples:
                DeleteProject400Example:
                  summary: Default DeleteProject 400 response
                  x-microcks-default: true
                  value:
                    message: example-value
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
              examples:
                DeleteProject500Example:
                  summary: Default DeleteProject 500 response
                  x-microcks-default: true
                  value:
                    message: example-value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Project:
      type: object
      properties:
        name:
          type: string
        arn:
          type: string
        description:
          type: string
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        serviceRole:
          type: string
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    CreateProjectResponse:
      type: object
      properties:
        project:
          $ref: '#/components/schemas/Project'
    ListProjectsResponse:
      type: object
      properties:
        projects:
          type: array
          items:
            type: string
        nextToken:
          type: string
    InvalidInputException:
      type: object
      properties:
        message:
          type: string
    ResourceAlreadyExistsException:
      type: object
      properties:
        message:
          type: string
    CreateProjectRequest:
      type: object
      required:
      - name
      - source
      - environment
      - serviceRole
      properties:
        name:
          type: string
          description: The name of the build project.
        description:
          type: string
          description: A description of the build project.
        source:
          type: object
          required:
          - type
          properties:
            type:
              type: string
              enum:
              - CODECOMMIT
              - CODEPIPELINE
              - GITHUB
              - GITHUB_ENTERPRISE
              - BITBUCKET
              - S3
              - NO_SOURCE
            location:
              type: string
            buildspec:
              type: string
        environment:
          type: object
          required:
          - type
          - image
          - computeType
          properties:
            type:
              type: string
              enum:
              - WINDOWS_CONTAINER
              - LINUX_CONTAINER
              - LINUX_GPU_CONTAINER
              - ARM_CONTAINER
            image:
              type: string
            computeType:
              type: string
              enum:
              - BUILD_GENERAL1_SMALL
              - BUILD_GENERAL1_MEDIUM
              - BUILD_GENERAL1_LARGE
              - BUILD_GENERAL1_2XLARGE
            environmentVariables:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
                  type:
                    type: string
                    enum:
                    - PLAINTEXT
                    - PARAMETER_STORE
                    - SECRETS_MANAGER
        serviceRole:
          type: string
          description: The ARN of the IAM role for CodeBuild.
        timeoutInMinutes:
          type: integer
          description: Build timeout in minutes.
externalDocs:
  description: Amazon CodeBuild API Reference
  url: https://docs.aws.amazon.com/codebuild/latest/APIReference/