aws-sdk
Version:
AWS SDK for JavaScript
816 lines • 201 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CodeBuild extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodeBuild.Types.ClientConfiguration)
config: Config & CodeBuild.Types.ClientConfiguration;
/**
* Deletes one or more builds.
*/
batchDeleteBuilds(params: CodeBuild.Types.BatchDeleteBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>;
/**
* Deletes one or more builds.
*/
batchDeleteBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchDeleteBuildsOutput) => void): Request<CodeBuild.Types.BatchDeleteBuildsOutput, AWSError>;
/**
* Retrieves information about one or more batch builds.
*/
batchGetBuildBatches(params: CodeBuild.Types.BatchGetBuildBatchesInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildBatchesOutput) => void): Request<CodeBuild.Types.BatchGetBuildBatchesOutput, AWSError>;
/**
* Retrieves information about one or more batch builds.
*/
batchGetBuildBatches(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildBatchesOutput) => void): Request<CodeBuild.Types.BatchGetBuildBatchesOutput, AWSError>;
/**
* Gets information about one or more builds.
*/
batchGetBuilds(params: CodeBuild.Types.BatchGetBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
/**
* Gets information about one or more builds.
*/
batchGetBuilds(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetBuildsOutput) => void): Request<CodeBuild.Types.BatchGetBuildsOutput, AWSError>;
/**
* Gets information about one or more compute fleets.
*/
batchGetFleets(params: CodeBuild.Types.BatchGetFleetsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetFleetsOutput) => void): Request<CodeBuild.Types.BatchGetFleetsOutput, AWSError>;
/**
* Gets information about one or more compute fleets.
*/
batchGetFleets(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetFleetsOutput) => void): Request<CodeBuild.Types.BatchGetFleetsOutput, AWSError>;
/**
* Gets information about one or more build projects.
*/
batchGetProjects(params: CodeBuild.Types.BatchGetProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
/**
* Gets information about one or more build projects.
*/
batchGetProjects(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetProjectsOutput) => void): Request<CodeBuild.Types.BatchGetProjectsOutput, AWSError>;
/**
* Returns an array of report groups.
*/
batchGetReportGroups(params: CodeBuild.Types.BatchGetReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>;
/**
* Returns an array of report groups.
*/
batchGetReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportGroupsOutput) => void): Request<CodeBuild.Types.BatchGetReportGroupsOutput, AWSError>;
/**
* Returns an array of reports.
*/
batchGetReports(params: CodeBuild.Types.BatchGetReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>;
/**
* Returns an array of reports.
*/
batchGetReports(callback?: (err: AWSError, data: CodeBuild.Types.BatchGetReportsOutput) => void): Request<CodeBuild.Types.BatchGetReportsOutput, AWSError>;
/**
* Creates a compute fleet.
*/
createFleet(params: CodeBuild.Types.CreateFleetInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateFleetOutput) => void): Request<CodeBuild.Types.CreateFleetOutput, AWSError>;
/**
* Creates a compute fleet.
*/
createFleet(callback?: (err: AWSError, data: CodeBuild.Types.CreateFleetOutput) => void): Request<CodeBuild.Types.CreateFleetOutput, AWSError>;
/**
* Creates a build project.
*/
createProject(params: CodeBuild.Types.CreateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
/**
* Creates a build project.
*/
createProject(callback?: (err: AWSError, data: CodeBuild.Types.CreateProjectOutput) => void): Request<CodeBuild.Types.CreateProjectOutput, AWSError>;
/**
* Creates a report group. A report group contains a collection of reports.
*/
createReportGroup(params: CodeBuild.Types.CreateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>;
/**
* Creates a report group. A report group contains a collection of reports.
*/
createReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.CreateReportGroupOutput) => void): Request<CodeBuild.Types.CreateReportGroupOutput, AWSError>;
/**
* 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.
*/
createWebhook(params: CodeBuild.Types.CreateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
/**
* 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.
*/
createWebhook(callback?: (err: AWSError, data: CodeBuild.Types.CreateWebhookOutput) => void): Request<CodeBuild.Types.CreateWebhookOutput, AWSError>;
/**
* Deletes a batch build.
*/
deleteBuildBatch(params: CodeBuild.Types.DeleteBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteBuildBatchOutput) => void): Request<CodeBuild.Types.DeleteBuildBatchOutput, AWSError>;
/**
* Deletes a batch build.
*/
deleteBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.DeleteBuildBatchOutput) => void): Request<CodeBuild.Types.DeleteBuildBatchOutput, AWSError>;
/**
* Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
*/
deleteFleet(params: CodeBuild.Types.DeleteFleetInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteFleetOutput) => void): Request<CodeBuild.Types.DeleteFleetOutput, AWSError>;
/**
* Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
*/
deleteFleet(callback?: (err: AWSError, data: CodeBuild.Types.DeleteFleetOutput) => void): Request<CodeBuild.Types.DeleteFleetOutput, AWSError>;
/**
* Deletes a build project. When you delete a project, its builds are not deleted.
*/
deleteProject(params: CodeBuild.Types.DeleteProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
/**
* Deletes a build project. When you delete a project, its builds are not deleted.
*/
deleteProject(callback?: (err: AWSError, data: CodeBuild.Types.DeleteProjectOutput) => void): Request<CodeBuild.Types.DeleteProjectOutput, AWSError>;
/**
* Deletes a report.
*/
deleteReport(params: CodeBuild.Types.DeleteReportInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>;
/**
* Deletes a report.
*/
deleteReport(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportOutput) => void): Request<CodeBuild.Types.DeleteReportOutput, AWSError>;
/**
* Deletes a report group. Before you delete a report group, you must delete its reports.
*/
deleteReportGroup(params: CodeBuild.Types.DeleteReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>;
/**
* Deletes a report group. Before you delete a report group, you must delete its reports.
*/
deleteReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.DeleteReportGroupOutput) => void): Request<CodeBuild.Types.DeleteReportGroupOutput, AWSError>;
/**
* Deletes a resource policy that is identified by its resource ARN.
*/
deleteResourcePolicy(params: CodeBuild.Types.DeleteResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>;
/**
* Deletes a resource policy that is identified by its resource ARN.
*/
deleteResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.DeleteResourcePolicyOutput) => void): Request<CodeBuild.Types.DeleteResourcePolicyOutput, AWSError>;
/**
* Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
*/
deleteSourceCredentials(params: CodeBuild.Types.DeleteSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
/**
* Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
*/
deleteSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.DeleteSourceCredentialsOutput) => void): Request<CodeBuild.Types.DeleteSourceCredentialsOutput, AWSError>;
/**
* 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.
*/
deleteWebhook(params: CodeBuild.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
/**
* 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.
*/
deleteWebhook(callback?: (err: AWSError, data: CodeBuild.Types.DeleteWebhookOutput) => void): Request<CodeBuild.Types.DeleteWebhookOutput, AWSError>;
/**
* Retrieves one or more code coverage reports.
*/
describeCodeCoverages(params: CodeBuild.Types.DescribeCodeCoveragesInput, callback?: (err: AWSError, data: CodeBuild.Types.DescribeCodeCoveragesOutput) => void): Request<CodeBuild.Types.DescribeCodeCoveragesOutput, AWSError>;
/**
* Retrieves one or more code coverage reports.
*/
describeCodeCoverages(callback?: (err: AWSError, data: CodeBuild.Types.DescribeCodeCoveragesOutput) => void): Request<CodeBuild.Types.DescribeCodeCoveragesOutput, AWSError>;
/**
* Returns a list of details about test cases for a report.
*/
describeTestCases(params: CodeBuild.Types.DescribeTestCasesInput, callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>;
/**
* Returns a list of details about test cases for a report.
*/
describeTestCases(callback?: (err: AWSError, data: CodeBuild.Types.DescribeTestCasesOutput) => void): Request<CodeBuild.Types.DescribeTestCasesOutput, AWSError>;
/**
* Analyzes and accumulates test report values for the specified test reports.
*/
getReportGroupTrend(params: CodeBuild.Types.GetReportGroupTrendInput, callback?: (err: AWSError, data: CodeBuild.Types.GetReportGroupTrendOutput) => void): Request<CodeBuild.Types.GetReportGroupTrendOutput, AWSError>;
/**
* Analyzes and accumulates test report values for the specified test reports.
*/
getReportGroupTrend(callback?: (err: AWSError, data: CodeBuild.Types.GetReportGroupTrendOutput) => void): Request<CodeBuild.Types.GetReportGroupTrendOutput, AWSError>;
/**
* Gets a resource policy that is identified by its resource ARN.
*/
getResourcePolicy(params: CodeBuild.Types.GetResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>;
/**
* Gets a resource policy that is identified by its resource ARN.
*/
getResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.GetResourcePolicyOutput) => void): Request<CodeBuild.Types.GetResourcePolicyOutput, AWSError>;
/**
* 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.
*/
importSourceCredentials(params: CodeBuild.Types.ImportSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
/**
* 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.
*/
importSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ImportSourceCredentialsOutput) => void): Request<CodeBuild.Types.ImportSourceCredentialsOutput, AWSError>;
/**
* Resets the cache for a project.
*/
invalidateProjectCache(params: CodeBuild.Types.InvalidateProjectCacheInput, callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
/**
* Resets the cache for a project.
*/
invalidateProjectCache(callback?: (err: AWSError, data: CodeBuild.Types.InvalidateProjectCacheOutput) => void): Request<CodeBuild.Types.InvalidateProjectCacheOutput, AWSError>;
/**
* Retrieves the identifiers of your build batches in the current region.
*/
listBuildBatches(params: CodeBuild.Types.ListBuildBatchesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesOutput) => void): Request<CodeBuild.Types.ListBuildBatchesOutput, AWSError>;
/**
* Retrieves the identifiers of your build batches in the current region.
*/
listBuildBatches(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesOutput) => void): Request<CodeBuild.Types.ListBuildBatchesOutput, AWSError>;
/**
* Retrieves the identifiers of the build batches for a specific project.
*/
listBuildBatchesForProject(params: CodeBuild.Types.ListBuildBatchesForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesForProjectOutput) => void): Request<CodeBuild.Types.ListBuildBatchesForProjectOutput, AWSError>;
/**
* Retrieves the identifiers of the build batches for a specific project.
*/
listBuildBatchesForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildBatchesForProjectOutput) => void): Request<CodeBuild.Types.ListBuildBatchesForProjectOutput, AWSError>;
/**
* Gets a list of build IDs, with each build ID representing a single build.
*/
listBuilds(params: CodeBuild.Types.ListBuildsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
/**
* Gets a list of build IDs, with each build ID representing a single build.
*/
listBuilds(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsOutput) => void): Request<CodeBuild.Types.ListBuildsOutput, AWSError>;
/**
* Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
*/
listBuildsForProject(params: CodeBuild.Types.ListBuildsForProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
/**
* Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
*/
listBuildsForProject(callback?: (err: AWSError, data: CodeBuild.Types.ListBuildsForProjectOutput) => void): Request<CodeBuild.Types.ListBuildsForProjectOutput, AWSError>;
/**
* Gets information about Docker images that are managed by CodeBuild.
*/
listCuratedEnvironmentImages(params: CodeBuild.Types.ListCuratedEnvironmentImagesInput, callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
/**
* Gets information about Docker images that are managed by CodeBuild.
*/
listCuratedEnvironmentImages(callback?: (err: AWSError, data: CodeBuild.Types.ListCuratedEnvironmentImagesOutput) => void): Request<CodeBuild.Types.ListCuratedEnvironmentImagesOutput, AWSError>;
/**
* Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
*/
listFleets(params: CodeBuild.Types.ListFleetsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListFleetsOutput) => void): Request<CodeBuild.Types.ListFleetsOutput, AWSError>;
/**
* Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
*/
listFleets(callback?: (err: AWSError, data: CodeBuild.Types.ListFleetsOutput) => void): Request<CodeBuild.Types.ListFleetsOutput, AWSError>;
/**
* Gets a list of build project names, with each build project name representing a single build project.
*/
listProjects(params: CodeBuild.Types.ListProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
/**
* Gets a list of build project names, with each build project name representing a single build project.
*/
listProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListProjectsOutput) => void): Request<CodeBuild.Types.ListProjectsOutput, AWSError>;
/**
* Gets a list ARNs for the report groups in the current Amazon Web Services account.
*/
listReportGroups(params: CodeBuild.Types.ListReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
/**
* Gets a list ARNs for the report groups in the current Amazon Web Services account.
*/
listReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListReportGroupsOutput) => void): Request<CodeBuild.Types.ListReportGroupsOutput, AWSError>;
/**
* Returns a list of ARNs for the reports in the current Amazon Web Services account.
*/
listReports(params: CodeBuild.Types.ListReportsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
/**
* Returns a list of ARNs for the reports in the current Amazon Web Services account.
*/
listReports(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsOutput) => void): Request<CodeBuild.Types.ListReportsOutput, AWSError>;
/**
* Returns a list of ARNs for the reports that belong to a ReportGroup.
*/
listReportsForReportGroup(params: CodeBuild.Types.ListReportsForReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>;
/**
* Returns a list of ARNs for the reports that belong to a ReportGroup.
*/
listReportsForReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.ListReportsForReportGroupOutput) => void): Request<CodeBuild.Types.ListReportsForReportGroupOutput, AWSError>;
/**
* Gets a list of projects that are shared with other Amazon Web Services accounts or users.
*/
listSharedProjects(params: CodeBuild.Types.ListSharedProjectsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
/**
* Gets a list of projects that are shared with other Amazon Web Services accounts or users.
*/
listSharedProjects(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedProjectsOutput) => void): Request<CodeBuild.Types.ListSharedProjectsOutput, AWSError>;
/**
* Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
*/
listSharedReportGroups(params: CodeBuild.Types.ListSharedReportGroupsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
/**
* Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
*/
listSharedReportGroups(callback?: (err: AWSError, data: CodeBuild.Types.ListSharedReportGroupsOutput) => void): Request<CodeBuild.Types.ListSharedReportGroupsOutput, AWSError>;
/**
* Returns a list of SourceCredentialsInfo objects.
*/
listSourceCredentials(params: CodeBuild.Types.ListSourceCredentialsInput, callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
/**
* Returns a list of SourceCredentialsInfo objects.
*/
listSourceCredentials(callback?: (err: AWSError, data: CodeBuild.Types.ListSourceCredentialsOutput) => void): Request<CodeBuild.Types.ListSourceCredentialsOutput, AWSError>;
/**
* Stores a resource policy for the ARN of a Project or ReportGroup object.
*/
putResourcePolicy(params: CodeBuild.Types.PutResourcePolicyInput, callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>;
/**
* Stores a resource policy for the ARN of a Project or ReportGroup object.
*/
putResourcePolicy(callback?: (err: AWSError, data: CodeBuild.Types.PutResourcePolicyOutput) => void): Request<CodeBuild.Types.PutResourcePolicyOutput, AWSError>;
/**
* Restarts a build.
*/
retryBuild(params: CodeBuild.Types.RetryBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildOutput) => void): Request<CodeBuild.Types.RetryBuildOutput, AWSError>;
/**
* Restarts a build.
*/
retryBuild(callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildOutput) => void): Request<CodeBuild.Types.RetryBuildOutput, AWSError>;
/**
* Restarts a failed batch build. Only batch builds that have failed can be retried.
*/
retryBuildBatch(params: CodeBuild.Types.RetryBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildBatchOutput) => void): Request<CodeBuild.Types.RetryBuildBatchOutput, AWSError>;
/**
* Restarts a failed batch build. Only batch builds that have failed can be retried.
*/
retryBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.RetryBuildBatchOutput) => void): Request<CodeBuild.Types.RetryBuildBatchOutput, AWSError>;
/**
* 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.
*/
startBuild(params: CodeBuild.Types.StartBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
/**
* 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.
*/
startBuild(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildOutput) => void): Request<CodeBuild.Types.StartBuildOutput, AWSError>;
/**
* Starts a batch build for a project.
*/
startBuildBatch(params: CodeBuild.Types.StartBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.StartBuildBatchOutput) => void): Request<CodeBuild.Types.StartBuildBatchOutput, AWSError>;
/**
* Starts a batch build for a project.
*/
startBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.StartBuildBatchOutput) => void): Request<CodeBuild.Types.StartBuildBatchOutput, AWSError>;
/**
* Attempts to stop running a build.
*/
stopBuild(params: CodeBuild.Types.StopBuildInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
/**
* Attempts to stop running a build.
*/
stopBuild(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildOutput) => void): Request<CodeBuild.Types.StopBuildOutput, AWSError>;
/**
* Stops a running batch build.
*/
stopBuildBatch(params: CodeBuild.Types.StopBuildBatchInput, callback?: (err: AWSError, data: CodeBuild.Types.StopBuildBatchOutput) => void): Request<CodeBuild.Types.StopBuildBatchOutput, AWSError>;
/**
* Stops a running batch build.
*/
stopBuildBatch(callback?: (err: AWSError, data: CodeBuild.Types.StopBuildBatchOutput) => void): Request<CodeBuild.Types.StopBuildBatchOutput, AWSError>;
/**
* Updates a compute fleet.
*/
updateFleet(params: CodeBuild.Types.UpdateFleetInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateFleetOutput) => void): Request<CodeBuild.Types.UpdateFleetOutput, AWSError>;
/**
* Updates a compute fleet.
*/
updateFleet(callback?: (err: AWSError, data: CodeBuild.Types.UpdateFleetOutput) => void): Request<CodeBuild.Types.UpdateFleetOutput, AWSError>;
/**
* Changes the settings of a build project.
*/
updateProject(params: CodeBuild.Types.UpdateProjectInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
/**
* Changes the settings of a build project.
*/
updateProject(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectOutput) => void): Request<CodeBuild.Types.UpdateProjectOutput, AWSError>;
/**
* 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.
*/
updateProjectVisibility(params: CodeBuild.Types.UpdateProjectVisibilityInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>;
/**
* 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.
*/
updateProjectVisibility(callback?: (err: AWSError, data: CodeBuild.Types.UpdateProjectVisibilityOutput) => void): Request<CodeBuild.Types.UpdateProjectVisibilityOutput, AWSError>;
/**
* Updates a report group.
*/
updateReportGroup(params: CodeBuild.Types.UpdateReportGroupInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>;
/**
* Updates a report group.
*/
updateReportGroup(callback?: (err: AWSError, data: CodeBuild.Types.UpdateReportGroupOutput) => void): Request<CodeBuild.Types.UpdateReportGroupOutput, AWSError>;
/**
* Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
*/
updateWebhook(params: CodeBuild.Types.UpdateWebhookInput, callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
/**
* Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.
*/
updateWebhook(callback?: (err: AWSError, data: CodeBuild.Types.UpdateWebhookOutput) => void): Request<CodeBuild.Types.UpdateWebhookOutput, AWSError>;
}
declare namespace CodeBuild {
export type ArtifactNamespace = "NONE"|"BUILD_ID"|string;
export type ArtifactPackaging = "NONE"|"ZIP"|string;
export type ArtifactsType = "CODEPIPELINE"|"S3"|"NO_ARTIFACTS"|string;
export type AuthType = "OAUTH"|"BASIC_AUTH"|"PERSONAL_ACCESS_TOKEN"|"CODECONNECTIONS"|"SECRETS_MANAGER"|string;
export interface BatchDeleteBuildsInput {
/**
* The IDs of the builds to delete.
*/
ids: BuildIds;
}
export interface BatchDeleteBuildsOutput {
/**
* The IDs of the builds that were successfully deleted.
*/
buildsDeleted?: BuildIds;
/**
* Information about any builds that could not be successfully deleted.
*/
buildsNotDeleted?: BuildsNotDeleted;
}
export interface BatchGetBuildBatchesInput {
/**
* An array that contains the batch build identifiers to retrieve.
*/
ids: BuildBatchIds;
}
export interface BatchGetBuildBatchesOutput {
/**
* An array of BuildBatch objects that represent the retrieved batch builds.
*/
buildBatches?: BuildBatches;
/**
* An array that contains the identifiers of any batch builds that are not found.
*/
buildBatchesNotFound?: BuildBatchIds;
}
export interface BatchGetBuildsInput {
/**
* The IDs of the builds.
*/
ids: BuildIds;
}
export interface BatchGetBuildsOutput {
/**
* Information about the requested builds.
*/
builds?: Builds;
/**
* The IDs of builds for which information could not be found.
*/
buildsNotFound?: BuildIds;
}
export interface BatchGetFleetsInput {
/**
* The names or ARNs of the compute fleets.
*/
names: FleetNames;
}
export interface BatchGetFleetsOutput {
/**
* Information about the requested compute fleets.
*/
fleets?: Fleets;
/**
* The names of compute fleets for which information could not be found.
*/
fleetsNotFound?: FleetNames;
}
export interface BatchGetProjectsInput {
/**
* The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
*/
names: ProjectNames;
}
export interface BatchGetProjectsOutput {
/**
* Information about the requested build projects.
*/
projects?: Projects;
/**
* The names of build projects for which information could not be found.
*/
projectsNotFound?: ProjectNames;
}
export interface BatchGetReportGroupsInput {
/**
* An array of report group ARNs that identify the report groups to return.
*/
reportGroupArns: ReportGroupArns;
}
export interface BatchGetReportGroupsOutput {
/**
* The array of report groups returned by BatchGetReportGroups.
*/
reportGroups?: ReportGroups;
/**
* An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.
*/
reportGroupsNotFound?: ReportGroupArns;
}
export interface BatchGetReportsInput {
/**
* An array of ARNs that identify the Report objects to return.
*/
reportArns: ReportArns;
}
export interface BatchGetReportsOutput {
/**
* The array of Report objects returned by BatchGetReports.
*/
reports?: Reports;
/**
* An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
*/
reportsNotFound?: ReportArns;
}
export type BatchReportModeType = "REPORT_INDIVIDUAL_BUILDS"|"REPORT_AGGREGATED_BATCH"|string;
export interface BatchRestrictions {
/**
* Specifies the maximum number of builds allowed.
*/
maximumBuildsAllowed?: WrapperInt;
/**
* An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.
*/
computeTypesAllowed?: ComputeTypesAllowed;
}
export type Boolean = boolean;
export type BucketOwnerAccess = "NONE"|"READ_ONLY"|"FULL"|string;
export interface Build {
/**
* The unique ID for the build.
*/
id?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the build.
*/
arn?: NonEmptyString;
/**
* The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.
*/
buildNumber?: WrapperLong;
/**
* When the build process started, expressed in Unix time format.
*/
startTime?: Timestamp;
/**
* When the build process ended, expressed in Unix time format.
*/
endTime?: Timestamp;
/**
* The current build phase.
*/
currentPhase?: String;
/**
* The current status of the build. Valid values include: FAILED: The build failed. FAULT: The build faulted. IN_PROGRESS: The build is still in progress. STOPPED: The build stopped. SUCCEEDED: The build succeeded. TIMED_OUT: The build timed out.
*/
buildStatus?: StatusType;
/**
* Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
*/
sourceVersion?: NonEmptyString;
/**
* An identifier for the version of this build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply.
*/
resolvedSourceVersion?: NonEmptyString;
/**
* The name of the CodeBuild project.
*/
projectName?: NonEmptyString;
/**
* Information about all previous build phases that are complete and information about any current build phase that is not yet complete.
*/
phases?: BuildPhases;
/**
* Information about the source code to be built.
*/
source?: ProjectSource;
/**
* An array of ProjectSource objects.
*/
secondarySources?: ProjectSources;
/**
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
*/
secondarySourceVersions?: ProjectSecondarySourceVersions;
/**
* Information about the output artifacts for the build.
*/
artifacts?: BuildArtifacts;
/**
* An array of ProjectArtifacts objects.
*/
secondaryArtifacts?: BuildArtifactsList;
/**
* Information about the cache for the build.
*/
cache?: ProjectCache;
/**
* Information about the build environment for this build.
*/
environment?: ProjectEnvironment;
/**
* The name of a service role used for this build.
*/
serviceRole?: NonEmptyString;
/**
* Information about the build's logs in CloudWatch Logs.
*/
logs?: LogsLocation;
/**
* How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out this build if it does not get marked as completed.
*/
timeoutInMinutes?: WrapperInt;
/**
* The number of minutes a build is allowed to be queued before it times out.
*/
queuedTimeoutInMinutes?: WrapperInt;
/**
* Whether the build is complete. True if complete; otherwise, false.
*/
buildComplete?: Boolean;
/**
* The entity that started the build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If a user started the build, the user's name (for example, MyUserName). If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
*/
initiator?: String;
/**
* If your CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
*/
vpcConfig?: VpcConfig;
/**
* Describes a network interface.
*/
networkInterface?: NetworkInterface;
/**
* The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
*/
encryptionKey?: NonEmptyString;
/**
* A list of exported environment variables for this build. Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
*/
exportedEnvironmentVariables?: ExportedEnvironmentVariables;
/**
* An array of the ARNs associated with this build's reports.
*/
reportArns?: BuildReportArns;
/**
* An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
*/
fileSystemLocations?: ProjectFileSystemLocations;
/**
* Contains information about the debug session for this build.
*/
debugSession?: DebugSession;
/**
* The ARN of the batch build that this build is a member of, if applicable.
*/
buildBatchArn?: String;
}
export interface BuildArtifacts {
/**
* Information about the location of the build artifacts.
*/
location?: String;
/**
* The SHA-256 hash of the build artifact. You can use this hash along with a checksum tool to confirm file integrity and authenticity. This value is available only if the build project's packaging value is set to ZIP.
*/
sha256sum?: String;
/**
* The MD5 hash of the build artifact. You can use this hash along with a checksum tool to confirm file integrity and authenticity. This value is available only if the build project's packaging value is set to ZIP.
*/
md5sum?: String;
/**
* If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.
*/
overrideArtifactName?: WrapperBoolean;
/**
* Information that tells you if encryption for build artifacts is disabled.
*/
encryptionDisabled?: WrapperBoolean;
/**
* An identifier for this artifact definition.
*/
artifactIdentifier?: String;
bucketOwnerAccess?: BucketOwnerAccess;
}
export type BuildArtifactsList = BuildArtifacts[];
export interface BuildBatch {
/**
* The identifier of the batch build.
*/
id?: NonEmptyString;
/**
* The ARN of the batch build.
*/
arn?: NonEmptyString;
/**
* The date and time that the batch build started.
*/
startTime?: Timestamp;
/**
* The date and time that the batch build ended.
*/
endTime?: Timestamp;
/**
* The current phase of the batch build.
*/
currentPhase?: String;
/**
* The status of the batch build.
*/
buildBatchStatus?: StatusType;
/**
* The identifier of the version of the source code to be built.
*/
sourceVersion?: NonEmptyString;
/**
* The identifier of the resolved version of this batch build's source code. For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID. For CodePipeline, the source revision provided by CodePipeline. For Amazon S3, this does not apply.
*/
resolvedSourceVersion?: NonEmptyString;
/**
* The name of the batch build project.
*/
projectName?: NonEmptyString;
/**
* An array of BuildBatchPhase objects the specify the phases of the batch build.
*/
phases?: BuildBatchPhases;
source?: ProjectSource;
/**
* An array of ProjectSource objects that define the sources for the batch build.
*/
secondarySources?: ProjectSources;
/**
* An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
*/
secondarySourceVersions?: ProjectSecondarySourceVersions;
/**
* A BuildArtifacts object the defines the build artifacts for this batch build.
*/
artifacts?: BuildArtifacts;
/**
* An array of BuildArtifacts objects the define the build artifacts for this batch build.
*/
secondaryArtifacts?: BuildArtifactsList;
cache?: ProjectCache;
environment?: ProjectEnvironment;
/**
* The name of a service role used for builds in the batch.
*/
serviceRole?: NonEmptyString;
logConfig?: LogsConfig;
/**
* Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.
*/
buildTimeoutInMinutes?: WrapperInt;
/**
* Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.
*/
queuedTimeoutInMinutes?: WrapperInt;
/**
* Indicates if the batch build is complete.
*/
complete?: Boolean;
/**
* The entity that started the batch build. Valid values include: If CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline). If a user started the build, the user's name. If the Jenkins plugin for CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
*/
initiator?: String;
vpcConfig?: VpcConfig;
/**
* The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).
*/
encryptionKey?: NonEmptyString;
/**
* The number of the batch build. For each project, the buildBatchNumber of its first batch build is 1. The buildBatchNumber of each subsequent batch build is incremented by 1. If a batch build is deleted, the buildBatchNumber of other batch builds does not change.
*/
buildBatchNumber?: WrapperLong;
/**
* An array of ProjectFileSystemLocation objects for the batch build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
*/
fileSystemLocations?: ProjectFileSystemLocations;
buildBatchConfig?: ProjectBuildBatchConfig;
/**
* An array of BuildGroup objects that define the build groups for the batch build.
*/
buildGroups?: BuildGroups;
/**
* Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
*/
debugSessionEnabled?: WrapperBoolean;
}
export interface BuildBatchFilter {
/**
* The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.
*/
status?: StatusType;
}
export type BuildBatchIds = NonEmptyString[];
export interface BuildBatchPhase {
/**
* The name of the batch build phase. Valid values include: COMBINE_ARTIFACTS Build output artifacts are being combined and uploaded to the output locatio