@aws-sdk/client-codebuild

Description

AWS SDK for JavaScript CodeBuild Client for Node.js, Browser and React Native.

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.

Installing

To install the this package, simply type add or install @aws-sdk/client-codebuild using your favorite package manager:

• npm install @aws-sdk/client-codebuild
• yarn add @aws-sdk/client-codebuild
• pnpm add @aws-sdk/client-codebuild

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the CodeBuildClient and the commands you need, for example BatchDeleteBuildsCommand:

// ES5 example
const { CodeBuildClient, BatchDeleteBuildsCommand } = require("@aws-sdk/client-codebuild");

// ES6+ example
import { CodeBuildClient, BatchDeleteBuildsCommand } from "@aws-sdk/client-codebuild";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by difference commands.
const client = new CodeBuildClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new BatchDeleteBuildsCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // proccess err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-codebuild";
const client = new AWS.CodeBuild({ region: "REGION" });

// async/await.
try {
  const data = client.batchDeleteBuilds(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .batchDeleteBuilds(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.batchDeleteBuilds(params, (err, data) => {
  // proccess err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-codebuild package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.