Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

Build

Information about a build.

Contents

Note

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

arn

The Amazon Resource Name (ARN) of the build.

Type: String

Length Constraints: Minimum length of 1.

Required: No

artifacts

Information about the output artifacts for the build.

Type: BuildArtifacts object

Required: No

buildComplete

Whether the build has finished. True if completed; otherwise, false.

Type: Boolean

Required: No

buildStatus

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.

Type: String

Valid Values: SUCCEEDED | FAILED | FAULT | TIMED_OUT | IN_PROGRESS | STOPPED

Required: No

currentPhase

The current build phase.

Type: String

Required: No

endTime

When the build process ended, expressed in Unix time format.

Type: Timestamp

Required: No

environment

Information about the build environment for this build.

Type: ProjectEnvironment object

Required: No

id

The unique ID for the build.

Type: String

Length Constraints: Minimum length of 1.

Required: No

initiator

The entity that started the build. Valid values include:

  • If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example MyUserName).

  • If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

Type: String

Required: No

logs

Information about the build's logs in Amazon CloudWatch Logs.

Type: LogsLocation object

Required: No

phases

Information about all previous build phases that are completed and information about any current build phase that is not yet complete.

Type: Array of BuildPhase objects

Required: No

projectName

The name of the build project.

Type: String

Length Constraints: Minimum length of 1.

Required: No

source

Information about the source code to be built.

Type: ProjectSource object

Required: No

sourceVersion

Any version identifier for the version of the source code to be built.

Type: String

Length Constraints: Minimum length of 1.

Required: No

startTime

When the build process started, expressed in Unix time format.

Type: Timestamp

Required: No

timeoutInMinutes

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

Type: Integer

Required: No

See Also

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

On this page: