Client library for AWS CodeBuild

Installation and Usage

npm install --save @datafire/amazonaws_codebuild

let amazonaws_codebuild = require('@datafire/amazonaws_codebuild').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS 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 AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

• BatchDeleteBuilds: Deletes one or more builds.

• BatchGetBuilds: Gets information about one or more builds.

• BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment is a representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build. You can add tags to build projects to help manage your resources and costs.

• BatchGetReportGroups: Returns an array of report groups.

• BatchGetReports: Returns an array of reports.

• CreateProject: Creates a build project.

• CreateReportGroup: Creates a report group. A report group contains a collection of reports.

• CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

• DeleteProject: Deletes a build project.

• DeleteReport: Deletes a report.

• DeleteReportGroup: Deletes a report group.

• DeleteResourcePolicy: Deletes a resource policy that is identified by its resource ARN.

• DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

• DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

• DescribeTestCases: Returns a list of details about test cases for a report.

• GetResourcePolicy: Gets a resource policy that is identified by its resource ARN.

• ImportSourceCredentials: Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

• InvalidateProjectCache: Resets the cache for a project.

• ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

• ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

• ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

• ListProjects: Gets a list of build project names, with each build project name representing a single build project.

• ListReportGroups: Gets a list ARNs for the report groups in the current AWS account.

• ListReports: Gets a list ARNs for the reports in the current AWS account.

• ListReportsForReportGroup: Returns a list of ARNs for the reports that belong to a ReportGroup.

• ListSharedProjects: Gets a list of ARNs associated with projects shared with the current AWS account or user.

• ListSharedReportGroups: Gets a list of ARNs associated with report groups shared with the current AWS account or user

• ListSourceCredentials: Returns a list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

• PutResourcePolicy: Stores a resource policy for the ARN of a Project or ReportGroup object.

• StartBuild: Starts running a build.

• StopBuild: Attempts to stop running a build.

• UpdateProject: Changes the settings of an existing build project.

• UpdateReportGroup: Changes a report group.

• UpdateWebhook: Changes the settings of an existing webhook.

Actions

BatchDeleteBuilds

amazonaws_codebuild.BatchDeleteBuilds({
  "ids": null
}, context)

Input

• input object
  • ids required
    • items NonEmptyString

Output

• output BatchDeleteBuildsOutput

BatchGetBuildBatches

amazonaws_codebuild.BatchGetBuildBatches({
  "ids": null
}, context)

Input

• input object
  • ids required
    • items NonEmptyString

Output

• output BatchGetBuildBatchesOutput

BatchGetBuilds

amazonaws_codebuild.BatchGetBuilds({
  "ids": null
}, context)

Input

• input object
  • ids required
    • items NonEmptyString

Output

• output BatchGetBuildsOutput

BatchGetProjects

amazonaws_codebuild.BatchGetProjects({
  "names": null
}, context)

Input

• input object
  • names required
    • items NonEmptyString

Output

• output BatchGetProjectsOutput

BatchGetReportGroups

amazonaws_codebuild.BatchGetReportGroups({
  "reportGroupArns": null
}, context)

Input

• input object
  • reportGroupArns required
    • items NonEmptyString

Output

• output BatchGetReportGroupsOutput

BatchGetReports

amazonaws_codebuild.BatchGetReports({
  "reportArns": null
}, context)

Input

• input object
  • reportArns required
    • items NonEmptyString

Output

• output BatchGetReportsOutput

CreateProject

amazonaws_codebuild.CreateProject({
  "name": null,
  "source": null,
  "artifacts": null,
  "environment": null,
  "serviceRole": null
}, context)

Input

• input object
  • tags
    • items Tag
  • artifacts required
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • badgeEnabled
  • buildBatchConfig
    • combineArtifacts
    • restrictions
      • computeTypesAllowed
        • items NonEmptyString
      • maximumBuildsAllowed
    • serviceRole
    • timeoutInMins
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • description
  • encryptionKey
  • environment required
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • logsConfig
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • name required
  • queuedTimeoutInMinutes
  • secondaryArtifacts
    • items ProjectArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole required
  • source required
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId

Output

• output CreateProjectOutput

CreateReportGroup

amazonaws_codebuild.CreateReportGroup({
  "name": null,
  "type": null,
  "exportConfig": null
}, context)

Input

• input object
  • tags
    • items Tag
  • exportConfig required
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path
  • name required
  • type required

Output

• output CreateReportGroupOutput

CreateWebhook

amazonaws_codebuild.CreateWebhook({
  "projectName": null
}, context)

Input

• input object
  • branchFilter
  • buildType
  • filterGroups
    • items FilterGroup
  • projectName required

Output

• output CreateWebhookOutput

DeleteBuildBatch

amazonaws_codebuild.DeleteBuildBatch({
  "id": null
}, context)

Input

• input object
  • id required

Output

• output DeleteBuildBatchOutput

DeleteProject

amazonaws_codebuild.DeleteProject({
  "name": null
}, context)

Input

• input object
  • name required

Output

• output DeleteProjectOutput

DeleteReport

amazonaws_codebuild.DeleteReport({
  "arn": null
}, context)

Input

• input object
  • arn required

Output

• output DeleteReportOutput

DeleteReportGroup

amazonaws_codebuild.DeleteReportGroup({
  "arn": null
}, context)

Input

• input object
  • arn required
  • deleteReports

Output

• output DeleteReportGroupOutput

DeleteResourcePolicy

amazonaws_codebuild.DeleteResourcePolicy({
  "resourceArn": null
}, context)

Input

• input object
  • resourceArn required

Output

• output DeleteResourcePolicyOutput

DeleteSourceCredentials

amazonaws_codebuild.DeleteSourceCredentials({
  "arn": null
}, context)

Input

• input object
  • arn required

Output

• output DeleteSourceCredentialsOutput

DeleteWebhook

amazonaws_codebuild.DeleteWebhook({
  "projectName": null
}, context)

Input

• input object
  • projectName required

Output

• output DeleteWebhookOutput

DescribeCodeCoverages

