Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartBuild

Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.

You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.

Request Syntax


{
   "artifactsOverride": { 
      "artifactIdentifier": "string",
      "bucketOwnerAccess": "string",
      "encryptionDisabled": boolean,
      "location": "string",
      "name": "string",
      "namespaceType": "string",
      "overrideArtifactName": boolean,
      "packaging": "string",
      "path": "string",
      "type": "string"
   },
   "autoRetryLimitOverride": number,
   "buildspecOverride": "string",
   "buildStatusConfigOverride": { 
      "context": "string",
      "targetUrl": "string"
   },
   "cacheOverride": { 
      "location": "string",
      "modes": [ "string" ],
      "type": "string"
   },
   "certificateOverride": "string",
   "computeTypeOverride": "string",
   "debugSessionEnabled": boolean,
   "encryptionKeyOverride": "string",
   "environmentTypeOverride": "string",
   "environmentVariablesOverride": [ 
      { 
         "name": "string",
         "type": "string",
         "value": "string"
      }
   ],
   "fleetOverride": { 
      "fleetArn": "string"
   },
   "gitCloneDepthOverride": number,
   "gitSubmodulesConfigOverride": { 
      "fetchSubmodules": boolean
   },
   "idempotencyToken": "string",
   "imageOverride": "string",
   "imagePullCredentialsTypeOverride": "string",
   "insecureSslOverride": boolean,
   "logsConfigOverride": { 
      "cloudWatchLogs": { 
         "groupName": "string",
         "status": "string",
         "streamName": "string"
      },
      "s3Logs": { 
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "status": "string"
      }
   },
   "privilegedModeOverride": boolean,
   "projectName": "string",
   "queuedTimeoutInMinutesOverride": number,
   "registryCredentialOverride": { 
      "credential": "string",
      "credentialProvider": "string"
   },
   "reportBuildStatusOverride": boolean,
   "secondaryArtifactsOverride": [ 
      { 
         "artifactIdentifier": "string",
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "name": "string",
         "namespaceType": "string",
         "overrideArtifactName": boolean,
         "packaging": "string",
         "path": "string",
         "type": "string"
      }
   ],
   "secondarySourcesOverride": [ 
      { 
         "auth": { 
            "resource": "string",
            "type": "string"
         },
         "buildspec": "string",
         "buildStatusConfig": { 
            "context": "string",
            "targetUrl": "string"
         },
         "gitCloneDepth": number,
         "gitSubmodulesConfig": { 
            "fetchSubmodules": boolean
         },
         "insecureSsl": boolean,
         "location": "string",
         "reportBuildStatus": boolean,
         "sourceIdentifier": "string",
         "type": "string"
      }
   ],
   "secondarySourcesVersionOverride": [ 
      { 
         "sourceIdentifier": "string",
         "sourceVersion": "string"
      }
   ],
   "serviceRoleOverride": "string",
   "sourceAuthOverride": { 
      "resource": "string",
      "type": "string"
   },
   "sourceLocationOverride": "string",
   "sourceTypeOverride": "string",
   "sourceVersion": "string",
   "timeoutInMinutesOverride": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

projectName

The name of the AWS CodeBuild build project to start running a build.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

artifactsOverride

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Type: ProjectArtifacts object

Required: No

autoRetryLimitOverride

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

Type: Integer

Required: No

buildspecOverride

A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.

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 AWS 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.

Note

Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.

Type: String

Required: No

buildStatusConfigOverride

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Type: BuildStatusConfig object

Required: No

cacheOverride

A ProjectCache object specified for this build that overrides the one defined in the build project.

Type: ProjectCache object

Required: No

certificateOverride

The name of a certificate for this build that overrides the one specified in the build project.

Type: String

Required: No

computeTypeOverride

The name of a compute type for this build that overrides the one specified in the build project.

Type: String

Required: No

debugSessionEnabled

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

Type: Boolean

Required: No

encryptionKeyOverride

The AWS Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

Note

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>).

Type: String

Length Constraints: Minimum length of 1.

Required: No

environmentTypeOverride

A container type for this build that overrides the one specified in the build project.

Type: String

Required: No

environmentVariablesOverride

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Type: Array of EnvironmentVariable objects

Required: No

fleetOverride

A ProjectFleet object specified for this build that overrides the one defined in the build project.

Type: ProjectFleet object

Required: No

gitCloneDepthOverride

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

gitSubmodulesConfigOverride

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Type: GitSubmodulesConfig object

Required: No

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Type: String

Required: No

imageOverride

The name of an image for this build that overrides the one specified in the build project.

Type: String

Length Constraints: Minimum length of 1.

Required: No

imagePullCredentialsTypeOverride

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD: Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.
SERVICE_ROLE: Specifies that AWS 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 AWS CodeBuild curated image, you must use CODEBUILD credentials.

Type: String

Valid Values: CODEBUILD | SERVICE_ROLE

Required: No

insecureSslOverride

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Type: Boolean

Required: No

logsConfigOverride

Log settings for this build that override the log settings defined in the build project.

Type: LogsConfig object

Required: No

privilegedModeOverride

Enable this flag to override privileged mode in the build project.

Type: Boolean

Required: No

queuedTimeoutInMinutesOverride

The number of minutes a build is allowed to be queued before it times out.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 480.

Required: No

registryCredentialOverride

The credentials for access to a private registry.

Type: RegistryCredential object

Required: No

reportBuildStatusOverride

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, GitLab, GitLab Self Managed, 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 AWS CodeBuild User Guide.

Note

The status of a build triggered by a webhook is always reported to your source provider.

Type: Boolean

Required: No

secondaryArtifactsOverride

An array of ProjectArtifacts objects.

Type: Array of ProjectArtifacts objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySourcesOverride

An array of ProjectSource objects.

