CodeBuild

import { CodeBuild } from "https://aws-api.deno.dev/v0.3/services/codebuild.ts?docs=full";

class CodeBuild {

constructor(apiFactory: client.ApiFactory);

async batchDeleteBuilds(params: BatchDeleteBuildsInput, opts?: client.RequestOptions): Promise<BatchDeleteBuildsOutput>;

async batchGetBuildBatches(params: BatchGetBuildBatchesInput, opts?: client.RequestOptions): Promise<BatchGetBuildBatchesOutput>;

async batchGetBuilds(params: BatchGetBuildsInput, opts?: client.RequestOptions): Promise<BatchGetBuildsOutput>;

async batchGetProjects(params: BatchGetProjectsInput, opts?: client.RequestOptions): Promise<BatchGetProjectsOutput>;

async batchGetReportGroups(params: BatchGetReportGroupsInput, opts?: client.RequestOptions): Promise<BatchGetReportGroupsOutput>;

async batchGetReports(params: BatchGetReportsInput, opts?: client.RequestOptions): Promise<BatchGetReportsOutput>;

async createProject(params: CreateProjectInput, opts?: client.RequestOptions): Promise<CreateProjectOutput>;

async createReportGroup(params: CreateReportGroupInput, opts?: client.RequestOptions): Promise<CreateReportGroupOutput>;

async createWebhook(params: CreateWebhookInput, opts?: client.RequestOptions): Promise<CreateWebhookOutput>;

async deleteBuildBatch(params: DeleteBuildBatchInput, opts?: client.RequestOptions): Promise<DeleteBuildBatchOutput>;

async deleteProject(params: DeleteProjectInput, opts?: client.RequestOptions): Promise<void>;

async deleteReport(params: DeleteReportInput, opts?: client.RequestOptions): Promise<void>;

async deleteReportGroup(params: DeleteReportGroupInput, opts?: client.RequestOptions): Promise<void>;

async deleteResourcePolicy(params: DeleteResourcePolicyInput, opts?: client.RequestOptions): Promise<void>;

async deleteSourceCredentials(params: DeleteSourceCredentialsInput, opts?: client.RequestOptions): Promise<DeleteSourceCredentialsOutput>;

async deleteWebhook(params: DeleteWebhookInput, opts?: client.RequestOptions): Promise<void>;

async describeCodeCoverages(params: DescribeCodeCoveragesInput, opts?: client.RequestOptions): Promise<DescribeCodeCoveragesOutput>;

async describeTestCases(params: DescribeTestCasesInput, opts?: client.RequestOptions): Promise<DescribeTestCasesOutput>;

async getReportGroupTrend(params: GetReportGroupTrendInput, opts?: client.RequestOptions): Promise<GetReportGroupTrendOutput>;

async getResourcePolicy(params: GetResourcePolicyInput, opts?: client.RequestOptions): Promise<GetResourcePolicyOutput>;

async importSourceCredentials(params: ImportSourceCredentialsInput, opts?: client.RequestOptions): Promise<ImportSourceCredentialsOutput>;

async invalidateProjectCache(params: InvalidateProjectCacheInput, opts?: client.RequestOptions): Promise<void>;

async listBuildBatches(params?: ListBuildBatchesInput, opts?: client.RequestOptions): Promise<ListBuildBatchesOutput>;

async listBuildBatchesForProject(params?: ListBuildBatchesForProjectInput, opts?: client.RequestOptions): Promise<ListBuildBatchesForProjectOutput>;

async listBuilds(params?: ListBuildsInput, opts?: client.RequestOptions): Promise<ListBuildsOutput>;

async listBuildsForProject(params: ListBuildsForProjectInput, opts?: client.RequestOptions): Promise<ListBuildsForProjectOutput>;

async listCuratedEnvironmentImages(opts?: client.RequestOptions): Promise<ListCuratedEnvironmentImagesOutput>;

async listProjects(params?: ListProjectsInput, opts?: client.RequestOptions): Promise<ListProjectsOutput>;

async listReportGroups(params?: ListReportGroupsInput, opts?: client.RequestOptions): Promise<ListReportGroupsOutput>;

async listReports(params?: ListReportsInput, opts?: client.RequestOptions): Promise<ListReportsOutput>;

async listReportsForReportGroup(params: ListReportsForReportGroupInput, opts?: client.RequestOptions): Promise<ListReportsForReportGroupOutput>;

async listSharedProjects(params?: ListSharedProjectsInput, opts?: client.RequestOptions): Promise<ListSharedProjectsOutput>;

async listSharedReportGroups(params?: ListSharedReportGroupsInput, opts?: client.RequestOptions): Promise<ListSharedReportGroupsOutput>;

async listSourceCredentials(opts?: client.RequestOptions): Promise<ListSourceCredentialsOutput>;

async putResourcePolicy(params: PutResourcePolicyInput, opts?: client.RequestOptions): Promise<PutResourcePolicyOutput>;

async retryBuild(params?: RetryBuildInput, opts?: client.RequestOptions): Promise<RetryBuildOutput>;

async retryBuildBatch(params?: RetryBuildBatchInput, opts?: client.RequestOptions): Promise<RetryBuildBatchOutput>;

async startBuild(params: StartBuildInput, opts?: client.RequestOptions): Promise<StartBuildOutput>;

async startBuildBatch(params: StartBuildBatchInput, opts?: client.RequestOptions): Promise<StartBuildBatchOutput>;

async stopBuild(params: StopBuildInput, opts?: client.RequestOptions): Promise<StopBuildOutput>;

async stopBuildBatch(params: StopBuildBatchInput, opts?: client.RequestOptions): Promise<StopBuildBatchOutput>;

async updateProject(params: UpdateProjectInput, opts?: client.RequestOptions): Promise<UpdateProjectOutput>;

async updateProjectVisibility(params: UpdateProjectVisibilityInput, opts?: client.RequestOptions): Promise<UpdateProjectVisibilityOutput>;

async updateReportGroup(params: UpdateReportGroupInput, opts?: client.RequestOptions): Promise<UpdateReportGroupOutput>;

async updateWebhook(params: UpdateWebhookInput, opts?: client.RequestOptions): Promise<UpdateWebhookOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new CodeBuild(apiFactory: client.ApiFactory)

[src]

§Methods

batchDeleteBuilds(params: BatchDeleteBuildsInput, opts?: client.RequestOptions): Promise<BatchDeleteBuildsOutput>

[src]

Deletes one or more builds.

batchGetBuildBatches(params: BatchGetBuildBatchesInput, opts?: client.RequestOptions): Promise<BatchGetBuildBatchesOutput>

[src]

Retrieves information about one or more batch builds.

batchGetBuilds(params: BatchGetBuildsInput, opts?: client.RequestOptions): Promise<BatchGetBuildsOutput>

[src]

Gets information about one or more builds.

batchGetProjects(params: BatchGetProjectsInput, opts?: client.RequestOptions): Promise<BatchGetProjectsOutput>

[src]

Gets information about one or more build projects.

batchGetReportGroups(params: BatchGetReportGroupsInput, opts?: client.RequestOptions): Promise<BatchGetReportGroupsOutput>

[src]

Returns an array of report groups.

batchGetReports(params: BatchGetReportsInput, opts?: client.RequestOptions): Promise<BatchGetReportsOutput>

[src]

Returns an array of reports.

createProject(params: CreateProjectInput, opts?: client.RequestOptions): Promise<CreateProjectOutput>

[src]

Creates a build project.

createReportGroup(params: CreateReportGroupInput, opts?: client.RequestOptions): Promise<CreateReportGroupOutput>

[src]

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

createWebhook(params: CreateWebhookInput, opts?: client.RequestOptions): Promise<CreateWebhookOutput>

[src]

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.

! IMPORTANT: ! 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: DeleteBuildBatchInput, opts?: client.RequestOptions): Promise<DeleteBuildBatchOutput>