amazonaws_codebuild.DescribeCodeCoverages({
  "reportArn": null
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxLineCoveragePercentage
  • maxResults
  • minLineCoveragePercentage
  • nextToken
  • reportArn required
  • sortBy
  • sortOrder

Output

• output DescribeCodeCoveragesOutput

DescribeTestCases

amazonaws_codebuild.DescribeTestCases({
  "reportArn": null
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filter
    • keyword
    • status
  • maxResults
  • nextToken
  • reportArn required

Output

• output DescribeTestCasesOutput

GetReportGroupTrend

amazonaws_codebuild.GetReportGroupTrend({
  "reportGroupArn": "",
  "trendField": ""
}, context)

Input

• input object
  • numOfReports PageSize
  • reportGroupArn required NonEmptyString
  • trendField required ReportGroupTrendFieldType

Output

• output GetReportGroupTrendOutput

GetResourcePolicy

amazonaws_codebuild.GetResourcePolicy({
  "resourceArn": null
}, context)

Input

• input object
  • resourceArn required

Output

• output GetResourcePolicyOutput

ImportSourceCredentials

amazonaws_codebuild.ImportSourceCredentials({
  "token": null,
  "serverType": null,
  "authType": null
}, context)

Input

• input object
  • authType required
  • serverType required
  • shouldOverwrite
  • token required
  • username

Output

• output ImportSourceCredentialsOutput

InvalidateProjectCache

amazonaws_codebuild.InvalidateProjectCache({
  "projectName": null
}, context)

Input

• input object
  • projectName required

Output

• output InvalidateProjectCacheOutput

ListBuildBatches

amazonaws_codebuild.ListBuildBatches({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filter
    • status
  • maxResults
  • nextToken
  • sortOrder

Output

• output ListBuildBatchesOutput

ListBuildBatchesForProject

amazonaws_codebuild.ListBuildBatchesForProject({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filter
    • status
  • maxResults
  • nextToken
  • projectName
  • sortOrder

Output

• output ListBuildBatchesForProjectOutput

ListBuilds

amazonaws_codebuild.ListBuilds({}, context)

Input

• input object
  • nextToken string
  • nextToken
  • sortOrder

Output

• output ListBuildsOutput

ListBuildsForProject

amazonaws_codebuild.ListBuildsForProject({
  "projectName": null
}, context)

Input

• input object
  • nextToken string
  • nextToken
  • projectName required
  • sortOrder

Output

• output ListBuildsForProjectOutput

ListCuratedEnvironmentImages

amazonaws_codebuild.ListCuratedEnvironmentImages({}, context)

Input

• input object

Output

• output ListCuratedEnvironmentImagesOutput

ListProjects

amazonaws_codebuild.ListProjects({}, context)

Input

• input object
  • nextToken string
  • nextToken
  • sortBy
  • sortOrder

Output

• output ListProjectsOutput

ListReportGroups

amazonaws_codebuild.ListReportGroups({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

Output

• output ListReportGroupsOutput

ListReports

amazonaws_codebuild.ListReports({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filter
    • status
  • maxResults
  • nextToken
  • sortOrder

Output

• output ListReportsOutput

ListReportsForReportGroup

amazonaws_codebuild.ListReportsForReportGroup({
  "reportGroupArn": null
}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • filter
    • status
  • maxResults
  • nextToken
  • reportGroupArn required
  • sortOrder

Output

• output ListReportsForReportGroupOutput

ListSharedProjects

amazonaws_codebuild.ListSharedProjects({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

Output

• output ListSharedProjectsOutput

ListSharedReportGroups

amazonaws_codebuild.ListSharedReportGroups({}, context)

Input

• input object
  • maxResults string
  • nextToken string
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

Output

• output ListSharedReportGroupsOutput

ListSourceCredentials

amazonaws_codebuild.ListSourceCredentials({}, context)

Input

• input object

Output

• output ListSourceCredentialsOutput

PutResourcePolicy

amazonaws_codebuild.PutResourcePolicy({
  "policy": null,
  "resourceArn": null
}, context)

Input

• input object
  • policy required
  • resourceArn required

Output

• output PutResourcePolicyOutput

RetryBuild

amazonaws_codebuild.RetryBuild({}, context)

Input

• input object
  • id

Output

• output RetryBuildOutput

RetryBuildBatch

amazonaws_codebuild.RetryBuildBatch({}, context)

Input

• input object
  • id
  • retryType

Output

• output RetryBuildBatchOutput

StartBuild

amazonaws_codebuild.StartBuild({
  "projectName": null
}, context)

Input

• input object
  • artifactsOverride
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • buildStatusConfigOverride
    • context
    • targetUrl
  • buildspecOverride
  • cacheOverride
    • location
    • modes
      • items CacheMode
    • type required
  • certificateOverride
  • computeTypeOverride
  • debugSessionEnabled
  • encryptionKeyOverride
  • environmentTypeOverride
  • environmentVariablesOverride
    • items EnvironmentVariable
  • gitCloneDepthOverride
  • gitSubmodulesConfigOverride
    • fetchSubmodules required
  • imageOverride
  • imagePullCredentialsTypeOverride
  • insecureSslOverride
  • logsConfigOverride
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • privilegedModeOverride
  • projectName required
  • queuedTimeoutInMinutesOverride
  • registryCredentialOverride
    • credential required
    • credentialProvider required
  • reportBuildStatusOverride
  • secondaryArtifactsOverride
    • items ProjectArtifacts
  • secondarySourcesOverride
    • items ProjectSource
  • secondarySourcesVersionOverride
    • items ProjectSourceVersion
  • serviceRoleOverride
  • sourceAuthOverride
    • resource
    • type required
  • sourceLocationOverride
  • sourceTypeOverride
  • sourceVersion
  • timeoutInMinutesOverride

Output

• output StartBuildOutput

StartBuildBatch

amazonaws_codebuild.StartBuildBatch({
  "projectName": null
}, context)

Input

• input object
  • artifactsOverride
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • buildBatchConfigOverride
    • combineArtifacts
    • restrictions
      • computeTypesAllowed
        • items NonEmptyString
      • maximumBuildsAllowed
    • serviceRole
    • timeoutInMins
  • buildTimeoutInMinutesOverride
  • buildspecOverride
  • cacheOverride
    • location
    • modes
      • items CacheMode
    • type required
  • certificateOverride
  • computeTypeOverride
  • encryptionKeyOverride
  • environmentTypeOverride
  • environmentVariablesOverride
    • items EnvironmentVariable
  • gitCloneDepthOverride
  • gitSubmodulesConfigOverride
    • fetchSubmodules required
  • imageOverride
  • imagePullCredentialsTypeOverride
  • insecureSslOverride
  • logsConfigOverride
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • privilegedModeOverride
  • projectName required
  • queuedTimeoutInMinutesOverride
  • registryCredentialOverride
    • credential required
    • credentialProvider required
  • reportBuildBatchStatusOverride
  • secondaryArtifactsOverride
    • items ProjectArtifacts
  • secondarySourcesOverride
    • items ProjectSource
  • secondarySourcesVersionOverride
    • items ProjectSourceVersion
  • serviceRoleOverride
  • sourceAuthOverride
    • resource
    • type required
  • sourceLocationOverride
  • sourceTypeOverride
  • sourceVersion

Output

• output StartBuildBatchOutput

StopBuild

amazonaws_codebuild.StopBuild({
  "id": null
}, context)

Input

• input object
  • id required

Output

• output StopBuildOutput

StopBuildBatch

amazonaws_codebuild.StopBuildBatch({
  "id": null
}, context)

Input

• input object
  • id required

Output

• output StopBuildBatchOutput

UpdateProject

amazonaws_codebuild.UpdateProject({
  "name": null
}, context)

Input

• input object
  • tags
    • items Tag
  • artifacts
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • badgeEnabled
  • buildBatchConfig ProjectBuildBatchConfig
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • description
  • encryptionKey
  • environment
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • logsConfig
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • name required
  • queuedTimeoutInMinutes
  • secondaryArtifacts
    • items ProjectArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole
  • source
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId

Output

• output UpdateProjectOutput

UpdateReportGroup

amazonaws_codebuild.UpdateReportGroup({
  "arn": null
}, context)

Input

• input object
  • tags
    • items Tag
  • arn required
  • exportConfig
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path

Output

• output UpdateReportGroupOutput

UpdateWebhook

amazonaws_codebuild.UpdateWebhook({
  "projectName": null
}, context)

Input

• input object
  • branchFilter
  • buildType
  • filterGroups
    • items FilterGroup
  • projectName required
  • rotateSecret

Output

• output UpdateWebhookOutput

Definitions

AccountLimitExceededException

ArtifactNamespace

• ArtifactNamespace string (values: NONE, BUILD_ID)

ArtifactPackaging

• ArtifactPackaging string (values: NONE, ZIP)

ArtifactsType

• ArtifactsType string (values: CODEPIPELINE, S3, NO_ARTIFACTS)

AuthType

• AuthType string (values: OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN)

BatchDeleteBuildsInput

• BatchDeleteBuildsInput object
  • ids required
    • items NonEmptyString

BatchDeleteBuildsOutput

• BatchDeleteBuildsOutput object
  • buildsDeleted
    • items NonEmptyString
  • buildsNotDeleted
    • items BuildNotDeleted

BatchGetBuildBatchesInput

• BatchGetBuildBatchesInput object
  • ids required
    • items NonEmptyString

BatchGetBuildBatchesOutput

• BatchGetBuildBatchesOutput object
  • buildBatches
    • items BuildBatch
  • buildBatchesNotFound
    • items NonEmptyString

BatchGetBuildsInput

• BatchGetBuildsInput object
  • ids required
    • items NonEmptyString

BatchGetBuildsOutput

• BatchGetBuildsOutput object
  • builds
    • items Build
  • buildsNotFound
    • items NonEmptyString

BatchGetProjectsInput

• BatchGetProjectsInput object
  • names required
    • items NonEmptyString

BatchGetProjectsOutput

• BatchGetProjectsOutput object
  • projects
    • items Project
  • projectsNotFound
    • items NonEmptyString

BatchGetReportGroupsInput

• BatchGetReportGroupsInput object
  • reportGroupArns required
    • items NonEmptyString

BatchGetReportGroupsOutput

• BatchGetReportGroupsOutput object
  • reportGroups
    • items ReportGroup
  • reportGroupsNotFound
    • items NonEmptyString

BatchGetReportsInput

• BatchGetReportsInput object
  • reportArns required
    • items NonEmptyString

BatchGetReportsOutput

• BatchGetReportsOutput object
  • reports
    • items Report
  • reportsNotFound
    • items NonEmptyString

BatchRestrictions

• BatchRestrictions object: Specifies restrictions for the batch build.
  • computeTypesAllowed
    • items NonEmptyString
  • maximumBuildsAllowed

Boolean

• Boolean boolean

Build

• Build object: Information about a build.
  • arn
  • artifacts
    • artifactIdentifier
    • encryptionDisabled
    • location
    • md5sum
    • overrideArtifactName
    • sha256sum
  • buildBatchArn
  • buildComplete
  • buildNumber
  • buildStatus
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • currentPhase
  • debugSession
    • sessionEnabled
    • sessionTarget
  • encryptionKey
  • endTime
  • environment
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • exportedEnvironmentVariables
    • items ExportedEnvironmentVariable
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • id
  • initiator
  • logs
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • cloudWatchLogsArn
    • deepLink
    • groupName
    • s3DeepLink
    • s3Logs
      • encryptionDisabled
      • location
      • status required
    • s3LogsArn
    • streamName
  • networkInterface
    • networkInterfaceId
    • subnetId
  • phases
    • items BuildPhase
  • projectName
  • queuedTimeoutInMinutes
  • reportArns
    • items String
  • resolvedSourceVersion
  • secondaryArtifacts
    • items BuildArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole
  • source
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • startTime
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId

BuildArtifacts

• BuildArtifacts object: Information about build output artifacts.
  • artifactIdentifier
  • encryptionDisabled
  • location
  • md5sum
  • overrideArtifactName
  • sha256sum

BuildArtifactsList

• BuildArtifactsList array
  • items BuildArtifacts

BuildBatch

• BuildBatch object: Contains information about a batch build.
  • arn
  • artifacts
    • artifactIdentifier
    • encryptionDisabled
    • location
    • md5sum
    • overrideArtifactName
    • sha256sum
  • buildBatchConfig ProjectBuildBatchConfig
  • buildBatchNumber
  • buildBatchStatus
  • buildGroups
    • items BuildGroup
  • buildTimeoutInMinutes
  • cache ProjectCache
  • complete
  • currentPhase
  • encryptionKey
  • endTime
  • environment ProjectEnvironment
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • id
  • initiator
  • logConfig LogsConfig
  • phases
    • items BuildBatchPhase
  • projectName
  • queuedTimeoutInMinutes
  • resolvedSourceVersion
  • secondaryArtifacts
    • items BuildArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole
  • source ProjectSource
  • sourceVersion
  • startTime
  • vpcConfig VpcConfig

BuildBatchFilter

• BuildBatchFilter object: Specifies filters when retrieving batch builds.
  • status

BuildBatchIds

• BuildBatchIds array
  • items NonEmptyString

BuildBatchPhase

• BuildBatchPhase object: Contains information about a stage for a batch build.
  • contexts
    • items PhaseContext
  • durationInSeconds
  • endTime
  • phaseStatus
  • phaseType
  • startTime

BuildBatchPhaseType

• BuildBatchPhaseType string (values: SUBMITTED, DOWNLOAD_BATCHSPEC, IN_PROGRESS, COMBINE_ARTIFACTS, SUCCEEDED, FAILED, STOPPED)

BuildBatchPhases

• BuildBatchPhases array
  • items BuildBatchPhase

BuildBatches

• BuildBatches array
  • items BuildBatch

BuildGroup

• BuildGroup object: 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.
  • currentBuildSummary
    • arn
    • buildStatus
    • primaryArtifact
      • identifier
      • location
      • type
    • requestedOn
    • secondaryArtifacts
      • items ResolvedArtifact
  • dependsOn
    • items NonEmptyString
  • identifier
  • ignoreFailure
  • priorBuildSummaryList
    • items BuildSummary

BuildGroups

• BuildGroups array
  • items BuildGroup

BuildIds

• BuildIds array
  • items NonEmptyString

BuildNotDeleted

• BuildNotDeleted object: Information about a build that could not be successfully deleted.
  • id
  • statusCode

BuildPhase

• BuildPhase object: Information about a stage for a build.
  • contexts
    • items PhaseContext
  • durationInSeconds
  • endTime
  • phaseStatus
  • phaseType
  • startTime

BuildPhaseType

• BuildPhaseType string (values: SUBMITTED, QUEUED, PROVISIONING, DOWNLOAD_SOURCE, INSTALL, PRE_BUILD, BUILD, POST_BUILD, UPLOAD_ARTIFACTS, FINALIZING, COMPLETED)

BuildPhases

• BuildPhases array
  • items BuildPhase

BuildReportArns

• BuildReportArns array
  • items String

BuildStatusConfig

• BuildStatusConfig object: Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
  • context
  • targetUrl

BuildSummaries

• BuildSummaries array
  • items BuildSummary

BuildSummary

• BuildSummary object: Contains summary information about a batch build group.
  • arn
  • buildStatus
  • primaryArtifact
    • identifier
    • location
    • type
  • requestedOn
  • secondaryArtifacts
    • items ResolvedArtifact

Builds

• Builds array
  • items Build

BuildsNotDeleted

• BuildsNotDeleted array
  • items BuildNotDeleted

CacheMode

• CacheMode string (values: LOCAL_DOCKER_LAYER_CACHE, LOCAL_SOURCE_CACHE, LOCAL_CUSTOM_CACHE)

CacheType

• CacheType string (values: NO_CACHE, S3, LOCAL)

CloudWatchLogsConfig

• CloudWatchLogsConfig object: Information about Amazon CloudWatch Logs for a build project.
  • groupName
  • status required
  • streamName

CodeCoverage

• CodeCoverage object:

  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.

  • branchCoveragePercentage
  • branchesCovered
  • branchesMissed
  • expired
  • filePath
  • id
  • lineCoveragePercentage
  • linesCovered
  • linesMissed
  • reportARN

CodeCoverageReportSummary

• CodeCoverageReportSummary object:

  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.

  • branchCoveragePercentage
  • branchesCovered
  • branchesMissed
  • lineCoveragePercentage
  • linesCovered
  • linesMissed

CodeCoverages

• CodeCoverages array
  • items CodeCoverage

ComputeType

• ComputeType string (values: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE, BUILD_GENERAL1_2XLARGE)

ComputeTypesAllowed

• ComputeTypesAllowed array
  • items NonEmptyString

CreateProjectInput

• CreateProjectInput object
  • tags
    • items Tag
  • artifacts required
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • badgeEnabled
  • buildBatchConfig
    • combineArtifacts
    • restrictions
      • computeTypesAllowed
        • items NonEmptyString
      • maximumBuildsAllowed
    • serviceRole
    • timeoutInMins
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • description
  • encryptionKey
  • environment required
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • logsConfig
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • name required
  • queuedTimeoutInMinutes
  • secondaryArtifacts
    • items ProjectArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole required
  • source required
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId

CreateProjectOutput

• CreateProjectOutput object
  • project
    • tags
      • items Tag
    • arn
    • artifacts
      • artifactIdentifier
      • encryptionDisabled
      • location
      • name
      • namespaceType
      • overrideArtifactName
      • packaging
      • path
      • type required
    • badge
      • badgeEnabled
      • badgeRequestUrl
    • buildBatchConfig
      • combineArtifacts
      • restrictions
        • computeTypesAllowed
          • items NonEmptyString
        • maximumBuildsAllowed
      • serviceRole
      • timeoutInMins
    • cache
      • location
      • modes
        • items CacheMode
      • type required
    • created
    • description
    • encryptionKey
    • environment
      • certificate
      • computeType required
      • environmentVariables
        • items EnvironmentVariable
      • image required
      • imagePullCredentialsType
      • privilegedMode
      • registryCredential
        • credential required
        • credentialProvider required
      • type required
    • fileSystemLocations
      • items ProjectFileSystemLocation
    • lastModified
    • logsConfig
      • cloudWatchLogs
        • groupName
        • status required
        • streamName
      • s3Logs
        • encryptionDisabled
        • location
        • status required
    • name
    • queuedTimeoutInMinutes
    • secondaryArtifacts
      • items ProjectArtifacts
    • secondarySourceVersions
      • items ProjectSourceVersion
    • secondarySources
      • items ProjectSource
    • serviceRole
    • source
      • auth
        • resource
        • type required
      • buildStatusConfig
        • context
        • targetUrl
      • buildspec
      • gitCloneDepth
      • gitSubmodulesConfig
        • fetchSubmodules required
      • insecureSsl
      • location
      • reportBuildStatus
      • sourceIdentifier
      • type required
    • sourceVersion
    • timeoutInMinutes
    • vpcConfig
      • securityGroupIds
        • items NonEmptyString
      • subnets
        • items NonEmptyString
      • vpcId
    • webhook
      • branchFilter
      • buildType
      • filterGroups
        • items FilterGroup
      • lastModifiedSecret
      • payloadUrl
      • secret
      • url

CreateReportGroupInput

• CreateReportGroupInput object
  • tags
    • items Tag
  • exportConfig required
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path
  • name required
  • type required

CreateReportGroupOutput

• CreateReportGroupOutput object
  • reportGroup
    • tags
      • items Tag
    • arn
    • created
    • exportConfig
      • exportConfigType
      • s3Destination
        • bucket
        • encryptionDisabled
        • encryptionKey
        • packaging
        • path
    • lastModified
    • name
    • status ReportGroupStatusType
    • type

CreateWebhookInput

• CreateWebhookInput object
  • branchFilter
  • buildType
  • filterGroups
    • items FilterGroup
  • projectName required

CreateWebhookOutput

• CreateWebhookOutput object
  • webhook
    • branchFilter
    • buildType
    • filterGroups
      • items FilterGroup
    • lastModifiedSecret
    • payloadUrl
    • secret
    • url

CredentialProviderType

• CredentialProviderType string (values: SECRETS_MANAGER)

DebugSession

• DebugSession object: Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.
  • sessionEnabled
  • sessionTarget

DeleteBuildBatchInput

• DeleteBuildBatchInput object
  • id required

DeleteBuildBatchOutput

• DeleteBuildBatchOutput object
  • buildsDeleted
    • items NonEmptyString
  • buildsNotDeleted
    • items BuildNotDeleted
  • statusCode

DeleteProjectInput

• DeleteProjectInput object
  • name required

DeleteProjectOutput

• DeleteProjectOutput object

DeleteReportGroupInput

• DeleteReportGroupInput object
  • arn required
  • deleteReports

DeleteReportGroupOutput

• DeleteReportGroupOutput object

DeleteReportInput

• DeleteReportInput object
  • arn required

DeleteReportOutput

• DeleteReportOutput object

DeleteResourcePolicyInput

• DeleteResourcePolicyInput object
  • resourceArn required

DeleteResourcePolicyOutput

• DeleteResourcePolicyOutput object

DeleteSourceCredentialsInput

• DeleteSourceCredentialsInput object
  • arn required

DeleteSourceCredentialsOutput

• DeleteSourceCredentialsOutput object
  • arn

DeleteWebhookInput

• DeleteWebhookInput object
  • projectName required

DeleteWebhookOutput

• DeleteWebhookOutput object

DescribeCodeCoveragesInput

• DescribeCodeCoveragesInput object
  • maxLineCoveragePercentage
  • maxResults
  • minLineCoveragePercentage
  • nextToken
  • reportArn required
  • sortBy
  • sortOrder

DescribeCodeCoveragesOutput

• DescribeCodeCoveragesOutput object
  • codeCoverages
    • items CodeCoverage
  • nextToken

DescribeTestCasesInput

• DescribeTestCasesInput object
  • filter
    • keyword
    • status
  • maxResults
  • nextToken
  • reportArn required

DescribeTestCasesOutput

• DescribeTestCasesOutput object
  • nextToken
  • testCases
    • items TestCase

EnvironmentImage

• EnvironmentImage object: Information about a Docker image that is managed by AWS CodeBuild.
  • description
  • name
  • versions
    • items String

EnvironmentImages

• EnvironmentImages array
  • items EnvironmentImage

EnvironmentLanguage

• EnvironmentLanguage object: A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
  • images
    • items EnvironmentImage
  • language

EnvironmentLanguages

• EnvironmentLanguages array
  • items EnvironmentLanguage

EnvironmentPlatform

• EnvironmentPlatform object: A set of Docker images that are related by platform and are managed by AWS CodeBuild.
  • languages
    • items EnvironmentLanguage
  • platform

EnvironmentPlatforms

• EnvironmentPlatforms array
  • items EnvironmentPlatform

EnvironmentType

• EnvironmentType string (values: WINDOWS_CONTAINER, LINUX_CONTAINER, LINUX_GPU_CONTAINER, ARM_CONTAINER, WINDOWS_SERVER_2019_CONTAINER)

EnvironmentVariable

• EnvironmentVariable object: Information about an environment variable for a build project or a build.
  • name required
  • type
  • value required

EnvironmentVariableType

• EnvironmentVariableType string (values: PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER)

EnvironmentVariables

• EnvironmentVariables array
  • items EnvironmentVariable

ExportedEnvironmentVariable

• ExportedEnvironmentVariable object: Information about an exported environment variable.
  • name
  • value

ExportedEnvironmentVariables

• ExportedEnvironmentVariables array
  • items ExportedEnvironmentVariable

FileSystemType

• FileSystemType string (values: EFS)

FilterGroup

• FilterGroup array
  • items WebhookFilter

FilterGroups

• FilterGroups array
  • items FilterGroup

GetReportGroupTrendInput

• GetReportGroupTrendInput object
  • numOfReports PageSize
  • reportGroupArn required NonEmptyString
  • trendField required ReportGroupTrendFieldType

GetReportGroupTrendOutput

• GetReportGroupTrendOutput object
  • rawData ReportGroupTrendRawDataList
  • stats ReportGroupTrendStats

GetResourcePolicyInput

• GetResourcePolicyInput object
  • resourceArn required

GetResourcePolicyOutput

• GetResourcePolicyOutput object
  • policy

GitCloneDepth

• GitCloneDepth integer

GitSubmodulesConfig

• GitSubmodulesConfig object: Information about the Git submodules configuration for an AWS CodeBuild build project.
  • fetchSubmodules required

Identifiers

• Identifiers array
  • items NonEmptyString

ImagePullCredentialsType

• ImagePullCredentialsType string (values: CODEBUILD, SERVICE_ROLE)

ImageVersions

• ImageVersions array
  • items String

ImportSourceCredentialsInput

• ImportSourceCredentialsInput object
  • authType required
  • serverType required
  • shouldOverwrite
  • token required
  • username

ImportSourceCredentialsOutput

• ImportSourceCredentialsOutput object
  • arn

InvalidInputException

InvalidateProjectCacheInput

• InvalidateProjectCacheInput object
  • projectName required

InvalidateProjectCacheOutput

• InvalidateProjectCacheOutput object

KeyInput

• KeyInput string

LanguageType

• LanguageType string (values: JAVA, PYTHON, NODE_JS, RUBY, GOLANG, DOCKER, ANDROID, DOTNET, BASE, PHP)

ListBuildBatchesForProjectInput

• ListBuildBatchesForProjectInput object
  • filter
    • status
  • maxResults
  • nextToken
  • projectName
  • sortOrder

ListBuildBatchesForProjectOutput

• ListBuildBatchesForProjectOutput object
  • ids
    • items NonEmptyString
  • nextToken

ListBuildBatchesInput

• ListBuildBatchesInput object
  • filter
    • status
  • maxResults
  • nextToken
  • sortOrder

ListBuildBatchesOutput

• ListBuildBatchesOutput object
  • ids
    • items NonEmptyString
  • nextToken

ListBuildsForProjectInput

• ListBuildsForProjectInput object
  • nextToken
  • projectName required
  • sortOrder

ListBuildsForProjectOutput

• ListBuildsForProjectOutput object
  • ids
    • items NonEmptyString
  • nextToken

ListBuildsInput

• ListBuildsInput object
  • nextToken
  • sortOrder

ListBuildsOutput

• ListBuildsOutput object
  • ids
    • items NonEmptyString
  • nextToken

ListCuratedEnvironmentImagesInput

• ListCuratedEnvironmentImagesInput object

ListCuratedEnvironmentImagesOutput

• ListCuratedEnvironmentImagesOutput object
  • platforms
    • items EnvironmentPlatform

ListProjectsInput

• ListProjectsInput object
  • nextToken
  • sortBy
  • sortOrder

ListProjectsOutput

• ListProjectsOutput object
  • nextToken
  • projects
    • items NonEmptyString

ListReportGroupsInput

• ListReportGroupsInput object
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

ListReportGroupsOutput

• ListReportGroupsOutput object
  • nextToken
  • reportGroups
    • items NonEmptyString

ListReportsForReportGroupInput

• ListReportsForReportGroupInput object
  • filter
    • status
  • maxResults
  • nextToken
  • reportGroupArn required
  • sortOrder

ListReportsForReportGroupOutput

• ListReportsForReportGroupOutput object
  • nextToken
  • reports
    • items NonEmptyString

ListReportsInput

• ListReportsInput object
  • filter
    • status
  • maxResults
  • nextToken
  • sortOrder

ListReportsOutput

• ListReportsOutput object
  • nextToken
  • reports
    • items NonEmptyString

ListSharedProjectsInput

• ListSharedProjectsInput object
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

ListSharedProjectsOutput

• ListSharedProjectsOutput object
  • nextToken
  • projects
    • items NonEmptyString

ListSharedReportGroupsInput

• ListSharedReportGroupsInput object
  • maxResults
  • nextToken
  • sortBy
  • sortOrder

ListSharedReportGroupsOutput

• ListSharedReportGroupsOutput object
  • nextToken
  • reportGroups
    • items NonEmptyString

ListSourceCredentialsInput

• ListSourceCredentialsInput object

ListSourceCredentialsOutput

• ListSourceCredentialsOutput object
  • sourceCredentialsInfos
    • items SourceCredentialsInfo

LogsConfig

• LogsConfig object: Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.
  • cloudWatchLogs
    • groupName
    • status required
    • streamName
  • s3Logs
    • encryptionDisabled
    • location
    • status required

LogsConfigStatusType

• LogsConfigStatusType string (values: ENABLED, DISABLED)

LogsLocation

• LogsLocation object: Information about build logs in Amazon CloudWatch Logs.
  • cloudWatchLogs
    • groupName
    • status required
    • streamName
  • cloudWatchLogsArn
  • deepLink
  • groupName
  • s3DeepLink
  • s3Logs
    • encryptionDisabled
    • location
    • status required
  • s3LogsArn
  • streamName

NetworkInterface

• NetworkInterface object: Describes a network interface.
  • networkInterfaceId
  • subnetId

NonEmptyString

• NonEmptyString string

NonNegativeInt

• NonNegativeInt integer

OAuthProviderException

PageSize

• PageSize integer

Percentage

• Percentage number

PhaseContext

• PhaseContext object: Additional information about a build phase that has an error. You can use this information for troubleshooting.
  • message
  • statusCode

PhaseContexts

• PhaseContexts array
  • items PhaseContext

PlatformType

• PlatformType string (values: DEBIAN, AMAZON_LINUX, UBUNTU, WINDOWS_SERVER)

Project

• Project object: Information about a build project.
  • tags
    • items Tag
  • arn
  • artifacts
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • badge
    • badgeEnabled
    • badgeRequestUrl
  • buildBatchConfig
    • combineArtifacts
    • restrictions
      • computeTypesAllowed
        • items NonEmptyString
      • maximumBuildsAllowed
    • serviceRole
    • timeoutInMins
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • created
  • description
  • encryptionKey
  • environment
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • lastModified
  • logsConfig
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • name
  • queuedTimeoutInMinutes
  • secondaryArtifacts
    • items ProjectArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole
  • source
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId
  • webhook
    • branchFilter
    • buildType
    • filterGroups
      • items FilterGroup
    • lastModifiedSecret
    • payloadUrl
    • secret
    • url

ProjectArns

• ProjectArns array
  • items NonEmptyString

ProjectArtifacts

• ProjectArtifacts object: Information about the build output artifacts for the build project.
  • artifactIdentifier
  • encryptionDisabled
  • location
  • name
  • namespaceType
  • overrideArtifactName
  • packaging
  • path
  • type required

ProjectArtifactsList

• ProjectArtifactsList array
  • items ProjectArtifacts

ProjectBadge

• ProjectBadge object: Information about the build badge for the build project.
  • badgeEnabled
  • badgeRequestUrl

ProjectBuildBatchConfig

• ProjectBuildBatchConfig object: Contains configuration information about a batch build project.
  • combineArtifacts
  • restrictions
    • computeTypesAllowed
      • items NonEmptyString
    • maximumBuildsAllowed
  • serviceRole
  • timeoutInMins

ProjectCache

• ProjectCache object: Information about the cache for the build project.
  • location
  • modes
    • items CacheMode
  • type required

ProjectCacheModes

• ProjectCacheModes array
  • items CacheMode

ProjectDescription

• ProjectDescription string

ProjectEnvironment

• ProjectEnvironment object: Information about the build environment of the build project.
  • certificate
  • computeType required
  • environmentVariables
    • items EnvironmentVariable
  • image required
  • imagePullCredentialsType
  • privilegedMode
  • registryCredential
    • credential required
    • credentialProvider required
  • type required

ProjectFileSystemLocation

• ProjectFileSystemLocation object: Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
  • identifier
  • location
  • mountOptions
  • mountPoint
  • type

ProjectFileSystemLocations

• ProjectFileSystemLocations array
  • items ProjectFileSystemLocation

ProjectName

• ProjectName string

ProjectNames

• ProjectNames array
  • items NonEmptyString

ProjectSecondarySourceVersions

• ProjectSecondarySourceVersions array
  • items ProjectSourceVersion

ProjectSortByType

• ProjectSortByType string (values: NAME, CREATED_TIME, LAST_MODIFIED_TIME)

ProjectSource

• ProjectSource object: Information about the build input source code for the build project.
  • auth
    • resource
    • type required
  • buildStatusConfig
    • context
    • targetUrl
  • buildspec
  • gitCloneDepth
  • gitSubmodulesConfig
    • fetchSubmodules required
  • insecureSsl
  • location
  • reportBuildStatus
  • sourceIdentifier
  • type required

ProjectSourceVersion

• ProjectSourceVersion object: A source identifier and its corresponding version.
  • sourceIdentifier required
  • sourceVersion required

ProjectSources

• ProjectSources array
  • items ProjectSource

Projects

• Projects array
  • items Project

PutResourcePolicyInput

• PutResourcePolicyInput object
  • policy required
  • resourceArn required

PutResourcePolicyOutput

• PutResourcePolicyOutput object
  • resourceArn

RegistryCredential

• RegistryCredential object:

  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 AWS Secrets Manager Sample for AWS CodeBuild.

  • credential required
  • credentialProvider required

Report

• Report object: 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.
  • arn
  • codeCoverageSummary
    • branchCoveragePercentage
    • branchesCovered
    • branchesMissed
    • lineCoveragePercentage
    • linesCovered
    • linesMissed
  • created
  • executionId
  • expired
  • exportConfig
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path
  • name
  • reportGroupArn
  • status
  • testSummary
    • durationInNanoSeconds required
    • statusCounts required
    • total required
  • truncated
  • type

ReportArns

• ReportArns array
  • items NonEmptyString

ReportCodeCoverageSortByType

• ReportCodeCoverageSortByType string (values: LINE_COVERAGE_PERCENTAGE, FILE_PATH)

ReportExportConfig

• ReportExportConfig object: Information about the location where the run of a report is exported.
  • exportConfigType
  • s3Destination
    • bucket
    • encryptionDisabled
    • encryptionKey
    • packaging
    • path

ReportExportConfigType

• ReportExportConfigType string (values: S3, NO_EXPORT)

ReportFilter

• ReportFilter object: A filter used to return reports with the status specified by the input status parameter.
  • status

ReportGroup

• ReportGroup object: A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
  • tags
    • items Tag
  • arn
  • created
  • exportConfig
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path
  • lastModified
  • name
  • status ReportGroupStatusType
  • type

ReportGroupArns

• ReportGroupArns array
  • items NonEmptyString

ReportGroupName

• ReportGroupName string

ReportGroupSortByType

• ReportGroupSortByType string (values: NAME, CREATED_TIME, LAST_MODIFIED_TIME)

ReportGroupStatusType

• ReportGroupStatusType string (values: ACTIVE, DELETING)

ReportGroupTrendFieldType

• ReportGroupTrendFieldType string (values: PASS_RATE, DURATION, TOTAL, LINE_COVERAGE, LINES_COVERED, LINES_MISSED, BRANCH_COVERAGE, BRANCHES_COVERED, BRANCHES_MISSED)

ReportGroupTrendRawDataList

• ReportGroupTrendRawDataList array
  • items ReportWithRawData

ReportGroupTrendStats

• ReportGroupTrendStats object
  • average String
  • max String
  • min String

ReportGroups

• ReportGroups array
  • items ReportGroup

ReportPackagingType

• ReportPackagingType string (values: ZIP, NONE)

ReportStatusCounts

• ReportStatusCounts object

ReportStatusType

• ReportStatusType string (values: GENERATING, SUCCEEDED, FAILED, INCOMPLETE, DELETING)

ReportType

• ReportType string (values: TEST, CODE_COVERAGE)

ReportWithRawData

• ReportWithRawData object
  • data String
  • reportArn NonEmptyString

Reports

• Reports array
  • items Report

ResolvedArtifact

• ResolvedArtifact object: Represents a resolved build artifact. A resolve artifact is an artifact that is built and deployed to the destination, such as Amazon Simple Storage Service (Amazon S3).
  • identifier
  • location
  • type

ResolvedSecondaryArtifacts

• ResolvedSecondaryArtifacts array
  • items ResolvedArtifact

ResourceAlreadyExistsException

ResourceNotFoundException

RetryBuildBatchInput

• RetryBuildBatchInput object
  • id
  • retryType

RetryBuildBatchOutput

• RetryBuildBatchOutput object
  • buildBatch BuildBatch

RetryBuildBatchType

• RetryBuildBatchType string (values: RETRY_ALL_BUILDS, RETRY_FAILED_BUILDS)

RetryBuildInput

• RetryBuildInput object
  • id

RetryBuildOutput

• RetryBuildOutput object
  • build Build

S3LogsConfig

• S3LogsConfig object: Information about S3 logs for a build project.
  • encryptionDisabled
  • location
  • status required

S3ReportExportConfig

• S3ReportExportConfig object: Information about the S3 bucket where the raw data of a report are exported.
  • bucket
  • encryptionDisabled
  • encryptionKey
  • packaging
  • path

SecurityGroupIds

• SecurityGroupIds array
  • items NonEmptyString

SensitiveNonEmptyString

• SensitiveNonEmptyString string

ServerType

• ServerType string (values: GITHUB, BITBUCKET, GITHUB_ENTERPRISE)

SharedResourceSortByType

• SharedResourceSortByType string (values: ARN, MODIFIED_TIME)

SortOrderType

• SortOrderType string (values: ASCENDING, DESCENDING)

SourceAuth

• SourceAuth object:

  Information about the authorization settings for AWS CodeBuild to access the source code to be built.

  This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.

  • resource
  • type required

SourceAuthType

• SourceAuthType string (values: OAUTH)

SourceCredentialsInfo

• SourceCredentialsInfo object: Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
  • arn
  • authType
  • serverType

SourceCredentialsInfos

• SourceCredentialsInfos array
  • items SourceCredentialsInfo

SourceType

• SourceType string (values: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE, NO_SOURCE)

StartBuildBatchInput

• StartBuildBatchInput object
  • artifactsOverride
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • buildBatchConfigOverride
    • combineArtifacts
    • restrictions
      • computeTypesAllowed
        • items NonEmptyString
      • maximumBuildsAllowed
    • serviceRole
    • timeoutInMins
  • buildTimeoutInMinutesOverride
  • buildspecOverride
  • cacheOverride
    • location
    • modes
      • items CacheMode
    • type required
  • certificateOverride
  • computeTypeOverride
  • encryptionKeyOverride
  • environmentTypeOverride
  • environmentVariablesOverride
    • items EnvironmentVariable
  • gitCloneDepthOverride
  • gitSubmodulesConfigOverride
    • fetchSubmodules required
  • imageOverride
  • imagePullCredentialsTypeOverride
  • insecureSslOverride
  • logsConfigOverride
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • privilegedModeOverride
  • projectName required
  • queuedTimeoutInMinutesOverride
  • registryCredentialOverride
    • credential required
    • credentialProvider required
  • reportBuildBatchStatusOverride
  • secondaryArtifactsOverride
    • items ProjectArtifacts
  • secondarySourcesOverride
    • items ProjectSource
  • secondarySourcesVersionOverride
    • items ProjectSourceVersion
  • serviceRoleOverride
  • sourceAuthOverride
    • resource
    • type required
  • sourceLocationOverride
  • sourceTypeOverride
  • sourceVersion

StartBuildBatchOutput

• StartBuildBatchOutput object
  • buildBatch
    • arn
    • artifacts
      • artifactIdentifier
      • encryptionDisabled
      • location
      • md5sum
      • overrideArtifactName
      • sha256sum
    • buildBatchConfig ProjectBuildBatchConfig
    • buildBatchNumber
    • buildBatchStatus
    • buildGroups
      • items BuildGroup
    • buildTimeoutInMinutes
    • cache ProjectCache
    • complete
    • currentPhase
    • encryptionKey
    • endTime
    • environment ProjectEnvironment
    • fileSystemLocations
      • items ProjectFileSystemLocation
    • id
    • initiator
    • logConfig LogsConfig
    • phases
      • items BuildBatchPhase
    • projectName
    • queuedTimeoutInMinutes
    • resolvedSourceVersion
    • secondaryArtifacts
      • items BuildArtifacts
    • secondarySourceVersions
      • items ProjectSourceVersion
    • secondarySources
      • items ProjectSource
    • serviceRole
    • source ProjectSource
    • sourceVersion
    • startTime
    • vpcConfig VpcConfig

StartBuildInput

• StartBuildInput object
  • artifactsOverride
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • buildStatusConfigOverride
    • context
    • targetUrl
  • buildspecOverride
  • cacheOverride
    • location
    • modes
      • items CacheMode
    • type required
  • certificateOverride
  • computeTypeOverride
  • debugSessionEnabled
  • encryptionKeyOverride
  • environmentTypeOverride
  • environmentVariablesOverride
    • items EnvironmentVariable
  • gitCloneDepthOverride
  • gitSubmodulesConfigOverride
    • fetchSubmodules required
  • imageOverride
  • imagePullCredentialsTypeOverride
  • insecureSslOverride
  • logsConfigOverride
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • privilegedModeOverride
  • projectName required
  • queuedTimeoutInMinutesOverride
  • registryCredentialOverride
    • credential required
    • credentialProvider required
  • reportBuildStatusOverride
  • secondaryArtifactsOverride
    • items ProjectArtifacts
  • secondarySourcesOverride
    • items ProjectSource
  • secondarySourcesVersionOverride
    • items ProjectSourceVersion
  • serviceRoleOverride
  • sourceAuthOverride
    • resource
    • type required
  • sourceLocationOverride
  • sourceTypeOverride
  • sourceVersion
  • timeoutInMinutesOverride

StartBuildOutput

• StartBuildOutput object
  • build
    • arn
    • artifacts
      • artifactIdentifier
      • encryptionDisabled
      • location
      • md5sum
      • overrideArtifactName
      • sha256sum
    • buildBatchArn
    • buildComplete
    • buildNumber
    • buildStatus
    • cache
      • location
      • modes
        • items CacheMode
      • type required
    • currentPhase
    • debugSession
      • sessionEnabled
      • sessionTarget
    • encryptionKey
    • endTime
    • environment
      • certificate
      • computeType required
      • environmentVariables
        • items EnvironmentVariable
      • image required
      • imagePullCredentialsType
      • privilegedMode
      • registryCredential
        • credential required
        • credentialProvider required
      • type required
    • exportedEnvironmentVariables
      • items ExportedEnvironmentVariable
    • fileSystemLocations
      • items ProjectFileSystemLocation
    • id
    • initiator
    • logs
      • cloudWatchLogs
        • groupName
        • status required
        • streamName
      • cloudWatchLogsArn
      • deepLink
      • groupName
      • s3DeepLink
      • s3Logs
        • encryptionDisabled
        • location
        • status required
      • s3LogsArn
      • streamName
    • networkInterface
      • networkInterfaceId
      • subnetId
    • phases
      • items BuildPhase
    • projectName
    • queuedTimeoutInMinutes
    • reportArns
      • items String
    • resolvedSourceVersion
    • secondaryArtifacts
      • items BuildArtifacts
    • secondarySourceVersions
      • items ProjectSourceVersion
    • secondarySources
      • items ProjectSource
    • serviceRole
    • source
      • auth
        • resource
        • type required
      • buildStatusConfig
        • context
        • targetUrl
      • buildspec
      • gitCloneDepth
      • gitSubmodulesConfig
        • fetchSubmodules required
      • insecureSsl
      • location
      • reportBuildStatus
      • sourceIdentifier
      • type required
    • sourceVersion
    • startTime
    • timeoutInMinutes
    • vpcConfig
      • securityGroupIds
        • items NonEmptyString
      • subnets
        • items NonEmptyString
      • vpcId

StatusType

• StatusType string (values: SUCCEEDED, FAILED, FAULT, TIMED_OUT, IN_PROGRESS, STOPPED)

StopBuildBatchInput

• StopBuildBatchInput object
  • id required

StopBuildBatchOutput

• StopBuildBatchOutput object
  • buildBatch BuildBatch

StopBuildInput

• StopBuildInput object
  • id required

StopBuildOutput

• StopBuildOutput object
  • build
    • arn
    • artifacts
      • artifactIdentifier
      • encryptionDisabled
      • location
      • md5sum
      • overrideArtifactName
      • sha256sum
    • buildBatchArn
    • buildComplete
    • buildNumber
    • buildStatus
    • cache
      • location
      • modes
        • items CacheMode
      • type required
    • currentPhase
    • debugSession
      • sessionEnabled
      • sessionTarget
    • encryptionKey
    • endTime
    • environment
      • certificate
      • computeType required
      • environmentVariables
        • items EnvironmentVariable
      • image required
      • imagePullCredentialsType
      • privilegedMode
      • registryCredential
        • credential required
        • credentialProvider required
      • type required
    • exportedEnvironmentVariables
      • items ExportedEnvironmentVariable
    • fileSystemLocations
      • items ProjectFileSystemLocation
    • id
    • initiator
    • logs
      • cloudWatchLogs
        • groupName
        • status required
        • streamName
      • cloudWatchLogsArn
      • deepLink
      • groupName
      • s3DeepLink
      • s3Logs
        • encryptionDisabled
        • location
        • status required
      • s3LogsArn
      • streamName
    • networkInterface
      • networkInterfaceId
      • subnetId
    • phases
      • items BuildPhase
    • projectName
    • queuedTimeoutInMinutes
    • reportArns
      • items String
    • resolvedSourceVersion
    • secondaryArtifacts
      • items BuildArtifacts
    • secondarySourceVersions
      • items ProjectSourceVersion
    • secondarySources
      • items ProjectSource
    • serviceRole
    • source
      • auth
        • resource
        • type required
      • buildStatusConfig
        • context
        • targetUrl
      • buildspec
      • gitCloneDepth
      • gitSubmodulesConfig
        • fetchSubmodules required
      • insecureSsl
      • location
      • reportBuildStatus
      • sourceIdentifier
      • type required
    • sourceVersion
    • startTime
    • timeoutInMinutes
    • vpcConfig
      • securityGroupIds
        • items NonEmptyString
      • subnets
        • items NonEmptyString
      • vpcId

String

• String string

Subnets

• Subnets array
  • items NonEmptyString

Tag

• Tag object:

  A tag, consisting of a key and a value.

  This tag is available for use by AWS services that support tags in AWS CodeBuild.

  • key
  • value

TagList

• TagList array
  • items Tag

TestCase

• TestCase object: 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.
  • durationInNanoSeconds
  • expired
  • message
  • name
  • prefix
  • reportArn
  • status
  • testRawDataPath

TestCaseFilter

• TestCaseFilter object: 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.
  • keyword
  • status

TestCases

• TestCases array
  • items TestCase

TestReportSummary

• TestReportSummary object: Information about a test report.
  • durationInNanoSeconds required
  • statusCounts required
  • total required

TimeOut

• TimeOut integer

Timestamp

• Timestamp string

UpdateProjectInput

• UpdateProjectInput object
  • tags
    • items Tag
  • artifacts
    • artifactIdentifier
    • encryptionDisabled
    • location
    • name
    • namespaceType
    • overrideArtifactName
    • packaging
    • path
    • type required
  • badgeEnabled
  • buildBatchConfig ProjectBuildBatchConfig
  • cache
    • location
    • modes
      • items CacheMode
    • type required
  • description
  • encryptionKey
  • environment
    • certificate
    • computeType required
    • environmentVariables
      • items EnvironmentVariable
    • image required
    • imagePullCredentialsType
    • privilegedMode
    • registryCredential
      • credential required
      • credentialProvider required
    • type required
  • fileSystemLocations
    • items ProjectFileSystemLocation
  • logsConfig
    • cloudWatchLogs
      • groupName
      • status required
      • streamName
    • s3Logs
      • encryptionDisabled
      • location
      • status required
  • name required
  • queuedTimeoutInMinutes
  • secondaryArtifacts
    • items ProjectArtifacts
  • secondarySourceVersions
    • items ProjectSourceVersion
  • secondarySources
    • items ProjectSource
  • serviceRole
  • source
    • auth
      • resource
      • type required
    • buildStatusConfig
      • context
      • targetUrl
    • buildspec
    • gitCloneDepth
    • gitSubmodulesConfig
      • fetchSubmodules required
    • insecureSsl
    • location
    • reportBuildStatus
    • sourceIdentifier
    • type required
  • sourceVersion
  • timeoutInMinutes
  • vpcConfig
    • securityGroupIds
      • items NonEmptyString
    • subnets
      • items NonEmptyString
    • vpcId

UpdateProjectOutput

• UpdateProjectOutput object
  • project
    • tags
      • items Tag
    • arn
    • artifacts
      • artifactIdentifier
      • encryptionDisabled
      • location
      • name
      • namespaceType
      • overrideArtifactName
      • packaging
      • path
      • type required
    • badge
      • badgeEnabled
      • badgeRequestUrl
    • buildBatchConfig
      • combineArtifacts
      • restrictions
        • computeTypesAllowed
          • items NonEmptyString
        • maximumBuildsAllowed
      • serviceRole
      • timeoutInMins
    • cache
      • location
      • modes
        • items CacheMode
      • type required
    • created
    • description
    • encryptionKey
    • environment
      • certificate
      • computeType required
      • environmentVariables
        • items EnvironmentVariable
      • image required
      • imagePullCredentialsType
      • privilegedMode
      • registryCredential
        • credential required
        • credentialProvider required
      • type required
    • fileSystemLocations
      • items ProjectFileSystemLocation
    • lastModified
    • logsConfig
      • cloudWatchLogs
        • groupName
        • status required
        • streamName
      • s3Logs
        • encryptionDisabled
        • location
        • status required
    • name
    • queuedTimeoutInMinutes
    • secondaryArtifacts
      • items ProjectArtifacts
    • secondarySourceVersions
      • items ProjectSourceVersion
    • secondarySources
      • items ProjectSource
    • serviceRole
    • source
      • auth
        • resource
        • type required
      • buildStatusConfig
        • context
        • targetUrl
      • buildspec
      • gitCloneDepth
      • gitSubmodulesConfig
        • fetchSubmodules required
      • insecureSsl
      • location
      • reportBuildStatus
      • sourceIdentifier
      • type required
    • sourceVersion
    • timeoutInMinutes
    • vpcConfig
      • securityGroupIds
        • items NonEmptyString
      • subnets
        • items NonEmptyString
      • vpcId
    • webhook
      • branchFilter
      • buildType
      • filterGroups
        • items FilterGroup
      • lastModifiedSecret
      • payloadUrl
      • secret
      • url

UpdateReportGroupInput

• UpdateReportGroupInput object
  • tags
    • items Tag
  • arn required
  • exportConfig
    • exportConfigType
    • s3Destination
      • bucket
      • encryptionDisabled
      • encryptionKey
      • packaging
      • path

UpdateReportGroupOutput

• UpdateReportGroupOutput object
  • reportGroup
    • tags
      • items Tag
    • arn
    • created
    • exportConfig
      • exportConfigType
      • s3Destination
        • bucket
        • encryptionDisabled
        • encryptionKey
        • packaging
        • path
    • lastModified
    • name
    • status ReportGroupStatusType
    • type

UpdateWebhookInput

• UpdateWebhookInput object
  • branchFilter
  • buildType
  • filterGroups
    • items FilterGroup
  • projectName required
  • rotateSecret

UpdateWebhookOutput

• UpdateWebhookOutput object
  • webhook
    • branchFilter
    • buildType
    • filterGroups
      • items FilterGroup
    • lastModifiedSecret
    • payloadUrl
    • secret
    • url

ValueInput

• ValueInput string

VpcConfig

• VpcConfig object: Information about the VPC configuration that AWS CodeBuild accesses.
  • securityGroupIds
    • items NonEmptyString
  • subnets
    • items NonEmptyString
  • vpcId

Webhook

• Webhook object: Information about a webhook that connects repository events to a build project in AWS CodeBuild.
  • branchFilter
  • buildType
  • filterGroups
    • items FilterGroup
  • lastModifiedSecret
  • payloadUrl
  • secret
  • url

WebhookBuildType

• WebhookBuildType string (values: BUILD, BUILD_BATCH)

WebhookFilter

• WebhookFilter object: A filter used to determine which webhooks trigger a build.
  • excludeMatchedPattern
  • pattern required
  • type required

WebhookFilterType

• WebhookFilterType string (values: EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH, COMMIT_MESSAGE)

WrapperBoolean

• WrapperBoolean boolean

WrapperInt

• WrapperInt integer

WrapperLong

• WrapperLong integer