CodeBuildClient

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.

Properties

Link copied to clipboard
abstract override val config: CodeBuildClient.Config

CodeBuildClient's configuration

Functions

Link copied to clipboard

Deletes one or more builds.

Link copied to clipboard

Retrieves information about one or more batch builds.

Link copied to clipboard

Gets information about one or more builds.

Link copied to clipboard

Gets information about the command executions.

Link copied to clipboard

Gets information about one or more compute fleets.

Link copied to clipboard

Gets information about one or more build projects.

Link copied to clipboard

Returns an array of report groups.

Link copied to clipboard

Returns an array of reports.

Link copied to clipboard

Gets information about the sandbox status.

Link copied to clipboard
abstract suspend fun createFleet(input: CreateFleetRequest): CreateFleetResponse

Creates a compute fleet.

Link copied to clipboard

Creates a build project.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Deletes a batch build.

Link copied to clipboard
abstract suspend fun deleteFleet(input: DeleteFleetRequest): DeleteFleetResponse

Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

Link copied to clipboard

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

Link copied to clipboard

Deletes a report.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Retrieves one or more code coverage reports.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Resets the cache for a project.

Link copied to clipboard
abstract suspend fun listBuildBatches(input: ListBuildBatchesRequest = ListBuildBatchesRequest { }): ListBuildBatchesResponse

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

Link copied to clipboard
abstract suspend fun listBuildBatchesForProject(input: ListBuildBatchesForProjectRequest = ListBuildBatchesForProjectRequest { }): ListBuildBatchesForProjectResponse

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

Link copied to clipboard
abstract suspend fun listBuilds(input: ListBuildsRequest = ListBuildsRequest { }): ListBuildsResponse

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

Link copied to clipboard

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

Link copied to clipboard

Gets a list of command executions for a sandbox.

Link copied to clipboard
abstract suspend fun listCuratedEnvironmentImages(input: ListCuratedEnvironmentImagesRequest = ListCuratedEnvironmentImagesRequest { }): ListCuratedEnvironmentImagesResponse

Gets information about Docker images that are managed by CodeBuild.

Link copied to clipboard
abstract suspend fun listFleets(input: ListFleetsRequest = ListFleetsRequest { }): ListFleetsResponse

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

Link copied to clipboard
abstract suspend fun listProjects(input: ListProjectsRequest = ListProjectsRequest { }): ListProjectsResponse

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

Link copied to clipboard
abstract suspend fun listReportGroups(input: ListReportGroupsRequest = ListReportGroupsRequest { }): ListReportGroupsResponse

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

Link copied to clipboard
abstract suspend fun listReports(input: ListReportsRequest = ListReportsRequest { }): ListReportsResponse

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listSandboxes(input: ListSandboxesRequest = ListSandboxesRequest { }): ListSandboxesResponse

Gets a list of sandboxes.

Link copied to clipboard

Gets a list of sandboxes for a given project.

Link copied to clipboard
abstract suspend fun listSharedProjects(input: ListSharedProjectsRequest = ListSharedProjectsRequest { }): ListSharedProjectsResponse

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

Link copied to clipboard
abstract suspend fun listSharedReportGroups(input: ListSharedReportGroupsRequest = ListSharedReportGroupsRequest { }): ListSharedReportGroupsResponse

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

Link copied to clipboard
abstract suspend fun listSourceCredentials(input: ListSourceCredentialsRequest = ListSourceCredentialsRequest { }): ListSourceCredentialsResponse

Returns a list of SourceCredentialsInfo objects.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun retryBuild(input: RetryBuildRequest = RetryBuildRequest { }): RetryBuildResponse

Restarts a build.

Link copied to clipboard
abstract suspend fun retryBuildBatch(input: RetryBuildBatchRequest = RetryBuildBatchRequest { }): RetryBuildBatchResponse

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

Link copied to clipboard
abstract suspend fun startBuild(input: StartBuildRequest): StartBuildResponse

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.

Link copied to clipboard

Starts a batch build for a project.

Link copied to clipboard

Starts a command execution.

