AWS.CodeBuild — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

batchDeleteBuilds(params = {}, callback) ⇒ AWS.Request

Deletes one or more builds.

batchGetBuildBatches(params = {}, callback) ⇒ AWS.Request

Retrieves information about one or more batch builds.

batchGetBuilds(params = {}, callback) ⇒ AWS.Request

Gets information about one or more builds.

batchGetFleets(params = {}, callback) ⇒ AWS.Request

Gets information about one or more compute fleets.

batchGetProjects(params = {}, callback) ⇒ AWS.Request

Gets information about one or more build projects.

batchGetReportGroups(params = {}, callback) ⇒ AWS.Request

Returns an array of report groups.

batchGetReports(params = {}, callback) ⇒ AWS.Request

Returns an array of reports.

createProject(params = {}, callback) ⇒ AWS.Request

createReportGroup(params = {}, callback) ⇒ AWS.Request

Creates a report group. A report group contains a collection of reports.

createWebhook(params = {}, callback) ⇒ AWS.Request

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

If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

deleteBuildBatch(params = {}, callback) ⇒ AWS.Request

deleteFleet(params = {}, callback) ⇒ AWS.Request

Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

deleteProject(params = {}, callback) ⇒ AWS.Request

Deletes a build project. When you delete a project, its builds are not deleted.

deleteReportGroup(params = {}, callback) ⇒ AWS.Request

Deletes a report group. Before you delete a report group, you must delete its reports.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Deletes a resource policy that is identified by its resource ARN.

deleteSourceCredentials(params = {}, callback) ⇒ AWS.Request

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

deleteWebhook(params = {}, callback) ⇒ AWS.Request

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

describeCodeCoverages(params = {}, callback) ⇒ AWS.Request

Retrieves one or more code coverage reports.

describeTestCases(params = {}, callback) ⇒ AWS.Request

Returns a list of details about test cases for a report.

getReportGroupTrend(params = {}, callback) ⇒ AWS.Request

Analyzes and accumulates test report values for the specified test reports.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Gets a resource policy that is identified by its resource ARN.

importSourceCredentials(params = {}, callback) ⇒ AWS.Request

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.

invalidateProjectCache(params = {}, callback) ⇒ AWS.Request

Resets the cache for a project.

listBuildBatches(params = {}, callback) ⇒ AWS.Request

Retrieves the identifiers of your build batches in the current region.

listBuildBatchesForProject(params = {}, callback) ⇒ AWS.Request

Retrieves the identifiers of the build batches for a specific project.

listBuilds(params = {}, callback) ⇒ AWS.Request

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

listBuildsForProject(params = {}, callback) ⇒ AWS.Request

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

listCuratedEnvironmentImages(params = {}, callback) ⇒ AWS.Request

Gets information about Docker images that are managed by CodeBuild.

listFleets(params = {}, callback) ⇒ AWS.Request

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

listProjects(params = {}, callback) ⇒ AWS.Request

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

listReportGroups(params = {}, callback) ⇒ AWS.Request

Gets a list ARNs for the report groups in the current Amazon Web Services account.

listReports(params = {}, callback) ⇒ AWS.Request

Returns a list of ARNs for the reports in the current Amazon Web Services account.

listReportsForReportGroup(params = {}, callback) ⇒ AWS.Request

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

listSharedProjects(params = {}, callback) ⇒ AWS.Request

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

listSharedReportGroups(params = {}, callback) ⇒ AWS.Request

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

listSourceCredentials(params = {}, callback) ⇒ AWS.Request

Returns a list of SourceCredentialsInfo objects.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

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

retryBuildBatch(params = {}, callback) ⇒ AWS.Request

Restarts a failed batch build. Only batch builds that have failed can be retried.

startBuild(params = {}, callback) ⇒ AWS.Request

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.

startBuildBatch(params = {}, callback) ⇒ AWS.Request

Starts a batch build for a project.

stopBuild(params = {}, callback) ⇒ AWS.Request

Attempts to stop running a build.

stopBuildBatch(params = {}, callback) ⇒ AWS.Request

Stops a running batch build.

updateProject(params = {}, callback) ⇒ AWS.Request

Changes the settings of a build project.

updateProjectVisibility(params = {}, callback) ⇒ AWS.Request

Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.

The following should be kept in mind when making your projects public:

• All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
• All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
  • Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
  • Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
• A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.

updateReportGroup(params = {}, callback) ⇒ AWS.Request

updateWebhook(params = {}, callback) ⇒ AWS.Request

Updates the webhook associated with an CodeBuild build project.

Note: If you use Bitbucket for your repository, rotateSecret is ignored.