Type: Array of ProjectSource objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

secondarySourcesVersionOverride

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Type: Array of ProjectSourceVersion objects

Array Members: Minimum number of 0 items. Maximum number of 12 items.

Required: No

serviceRoleOverride

The name of a service role for this build that overrides the one specified in the build project.

Type: String

Length Constraints: Minimum length of 1.

Required: No

sourceAuthOverride

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, GitHub, GitLab, or GitLab Self Managed.

Type: SourceAuth object

Required: No

sourceLocationOverride

A location that overrides, for this build, the source location for the one defined in the build project.

Type: String

Required: No

sourceTypeOverride

A source input type, for this build, that overrides the source input defined in the build project.

Type: String

Required: No

sourceVersion

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:

CodeCommit: The commit ID, branch, or Git tag to use.
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.
GitLab: The commit ID, branch, or Git tag to use.
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.
Amazon S3: 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 AWS CodeBuild User Guide.

Type: String

Required: No

timeoutInMinutesOverride

The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 2160.

Required: No

Response Syntax


{
   "build": { 
      "arn": "string",
      "artifacts": { 
         "artifactIdentifier": "string",
         "bucketOwnerAccess": "string",
         "encryptionDisabled": boolean,
         "location": "string",
         "md5sum": "string",
         "overrideArtifactName": boolean,
         "sha256sum": "string"
      },
      "autoRetryConfig": { 
         "autoRetryLimit": number,
         "autoRetryNumber": number,
         "nextAutoRetry": "string",
         "previousAutoRetry": "string"
      },
      "buildBatchArn": "string",
      "buildComplete": boolean,
      "buildNumber": number,
      "buildStatus": "string",
      "cache": { 
         "location": "string",
         "modes": [ "string" ],
         "type": "string"
      },
      "currentPhase": "string",
      "debugSession": { 
         "sessionEnabled": boolean,
         "sessionTarget": "string"
      },
      "encryptionKey": "string",
      "endTime": number,
      "environment": { 
         "certificate": "string",
         "computeConfiguration": { 
            "disk": number,
            "machineType": "string",
            "memory": number,
            "vCpu": number
         },
         "computeType": "string",
         "environmentVariables": [ 
            { 
               "name": "string",
               "type": "string",
               "value": "string"
            }
         ],
         "fleet": { 
            "fleetArn": "string"
         },
         "image": "string",
         "imagePullCredentialsType": "string",
         "privilegedMode": boolean,
         "registryCredential": { 
            "credential": "string",
            "credentialProvider": "string"
         },
         "type": "string"
      },
      "exportedEnvironmentVariables": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "fileSystemLocations": [ 
         { 
            "identifier": "string",
            "location": "string",
            "mountOptions": "string",
            "mountPoint": "string",
            "type": "string"
         }
      ],
      "id": "string",
      "initiator": "string",
      "logs": { 
         "cloudWatchLogs": { 
            "groupName": "string",
            "status": "string",
            "streamName": "string"
         },
         "cloudWatchLogsArn": "string",
         "deepLink": "string",
         "groupName": "string",
         "s3DeepLink": "string",
         "s3Logs": { 
            "bucketOwnerAccess": "string",
            "encryptionDisabled": boolean,
            "location": "string",
            "status": "string"
         },
         "s3LogsArn": "string",
         "streamName": "string"
      },
      "networkInterface": { 
         "networkInterfaceId": "string",
         "subnetId": "string"
      },
      "phases": [ 
         { 
            "contexts": [ 
               { 
                  "message": "string",
                  "statusCode": "string"
               }
            ],
            "durationInSeconds": number,
            "endTime": number,
            "phaseStatus": "string",
            "phaseType": "string",
            "startTime": number
         }
      ],
      "projectName": "string",
      "queuedTimeoutInMinutes": number,
      "reportArns": [ "string" ],
      "resolvedSourceVersion": "string",
      "secondaryArtifacts": [ 
         { 
            "artifactIdentifier": "string",
            "bucketOwnerAccess": "string",
            "encryptionDisabled": boolean,
            "location": "string",
            "md5sum": "string",
            "overrideArtifactName": boolean,
            "sha256sum": "string"
         }
      ],
      "secondarySources": [ 
         { 
            "auth": { 
               "resource": "string",
               "type": "string"
            },
            "buildspec": "string",
            "buildStatusConfig": { 
               "context": "string",
               "targetUrl": "string"
            },
            "gitCloneDepth": number,
            "gitSubmodulesConfig": { 
               "fetchSubmodules": boolean
            },
            "insecureSsl": boolean,
            "location": "string",
            "reportBuildStatus": boolean,
            "sourceIdentifier": "string",
            "type": "string"
         }
      ],
      "secondarySourceVersions": [ 
         { 
            "sourceIdentifier": "string",
            "sourceVersion": "string"
         }
      ],
      "serviceRole": "string",
      "source": { 
         "auth": { 
            "resource": "string",
            "type": "string"
         },
         "buildspec": "string",
         "buildStatusConfig": { 
            "context": "string",
            "targetUrl": "string"
         },
         "gitCloneDepth": number,
         "gitSubmodulesConfig": { 
            "fetchSubmodules": boolean
         },
         "insecureSsl": boolean,
         "location": "string",
         "reportBuildStatus": boolean,
         "sourceIdentifier": "string",
         "type": "string"
      },
      "sourceVersion": "string",
      "startTime": number,
      "timeoutInMinutes": number,
      "vpcConfig": { 
         "securityGroupIds": [ "string" ],
         "subnets": [ "string" ],
         "vpcId": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

build

Information about the build to be run.

Type: Build object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccountLimitExceededException

An AWS service limit was exceeded for the calling AWS account.

HTTP Status Code: 400

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400