Link copied to clipboard
abstract suspend fun startSandbox(input: StartSandboxRequest = StartSandboxRequest { }): StartSandboxResponse

Starts a sandbox.

Link copied to clipboard

Starts a sandbox connection.

Link copied to clipboard
abstract suspend fun stopBuild(input: StopBuildRequest): StopBuildResponse

Attempts to stop running a build.

Link copied to clipboard

Stops a running batch build.

Link copied to clipboard
abstract suspend fun stopSandbox(input: StopSandboxRequest): StopSandboxResponse

Stops a sandbox.

Link copied to clipboard
abstract suspend fun updateFleet(input: UpdateFleetRequest): UpdateFleetResponse

Updates a compute fleet.

Link copied to clipboard

Changes the settings of a build project.

Link copied to clipboard

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.

Link copied to clipboard

Updates a report group.

Link copied to clipboard

Updates the webhook associated with an CodeBuild build project.

Inherited functions

Link copied to clipboard

Deletes one or more builds.

Link copied to clipboard

Retrieves information about one or more batch builds.

Link copied to clipboard

Gets information about one or more builds.

Link copied to clipboard

Gets information about the command executions.

Link copied to clipboard

Gets information about one or more compute fleets.

Link copied to clipboard

Gets information about one or more build projects.

Link copied to clipboard

Returns an array of report groups.

Link copied to clipboard

Returns an array of reports.

Link copied to clipboard

Gets information about the sandbox status.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun CodeBuildClient.createFleet(crossinline block: CreateFleetRequest.Builder.() -> Unit): CreateFleetResponse

Creates a compute fleet.

Link copied to clipboard

Creates a build project.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Deletes a batch build.

Link copied to clipboard
inline suspend fun CodeBuildClient.deleteFleet(crossinline block: DeleteFleetRequest.Builder.() -> Unit): DeleteFleetResponse

Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

Link copied to clipboard

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

Link copied to clipboard

Deletes a report.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Retrieves one or more code coverage reports.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Resets the cache for a project.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun CodeBuildClient.listBuilds(crossinline block: ListBuildsRequest.Builder.() -> Unit): ListBuildsResponse

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Gets a list of command executions for a sandbox.

Link copied to clipboard

Gets information about Docker images that are managed by CodeBuild.

Link copied to clipboard
inline suspend fun CodeBuildClient.listFleets(crossinline block: ListFleetsRequest.Builder.() -> Unit): ListFleetsResponse

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
inline suspend fun CodeBuildClient.listReports(crossinline block: ListReportsRequest.Builder.() -> Unit): ListReportsResponse

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Gets a list of sandboxes.

Link copied to clipboard

Gets a list of sandboxes for a given project.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Returns a list of SourceCredentialsInfo objects.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun CodeBuildClient.retryBuild(crossinline block: RetryBuildRequest.Builder.() -> Unit): RetryBuildResponse

Restarts a build.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun CodeBuildClient.startBuild(crossinline block: StartBuildRequest.Builder.() -> Unit): StartBuildResponse

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.

Link copied to clipboard

Starts a batch build for a project.

Link copied to clipboard

Starts a command execution.

Link copied to clipboard

Starts a sandbox.

Link copied to clipboard

Starts a sandbox connection.

Link copied to clipboard
inline suspend fun CodeBuildClient.stopBuild(crossinline block: StopBuildRequest.Builder.() -> Unit): StopBuildResponse

Attempts to stop running a build.

Link copied to clipboard

Stops a running batch build.

Link copied to clipboard
inline suspend fun CodeBuildClient.stopSandbox(crossinline block: StopSandboxRequest.Builder.() -> Unit): StopSandboxResponse

Stops a sandbox.

Link copied to clipboard
inline suspend fun CodeBuildClient.updateFleet(crossinline block: UpdateFleetRequest.Builder.() -> Unit): UpdateFleetResponse

Updates a compute fleet.

Link copied to clipboard

Changes the settings of a build project.

Link copied to clipboard

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.

Link copied to clipboard

Updates a report group.

Link copied to clipboard

Updates the webhook associated with an CodeBuild build project.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.