@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeBuild
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCodeBuild
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchDeleteBuildsResult |
batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)
Deletes one or more builds.
|
BatchGetBuildBatchesResult |
batchGetBuildBatches(BatchGetBuildBatchesRequest batchGetBuildBatchesRequest)
Retrieves information about one or more batch builds.
|
BatchGetBuildsResult |
batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
Gets information about one or more builds.
|
BatchGetFleetsResult |
batchGetFleets(BatchGetFleetsRequest batchGetFleetsRequest)
Gets information about one or more compute fleets.
|
BatchGetProjectsResult |
batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
Gets information about one or more build projects.
|
BatchGetReportGroupsResult |
batchGetReportGroups(BatchGetReportGroupsRequest batchGetReportGroupsRequest)
Returns an array of report groups.
|
BatchGetReportsResult |
batchGetReports(BatchGetReportsRequest batchGetReportsRequest)
Returns an array of reports.
|
CreateFleetResult |
createFleet(CreateFleetRequest createFleetRequest)
Creates a compute fleet.
|
CreateProjectResult |
createProject(CreateProjectRequest createProjectRequest)
Creates a build project.
|
CreateReportGroupResult |
createReportGroup(CreateReportGroupRequest createReportGroupRequest)
Creates a report group.
|
CreateWebhookResult |
createWebhook(CreateWebhookRequest createWebhookRequest)
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.
|
DeleteBuildBatchResult |
deleteBuildBatch(DeleteBuildBatchRequest deleteBuildBatchRequest)
Deletes a batch build.
|
DeleteFleetResult |
deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a compute fleet.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a build project.
|
DeleteReportResult |
deleteReport(DeleteReportRequest deleteReportRequest)
Deletes a report.
|
DeleteReportGroupResult |
deleteReportGroup(DeleteReportGroupRequest deleteReportGroupRequest)
Deletes a report group.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy that is identified by its resource ARN.
|
DeleteSourceCredentialsResult |
deleteSourceCredentials(DeleteSourceCredentialsRequest deleteSourceCredentialsRequest)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
|
DeleteWebhookResult |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
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.
|
DescribeCodeCoveragesResult |
describeCodeCoverages(DescribeCodeCoveragesRequest describeCodeCoveragesRequest)
Retrieves one or more code coverage reports.
|
DescribeTestCasesResult |
describeTestCases(DescribeTestCasesRequest describeTestCasesRequest)
Returns a list of details about test cases for a report.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetReportGroupTrendResult |
getReportGroupTrend(GetReportGroupTrendRequest getReportGroupTrendRequest)
Analyzes and accumulates test report values for the specified test reports.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Gets a resource policy that is identified by its resource ARN.
|
ImportSourceCredentialsResult |
importSourceCredentials(ImportSourceCredentialsRequest importSourceCredentialsRequest)
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub,
GitHub Enterprise, or Bitbucket repository.
|
InvalidateProjectCacheResult |
invalidateProjectCache(InvalidateProjectCacheRequest invalidateProjectCacheRequest)
Resets the cache for a project.
|
ListBuildBatchesResult |
listBuildBatches(ListBuildBatchesRequest listBuildBatchesRequest)
Retrieves the identifiers of your build batches in the current region.
|
ListBuildBatchesForProjectResult |
listBuildBatchesForProject(ListBuildBatchesForProjectRequest listBuildBatchesForProjectRequest)
Retrieves the identifiers of the build batches for a specific project.
|
ListBuildsResult |
listBuilds(ListBuildsRequest listBuildsRequest)
Gets a list of build IDs, with each build ID representing a single build.
|
ListBuildsForProjectResult |
listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)
Gets a list of build identifiers for the specified build project, with each build identifier representing a
single build.
|
ListCuratedEnvironmentImagesResult |
listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
Gets information about Docker images that are managed by CodeBuild.
|
ListFleetsResult |
listFleets(ListFleetsRequest listFleetsRequest)
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
|
ListProjectsResult |
listProjects(ListProjectsRequest listProjectsRequest)
Gets a list of build project names, with each build project name representing a single build project.
|
ListReportGroupsResult |
listReportGroups(ListReportGroupsRequest listReportGroupsRequest)
Gets a list ARNs for the report groups in the current Amazon Web Services account.
|
ListReportsResult |
listReports(ListReportsRequest listReportsRequest)
Returns a list of ARNs for the reports in the current Amazon Web Services account.
|
ListReportsForReportGroupResult |
listReportsForReportGroup(ListReportsForReportGroupRequest listReportsForReportGroupRequest)
Returns a list of ARNs for the reports that belong to a
ReportGroup . |
ListSharedProjectsResult |
listSharedProjects(ListSharedProjectsRequest listSharedProjectsRequest)
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
|
ListSharedReportGroupsResult |
listSharedReportGroups(ListSharedReportGroupsRequest listSharedReportGroupsRequest)
Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
|
ListSourceCredentialsResult |
listSourceCredentials(ListSourceCredentialsRequest listSourceCredentialsRequest)
Returns a list of
SourceCredentialsInfo objects. |
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Stores a resource policy for the ARN of a
Project or ReportGroup object. |
RetryBuildResult |
retryBuild(RetryBuildRequest retryBuildRequest)
Restarts a build.
|
RetryBuildBatchResult |
retryBuildBatch(RetryBuildBatchRequest retryBuildBatchRequest)
Restarts a failed batch build.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartBuildResult |
startBuild(StartBuildRequest startBuildRequest)
Starts running a build with the settings defined in the project.
|
StartBuildBatchResult |
startBuildBatch(StartBuildBatchRequest startBuildBatchRequest)
Starts a batch build for a project.
|
StopBuildResult |
stopBuild(StopBuildRequest stopBuildRequest)
Attempts to stop running a build.
|
StopBuildBatchResult |
stopBuildBatch(StopBuildBatchRequest stopBuildBatchRequest)
Stops a running batch build.
|
UpdateFleetResult |
updateFleet(UpdateFleetRequest updateFleetRequest)
Updates a compute fleet.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest updateProjectRequest)
Changes the settings of a build project.
|
UpdateProjectVisibilityResult |
updateProjectVisibility(UpdateProjectVisibilityRequest updateProjectVisibilityRequest)
Changes the public visibility for a project.
|
UpdateReportGroupResult |
updateReportGroup(UpdateReportGroupRequest updateReportGroupRequest)
Updates a report group.
|
UpdateWebhookResult |
updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Updates the webhook associated with an CodeBuild build project.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "codebuild.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "codebuild.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "codebuild.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"codebuild.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate
with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
BatchDeleteBuildsResult batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)
Deletes one or more builds.
batchDeleteBuildsRequest
- InvalidInputException
- The input value that was provided is not valid.BatchGetBuildBatchesResult batchGetBuildBatches(BatchGetBuildBatchesRequest batchGetBuildBatchesRequest)
Retrieves information about one or more batch builds.
batchGetBuildBatchesRequest
- InvalidInputException
- The input value that was provided is not valid.BatchGetBuildsResult batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
Gets information about one or more builds.
batchGetBuildsRequest
- InvalidInputException
- The input value that was provided is not valid.AWSCodeBuild client = AWSCodeBuildClientBuilder.standard().build(); BatchGetBuildsRequest request = new BatchGetBuildsRequest().withIds("codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX"); BatchGetBuildsResult response = client.batchGetBuilds(request);
BatchGetFleetsResult batchGetFleets(BatchGetFleetsRequest batchGetFleetsRequest)
Gets information about one or more compute fleets.
batchGetFleetsRequest
- InvalidInputException
- The input value that was provided is not valid.BatchGetProjectsResult batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
Gets information about one or more build projects.
batchGetProjectsRequest
- InvalidInputException
- The input value that was provided is not valid.BatchGetReportGroupsResult batchGetReportGroups(BatchGetReportGroupsRequest batchGetReportGroupsRequest)
Returns an array of report groups.
batchGetReportGroupsRequest
- InvalidInputException
- The input value that was provided is not valid.BatchGetReportsResult batchGetReports(BatchGetReportsRequest batchGetReportsRequest)
Returns an array of reports.
batchGetReportsRequest
- InvalidInputException
- The input value that was provided is not valid.CreateFleetResult createFleet(CreateFleetRequest createFleetRequest)
Creates a compute fleet.
createFleetRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceAlreadyExistsException
- The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource
with the same settings already exists.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
Creates a build project.
createProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceAlreadyExistsException
- The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource
with the same settings already exists.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.CreateReportGroupResult createReportGroup(CreateReportGroupRequest createReportGroupRequest)
Creates a report group. A report group contains a collection of reports.
createReportGroupRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceAlreadyExistsException
- The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource
with the same settings already exists.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.CreateWebhookResult createWebhook(CreateWebhookRequest createWebhookRequest)
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.
createWebhookRequest
- InvalidInputException
- The input value that was provided is not valid.OAuthProviderException
- There was a problem with the underlying OAuth provider.ResourceAlreadyExistsException
- The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource
with the same settings already exists.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.DeleteBuildBatchResult deleteBuildBatch(DeleteBuildBatchRequest deleteBuildBatchRequest)
Deletes a batch build.
deleteBuildBatchRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteFleetResult deleteFleet(DeleteFleetRequest deleteFleetRequest)
Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.
deleteFleetRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a build project. When you delete a project, its builds are not deleted.
deleteProjectRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteReportResult deleteReport(DeleteReportRequest deleteReportRequest)
Deletes a report.
deleteReportRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteReportGroupResult deleteReportGroup(DeleteReportGroupRequest deleteReportGroupRequest)
Deletes a report group. Before you delete a report group, you must delete its reports.
deleteReportGroupRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)
Deletes a resource policy that is identified by its resource ARN.
deleteResourcePolicyRequest
- InvalidInputException
- The input value that was provided is not valid.DeleteSourceCredentialsResult deleteSourceCredentials(DeleteSourceCredentialsRequest deleteSourceCredentialsRequest)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
deleteSourceCredentialsRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.DeleteWebhookResult deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
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.
deleteWebhookRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.DescribeCodeCoveragesResult describeCodeCoverages(DescribeCodeCoveragesRequest describeCodeCoveragesRequest)
Retrieves one or more code coverage reports.
describeCodeCoveragesRequest
- InvalidInputException
- The input value that was provided is not valid.DescribeTestCasesResult describeTestCases(DescribeTestCasesRequest describeTestCasesRequest)
Returns a list of details about test cases for a report.
describeTestCasesRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.GetReportGroupTrendResult getReportGroupTrend(GetReportGroupTrendRequest getReportGroupTrendRequest)
Analyzes and accumulates test report values for the specified test reports.
getReportGroupTrendRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)
Gets a resource policy that is identified by its resource ARN.
getResourcePolicyRequest
- ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.InvalidInputException
- The input value that was provided is not valid.ImportSourceCredentialsResult importSourceCredentials(ImportSourceCredentialsRequest importSourceCredentialsRequest)
Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
importSourceCredentialsRequest
- InvalidInputException
- The input value that was provided is not valid.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.ResourceAlreadyExistsException
- The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource
with the same settings already exists.InvalidateProjectCacheResult invalidateProjectCache(InvalidateProjectCacheRequest invalidateProjectCacheRequest)
Resets the cache for a project.
invalidateProjectCacheRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.ListBuildBatchesResult listBuildBatches(ListBuildBatchesRequest listBuildBatchesRequest)
Retrieves the identifiers of your build batches in the current region.
listBuildBatchesRequest
- InvalidInputException
- The input value that was provided is not valid.ListBuildBatchesForProjectResult listBuildBatchesForProject(ListBuildBatchesForProjectRequest listBuildBatchesForProjectRequest)
Retrieves the identifiers of the build batches for a specific project.
listBuildBatchesForProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.ListBuildsResult listBuilds(ListBuildsRequest listBuildsRequest)
Gets a list of build IDs, with each build ID representing a single build.
listBuildsRequest
- InvalidInputException
- The input value that was provided is not valid.ListBuildsForProjectResult listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)
Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.
listBuildsForProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.ListCuratedEnvironmentImagesResult listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
Gets information about Docker images that are managed by CodeBuild.
listCuratedEnvironmentImagesRequest
- ListFleetsResult listFleets(ListFleetsRequest listFleetsRequest)
Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.
listFleetsRequest
- InvalidInputException
- The input value that was provided is not valid.ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
Gets a list of build project names, with each build project name representing a single build project.
listProjectsRequest
- InvalidInputException
- The input value that was provided is not valid.ListReportGroupsResult listReportGroups(ListReportGroupsRequest listReportGroupsRequest)
Gets a list ARNs for the report groups in the current Amazon Web Services account.
listReportGroupsRequest
- InvalidInputException
- The input value that was provided is not valid.ListReportsResult listReports(ListReportsRequest listReportsRequest)
Returns a list of ARNs for the reports in the current Amazon Web Services account.
listReportsRequest
- InvalidInputException
- The input value that was provided is not valid.ListReportsForReportGroupResult listReportsForReportGroup(ListReportsForReportGroupRequest listReportsForReportGroupRequest)
Returns a list of ARNs for the reports that belong to a ReportGroup
.
listReportsForReportGroupRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.ListSharedProjectsResult listSharedProjects(ListSharedProjectsRequest listSharedProjectsRequest)
Gets a list of projects that are shared with other Amazon Web Services accounts or users.
listSharedProjectsRequest
- InvalidInputException
- The input value that was provided is not valid.ListSharedReportGroupsResult listSharedReportGroups(ListSharedReportGroupsRequest listSharedReportGroupsRequest)
Gets a list of report groups that are shared with other Amazon Web Services accounts or users.
listSharedReportGroupsRequest
- InvalidInputException
- The input value that was provided is not valid.ListSourceCredentialsResult listSourceCredentials(ListSourceCredentialsRequest listSourceCredentialsRequest)
Returns a list of SourceCredentialsInfo
objects.
listSourceCredentialsRequest
- InvalidInputException
- The input value that was provided is not valid.PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)
Stores a resource policy for the ARN of a Project
or ReportGroup
object.
putResourcePolicyRequest
- ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.InvalidInputException
- The input value that was provided is not valid.RetryBuildResult retryBuild(RetryBuildRequest retryBuildRequest)
Restarts a build.
retryBuildRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.RetryBuildBatchResult retryBuildBatch(RetryBuildBatchRequest retryBuildBatchRequest)
Restarts a failed batch build. Only batch builds that have failed can be retried.
retryBuildBatchRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.StartBuildResult startBuild(StartBuildRequest startBuildRequest)
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.
startBuildRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.StartBuildBatchResult startBuildBatch(StartBuildBatchRequest startBuildBatchRequest)
Starts a batch build for a project.
startBuildBatchRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.StopBuildResult stopBuild(StopBuildRequest stopBuildRequest)
Attempts to stop running a build.
stopBuildRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.StopBuildBatchResult stopBuildBatch(StopBuildBatchRequest stopBuildBatchRequest)
Stops a running batch build.
stopBuildBatchRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.UpdateFleetResult updateFleet(UpdateFleetRequest updateFleetRequest)
Updates a compute fleet.
updateFleetRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.AccountLimitExceededException
- An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
Changes the settings of a build project.
updateProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.UpdateProjectVisibilityResult updateProjectVisibility(UpdateProjectVisibilityRequest updateProjectVisibilityRequest)
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.
updateProjectVisibilityRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.UpdateReportGroupResult updateReportGroup(UpdateReportGroupRequest updateReportGroupRequest)
Updates a report group.
updateReportGroupRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.UpdateWebhookResult updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret
is ignored.
updateWebhookRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified Amazon Web Services resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.