[src]

Deletes a batch build.

deleteProject(params: DeleteProjectInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteReport(params: DeleteReportInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a report.

deleteReportGroup(params: DeleteReportGroupInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteResourcePolicy(params: DeleteResourcePolicyInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteSourceCredentials(params: DeleteSourceCredentialsInput, opts?: client.RequestOptions): Promise<DeleteSourceCredentialsOutput>

[src]

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

deleteWebhook(params: DeleteWebhookInput, opts?: client.RequestOptions): Promise<void>

[src]

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: DescribeCodeCoveragesInput, opts?: client.RequestOptions): Promise<DescribeCodeCoveragesOutput>

[src]

Retrieves one or more code coverage reports.

describeTestCases(params: DescribeTestCasesInput, opts?: client.RequestOptions): Promise<DescribeTestCasesOutput>

[src]

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

getReportGroupTrend(params: GetReportGroupTrendInput, opts?: client.RequestOptions): Promise<GetReportGroupTrendOutput>

[src]

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

getResourcePolicy(params: GetResourcePolicyInput, opts?: client.RequestOptions): Promise<GetResourcePolicyOutput>

[src]

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

importSourceCredentials(params: ImportSourceCredentialsInput, opts?: client.RequestOptions): Promise<ImportSourceCredentialsOutput>

[src]

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

invalidateProjectCache(params: InvalidateProjectCacheInput, opts?: client.RequestOptions): Promise<void>

[src]

Resets the cache for a project.

listBuildBatches(params?: ListBuildBatchesInput, opts?: client.RequestOptions): Promise<ListBuildBatchesOutput>

[src]

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

listBuildBatchesForProject(params?: ListBuildBatchesForProjectInput, opts?: client.RequestOptions): Promise<ListBuildBatchesForProjectOutput>

[src]

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

listBuilds(params?: ListBuildsInput, opts?: client.RequestOptions): Promise<ListBuildsOutput>

[src]

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

listBuildsForProject(params: ListBuildsForProjectInput, opts?: client.RequestOptions): Promise<ListBuildsForProjectOutput>

[src]

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

listCuratedEnvironmentImages(opts?: client.RequestOptions): Promise<ListCuratedEnvironmentImagesOutput>

[src]

Gets information about Docker images that are managed by CodeBuild.

listProjects(params?: ListProjectsInput, opts?: client.RequestOptions): Promise<ListProjectsOutput>

[src]

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

listReportGroups(params?: ListReportGroupsInput, opts?: client.RequestOptions): Promise<ListReportGroupsOutput>

[src]

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

listReports(params?: ListReportsInput, opts?: client.RequestOptions): Promise<ListReportsOutput>

[src]

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

listReportsForReportGroup(params: ListReportsForReportGroupInput, opts?: client.RequestOptions): Promise<ListReportsForReportGroupOutput>

[src]

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

listSharedProjects(params?: ListSharedProjectsInput, opts?: client.RequestOptions): Promise<ListSharedProjectsOutput>

[src]

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

listSharedReportGroups(params?: ListSharedReportGroupsInput, opts?: client.RequestOptions): Promise<ListSharedReportGroupsOutput>

[src]

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

listSourceCredentials(opts?: client.RequestOptions): Promise<ListSourceCredentialsOutput>

[src]

Returns a list of SourceCredentialsInfo objects.

putResourcePolicy(params: PutResourcePolicyInput, opts?: client.RequestOptions): Promise<PutResourcePolicyOutput>

[src]

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

retryBuild(params?: RetryBuildInput, opts?: client.RequestOptions): Promise<RetryBuildOutput>

[src]

Restarts a build.

retryBuildBatch(params?: RetryBuildBatchInput, opts?: client.RequestOptions): Promise<RetryBuildBatchOutput>

[src]

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

startBuild(params: StartBuildInput, opts?: client.RequestOptions): Promise<StartBuildOutput>

[src]

Starts running a build.

startBuildBatch(params: StartBuildBatchInput, opts?: client.RequestOptions): Promise<StartBuildBatchOutput>

[src]

Starts a batch build for a project.

stopBuild(params: StopBuildInput, opts?: client.RequestOptions): Promise<StopBuildOutput>

[src]

Attempts to stop running a build.

stopBuildBatch(params: StopBuildBatchInput, opts?: client.RequestOptions): Promise<StopBuildBatchOutput>

[src]

Stops a running batch build.

updateProject(params: UpdateProjectInput, opts?: client.RequestOptions): Promise<UpdateProjectOutput>

[src]

Changes the settings of a build project.

updateProjectVisibility(params: UpdateProjectVisibilityInput, opts?: client.RequestOptions): Promise<UpdateProjectVisibilityOutput>

[src]

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.

! IMPORTANT: ! 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, especially Amazon Web Services access key IDs and secret access keys, 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: UpdateReportGroupInput, opts?: client.RequestOptions): Promise<UpdateReportGroupOutput>

[src]

Updates a report group.

updateWebhook(params: UpdateWebhookInput, opts?: client.RequestOptions): Promise<UpdateWebhookOutput>

[src]

Updates the webhook associated with an CodeBuild build project.

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]