@aws-sdk/client-codebuild
Advanced tools
AWS SDK for JavaScript Codebuild Client for Node.js, Browser and React Native
@aws-sdk/client-codebuild is a part of the AWS SDK for JavaScript, which allows developers to interact with AWS CodeBuild, a fully managed continuous integration service that compiles source code, runs tests, and produces software packages that are ready to deploy.
Start a Build
This feature allows you to start a new build for a specified CodeBuild project. The code sample demonstrates how to initiate a build using the StartBuildCommand.
const { CodeBuildClient, StartBuildCommand } = require('@aws-sdk/client-codebuild');
const client = new CodeBuildClient({ region: 'us-west-2' });
const params = {
projectName: 'my-project',
};
const run = async () => {
try {
const data = await client.send(new StartBuildCommand(params));
console.log('Build started:', data);
} catch (err) {
console.error('Error starting build:', err);
}
};
run();List Builds
This feature allows you to list all the builds in your AWS account. The code sample demonstrates how to retrieve and print the list of build IDs using the ListBuildsCommand.
const { CodeBuildClient, ListBuildsCommand } = require('@aws-sdk/client-codebuild');
const client = new CodeBuildClient({ region: 'us-west-2' });
const run = async () => {
try {
const data = await client.send(new ListBuildsCommand({}));
console.log('Builds:', data.ids);
} catch (err) {
console.error('Error listing builds:', err);
}
};
run();Get Build Details
This feature allows you to get detailed information about specific builds. The code sample demonstrates how to retrieve details for specified build IDs using the BatchGetBuildsCommand.
const { CodeBuildClient, BatchGetBuildsCommand } = require('@aws-sdk/client-codebuild');
const client = new CodeBuildClient({ region: 'us-west-2' });
const params = {
ids: ['build-id-1', 'build-id-2'],
};
const run = async () => {
try {
const data = await client.send(new BatchGetBuildsCommand(params));
console.log('Build details:', data.builds);
} catch (err) {
console.error('Error getting build details:', err);
}
};
run();The 'aws-sdk' package is the older version of the AWS SDK for JavaScript. It provides a comprehensive set of tools for interacting with AWS services, including CodeBuild. However, it is not modular like the '@aws-sdk/client-codebuild' package, which means it can be bulkier and less efficient for applications that only need specific services.
The 'serverless' package is a framework for building and deploying serverless applications. While it is not specifically focused on CodeBuild, it provides integrations with AWS services, including CodeBuild, to facilitate CI/CD pipelines. It offers a higher-level abstraction compared to '@aws-sdk/client-codebuild'.
The 'aws-cdk' (AWS Cloud Development Kit) allows developers to define cloud infrastructure using familiar programming languages. It includes constructs for CodeBuild projects and pipelines, providing a higher-level, more abstract way to manage CI/CD compared to the '@aws-sdk/client-codebuild' package.
AWS SDK for JavaScript CodeBuild Client for Node.js, Browser and React Native.
CodeBuild
CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. 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 CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.
To install this package, simply type add or install @aws-sdk/client-codebuild using your favorite package manager:
npm install @aws-sdk/client-codebuildyarn add @aws-sdk/client-codebuildpnpm add @aws-sdk/client-codebuildThe 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 ListBuildsCommand:
// ES5 example
const { CodeBuildClient, ListBuildsCommand } = require("@aws-sdk/client-codebuild");
// ES6+ example
import { CodeBuildClient, ListBuildsCommand } from "@aws-sdk/client-codebuild";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new CodeBuildClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListBuildsCommand(params);
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.
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.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
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 = await client.listBuilds(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listBuilds(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listBuilds(params, (err, data) => {
// process err and data.
});
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;
* }
*/
}
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.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
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.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Codebuild Client for Node.js, Browser and React Native
We found that @aws-sdk/client-codebuild demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.