openapi: 3.0.0
info:
version: '2016-10-06'
x-release: v4
title: AWS CodeBuild
description: '
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 CodeBuild User Guide.
' 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' version: 1.0.0 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 externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/codebuild/' 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=CodeBuild_20161006.BatchDeleteBuilds: post: operationId: BatchDeleteBuilds description: Deletes one or more builds. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchDeleteBuildsOutput' examples: BatchDeleteBuilds200Example: summary: Default BatchDeleteBuilds 200 response x-microcks-default: true value: buildsDeleted: example-value buildsNotDeleted: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchDeleteBuilds480Example: summary: Default BatchDeleteBuilds 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDeleteBuildsInput' examples: BatchDeleteBuildsRequestExample: summary: Default BatchDeleteBuilds request x-microcks-default: true value: ids: '500123' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchDeleteBuilds summary: Amazon CodeBuild Batch Delete Builds x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.BatchGetBuildBatches: post: operationId: BatchGetBuildBatches description: Retrieves information about one or more batch builds. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetBuildBatchesOutput' examples: BatchGetBuildBatches200Example: summary: Default BatchGetBuildBatches 200 response x-microcks-default: true value: buildBatches: example-value buildBatchesNotFound: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchGetBuildBatches480Example: summary: Default BatchGetBuildBatches 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetBuildBatchesInput' examples: BatchGetBuildBatchesRequestExample: summary: Default BatchGetBuildBatches request x-microcks-default: true value: ids: '500123' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchGetBuildBatches summary: Amazon CodeBuild Batch Get Build Batches x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.BatchGetBuilds: post: operationId: BatchGetBuilds description: Gets information about one or more builds. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetBuildsOutput' examples: BatchGetBuilds200Example: summary: Default BatchGetBuilds 200 response x-microcks-default: true value: builds: example-value buildsNotFound: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchGetBuilds480Example: summary: Default BatchGetBuilds 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetBuildsInput' examples: BatchGetBuildsRequestExample: summary: Default BatchGetBuilds request x-microcks-default: true value: ids: '500123' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchGetBuilds summary: Amazon CodeBuild Batch Get Builds x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.BatchGetProjects: post: operationId: BatchGetProjects description: Gets information about one or more build projects. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetProjectsOutput' examples: BatchGetProjects200Example: summary: Default BatchGetProjects 200 response x-microcks-default: true value: projects: example-value projectsNotFound: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchGetProjects480Example: summary: Default BatchGetProjects 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetProjectsInput' examples: BatchGetProjectsRequestExample: summary: Default BatchGetProjects request x-microcks-default: true value: names: example-resource parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchGetProjects summary: Amazon CodeBuild Batch Get Projects x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.BatchGetReportGroups: post: operationId: BatchGetReportGroups description: ' Returns an array of report groups. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetReportGroupsOutput' examples: BatchGetReportGroups200Example: summary: Default BatchGetReportGroups 200 response x-microcks-default: true value: reportGroups: example-value reportGroupsNotFound: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchGetReportGroups480Example: summary: Default BatchGetReportGroups 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetReportGroupsInput' examples: BatchGetReportGroupsRequestExample: summary: Default BatchGetReportGroups request x-microcks-default: true value: reportGroupArns: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchGetReportGroups summary: Amazon CodeBuild Batch Get Report Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.BatchGetReports: post: operationId: BatchGetReports description: ' Returns an array of reports. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BatchGetReportsOutput' examples: BatchGetReports200Example: summary: Default BatchGetReports 200 response x-microcks-default: true value: reports: example-value reportsNotFound: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: BatchGetReports480Example: summary: Default BatchGetReports 480 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchGetReportsInput' examples: BatchGetReportsRequestExample: summary: Default BatchGetReports request x-microcks-default: true value: reportArns: arn:aws:service:us-east-1:123456789012:resource/example parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.BatchGetReports summary: Amazon CodeBuild Batch Get Reports x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.CreateProject: post: operationId: CreateProject description: Creates a build project. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateProjectOutput' examples: CreateProject200Example: summary: Default CreateProject 200 response x-microcks-default: true value: project: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateProject480Example: summary: Default CreateProject 480 response x-microcks-default: true value: example-value '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' examples: CreateProject481Example: summary: Default CreateProject 481 response x-microcks-default: true value: example-value '482': description: AccountLimitExceededException content: application/json: schema: $ref: '#/components/schemas/AccountLimitExceededException' examples: CreateProject482Example: summary: Default CreateProject 482 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectInput' examples: CreateProjectRequestExample: summary: Default CreateProject request x-microcks-default: true value: name: example-resource description: Example description source: example-value secondarySources: example-value sourceVersion: 1.0.0 secondarySourceVersions: 1.0.0 artifacts: example-value secondaryArtifacts: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.CreateProject summary: Amazon CodeBuild Create Project x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.CreateReportGroup: post: operationId: CreateReportGroup description: ' Creates a report group. A report group contains a collection of reports. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateReportGroupOutput' examples: CreateReportGroup200Example: summary: Default CreateReportGroup 200 response x-microcks-default: true value: reportGroup: example-value '480': description: InvalidInputException content: application/json: schema: $ref: '#/components/schemas/InvalidInputException' examples: CreateReportGroup480Example: summary: Default CreateReportGroup 480 response x-microcks-default: true value: example-value '481': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' examples: CreateReportGroup481Example: summary: Default CreateReportGroup 481 response x-microcks-default: true value: example-value '482': description: AccountLimitExceededException content: application/json: schema: $ref: '#/components/schemas/AccountLimitExceededException' examples: CreateReportGroup482Example: summary: Default CreateReportGroup 482 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateReportGroupInput' examples: CreateReportGroupRequestExample: summary: Default CreateReportGroup request x-microcks-default: true value: name: example-resource type: STANDARD exportConfig: example-value tags: example-value parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeBuild_20161006.CreateReportGroup summary: Amazon CodeBuild Create Report Group x-microcks-operation: delay: 0 dispatcher: FALLBACK 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' /#X-Amz-Target=CodeBuild_20161006.CreateWebhook: post: operationId: CreateWebhook description: 'For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project''s Settings.
ReportGroup. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListReportsForReportGroupOutput'
examples:
ListReportsForReportGroup200Example:
summary: Default ListReportsForReportGroup 200 response
x-microcks-default: true
value:
nextToken: example-value
reports: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListReportsForReportGroup480Example:
summary: Default ListReportsForReportGroup 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
ListReportsForReportGroup481Example:
summary: Default ListReportsForReportGroup 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListReportsForReportGroupInput'
examples:
ListReportsForReportGroupRequestExample:
summary: Default ListReportsForReportGroup request
x-microcks-default: true
value:
reportGroupArn: arn:aws:service:us-east-1:123456789012:resource/example
nextToken: example-value
sortOrder: example-value
maxResults: example-value
filter: example-value
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.ListReportsForReportGroup
summary: Amazon CodeBuild List Reports for Report Group
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.ListSharedProjects:
post:
operationId: ListSharedProjects
description: ' Gets a list of projects that are shared with other Amazon Web Services accounts or users. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSharedProjectsOutput'
examples:
ListSharedProjects200Example:
summary: Default ListSharedProjects 200 response
x-microcks-default: true
value:
nextToken: example-value
projects: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListSharedProjects480Example:
summary: Default ListSharedProjects 480 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListSharedProjectsInput'
examples:
ListSharedProjectsRequestExample:
summary: Default ListSharedProjects request
x-microcks-default: true
value:
sortBy: example-value
sortOrder: example-value
maxResults: example-value
nextToken: example-value
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.ListSharedProjects
summary: Amazon CodeBuild List Shared Projects
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.ListSharedReportGroups:
post:
operationId: ListSharedReportGroups
description: ' Gets a list of report groups that are shared with other Amazon Web Services accounts or users. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSharedReportGroupsOutput'
examples:
ListSharedReportGroups200Example:
summary: Default ListSharedReportGroups 200 response
x-microcks-default: true
value:
nextToken: example-value
reportGroups: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListSharedReportGroups480Example:
summary: Default ListSharedReportGroups 480 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListSharedReportGroupsInput'
examples:
ListSharedReportGroupsRequestExample:
summary: Default ListSharedReportGroups request
x-microcks-default: true
value:
sortOrder: example-value
sortBy: example-value
nextToken: example-value
maxResults: example-value
parameters:
- name: maxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: nextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.ListSharedReportGroups
summary: Amazon CodeBuild List Shared Report Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.ListSourceCredentials:
post:
operationId: ListSourceCredentials
description: ' Returns a list of SourceCredentialsInfo objects. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSourceCredentialsOutput'
examples:
ListSourceCredentials200Example:
summary: Default ListSourceCredentials 200 response
x-microcks-default: true
value:
sourceCredentialsInfos: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
ListSourceCredentials480Example:
summary: Default ListSourceCredentials 480 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListSourceCredentialsInput'
examples:
ListSourceCredentialsRequestExample:
summary: Default ListSourceCredentials request
x-microcks-default: true
value: {}
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.ListSourceCredentials
summary: Amazon CodeBuild List Source Credentials
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.PutResourcePolicy:
post:
operationId: PutResourcePolicy
description: ' Stores a resource policy for the ARN of a Project or ReportGroup object. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyOutput'
examples:
PutResourcePolicy200Example:
summary: Default PutResourcePolicy 200 response
x-microcks-default: true
value:
resourceArn: arn:aws:service:us-east-1:123456789012:resource/example
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
PutResourcePolicy480Example:
summary: Default PutResourcePolicy 480 response
x-microcks-default: true
value: example-value
'481':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
PutResourcePolicy481Example:
summary: Default PutResourcePolicy 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutResourcePolicyInput'
examples:
PutResourcePolicyRequestExample:
summary: Default PutResourcePolicy request
x-microcks-default: true
value:
policy: example-value
resourceArn: arn:aws:service:us-east-1:123456789012:resource/example
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.PutResourcePolicy
summary: Amazon CodeBuild Put Resource Policy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.RetryBuild:
post:
operationId: RetryBuild
description: Restarts a build.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RetryBuildOutput'
examples:
RetryBuild200Example:
summary: Default RetryBuild 200 response
x-microcks-default: true
value:
build:
id: '500123'
arn: arn:aws:service:us-east-1:123456789012:resource/example
buildNumber: example-value
startTime: example-value
endTime: example-value
currentPhase: example-value
buildStatus: ACTIVE
sourceVersion: 1.0.0
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
RetryBuild480Example:
summary: Default RetryBuild 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
RetryBuild481Example:
summary: Default RetryBuild 481 response
x-microcks-default: true
value: example-value
'482':
description: AccountLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/AccountLimitExceededException'
examples:
RetryBuild482Example:
summary: Default RetryBuild 482 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RetryBuildInput'
examples:
RetryBuildRequestExample:
summary: Default RetryBuild request
x-microcks-default: true
value:
id: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.RetryBuild
summary: Amazon CodeBuild Retry Build
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.RetryBuildBatch:
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
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'
/#X-Amz-Target=CodeBuild_20161006.StartBuild:
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
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'
/#X-Amz-Target=CodeBuild_20161006.StartBuildBatch:
post:
operationId: StartBuildBatch
description: Starts a batch build for a project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildBatchOutput'
examples:
StartBuildBatch200Example:
summary: Default StartBuildBatch 200 response
x-microcks-default: true
value:
buildBatch: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StartBuildBatch480Example:
summary: Default StartBuildBatch 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StartBuildBatch481Example:
summary: Default StartBuildBatch 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartBuildBatchInput'
examples:
StartBuildBatchRequestExample:
summary: Default StartBuildBatch 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.StartBuildBatch
summary: Amazon CodeBuild Start Build Batch
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.StopBuild:
post:
operationId: StopBuild
description: Attempts to stop running a build.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildOutput'
examples:
StopBuild200Example:
summary: Default StopBuild 200 response
x-microcks-default: true
value:
build: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
StopBuild480Example:
summary: Default StopBuild 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopBuild481Example:
summary: Default StopBuild 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildInput'
examples:
StopBuildRequestExample:
summary: Default StopBuild request
x-microcks-default: true
value:
id: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.StopBuild
summary: Amazon CodeBuild Stop Build
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.StopBuildBatch:
post:
operationId: StopBuildBatch
description: Stops a running batch build.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildBatchOutput'
examples:
StopBuildBatch200Example:
summary: Default StopBuildBatch 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:
StopBuildBatch480Example:
summary: Default StopBuildBatch 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
StopBuildBatch481Example:
summary: Default StopBuildBatch 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopBuildBatchInput'
examples:
StopBuildBatchRequestExample:
summary: Default StopBuildBatch request
x-microcks-default: true
value:
id: '500123'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.StopBuildBatch
summary: Amazon CodeBuild Stop Build Batch
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.UpdateProject:
post:
operationId: UpdateProject
description: Changes the settings of a build project.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectOutput'
examples:
UpdateProject200Example:
summary: Default UpdateProject 200 response
x-microcks-default: true
value:
project: example-value
'480':
description: InvalidInputException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputException'
examples:
UpdateProject480Example:
summary: Default UpdateProject 480 response
x-microcks-default: true
value: example-value
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdateProject481Example:
summary: Default UpdateProject 481 response
x-microcks-default: true
value: example-value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateProjectInput'
examples:
UpdateProjectRequestExample:
summary: Default UpdateProject request
x-microcks-default: true
value:
name: example-resource
description: Example description
source: example-value
secondarySources: example-value
sourceVersion: 1.0.0
secondarySourceVersions: 1.0.0
artifacts: example-value
secondaryArtifacts: example-value
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- CodeBuild_20161006.UpdateProject
summary: Amazon CodeBuild Update Project
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
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'
/#X-Amz-Target=CodeBuild_20161006.UpdateProjectVisibility:
post:
operationId: UpdateProjectVisibility
description: 'Changes the public visibility for a project. The project''s build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project''s build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret is ignored.
BuildBatch objects that represent the retrieved batch builds.
buildBatchesNotFound:
allOf:
- $ref: '#/components/schemas/BuildBatchIds'
- description: An array that contains the identifiers of any batch builds that are not found.
BatchGetBuildBatchesInput:
type: object
required:
- ids
title: BatchGetBuildBatchesInput
properties:
ids:
allOf:
- $ref: '#/components/schemas/BuildBatchIds'
- description: An array that contains the batch build identifiers to retrieve.
BatchGetBuildsOutput:
type: object
properties:
builds:
allOf:
- $ref: '#/components/schemas/Builds'
- description: Information about the requested builds.
buildsNotFound:
allOf:
- $ref: '#/components/schemas/BuildIds'
- description: The IDs of builds for which information could not be found.
BatchGetBuildsInput:
type: object
required:
- ids
title: BatchGetBuildsInput
properties:
ids:
allOf:
- $ref: '#/components/schemas/BuildIds'
- description: The IDs of the builds.
BatchGetProjectsOutput:
type: object
properties:
projects:
allOf:
- $ref: '#/components/schemas/Projects'
- description: Information about the requested build projects.
projectsNotFound:
allOf:
- $ref: '#/components/schemas/ProjectNames'
- description: The names of build projects for which information could not be found.
BatchGetProjectsInput:
type: object
required:
- names
title: BatchGetProjectsInput
properties:
names:
allOf:
- $ref: '#/components/schemas/ProjectNames'
- description: 'The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared
project using its name.'
BatchGetReportGroupsOutput:
type: object
properties:
reportGroups:
allOf:
- $ref: '#/components/schemas/ReportGroups'
- description: ' The array of report groups returned by BatchGetReportGroups. '
reportGroupsNotFound:
allOf:
- $ref: '#/components/schemas/ReportGroupArns'
- description: ' An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup. '
BatchGetReportGroupsInput:
type: object
required:
- reportGroupArns
title: BatchGetReportGroupsInput
properties:
reportGroupArns:
allOf:
- $ref: '#/components/schemas/ReportGroupArns'
- description: ' An array of report group ARNs that identify the report groups to return. '
BatchGetReportsOutput:
type: object
properties:
reports:
allOf:
- $ref: '#/components/schemas/Reports'
- description: ' The array of Report objects returned by BatchGetReports. '
reportsNotFound:
allOf:
- $ref: '#/components/schemas/ReportArns'
- description: ' An array of ARNs passed to BatchGetReportGroups that are not associated with a Report. '
BatchGetReportsInput:
type: object
required:
- reportArns
title: BatchGetReportsInput
properties:
reportArns:
allOf:
- $ref: '#/components/schemas/ReportArns'
- description: ' An array of ARNs that identify the Report objects to return. '
CreateProjectOutput:
type: object
properties:
project:
allOf:
- $ref: '#/components/schemas/Project'
- description: Information about the build project that was created.
CreateProjectInput:
type: object
required:
- name
- source
- artifacts
- environment
- serviceRole
title: CreateProjectInput
properties:
name:
allOf:
- $ref: '#/components/schemas/ProjectName'
- description: The name of the build project.
description:
allOf:
- $ref: '#/components/schemas/ProjectDescription'
- description: A description that makes the build project easy to identify.
source:
allOf:
- $ref: '#/components/schemas/ProjectSource'
- description: Information about the build input source code for the build project.
secondarySources:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: 'An array of ProjectSource objects. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes
precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' secondarySourceVersions: allOf: - $ref: '#/components/schemas/ProjectSecondarySourceVersions' - description: 'An array ofProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions
(at the project level). '
artifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifacts'
- description: Information about the build output artifacts for the build project.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: 'An array of ProjectArtifacts objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Stores recently used information so that it can be quickly accessed at a later time.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for the build project.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.'
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'The number of minutes a build is allowed to be queued before it times out. '
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK''s alias (using
the format alias/<alias-name>).
A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
vpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: VpcConfig enables CodeBuild to access resources in an Amazon VPC. badgeEnabled: allOf: - $ref: '#/components/schemas/WrapperBoolean' - description: Set this to true to generate a publicly accessible URL for your project's build badge. logsConfig: allOf: - $ref: '#/components/schemas/LogsConfig' - description: 'Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both. ' fileSystemLocations: allOf: - $ref: '#/components/schemas/ProjectFileSystemLocations' - description: ' An array ofProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System. '
buildBatchConfig:
allOf:
- $ref: '#/components/schemas/ProjectBuildBatchConfig'
- description: A ProjectBuildBatchConfig object that defines the batch build options for the project.
concurrentBuildLimit:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
' ResourceAlreadyExistsException: {} AccountLimitExceededException: {} CreateReportGroupOutput: type: object properties: reportGroup: allOf: - $ref: '#/components/schemas/ReportGroup' - description: ' Information about the report group that was created. ' CreateReportGroupInput: type: object required: - name - type - exportConfig title: CreateReportGroupInput properties: name: allOf: - $ref: '#/components/schemas/ReportGroupName' - description: ' The name of the report group. ' type: allOf: - $ref: '#/components/schemas/ReportType' - description: ' The type of report group. ' exportConfig: allOf: - $ref: '#/components/schemas/ReportExportConfig' - description: ' AReportExportConfig object that contains information about where the report group test results are exported. '
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
CreateWebhookOutput: type: object properties: webhook: allOf: - $ref: '#/components/schemas/Webhook' - description: Information about a webhook that connects repository events to a build project in CodeBuild. CreateWebhookInput: type: object required: - projectName title: CreateWebhookInput properties: projectName: allOf: - $ref: '#/components/schemas/ProjectName' - description: The name of the CodeBuild project. branchFilter: allOf: - $ref: '#/components/schemas/String' - description: 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built.
If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT
as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must
pass.
BuildNotDeleted objects that specify the builds that could not be deleted.
DeleteBuildBatchInput:
type: object
required:
- id
title: DeleteBuildBatchInput
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The identifier of the batch build to delete.
DeleteProjectOutput:
type: object
properties: {}
DeleteProjectInput:
type: object
required:
- name
title: DeleteProjectInput
properties:
name:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the build project.
DeleteReportOutput:
type: object
properties: {}
DeleteReportInput:
type: object
required:
- arn
title: DeleteReportInput
properties:
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The ARN of the report to delete. '
DeleteReportGroupOutput:
type: object
properties: {}
DeleteReportGroupInput:
type: object
required:
- arn
title: DeleteReportGroupInput
properties:
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The ARN of the report group to delete. '
deleteReports:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, deletes any reports that belong to a report group before deleting the report group.
If false, you must delete any reports in the report
group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group
that contains one or more reports, an exception is thrown.
DescribeCodeCoverages to retrieve the next set of items.'
codeCoverages:
allOf:
- $ref: '#/components/schemas/CodeCoverages'
- description: An array of CodeCoverage objects that contain the results.
DescribeCodeCoveragesInput:
type: object
required:
- reportArn
title: DescribeCodeCoveragesInput
properties:
reportArn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The ARN of the report for which test cases are returned. '
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list,
exclude this parameter.'
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: Specifies if the results are sorted in ascending or descending order.
sortBy:
allOf:
- $ref: '#/components/schemas/ReportCodeCoverageSortByType'
- description: 'Specifies how the results are sorted. Possible values are:
The results are sorted by file path.
The results are sorted by the percentage of lines that are covered.
maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
testCases:
allOf:
- $ref: '#/components/schemas/TestCases'
- description: ' The returned list of test cases. '
DescribeTestCasesInput:
type: object
required:
- reportArn
title: DescribeTestCasesInput
properties:
reportArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of the report for which test cases are returned. '
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default
value is 100. '
filter:
allOf:
- $ref: '#/components/schemas/TestCaseFilter'
- description: ' A TestCaseFilter object used to filter the returned reports. '
GetReportGroupTrendOutput:
type: object
properties:
stats:
allOf:
- $ref: '#/components/schemas/ReportGroupTrendStats'
- description: Contains the accumulated trend data.
rawData:
allOf:
- $ref: '#/components/schemas/ReportGroupTrendRawDataList'
- description: An array that contains the raw data for each report.
GetReportGroupTrendInput:
type: object
required:
- reportGroupArn
- trendField
title: GetReportGroupTrendInput
properties:
reportGroupArn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ARN of the report group that contains the reports to analyze.
numOfReports:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: 'The number of reports to analyze. This operation always retrieves the most recent reports.
If this parameter is omitted, the most recent 100 reports are analyzed.
' trendField: allOf: - $ref: '#/components/schemas/ReportGroupTrendFieldType' - description: 'The test report value to accumulate. This must be one of the following values:
Accumulate the test run times for the specified reports.
Accumulate the percentage of tests that passed for the specified test reports.
Accumulate the total number of tests for the specified test reports.
Accumulate the branch coverage percentages for the specified test reports.
Accumulate the branches covered values for the specified test reports.
Accumulate the branches missed values for the specified test reports.
Accumulate the line coverage percentages for the specified test reports.
Accumulate the lines covered values for the specified test reports.
Accumulate the lines not covered values for the specified test reports.
authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. '
token:
allOf:
- $ref: '#/components/schemas/SensitiveNonEmptyString'
- description: ' For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. '
serverType:
allOf:
- $ref: '#/components/schemas/ServerType'
- description: ' The source provider used for this project. '
authType:
allOf:
- $ref: '#/components/schemas/AuthType'
- description: ' The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the
CodeBuild console. '
shouldOverwrite:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value
is true. '
InvalidateProjectCacheOutput:
type: object
properties: {}
InvalidateProjectCacheInput:
type: object
required:
- projectName
title: InvalidateProjectCacheInput
properties:
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the CodeBuild build project that the cache is reset for.
ListBuildBatchesOutput:
type: object
properties:
ids:
allOf:
- $ref: '#/components/schemas/BuildBatchIds'
- description: An array of strings that contains the batch build identifiers.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.'
ListBuildBatchesInput:
type: object
title: ListBuildBatchesInput
properties:
filter:
allOf:
- $ref: '#/components/schemas/BuildBatchFilter'
- description: A BuildBatchFilter object that specifies the filters for the search.
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: 'Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude
this parameter.'
ListBuildBatchesForProjectOutput:
type: object
properties:
ids:
allOf:
- $ref: '#/components/schemas/BuildBatchIds'
- description: An array of strings that contains the batch build identifiers.
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.'
ListBuildBatchesForProjectInput:
type: object
title: ListBuildBatchesForProjectInput
properties:
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the project.
filter:
allOf:
- $ref: '#/components/schemas/BuildBatchFilter'
- description: A BuildBatchFilter object that specifies the filters for the search.
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: The maximum number of results to return.
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: 'Specifies the sort order of the returned items. Valid values include:
ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.
nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the
list, exclude this parameter.'
ListBuildsOutput:
type: object
properties:
ids:
allOf:
- $ref: '#/components/schemas/BuildIds'
- description: 'A list of build IDs, with each build ID representing a single build.'
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the
list, call this operation again, adding the next token to the call.'
ListBuildsInput:
type: object
title: ListBuildsInput
properties:
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: 'The order to list build IDs. Valid values include:
ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING:
List the build IDs in descending order by build ID.
The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.
Valid values include:
ASCENDING: List the build identifiers in ascending order, by build number.
DESCENDING: List the build
identifiers in descending order, by build number.
If the project has more than 100 builds, setting the sort order will result in an error.
' nextToken: allOf: - $ref: '#/components/schemas/String' - description: 'During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.' ListCuratedEnvironmentImagesOutput: type: object properties: platforms: allOf: - $ref: '#/components/schemas/EnvironmentPlatforms' - description: Information about supported platforms for Docker images that are managed by CodeBuild. ListCuratedEnvironmentImagesInput: type: object title: ListCuratedEnvironmentImagesInput properties: {} ListProjectsOutput: type: object properties: nextToken: allOf: - $ref: '#/components/schemas/String' - description: 'If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.' projects: allOf: - $ref: '#/components/schemas/ProjectNames' - description: 'The list of build project names, with each build project name representing a single build project.' ListProjectsInput: type: object title: ListProjectsInput properties: sortBy: allOf: - $ref: '#/components/schemas/ProjectSortByType' - description: 'The criterion to be used to list build project names. Valid values include:
CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project''s
name.
Use sortOrder to specify in what order to list the build project names based on the preceding criteria.
The order in which to list build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING:
List in descending order.
Use sortBy to specify the criterion to be used to list build project names.
maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
reportGroups:
allOf:
- $ref: '#/components/schemas/ReportGroupArns'
- description: ' The list of ARNs for the report groups in the current Amazon Web Services account. '
ListReportGroupsInput:
type: object
title: ListReportGroupsInput
properties:
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: ' Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING. '
sortBy:
allOf:
- $ref: '#/components/schemas/ReportGroupSortByType'
- description: 'The criterion to be used to list build report groups. Valid values include:
CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group''s name.
maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The
default value is 100. '
ListReportsOutput:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
reports:
allOf:
- $ref: '#/components/schemas/ReportArns'
- description: ' The list of returned ARNs for the reports in the current Amazon Web Services account. '
ListReportsInput:
type: object
title: ListReportsInput
properties:
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: 'Specifies the sort order for the list of returned reports. Valid values are:
ASCENDING: return reports in chronological order based on their
creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.
maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value
is 100. '
filter:
allOf:
- $ref: '#/components/schemas/ReportFilter'
- description: ' A ReportFilter object used to filter the returned reports. '
ListReportsForReportGroupOutput:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
reports:
allOf:
- $ref: '#/components/schemas/ReportArns'
- description: ' The list of report ARNs. '
ListReportsForReportGroupInput:
type: object
required:
- reportGroupArn
title: ListReportsForReportGroupInput
properties:
reportGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of the report group for which you want to return report ARNs. '
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: ' Use to specify whether the results are returned in ascending or descending order. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects.
The default value is 100. '
filter:
allOf:
- $ref: '#/components/schemas/ReportFilter'
- description: ' A ReportFilter object used to filter the returned reports. '
ListSharedProjectsOutput:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
projects:
allOf:
- $ref: '#/components/schemas/ProjectArns'
- description: ' The list of ARNs for the build projects shared with the current Amazon Web Services account or user. '
ListSharedProjectsInput:
type: object
title: ListSharedProjectsInput
properties:
sortBy:
allOf:
- $ref: '#/components/schemas/SharedResourceSortByType'
- description: 'The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:
ARN: List
based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.
The order in which to list shared build projects. Valid values include:
ASCENDING: List in ascending order.
DESCENDING:
List in descending order.
nextToken to iterate pages in the list of returned Project objects.
The default value is 100. '
nextToken:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
ListSharedReportGroupsOutput:
type: object
properties:
nextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: ' During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
reportGroups:
allOf:
- $ref: '#/components/schemas/ReportGroupArns'
- description: ' The list of ARNs for the report groups shared with the current Amazon Web Services account or user. '
ListSharedReportGroupsInput:
type: object
title: ListSharedReportGroupsInput
properties:
sortOrder:
allOf:
- $ref: '#/components/schemas/SortOrderType'
- description: 'The order in which to list shared report groups. Valid values include:
ASCENDING: List in ascending order.
DESCENDING:
List in descending order.
The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:
ARN: List
based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.
maxResults. If there more items in the list, then a unique string
called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling
this operation with each subsequent next token that is returned, until no more next tokens are returned. '
maxResults:
allOf:
- $ref: '#/components/schemas/PageSize'
- description: ' The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default
value is 100. '
ListSourceCredentialsOutput:
type: object
properties:
sourceCredentialsInfos:
allOf:
- $ref: '#/components/schemas/SourceCredentialsInfos'
- description: ' A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for
one set of credentials. '
ListSourceCredentialsInput:
type: object
title: ListSourceCredentialsInput
properties: {}
PutResourcePolicyOutput:
type: object
properties:
resourceArn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The ARN of the Project or ReportGroup resource that is associated with a resource policy. '
PutResourcePolicyInput:
type: object
required:
- policy
- resourceArn
title: PutResourcePolicyInput
properties:
policy:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' A JSON-formatted resource policy. For more information, see Sharing
a Project and Sharing a Report Group in the CodeBuild User
Guide. '
resourceArn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The ARN of the Project or ReportGroup resource you want to associate with a resource policy. '
RetryBuildOutput:
type: object
properties:
build:
$ref: '#/components/schemas/Build'
RetryBuildInput:
type: object
title: RetryBuildInput
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Specifies the identifier of the build to restart.
RetryBuildBatchOutput:
type: object
properties:
buildBatch:
$ref: '#/components/schemas/BuildBatch'
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.
StartBuildOutput:
type: object
properties:
build:
allOf:
- $ref: '#/components/schemas/Build'
- description: Information about the build to be run.
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 ProjectSource objects. '
secondarySourcesVersionOverride:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: ' An array of ProjectSourceVersion 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: '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:
The commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example pr/25). 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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified
at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' 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 ofProjectArtifacts 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: 'A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec
File Name and Storage Location.
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 invalidInputException is thrown.
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 Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
GITHUB,
GITHUB_ENTERPRISE, or BITBUCKET.'
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: '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.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN)
of the CMK or, if available, the CMK''s alias (using the format alias/<alias-name>).
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild''s service principal.
Specifies that CodeBuild uses your build project''s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must
use CODEBUILD credentials.
BuildBatch object that contains information about the batch build.
StartBuildBatchInput:
type: object
required:
- projectName
title: StartBuildBatchInput
properties:
projectName:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the project.
secondarySourcesOverride:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: An array of ProjectSource objects that override the secondary sources defined in the batch build project.
secondarySourcesVersionOverride:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The version of the batch 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:
The commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example pr/25). 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.
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.
The version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified
at the project level, then this sourceVersion (at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' artifactsOverride: allOf: - $ref: '#/components/schemas/ProjectArtifacts' - description: An array ofProjectArtifacts objects that contains information about the build output artifact overrides for the build project.
secondaryArtifactsOverride:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.
environmentVariablesOverride:
allOf:
- $ref: '#/components/schemas/EnvironmentVariables'
- description: 'An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.'
sourceTypeOverride:
allOf:
- $ref: '#/components/schemas/SourceType'
- description: The source input type that overrides the source input defined in the batch build project.
sourceLocationOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A location that overrides, for this batch build, the source location defined in the batch build project.'
sourceAuthOverride:
allOf:
- $ref: '#/components/schemas/SourceAuth'
- description: A SourceAuth object that overrides the one defined in the batch 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 batch build only, any previous depth of history defined in the batch build project.'
gitSubmodulesConfigOverride:
allOf:
- $ref: '#/components/schemas/GitSubmodulesConfig'
- description: A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
buildspecOverride:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.
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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec
File Name and Storage Location.
Set to true to report to your source provider the status of a batch build''s start and completion. If you use this option with a source provider other than GitHub,
GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.
The status of a build triggered by a webhook is always reported to your source provider.
ProjectCache object that specifies cache overrides.
serviceRoleOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role for this batch build that overrides the one specified in the batch build project.
privilegedModeOverride:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Enable this flag to override privileged mode in the batch build project.
buildTimeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: Overrides the build timeout specified in the batch build project.
queuedTimeoutInMinutesOverride:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: The number of minutes a batch build is allowed to be queued before it times out.
encryptionKeyOverride:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name
(ARN) of the CMK or, if available, the CMK''s alias (using the format alias/<alias-name>).
LogsConfig object that override the log settings defined in the batch build project.
registryCredentialOverride:
allOf:
- $ref: '#/components/schemas/RegistryCredential'
- description: A RegistryCredential object that overrides credentials for access to a private registry.
imagePullCredentialsTypeOverride:
allOf:
- $ref: '#/components/schemas/ImagePullCredentialsType'
- description: 'The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:
Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild''s service principal.
Specifies that CodeBuild uses your build project''s service role.
When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated
image, you must use CODEBUILD credentials.
BuildBatchConfigOverride object that contains batch build configuration overrides.
debugSessionEnabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: 'Specifies if session debugging is enabled for this batch build. For more information, see Viewing
a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.'
StopBuildOutput:
type: object
properties:
build:
allOf:
- $ref: '#/components/schemas/Build'
- description: Information about the build.
StopBuildInput:
type: object
required:
- id
title: StopBuildInput
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the build.
StopBuildBatchOutput:
type: object
properties:
buildBatch:
$ref: '#/components/schemas/BuildBatch'
StopBuildBatchInput:
type: object
required:
- id
title: StopBuildBatchInput
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The identifier of the batch build to stop.
UpdateProjectOutput:
type: object
properties:
project:
allOf:
- $ref: '#/components/schemas/Project'
- description: Information about the build project that was changed.
UpdateProjectInput:
type: object
required:
- name
title: UpdateProjectInput
properties:
name:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the build project.
You cannot change a build project's name.
ProjectSource objects. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes
precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' secondarySourceVersions: allOf: - $ref: '#/components/schemas/ProjectSecondarySourceVersions' - description: ' An array ofProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions
(at the project level). '
artifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifacts'
- description: Information to be changed about the build output artifacts for the build project.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: ' An array of ProjectArtifact objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Stores recently used information so that it can be quickly accessed at a later time.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information to be changed about the build environment for the build project.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.'
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: ' The number of minutes a build is allowed to be queued before it times out. '
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK''s alias
(using the format alias/<alias-name>).
An updated list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
vpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: VpcConfig enables CodeBuild to access resources in an Amazon VPC. badgeEnabled: allOf: - $ref: '#/components/schemas/WrapperBoolean' - description: Set this to true to generate a publicly accessible URL for your project's build badge. logsConfig: allOf: - $ref: '#/components/schemas/LogsConfig' - description: ' Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both. ' fileSystemLocations: allOf: - $ref: '#/components/schemas/ProjectFileSystemLocations' - description: ' An array ofProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System. '
buildBatchConfig:
$ref: '#/components/schemas/ProjectBuildBatchConfig'
concurrentBuildLimit:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
To remove this limit, set this value to -1.
' UpdateProjectVisibilityOutput: type: object properties: projectArn: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The Amazon Resource Name (ARN) of the build project. publicProjectAlias: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'Contains the project identifier used with the public build APIs. ' projectVisibility: $ref: '#/components/schemas/ProjectVisibilityType' UpdateProjectVisibilityInput: type: object required: - projectArn - projectVisibility title: UpdateProjectVisibilityInput properties: projectArn: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The Amazon Resource Name (ARN) of the build project. projectVisibility: $ref: '#/components/schemas/ProjectVisibilityType' resourceAccessRole: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. UpdateReportGroupOutput: type: object properties: reportGroup: allOf: - $ref: '#/components/schemas/ReportGroup' - description: ' Information about the updated report group. ' UpdateReportGroupInput: type: object required: - arn title: UpdateReportGroupInput properties: arn: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: ' The ARN of the report group to update. ' exportConfig: allOf: - $ref: '#/components/schemas/ReportExportConfig' - description: 'Used to specify an updated export type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT:
The report results are not exported.
An updated list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
UpdateWebhookOutput: type: object properties: webhook: allOf: - $ref: '#/components/schemas/Webhook' - description: ' Information about a repository''s webhook that is associated with a project in CodeBuild. ' UpdateWebhookInput: type: object required: - projectName title: UpdateWebhookInput properties: projectName: allOf: - $ref: '#/components/schemas/ProjectName' - description: The name of the CodeBuild project. branchFilter: allOf: - $ref: '#/components/schemas/String' - description: 'A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built.
If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
rotateSecret
is ignored. '
filterGroups:
allOf:
- $ref: '#/components/schemas/FilterGroups'
- description: ' An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT
WebhookFilter. '
buildType:
allOf:
- $ref: '#/components/schemas/WebhookBuildType'
- description: Specifies the type of build this webhook will trigger.
ArtifactNamespace:
type: string
enum:
- NONE
- BUILD_ID
ArtifactPackaging:
type: string
enum:
- NONE
- ZIP
ArtifactsType:
type: string
enum:
- CODEPIPELINE
- S3
- NO_ARTIFACTS
AuthType:
type: string
enum:
- OAUTH
- BASIC_AUTH
- PERSONAL_ACCESS_TOKEN
BuildIds:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
BuildsNotDeleted:
type: array
items:
$ref: '#/components/schemas/BuildNotDeleted'
BuildBatchIds:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 0
maxItems: 100
BuildBatches:
type: array
items:
$ref: '#/components/schemas/BuildBatch'
minItems: 0
maxItems: 100
Builds:
type: array
items:
$ref: '#/components/schemas/Build'
ProjectNames:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
Projects:
type: array
items:
$ref: '#/components/schemas/Project'
ReportGroupArns:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
ReportGroups:
type: array
items:
$ref: '#/components/schemas/ReportGroup'
minItems: 1
maxItems: 100
ReportArns:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
Reports:
type: array
items:
$ref: '#/components/schemas/Report'
minItems: 1
maxItems: 100
BatchReportModeType:
type: string
enum:
- REPORT_INDIVIDUAL_BUILDS
- REPORT_AGGREGATED_BATCH
WrapperInt:
type: integer
ComputeTypesAllowed:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
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 Build
environment compute types in the CodeBuild User Guide for these values. '
description: Specifies restrictions for the batch build.
Boolean:
type: boolean
BucketOwnerAccess:
type: string
enum:
- NONE
- READ_ONLY
- FULL
description: 'Specifies the bucket owner''s access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects to the bucket has access to these objects. This property allows you to give the bucket owner access to these objects.
To use this property, your CodeBuild service role must have the s3:PutBucketAcl
permission. This permission allows CodeBuild to modify the access control list for the bucket.
This property can be one of the following values:
The bucket owner does not have access to the objects. This is the default.
The bucket owner has read-only access to the objects. The uploading account retains ownership of the objects.
The bucket owner has full access to the objects. Object ownership is determined by the following criteria:
If the bucket is configured with the Bucket owner preferred setting, the bucket owner owns the objects. The uploading account will have object access as specified by the bucket''s policy.
Otherwise, the uploading account retains ownership of the objects.
For more information about Amazon S3 object ownership, see Controlling ownership of uploaded objects using S3 Object Ownership in the Amazon Simple Storage Service User Guide.
The type of repository that contains the source code to be built. Valid values include:
BITBUCKET: The source code is in a Bitbucket repository.
CODECOMMIT: The source code is in an CodeCommit repository.
CODEPIPELINE: The source code settings are specified in the source action
of a pipeline in CodePipeline.
GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.
GITHUB_ENTERPRISE:
The source code is in a GitHub Enterprise Server repository.
NO_SOURCE: The project does not have input source code.
S3: The
source code is in an Amazon S3 bucket.
Information about the location of the source code to be built. Valid values include:
For source code settings that are specified in the source action of a pipeline
in CodePipeline, location 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.
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, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).
For source code in an Amazon S3 input bucket, one of the following.
The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).
The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).
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 Authorize application
page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (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
source object, set the auth object''s type value to OAUTH.
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 Confirm access to your account page, choose Grant access. (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 source
object, set the auth object''s type value to OAUTH.
If you specify CODEPIPELINE for the Type property,
don''t specify this property. For all of the other types, you must specify Location.
The buildspec file declaration to use for the builds in this build project.
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 CODEBUILD_SRC_DIR 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, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). 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 Buildspec
File Name and Storage Location.
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
reportBuildStatus: allOf: - $ref: '#/components/schemas/WrapperBoolean' - description: ' 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 invalidInputException is thrown.
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 Source provider access in the CodeBuild User Guide.
The status of a build triggered by a webhook is always reported to your source provider.
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.
' 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 isGITHUB,
GITHUB_ENTERPRISE, or BITBUCKET.'
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.
ProjectSources:
type: array
items:
$ref: '#/components/schemas/ProjectSource'
minItems: 0
maxItems: 12
ProjectSecondarySourceVersions:
type: array
items:
$ref: '#/components/schemas/ProjectSourceVersion'
minItems: 0
maxItems: 12
BuildArtifacts:
type: object
properties:
location:
allOf:
- $ref: '#/components/schemas/String'
- description: Information about the location of the build artifacts.
sha256sum:
allOf:
- $ref: '#/components/schemas/String'
- description: The SHA-256 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is
available only if the build project's packaging value is set to ZIP.
The MD5 hash of the build artifact.
You can use this hash along with a checksum tool to confirm file integrity and authenticity.
This value is
available only if the build project's packaging value is set to ZIP.
The type of cache used by the build project. Valid values include:
NO_CACHE: The build project does not use any cache.
S3:
The build project reads and writes from and to S3.
LOCAL: The build project stores a cache locally on a build host that is only available to that build host.
Information about the cache location:
NO_CACHE or LOCAL: This value is ignored.
S3: This is the
S3 bucket name/prefix.
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.
Possible values are:
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.
You can use a Docker layer cache in the Linux environment only.
The privileged flag must be set so that your project has the required Docker permissions.
You should consider the security implications before you use a Docker layer cache.
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:
Only directories can be specified for caching. You cannot specify individual files.
Symlinks are used to reference cached directories.
Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.
The type of build environment to use for related builds.
The environment type ARM_CONTAINER 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).
The environment type LINUX_CONTAINER
with compute type build.general1.2xlarge 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).
The environment type LINUX_GPU_CONTAINER
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).
The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).
For more information, see Build environment compute types in the CodeBuild user guide.
' image: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
For an image tag: <registry>/<repository>:<tag>.
For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.
For an image digest: <registry>/<repository>@<digest>.
For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.
' computeType: allOf: - $ref: '#/components/schemas/ComputeType' - description: 'Information about the compute resources the build project uses. Available values include:
BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs
for builds.
BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GB memory
and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: 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.
If you use BUILD_GENERAL1_LARGE:
For environment type LINUX_CONTAINER,
you can use up to 15 GB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla
V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build Environment Compute Types in the CodeBuild User Guide.
' 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: '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 false.
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:
If the operating system''s base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock
--host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system''s base
image is Alpine Linux and the previous command does not work, add the -t argument to timeout:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock
--host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
The type of credentials CodeBuild uses to pull images in your build. There are two valid values:
CODEBUILD specifies that CodeBuild uses its
own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.
SERVICE_ROLE specifies that CodeBuild uses
your build project''s service role.
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.
' description: Information about the build environment of the build project. LogsLocation: type: object properties: groupName: allOf: - $ref: '#/components/schemas/String' - description: The name of the CloudWatch Logs group for the build logs. streamName: allOf: - $ref: '#/components/schemas/String' - description: The name of the CloudWatch Logs stream for the build logs. deepLink: allOf: - $ref: '#/components/schemas/String' - description: The URL to an individual build log in CloudWatch Logs. s3DeepLink: allOf: - $ref: '#/components/schemas/String' - description: ' The URL to a build log in an S3 bucket. ' cloudWatchLogsArn: allOf: - $ref: '#/components/schemas/String' - description: ' The ARN of CloudWatch Logs for a build project. Its format isarn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}. For
more information, see Resources Defined by CloudWatch
Logs. '
s3LogsArn:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The ARN of S3 logs for a build project. Its format is arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources
Defined by Amazon S3. '
cloudWatchLogs:
allOf:
- $ref: '#/components/schemas/CloudWatchLogsConfig'
- description: ' Information about CloudWatch Logs for a build project. '
s3Logs:
allOf:
- $ref: '#/components/schemas/S3LogsConfig'
- description: ' Information about S3 logs for a build project. '
description: Information about build logs in CloudWatch Logs.
VpcConfig:
type: object
properties:
vpcId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the Amazon VPC.
subnets:
allOf:
- $ref: '#/components/schemas/Subnets'
- description: A list of one or more subnet IDs in your Amazon VPC.
securityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: A list of one or more security groups IDs in your Amazon VPC.
description: Information about the VPC configuration that CodeBuild accesses.
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.
ExportedEnvironmentVariables:
type: array
items:
$ref: '#/components/schemas/ExportedEnvironmentVariable'
BuildReportArns:
type: array
items:
$ref: '#/components/schemas/String'
ProjectFileSystemLocations:
type: array
items:
$ref: '#/components/schemas/ProjectFileSystemLocation'
DebugSession:
type: object
properties:
sessionEnabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Specifies if session debugging is enabled for this build.
sessionTarget:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'Contains the identifier of the Session Manager session used for the build. To work with the paused build, you open this session to examine, control, and resume the build.'
description: 'Contains information about the debug session for a build. For more information, see Viewing a running
build in Session Manager.'
Build:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The unique ID for the build.
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The Amazon Resource Name (ARN) of the build.
buildNumber:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: 'The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented
by 1. If a build is deleted, the buildNumber of other builds does not change.'
startTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'When the build process started, expressed in Unix time format.'
endTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'When the build process ended, expressed in Unix time format.'
currentPhase:
allOf:
- $ref: '#/components/schemas/String'
- description: The current build phase.
buildStatus:
allOf:
- $ref: '#/components/schemas/StatusType'
- description: 'The current status of the build. Valid values include:
FAILED: The build failed.
FAULT: The build faulted.
IN_PROGRESS: The build is still in progress.
STOPPED: The build stopped.
SUCCEEDED: The build succeeded.
TIMED_OUT: The build timed out.
Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion
(at the build level) takes precedence.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' resolvedSourceVersion: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'An identifier for the version of this build''s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
ProjectSource objects. '
secondarySourceVersions:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: ' An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example, pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
ProjectArtifacts objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Information about the cache for the build.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for this build.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of a service role used for this build.
logs:
allOf:
- $ref: '#/components/schemas/LogsLocation'
- description: Information about the build's logs in CloudWatch Logs.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: 'How long, in minutes, for CodeBuild to wait before timing out this build if it does not get marked as completed.'
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: ' The number of minutes a build is allowed to be queued before it times out. '
buildComplete:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Whether the build is complete. True if complete; otherwise, false.'
initiator:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The entity that started the build. Valid values include:
If CodePipeline started the build, the pipeline''s name (for example, codepipeline/my-demo-pipeline).
If an IAM user started the build, the user''s name (for example, MyUserName).
If the Jenkins plugin for CodeBuild started the build, the string
CodeBuild-Jenkins-Plugin.
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK''s alias
(using the format alias/<alias-name>).
A list of exported environment variables for this build.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
' reportArns: allOf: - $ref: '#/components/schemas/BuildReportArns' - description: ' An array of the ARNs associated with this build''s reports. ' fileSystemLocations: allOf: - $ref: '#/components/schemas/ProjectFileSystemLocations' - description: ' An array ofProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System. '
debugSession:
allOf:
- $ref: '#/components/schemas/DebugSession'
- description: Contains information about the debug session for this build.
buildBatchArn:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ARN of the batch build that this build is a member of, if applicable.'
description: Information about a build.
WrapperBoolean:
type: boolean
BuildBatchPhases:
type: array
items:
$ref: '#/components/schemas/BuildBatchPhase'
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. '
ProjectBuildBatchConfig:
type: object
properties:
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: Specifies the service role ARN for the batch build project.
combineArtifacts:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: Specifies if the build artifacts for the batch build should be combined into a single artifact location.
restrictions:
allOf:
- $ref: '#/components/schemas/BatchRestrictions'
- description: A BatchRestrictions object that specifies the restrictions for the batch build.
timeoutInMins:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: 'Specifies the maximum amount of time, in minutes, that the batch build must be completed in.'
batchReportMode:
allOf:
- $ref: '#/components/schemas/BatchReportModeType'
- description: 'Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
(Default) Aggregate all of the build statuses into a single status report.
Send a separate status report for each individual build.
The identifier of the resolved version of this batch build''s source code.
For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
For CodePipeline, the source revision provided by CodePipeline.
For Amazon S3, this does not apply.
BuildBatchPhase objects the specify the phases of the batch build.
source:
$ref: '#/components/schemas/ProjectSource'
secondarySources:
allOf:
- $ref: '#/components/schemas/ProjectSources'
- description: An array of ProjectSource objects that define the sources for the batch build.
secondarySourceVersions:
allOf:
- $ref: '#/components/schemas/ProjectSecondarySourceVersions'
- description: 'An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example, pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
BuildArtifacts object the defines the build artifacts for this batch build.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/BuildArtifactsList'
- description: An array of BuildArtifacts 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: 'The entity that started the batch build. Valid values include:
If CodePipeline started the build, the pipeline''s name (for example, codepipeline/my-demo-pipeline).
If an IAM user started the build, the user''s name.
If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK''s alias
(using the format alias/<alias-name>).
buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent
batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.'
fileSystemLocations:
allOf:
- $ref: '#/components/schemas/ProjectFileSystemLocations'
- description: 'An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location,
mountOptions, mountPoint, and type 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 BuildGroup 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 Viewing
a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.'
description: Contains information about a batch build.
BuildBatchFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/StatusType'
- description: The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
description: Specifies filters when retrieving batch builds.
BuildBatchPhaseType:
type: string
enum:
- SUBMITTED
- DOWNLOAD_BATCHSPEC
- IN_PROGRESS
- COMBINE_ARTIFACTS
- SUCCEEDED
- FAILED
- STOPPED
PhaseContexts:
type: array
items:
$ref: '#/components/schemas/PhaseContext'
BuildBatchPhase:
type: object
properties:
phaseType:
allOf:
- $ref: '#/components/schemas/BuildBatchPhaseType'
- description: 'The name of the batch build phase. Valid values include:
Build output artifacts are being combined and uploaded to the output location.
The batch build specification is being downloaded.
One or more of the builds failed.
The batch build is in progress.
The batch build was stopped.
The btach build has been submitted.
The batch build succeeded.
The current status of the batch build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
The status of the build group.
The build group failed.
The build group faulted.
The build group is still in progress.
The build group stopped.
The build group succeeded.
The build group timed out.
ResolvedArtifact object that represents the primary build artifacts for the build group.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/ResolvedSecondaryArtifacts'
- description: An array of ResolvedArtifact objects that represents the secondary build artifacts for the build group.
description: Contains summary information about a batch build group.
BuildSummaries:
type: array
items:
$ref: '#/components/schemas/BuildSummary'
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 BuildSummary object that contains a summary of the current build group.
priorBuildSummaryList:
allOf:
- $ref: '#/components/schemas/BuildSummaries'
- description: An array of BuildSummary 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.'
BuildNotDeleted:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ID of the build that could not be successfully deleted.
statusCode:
allOf:
- $ref: '#/components/schemas/String'
- description: Additional information about the build that could not be successfully deleted.
description: Information about a build that could not be successfully deleted.
BuildPhaseType:
type: string
enum:
- SUBMITTED
- QUEUED
- PROVISIONING
- DOWNLOAD_SOURCE
- INSTALL
- PRE_BUILD
- BUILD
- POST_BUILD
- UPLOAD_ARTIFACTS
- FINALIZING
- COMPLETED
BuildPhase:
type: object
properties:
phaseType:
allOf:
- $ref: '#/components/schemas/BuildPhaseType'
- description: 'The name of the build phase. Valid values include:
Core build activities typically occur in this build phase.
The build has been completed.
Source code is being downloaded in this build phase.
The build process is completing in this build phase.
Installation activities typically occur in this build phase.
Post-build activities typically occur in this build phase.
Pre-build activities typically occur in this build phase.
The build environment is being set up.
The build has been submitted and is queued behind other submitted builds.
The build has been submitted.
Build output artifacts are being uploaded to the output location.
The current status of the build phase. Valid values include:
The build phase failed.
The build phase faulted.
The build phase is still in progress.
The build phase stopped.
The build phase succeeded.
The build phase timed out.
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build
in the Bitbucket API documentation.
This parameter is used for the context parameter in the GitHub commit status. For
more information, see Create a commit status in the GitHub developer guide.
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build
in the Bitbucket API documentation.
This parameter is used for the target_url parameter in the GitHub commit status.
For more information, see Create a commit status in the GitHub developer guide.
The current status of the logs in CloudWatch Logs for a build project. Valid values are:
ENABLED: CloudWatch Logs are enabled for this build project.
DISABLED: CloudWatch Logs are not enabled for this build project.
Contains code coverage report information.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
Contains a summary of a code coverage report.
Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control structure, such as an if or case statement.
The type of build output artifact. Valid values include:
CODEPIPELINE: The build project has build output generated through CodePipeline.
The CODEPIPELINE type is not supported for secondaryArtifacts.
NO_ARTIFACTS: The build project does not produce
any build output.
S3: The build project stores build output in Amazon S3.
Information about the build output artifact location:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified.
This is because CodePipeline manages its build output locations instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified,
because no build output is produced.
If type is set to S3, this is the name of the output bucket.
Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:
If type is
set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type
is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, this is the
path to the output artifact. If path is not specified, path is not used.
For example, if path is set to MyArtifacts,
namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.
Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:
If type
is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type
is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, valid values
include:
BUILD_ID: Include the build ID in the location of the build output artifact.
NONE: Do not include the build ID. This
is the default if namespaceType is not specified.
For example, if path is set to MyArtifacts, namespaceType
is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:
If type is
set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.
If type
is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.
If type is set to S3, 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.
For example:
If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the
output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.
If path is empty, namespaceType is set to NONE,
and name is set to "/", the output artifact is stored in the root of the output bucket.
If path is set to MyArtifacts,
namespaceType is set to BUILD_ID, and name is set to "/", the output artifact is stored in MyArtifacts/<build-ID>.
The type of build output artifact to create:
If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is
because CodePipeline manages its build output artifacts instead of CodeBuild.
If type is set to NO_ARTIFACTS, this value is ignored if specified,
because no build output is produced.
If type is set to S3, valid values include:
NONE: CodeBuild creates in the output
bucket a folder that contains the build output. This is the default if packaging is not specified.
ZIP: CodeBuild creates in the output bucket
a ZIP file that contains the build output.
ProjectSource objects. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If sourceVersion is specified at the build level, then that version takes
precedence over this sourceVersion (at the project level).
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' secondarySourceVersions: allOf: - $ref: '#/components/schemas/ProjectSecondarySourceVersions' - description: 'An array ofProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions
(at the project level). '
artifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifacts'
- description: Information about the build output artifacts for the build project.
secondaryArtifacts:
allOf:
- $ref: '#/components/schemas/ProjectArtifactsList'
- description: 'An array of ProjectArtifacts objects. '
cache:
allOf:
- $ref: '#/components/schemas/ProjectCache'
- description: Information about the cache for the build project.
environment:
allOf:
- $ref: '#/components/schemas/ProjectEnvironment'
- description: Information about the build environment for this build project.
serviceRole:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
timeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.'
queuedTimeoutInMinutes:
allOf:
- $ref: '#/components/schemas/TimeOut'
- description: 'The number of minutes a build is allowed to be queued before it times out. '
encryptionKey:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK''s alias (using
the format alias/<alias-name>). If you don''t specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).
A list of tag key and value pairs associated with this build project.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
created: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the build project was created, expressed in Unix time format.' lastModified: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'When the build project''s settings were last modified, expressed in Unix time format.' webhook: allOf: - $ref: '#/components/schemas/Webhook' - description: Information about a webhook that connects repository events to a build project in CodeBuild. vpcConfig: allOf: - $ref: '#/components/schemas/VpcConfig' - description: Information about the VPC configuration that CodeBuild accesses. badge: allOf: - $ref: '#/components/schemas/ProjectBadge' - description: Information about the build badge for the build project. logsConfig: allOf: - $ref: '#/components/schemas/LogsConfig' - description: 'Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. ' fileSystemLocations: allOf: - $ref: '#/components/schemas/ProjectFileSystemLocations' - description: ' An array ofProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier,
location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System. '
buildBatchConfig:
allOf:
- $ref: '#/components/schemas/ProjectBuildBatchConfig'
- description: A ProjectBuildBatchConfig object that defines the batch build options for the project.
concurrentBuildLimit:
allOf:
- $ref: '#/components/schemas/WrapperInt'
- description: 'The maximum number of concurrent builds that are allowed for this project.
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
' projectVisibility: $ref: '#/components/schemas/ProjectVisibilityType' publicProjectAlias: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: 'Contains the project identifier used with the public build APIs. ' resourceAccessRole: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds. description: Information about a build project. ReportGroupName: type: string minLength: 2 maxLength: 128 ReportType: type: string enum: - TEST - CODE_COVERAGE ReportExportConfig: type: object properties: exportConfigType: allOf: - $ref: '#/components/schemas/ReportExportConfigType' - description: 'The export configuration type. Valid values are:
S3: The report results are exported to an S3 bucket.
NO_EXPORT:
The report results are not exported.
S3ReportExportConfig object that contains information about the S3 bucket where the run of a report is exported. '
description: ' Information about the location where the run of a report is exported. '
ReportGroup:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: 'The ARN of the ReportGroup. '
name:
allOf:
- $ref: '#/components/schemas/ReportGroupName'
- description: 'The name of the ReportGroup. '
type:
allOf:
- $ref: '#/components/schemas/ReportType'
- description: 'The type of the ReportGroup. This can be one of the following values:
The report group contains code coverage reports.
The report group contains test reports.
ReportGroup is exported. '
created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time this ReportGroup was created. '
lastModified:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: 'The date and time this ReportGroup was last modified. '
tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of tag key and value pairs associated with this report group.
These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
status: allOf: - $ref: '#/components/schemas/ReportGroupStatusType' - description: 'The status of the report group. This property is read-only.
This can be one of the following values:
The report group is active.
The report group is in the process of being deleted.
The secret token of the associated repository.
A Bitbucket webhook does not support secret.
A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built.
If branchFilter is empty, then all branches are built.
It is recommended that you use filterGroups instead of branchFilter.
An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT
as its type.
For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must
pass.
The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:
SUCCEEDED
FAILED
ERROR
SKIPPED
UNKNOWN
name or the prefix of the test cases. Only test cases where the keyword is a substring of the
name or the prefix will be returned.
description: 'A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties.'
TestCases:
type: array
items:
$ref: '#/components/schemas/TestCase'
ImageVersions:
type: array
items:
$ref: '#/components/schemas/String'
EnvironmentImage:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the Docker image.
description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the Docker image.
versions:
allOf:
- $ref: '#/components/schemas/ImageVersions'
- description: A list of environment image versions.
description: Information about a Docker image that is managed by CodeBuild.
EnvironmentImages:
type: array
items:
$ref: '#/components/schemas/EnvironmentImage'
LanguageType:
type: string
enum:
- JAVA
- PYTHON
- NODE_JS
- RUBY
- GOLANG
- DOCKER
- ANDROID
- DOTNET
- BASE
- PHP
EnvironmentLanguage:
type: object
properties:
language:
allOf:
- $ref: '#/components/schemas/LanguageType'
- description: The programming language for the Docker images.
images:
allOf:
- $ref: '#/components/schemas/EnvironmentImages'
- description: The list of Docker images that are related by the specified programming language.
description: A set of Docker images that are related by programming language and are managed by CodeBuild.
EnvironmentLanguages:
type: array
items:
$ref: '#/components/schemas/EnvironmentLanguage'
PlatformType:
type: string
enum:
- DEBIAN
- AMAZON_LINUX
- UBUNTU
- WINDOWS_SERVER
EnvironmentPlatform:
type: object
properties:
platform:
allOf:
- $ref: '#/components/schemas/PlatformType'
- description: The platform's name.
languages:
allOf:
- $ref: '#/components/schemas/EnvironmentLanguages'
- description: The list of programming languages that are available for the specified platform.
description: A set of Docker images that are related by platform and are managed by CodeBuild.
EnvironmentPlatforms:
type: array
items:
$ref: '#/components/schemas/EnvironmentPlatform'
EnvironmentType:
type: string
enum:
- WINDOWS_CONTAINER
- LINUX_CONTAINER
- LINUX_GPU_CONTAINER
- ARM_CONTAINER
- WINDOWS_SERVER_2019_CONTAINER
EnvironmentVariableType:
type: string
enum:
- PLAINTEXT
- PARAMETER_STORE
- SECRETS_MANAGER
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: 'The value of the environment variable.
We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially
Amazon Web Services secret key IDs and secret access keys. PLAINTEXT 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 PARAMETER_STORE or SECRETS_MANAGER.
The type of environment variable. Valid values include:
PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. To
learn how to specify a parameter store environment variable, see env/parameter-store
in the CodeBuild User Guide.
PLAINTEXT: An environment variable in plain text format. This is the default value.
SECRETS_MANAGER:
An environment variable stored in Secrets Manager. To learn how to specify a secrets manager environment variable, see env/secrets-manager
in the CodeBuild User Guide.
Contains information about an exported environment variable.
Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the
install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.
The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH,
and COMMIT_MESSAGE.
A webhook event triggers a build when the provided pattern matches one of five event types: PUSH,
PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. The EVENT patterns are specified
as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.
The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.
A webhook event triggers a build when a GitHub,
GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.
A webhook event triggers a build when the head reference
matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.
Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
A webhook event triggers a build when the base reference
matches the regular expression pattern. For example, refs/heads/branch-name.
Works with pull request events only.
A webhook triggers a build when the path of a changed file matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
A webhook
triggers a build when the head commit message matches the regular expression pattern.
Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.
For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH,
PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.
For a WebHookFilter that
uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/
triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.
pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern
triggers a build. If false, then a webhook event that matches the pattern triggers a build. '
description: ' A filter used to determine which webhooks trigger a build. '
FilterGroup:
type: array
items:
$ref: '#/components/schemas/WebhookFilter'
ReportGroupTrendFieldType:
type: string
enum:
- PASS_RATE
- DURATION
- TOTAL
- LINE_COVERAGE
- LINES_COVERED
- LINES_MISSED
- BRANCH_COVERAGE
- BRANCHES_COVERED
- BRANCHES_MISSED
ReportGroupTrendStats:
type: object
properties:
average:
allOf:
- $ref: '#/components/schemas/String'
- description: Contains the average of all values analyzed.
max:
allOf:
- $ref: '#/components/schemas/String'
- description: Contains the maximum value analyzed.
min:
allOf:
- $ref: '#/components/schemas/String'
- description: Contains the minimum value analyzed.
description: 'Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .'
ReportGroupTrendRawDataList:
type: array
items:
$ref: '#/components/schemas/ReportWithRawData'
GitCloneDepth:
type: integer
minimum: 0
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. '
ImagePullCredentialsType:
type: string
enum:
- CODEBUILD
- SERVICE_ROLE
SensitiveNonEmptyString:
type: string
minLength: 1
format: password
ServerType:
type: string
enum:
- GITHUB
- BITBUCKET
- GITHUB_ENTERPRISE
KeyInput:
type: string
pattern: '^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$'
minLength: 1
maxLength: 127
ProjectSortByType:
type: string
enum:
- NAME
- CREATED_TIME
- LAST_MODIFIED_TIME
ReportGroupSortByType:
type: string
enum:
- NAME
- CREATED_TIME
- LAST_MODIFIED_TIME
ReportFilter:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/ReportStatusType'
- description: ' The status used to filter reports. You can filter using one status only. '
description: ' A filter used to return reports with the status specified by the input status parameter. '
SharedResourceSortByType:
type: string
enum:
- ARN
- MODIFIED_TIME
ProjectArns:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
minItems: 1
maxItems: 100
SourceCredentialsInfos:
type: array
items:
$ref: '#/components/schemas/SourceCredentialsInfo'
S3LogsConfig:
type: object
required:
- status
properties:
status:
allOf:
- $ref: '#/components/schemas/LogsConfigStatusType'
- description: 'The current status of the S3 build logs. Valid values are:
ENABLED: S3 build logs are enabled for this build project.
DISABLED:
S3 build logs are not enabled for this build project.
my-bucket, and your path prefix is build-log, then acceptable
formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log. '
encryptionDisabled:
allOf:
- $ref: '#/components/schemas/WrapperBoolean'
- description: ' Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. '
bucketOwnerAccess:
$ref: '#/components/schemas/BucketOwnerAccess'
description: ' Information about S3 logs for a build project. '
PhaseContext:
type: object
properties:
statusCode:
allOf:
- $ref: '#/components/schemas/String'
- description: The status code for the context of the build phase.
message:
allOf:
- $ref: '#/components/schemas/String'
- description: An explanation of the build phase's context. This might include a command ID and an exit code.
description: Additional information about a build phase that has an error. You can use this information for troubleshooting.
ProjectBadge:
type: object
properties:
badgeEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Set this to true to generate a publicly accessible URL for your project's build badge.
badgeRequestUrl:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The publicly-accessible URL through which you can access the build badge for your project. '
description: Information about the build badge for the build project.
ProjectVisibilityType:
type: string
enum:
- PUBLIC_READ
- PRIVATE
description: 'Specifies the visibility of the project''s builds. Possible values are:
The project builds are visible to the public.
The project builds are not visible to the public.
The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.
The credential can use the name of the credentials only
if they exist in your current Amazon Web Services Region.
Information about credentials that provide access to a private Docker registry. When this is set:
imagePullCredentialsType must be set to SERVICE_ROLE.
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with Secrets Manager Sample for CodeBuild.
' ProjectFileSystemLocation: type: object properties: type: allOf: - $ref: '#/components/schemas/FileSystemType' - description: ' The type of the file system. The one supported type isEFS. '
location:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. 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 fs-abcd1234.efs.us-west-2.amazonaws.com,
and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.
The
directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire
file system.
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_.
For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.
The identifier
is used to mount your file system.
nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2.
For more information, see Recommended NFS Mount Options. '
description: ' Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon
Elastic File System? '
ProjectSourceVersion:
type: object
required:
- sourceIdentifier
- sourceVersion
properties:
sourceIdentifier:
allOf:
- $ref: '#/components/schemas/String'
- description: 'An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. '
sourceVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The source version for the corresponding source identifier. If specified, must be one of:
For CodeCommit: the commit ID, branch, or Git tag to use.
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 pr/pull-request-ID (for example, pr/25). 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.
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.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
' description: ' A source identifier and its corresponding version. ' SourceType: type: string enum: - CODECOMMIT - CODEPIPELINE - GITHUB - S3 - BITBUCKET - GITHUB_ENTERPRISE - NO_SOURCE SourceAuth: type: object required: - type properties: type: allOf: - $ref: '#/components/schemas/SourceAuthType' - description: 'This data type is deprecated and is no longer accurate or used.
The authorization type to use. The only valid value is OAUTH, which represents
the OAuth authorization type.
Information about the authorization settings for CodeBuild to access the source code to be built.
This information is for the CodeBuild console's use only. Your code should not get or set this information directly.
ReportStatusType: type: string enum: - GENERATING - SUCCEEDED - FAILED - INCOMPLETE - DELETING TestReportSummary: type: object required: - total - statusCounts - durationInNanoSeconds properties: total: allOf: - $ref: '#/components/schemas/WrapperInt' - description: ' The number of test cases in thisTestReportSummary. The total includes truncated test cases. '
statusCounts:
allOf:
- $ref: '#/components/schemas/ReportStatusCounts'
- description: ' A map that contains the number of each type of status returned by the test results in this TestReportSummary. '
durationInNanoSeconds:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: ' The number of nanoseconds it took to run all of the test cases in this report. '
description: ' Information about a test report. '
Report:
type: object
properties:
arn:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The ARN of the report run. '
type:
allOf:
- $ref: '#/components/schemas/ReportType'
- description: The type of the report that was run.
A code coverage report.
A test report.
TestReportSummary object that contains information about this test report. '
codeCoverageSummary:
allOf:
- $ref: '#/components/schemas/CodeCoverageReportSummary'
- description: A CodeCoverageReportSummary object that contains a code coverage summary for this report.
description: 'Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or
more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests. '
ReportExportConfigType:
type: string
enum:
- S3
- NO_EXPORT
S3ReportExportConfig:
type: object
properties:
bucket:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: ' The name of the S3 bucket where the raw data of a report are exported. '
bucketOwner:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account
other than the account running the build.
path:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The path to the exported report''s raw data results. '
packaging:
allOf:
- $ref: '#/components/schemas/ReportPackagingType'
- description: 'The type of build output artifact to create. Valid values include:
NONE: CodeBuild creates the raw data in the output bucket. This is the default
if packaging is not specified.
ZIP: CodeBuild creates a ZIP file with the raw data in the output bucket.
A tag, consisting of a key and a value.
This tag is available for use by Amazon Web Services services that support tags in CodeBuild.
' TestCase: type: object properties: reportArn: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: ' The ARN of the report to which the test case belongs. ' testRawDataPath: allOf: - $ref: '#/components/schemas/String' - description: ' The path to the raw data file that contains the test result. ' prefix: allOf: - $ref: '#/components/schemas/String' - description: ' A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests. ' name: allOf: - $ref: '#/components/schemas/String' - description: ' The name of the test case. ' status: allOf: - $ref: '#/components/schemas/String' - description: ' The status returned by the test case after it was run. Valid statuses areSUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN. '
durationInNanoSeconds:
allOf:
- $ref: '#/components/schemas/WrapperLong'
- description: ' The number of nanoseconds it took to run this test case. '
message:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A message associated with a test case. For example, an error message or stack trace. '
expired:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild. '
description: ' Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test. '
WebhookFilterType:
type: string
enum:
- EVENT
- BASE_REF
- HEAD_REF
- ACTOR_ACCOUNT_ID
- FILE_PATH
- COMMIT_MESSAGE
security:
- hmac: []