@aws-sdk/client-codebuild

Description

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.

Installing

To install 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

$3

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 ListBuildsCommand:

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

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

$3

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.

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

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

#### Async/await

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

`js
// 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.

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

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

`js
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.

`js
// callbacks.
client.send(command, (err, data) => {
// process 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

`ts
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.
});
`

$3

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

`js
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.

Client Commands (Operations List)

BatchDeleteBuilds

Command API Reference / Input / Output

BatchGetBuildBatches

Command API Reference / Input / Output

BatchGetBuilds

Command API Reference / Input / Output

BatchGetCommandExecutions

Command API Reference / Input / Output

BatchGetFleets

Command API Reference / Input / Output

BatchGetProjects

Command API Reference / Input / Output

BatchGetReportGroups

Command API Reference / Input / Output

BatchGetReports

Command API Reference / Input / Output

BatchGetSandboxes

Command API Reference / Input / Output

CreateFleet

Command API Reference / Input / Output

CreateProject

Command API Reference / Input / Output

CreateReportGroup

Command API Reference / Input / Output

CreateWebhook

Command API Reference / Input / Output

DeleteBuildBatch

Command API Reference / Input / Output

DeleteFleet

Command API Reference / Input / Output

DeleteProject

Command API Reference / Input / Output

DeleteReport

Command API Reference / Input / Output

DeleteReportGroup

Command API Reference / Input / Output

DeleteResourcePolicy

Command API Reference / Input / Output

DeleteSourceCredentials

Command API Reference / Input / Output

DeleteWebhook

Command API Reference / Input / Output

DescribeCodeCoverages

Command API Reference / Input / Output

DescribeTestCases

Command API Reference / Input / Output

GetReportGroupTrend

Command API Reference / Input / Output

GetResourcePolicy

Command API Reference / Input / Output

ImportSourceCredentials

Command API Reference / Input / Output

InvalidateProjectCache

Command API Reference / Input / Output

ListBuildBatches

Command API Reference / Input / Output

ListBuildBatchesForProject

Command API Reference / Input / Output

ListBuilds

Command API Reference / Input / Output

ListBuildsForProject

Command API Reference / Input / Output

ListCommandExecutionsForSandbox

Command API Reference / Input / Output

ListCuratedEnvironmentImages

Command API Reference / Input / Output

ListFleets

Command API Reference / Input / Output

ListProjects

Command API Reference / Input / Output

ListReportGroups

Command API Reference / Input / Output

ListReports

Command API Reference / Input / Output

ListReportsForReportGroup

Command API Reference / Input / Output

ListSandboxes

Command API Reference / Input / Output

ListSandboxesForProject

Command API Reference / Input / Output

ListSharedProjects

Command API Reference / Input / Output

ListSharedReportGroups

Command API Reference / Input / Output

ListSourceCredentials

Command API Reference / Input / Output

PutResourcePolicy

Command API Reference / Input / Output

RetryBuild

Command API Reference / Input / Output

RetryBuildBatch

Command API Reference / Input / Output

StartBuild

Command API Reference / Input / Output

StartBuildBatch

Command API Reference / Input / Output

StartCommandExecution

Command API Reference / Input / Output

StartSandbox

Command API Reference / Input / Output

StartSandboxConnection

Command API Reference / Input / Output

StopBuild

Command API Reference / Input / Output

StopBuildBatch

Command API Reference / Input / Output

StopSandbox

Command API Reference / Input / Output

UpdateFleet

Command API Reference / Input / Output

UpdateProject

Command API Reference / Input / Output

UpdateProjectVisibility

Command API Reference / Input / Output

UpdateReportGroup

Command API Reference / Input / Output

UpdateWebhook

Command API Reference / Input / Output