StartBuildBatch - AWS CodeBuild

StartBuildBatch

Starts a batch build for a project.

Request Syntax

{ "artifactsOverride": { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "name": "string", "namespaceType": "string", "overrideArtifactName": boolean, "packaging": "string", "path": "string", "type": "string" }, "buildBatchConfigOverride": { "combineArtifacts": boolean, "restrictions": { "computeTypesAllowed": [ "string" ], "maximumBuildsAllowed": number }, "serviceRole": "string", "timeoutInMins": number }, "buildspecOverride": "string", "buildTimeoutInMinutesOverride": number, "cacheOverride": { "location": "string", "modes": [ "string" ], "type": "string" }, "certificateOverride": "string", "computeTypeOverride": "string", "encryptionKeyOverride": "string", "environmentTypeOverride": "string", "environmentVariablesOverride": [ { "name": "string", "type": "string", "value": "string" } ], "gitCloneDepthOverride": number, "gitSubmodulesConfigOverride": { "fetchSubmodules": boolean }, "idempotencyToken": "string", "imageOverride": "string", "imagePullCredentialsTypeOverride": "string", "insecureSslOverride": boolean, "logsConfigOverride": { "cloudWatchLogs": { "groupName": "string", "status": "string", "streamName": "string" }, "s3Logs": { "encryptionDisabled": boolean, "location": "string", "status": "string" } }, "privilegedModeOverride": boolean, "projectName": "string", "queuedTimeoutInMinutesOverride": number, "registryCredentialOverride": { "credential": "string", "credentialProvider": "string" }, "reportBuildBatchStatusOverride": boolean, "secondaryArtifactsOverride": [ { "artifactIdentifier": "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" }

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

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

artifactsOverride

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Type: ProjectArtifacts object

Required: No

buildBatchConfigOverride

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Type: ProjectBuildBatchConfig object

Required: No

buildspecOverride

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

Type: String

Required: No

buildTimeoutInMinutesOverride

Overrides the build timeout specified in the batch build project.

Type: Integer

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

Required: No

cacheOverride

A ProjectCache object that specifies cache overrides.

Type: ProjectCache object

Required: No

certificateOverride

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

Type: String

Required: No

computeTypeOverride

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

Type: String

Valid Values: BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_2XLARGE

Required: No

encryptionKeyOverride

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch 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 batch build that overrides the one specified in the batch build project.

Type: String

Valid Values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER | WINDOWS_SERVER_2019_CONTAINER

Required: No

environmentVariablesOverride

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Type: Array of EnvironmentVariable objects

Required: No

gitCloneDepthOverride

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

gitSubmodulesConfigOverride

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Type: GitSubmodulesConfig object

Required: No

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch 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 batch build that overrides the one specified in the batch 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 batch 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 batch 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

A LogsConfig object that override the log settings defined in the batch build project.

Type: LogsConfig object

Required: No

privilegedModeOverride

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

Type: Boolean

Required: No

queuedTimeoutInMinutesOverride

The number of minutes a batch 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

A RegistryCredential object that overrides credentials for access to a private registry.

Type: RegistryCredential object

Required: No

reportBuildBatchStatusOverride

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.

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 that override the secondary artifacts defined in the batch build project.

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 that override the secondary sources defined in the batch build project.

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 override the secondary source versions in the batch build project.

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 batch build that overrides the one specified in the batch build project.

Type: String

Length Constraints: Minimum length of 1.

Required: No

sourceAuthOverride

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.

Type: SourceAuth object

Required: No

sourceLocationOverride

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

Type: String

Required: No

sourceTypeOverride

The source input type that overrides the source input defined in the batch build project.

Type: String

Valid Values: CODECOMMIT | CODEPIPELINE | GITHUB | S3 | BITBUCKET | GITHUB_ENTERPRISE | NO_SOURCE

Required: No

sourceVersion

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:

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

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 Simple Storage Service (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

Response Syntax

{ "buildBatch": { "arn": "string", "artifacts": { "artifactIdentifier": "string", "encryptionDisabled": boolean, "location": "string", "md5sum": "string", "overrideArtifactName": boolean, "sha256sum": "string" }, "buildBatchConfig": { "combineArtifacts": boolean, "restrictions": { "computeTypesAllowed": [ "string" ], "maximumBuildsAllowed": number }, "serviceRole": "string", "timeoutInMins": number }, "buildBatchNumber": number, "buildBatchStatus": "string", "buildGroups": [ { "currentBuildSummary": { "arn": "string", "buildStatus": "string", "primaryArtifact": { "identifier": "string", "location": "string", "type": "string" }, "requestedOn": number, "secondaryArtifacts": [ { "identifier": "string", "location": "string", "type": "string" } ] }, "dependsOn": [ "string" ], "identifier": "string", "ignoreFailure": boolean, "priorBuildSummaryList": [ { "arn": "string", "buildStatus": "string", "primaryArtifact": { "identifier": "string", "location": "string", "type": "string" }, "requestedOn": number, "secondaryArtifacts": [ { "identifier": "string", "location": "string", "type": "string" } ] } ] } ], "buildTimeoutInMinutes": number, "cache": { "location": "string", "modes": [ "string" ], "type": "string" }, "complete": boolean, "currentPhase": "string", "encryptionKey": "string", "endTime": number, "environment": { "certificate": "string", "computeType": "string", "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "image": "string", "imagePullCredentialsType": "string", "privilegedMode": boolean, "registryCredential": { "credential": "string", "credentialProvider": "string" }, "type": "string" }, "fileSystemLocations": [ { "identifier": "string", "location": "string", "mountOptions": "string", "mountPoint": "string", "type": "string" } ], "id": "string", "initiator": "string", "logConfig": { "cloudWatchLogs": { "groupName": "string", "status": "string", "streamName": "string" }, "s3Logs": { "encryptionDisabled": boolean, "location": "string", "status": "string" } }, "phases": [ { "contexts": [ { "message": "string", "statusCode": "string" } ], "durationInSeconds": number, "endTime": number, "phaseStatus": "string", "phaseType": "string", "startTime": number } ], "projectName": "string", "queuedTimeoutInMinutes": number, "resolvedSourceVersion": "string", "secondaryArtifacts": [ { "artifactIdentifier": "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, "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.

buildBatch

A BuildBatch object that contains information about the batch build.

Type: BuildBatch object

Errors

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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: