com.amazonaws.services.codebuild

Interface AWSCodeBuild

All Known Subinterfaces:

AWSCodeBuildAsync

All Known Implementing Classes:

AbstractAWSCodeBuild, AbstractAWSCodeBuildAsync, AWSCodeBuildAsyncClient, AWSCodeBuildClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCodeBuild

Interface for accessing AWS CodeBuild.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCodeBuild instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("codebuild.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

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.

Parameters:

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.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to 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.

Parameters:

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.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

batchDeleteBuilds

BatchDeleteBuildsResult batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)

Deletes one or more builds.

Parameters:

batchDeleteBuildsRequest -

Returns:

Result of the BatchDeleteBuilds operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

batchGetBuildBatches

BatchGetBuildBatchesResult batchGetBuildBatches(BatchGetBuildBatchesRequest batchGetBuildBatchesRequest)

Retrieves information about one or more batch builds.

Parameters:

batchGetBuildBatchesRequest -

Returns:

Result of the BatchGetBuildBatches operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

batchGetBuilds

BatchGetBuildsResult batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)

Gets information about one or more builds.

Parameters:

batchGetBuildsRequest -

Returns:

Result of the BatchGetBuilds operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

Samples:

• To get information about builds

  The following example gets information about builds with the specified build IDs.
  

  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);

batchGetProjects

BatchGetProjectsResult batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)

Gets information about one or more build projects.

Parameters:

batchGetProjectsRequest -

Returns:

Result of the BatchGetProjects operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

batchGetReportGroups

BatchGetReportGroupsResult batchGetReportGroups(BatchGetReportGroupsRequest batchGetReportGroupsRequest)

Returns an array of report groups.

Parameters:

batchGetReportGroupsRequest -

Returns:

Result of the BatchGetReportGroups operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

batchGetReports

BatchGetReportsResult batchGetReports(BatchGetReportsRequest batchGetReportsRequest)

Returns an array of reports.

Parameters:

batchGetReportsRequest -

Returns:

Result of the BatchGetReports operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

createProject

CreateProjectResult createProject(CreateProjectRequest createProjectRequest)

Creates a build project.

Parameters:

createProjectRequest -

Returns:

Result of the CreateProject operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createReportGroup

CreateReportGroupResult createReportGroup(CreateReportGroupRequest createReportGroupRequest)

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

Parameters:

createReportGroupRequest -

Returns:

Result of the CreateReportGroup operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

createWebhook

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.

Parameters:

createWebhookRequest -

Returns:

Result of the CreateWebhook operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

deleteBuildBatch

DeleteBuildBatchResult deleteBuildBatch(DeleteBuildBatchRequest deleteBuildBatchRequest)

Deletes a batch build.

Parameters:

deleteBuildBatchRequest -

Returns:

Result of the DeleteBuildBatch operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

deleteProject

DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)

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

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

deleteReport

DeleteReportResult deleteReport(DeleteReportRequest deleteReportRequest)

Deletes a report.

Parameters:

deleteReportRequest -

Returns:

Result of the DeleteReport operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

deleteReportGroup

DeleteReportGroupResult deleteReportGroup(DeleteReportGroupRequest deleteReportGroupRequest)

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

Parameters:

deleteReportGroupRequest -

Returns:

Result of the DeleteReportGroup operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

deleteResourcePolicy

DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

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

Parameters:

deleteResourcePolicyRequest -

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

deleteSourceCredentials

DeleteSourceCredentialsResult deleteSourceCredentials(DeleteSourceCredentialsRequest deleteSourceCredentialsRequest)

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

Parameters:

deleteSourceCredentialsRequest -

Returns:

Result of the DeleteSourceCredentials operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

deleteWebhook

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.

Parameters:

deleteWebhookRequest -

Returns:

Result of the DeleteWebhook operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeCodeCoverages

DescribeCodeCoveragesResult describeCodeCoverages(DescribeCodeCoveragesRequest describeCodeCoveragesRequest)

Retrieves one or more code coverage reports.

Parameters:

describeCodeCoveragesRequest -

Returns:

Result of the DescribeCodeCoverages operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

describeTestCases

DescribeTestCasesResult describeTestCases(DescribeTestCasesRequest describeTestCasesRequest)

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

Parameters:

describeTestCasesRequest -

Returns:

Result of the DescribeTestCases operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

getReportGroupTrend

GetReportGroupTrendResult getReportGroupTrend(GetReportGroupTrendRequest getReportGroupTrendRequest)

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

Parameters:

getReportGroupTrendRequest -

Returns:

Result of the GetReportGroupTrend operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

getResourcePolicy

GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest getResourcePolicyRequest)

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

Parameters:

getResourcePolicyRequest -

Returns:

Result of the GetResourcePolicy operation returned by the service.

Throws:

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

importSourceCredentials

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.

Parameters:

importSourceCredentialsRequest -

Returns:

Result of the ImportSourceCredentials operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

invalidateProjectCache

InvalidateProjectCacheResult invalidateProjectCache(InvalidateProjectCacheRequest invalidateProjectCacheRequest)

Resets the cache for a project.

Parameters:

invalidateProjectCacheRequest -

Returns:

Result of the InvalidateProjectCache operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

listBuildBatches

ListBuildBatchesResult listBuildBatches(ListBuildBatchesRequest listBuildBatchesRequest)

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

Parameters:

listBuildBatchesRequest -

Returns:

Result of the ListBuildBatches operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listBuildBatchesForProject

ListBuildBatchesForProjectResult listBuildBatchesForProject(ListBuildBatchesForProjectRequest listBuildBatchesForProjectRequest)

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

Parameters:

listBuildBatchesForProjectRequest -

Returns:

Result of the ListBuildBatchesForProject operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

listBuilds

ListBuildsResult listBuilds(ListBuildsRequest listBuildsRequest)

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

Parameters:

listBuildsRequest -

Returns:

Result of the ListBuilds operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listBuildsForProject

ListBuildsForProjectResult listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)

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

Parameters:

listBuildsForProjectRequest -

Returns:

Result of the ListBuildsForProject operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

listCuratedEnvironmentImages

ListCuratedEnvironmentImagesResult listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)

Gets information about Docker images that are managed by CodeBuild.

Parameters:

listCuratedEnvironmentImagesRequest -

Returns:

Result of the ListCuratedEnvironmentImages operation returned by the service.

See Also:

AWS API Documentation

listProjects

ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)

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

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listReportGroups

ListReportGroupsResult listReportGroups(ListReportGroupsRequest listReportGroupsRequest)

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

Parameters:

listReportGroupsRequest -

Returns:

Result of the ListReportGroups operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listReports

ListReportsResult listReports(ListReportsRequest listReportsRequest)

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

Parameters:

listReportsRequest -

Returns:

Result of the ListReports operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listReportsForReportGroup

ListReportsForReportGroupResult listReportsForReportGroup(ListReportsForReportGroupRequest listReportsForReportGroupRequest)

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

Parameters:

listReportsForReportGroupRequest -

Returns:

Result of the ListReportsForReportGroup operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

listSharedProjects

ListSharedProjectsResult listSharedProjects(ListSharedProjectsRequest listSharedProjectsRequest)

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

Parameters:

listSharedProjectsRequest -

Returns:

Result of the ListSharedProjects operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listSharedReportGroups

ListSharedReportGroupsResult listSharedReportGroups(ListSharedReportGroupsRequest listSharedReportGroupsRequest)

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

Parameters:

listSharedReportGroupsRequest -

Returns:

Result of the ListSharedReportGroups operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

listSourceCredentials

ListSourceCredentialsResult listSourceCredentials(ListSourceCredentialsRequest listSourceCredentialsRequest)

Returns a list of SourceCredentialsInfo objects.

Parameters:

listSourceCredentialsRequest -

Returns:

Result of the ListSourceCredentials operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

putResourcePolicy

PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

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

Parameters:

putResourcePolicyRequest -

Returns:

Result of the PutResourcePolicy operation returned by the service.

Throws:

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

InvalidInputException - The input value that was provided is not valid.

See Also:

AWS API Documentation

retryBuild

RetryBuildResult retryBuild(RetryBuildRequest retryBuildRequest)

Restarts a build.

Parameters:

retryBuildRequest -

Returns:

Result of the RetryBuild operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

retryBuildBatch

RetryBuildBatchResult retryBuildBatch(RetryBuildBatchRequest retryBuildBatchRequest)

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

Parameters:

retryBuildBatchRequest -

Returns:

Result of the RetryBuildBatch operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

startBuild

StartBuildResult startBuild(StartBuildRequest startBuildRequest)

Starts running a build.

Parameters:

startBuildRequest -

Returns:

Result of the StartBuild operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

startBuildBatch

StartBuildBatchResult startBuildBatch(StartBuildBatchRequest startBuildBatchRequest)

Starts a batch build for a project.

Parameters:

startBuildBatchRequest -

Returns:

Result of the StartBuildBatch operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

stopBuild

StopBuildResult stopBuild(StopBuildRequest stopBuildRequest)

Attempts to stop running a build.

Parameters:

stopBuildRequest -

Returns:

Result of the StopBuild operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

stopBuildBatch

StopBuildBatchResult stopBuildBatch(StopBuildBatchRequest stopBuildBatchRequest)

Stops a running batch build.

Parameters:

stopBuildBatchRequest -

Returns:

Result of the StopBuildBatch operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

updateProject

UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)

Changes the settings of a build project.

Parameters:

updateProjectRequest -

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

updateProjectVisibility

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, 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.

Parameters:

updateProjectVisibilityRequest -

Returns:

Result of the UpdateProjectVisibility operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

updateReportGroup

UpdateReportGroupResult updateReportGroup(UpdateReportGroupRequest updateReportGroupRequest)

Updates a report group.

Parameters:

updateReportGroupRequest -

Returns:

Result of the UpdateReportGroup operation returned by the service.

Throws:

InvalidInputException - The input value that was provided is not valid.

ResourceNotFoundException - The specified Amazon Web Services resource cannot be found.

See Also:

AWS API Documentation

updateWebhook

UpdateWebhookResult updateWebhook(UpdateWebhookRequest updateWebhookRequest)

Updates the webhook associated with an CodeBuild build project.

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

Parameters:

updateWebhookRequest -

Returns:

Result of the UpdateWebhook operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.