@Generated(value="software.amazon.awssdk:codegen") public interface CodeBuildClient extends SdkClient
builder()
method.
AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS 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 AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.
AWS CodeBuild supports these operations:
BatchDeleteBuilds
: Deletes one or more builds.
BatchGetProjects
: Gets information about one or more build projects. A build project defines how
AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build
environment to use, the build commands to run, and where to store the build output. A build environment is a
representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build.
You can add tags to build projects to help manage your resources and costs.
CreateProject
: Creates a build project.
CreateWebhook
: For an existing AWS CodeBuild build project that has its source code stored in a GitHub
or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed
to the repository.
UpdateWebhook
: Changes the settings of an existing webhook.
DeleteProject
: Deletes a build project.
DeleteWebhook
: For an existing AWS CodeBuild build project that has its source code stored in a GitHub
or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to
the repository.
ListProjects
: Gets a list of build project names, with each build project name representing a single
build project.
UpdateProject
: Changes the settings of an existing build project.
BatchGetBuilds
: Gets information about one or more builds.
ListBuilds
: Gets a list of build IDs, with each build ID representing a single build.
ListBuildsForProject
: Gets a list of build IDs for the specified build project, with each build ID
representing a single build.
StartBuild
: Starts running a build.
StopBuild
: Attempts to stop running a build.
ListCuratedEnvironmentImages
: Gets information about Docker images that are managed by AWS CodeBuild.
DeleteSourceCredentials
: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
ImportSourceCredentials
: Imports the source repository credentials for an AWS CodeBuild project that has
its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
ListSourceCredentials
: Returns a list of SourceCredentialsInfo
objects. Each
SourceCredentialsInfo
object includes the authentication type, token ARN, and type of source provider
for one set of credentials.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default BatchDeleteBuildsResponse |
batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)
Deletes one or more builds.
|
default BatchDeleteBuildsResponse |
batchDeleteBuilds(Consumer<BatchDeleteBuildsRequest.Builder> batchDeleteBuildsRequest)
Deletes one or more builds.
|
default BatchGetBuildsResponse |
batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
Gets information about builds.
|
default BatchGetBuildsResponse |
batchGetBuilds(Consumer<BatchGetBuildsRequest.Builder> batchGetBuildsRequest)
Gets information about builds.
|
default BatchGetProjectsResponse |
batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
Gets information about build projects.
|
default BatchGetProjectsResponse |
batchGetProjects(Consumer<BatchGetProjectsRequest.Builder> batchGetProjectsRequest)
Gets information about build projects.
|
static CodeBuildClientBuilder |
builder()
Create a builder that can be used to configure and create a
CodeBuildClient . |
static CodeBuildClient |
create()
Create a
CodeBuildClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateProjectResponse |
createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest)
Creates a build project.
|
default CreateProjectResponse |
createProject(CreateProjectRequest createProjectRequest)
Creates a build project.
|
default CreateWebhookResponse |
createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest)
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
|
default CreateWebhookResponse |
createWebhook(CreateWebhookRequest createWebhookRequest)
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
|
default DeleteProjectResponse |
deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest)
Deletes a build project.
|
default DeleteProjectResponse |
deleteProject(DeleteProjectRequest deleteProjectRequest)
Deletes a build project.
|
default DeleteSourceCredentialsResponse |
deleteSourceCredentials(Consumer<DeleteSourceCredentialsRequest.Builder> deleteSourceCredentialsRequest)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
|
default DeleteSourceCredentialsResponse |
deleteSourceCredentials(DeleteSourceCredentialsRequest deleteSourceCredentialsRequest)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
|
default DeleteWebhookResponse |
deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest)
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
|
default DeleteWebhookResponse |
deleteWebhook(DeleteWebhookRequest deleteWebhookRequest)
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository,
stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
|
default ImportSourceCredentialsResponse |
importSourceCredentials(Consumer<ImportSourceCredentialsRequest.Builder> importSourceCredentialsRequest)
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a
GitHub, GitHub Enterprise, or Bitbucket repository.
|
default ImportSourceCredentialsResponse |
importSourceCredentials(ImportSourceCredentialsRequest importSourceCredentialsRequest)
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a
GitHub, GitHub Enterprise, or Bitbucket repository.
|
default InvalidateProjectCacheResponse |
invalidateProjectCache(Consumer<InvalidateProjectCacheRequest.Builder> invalidateProjectCacheRequest)
Resets the cache for a project.
|
default InvalidateProjectCacheResponse |
invalidateProjectCache(InvalidateProjectCacheRequest invalidateProjectCacheRequest)
Resets the cache for a project.
|
default ListBuildsResponse |
listBuilds()
Gets a list of build IDs, with each build ID representing a single build.
|
default ListBuildsResponse |
listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest)
Gets a list of build IDs, with each build ID representing a single build.
|
default ListBuildsResponse |
listBuilds(ListBuildsRequest listBuildsRequest)
Gets a list of build IDs, with each build ID representing a single build.
|
default ListBuildsForProjectResponse |
listBuildsForProject(Consumer<ListBuildsForProjectRequest.Builder> listBuildsForProjectRequest)
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
|
default ListBuildsForProjectResponse |
listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
|
default ListCuratedEnvironmentImagesResponse |
listCuratedEnvironmentImages()
Gets information about Docker images that are managed by AWS CodeBuild.
|
default ListCuratedEnvironmentImagesResponse |
listCuratedEnvironmentImages(Consumer<ListCuratedEnvironmentImagesRequest.Builder> listCuratedEnvironmentImagesRequest)
Gets information about Docker images that are managed by AWS CodeBuild.
|
default ListCuratedEnvironmentImagesResponse |
listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
Gets information about Docker images that are managed by AWS CodeBuild.
|
default ListProjectsResponse |
listProjects()
Gets a list of build project names, with each build project name representing a single build project.
|
default ListProjectsResponse |
listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest)
Gets a list of build project names, with each build project name representing a single build project.
|
default ListProjectsResponse |
listProjects(ListProjectsRequest listProjectsRequest)
Gets a list of build project names, with each build project name representing a single build project.
|
default ListSourceCredentialsResponse |
listSourceCredentials()
Returns a list of
SourceCredentialsInfo objects. |
default ListSourceCredentialsResponse |
listSourceCredentials(Consumer<ListSourceCredentialsRequest.Builder> listSourceCredentialsRequest)
Returns a list of
SourceCredentialsInfo objects. |
default ListSourceCredentialsResponse |
listSourceCredentials(ListSourceCredentialsRequest listSourceCredentialsRequest)
Returns a list of
SourceCredentialsInfo objects. |
static ServiceMetadata |
serviceMetadata() |
default StartBuildResponse |
startBuild(Consumer<StartBuildRequest.Builder> startBuildRequest)
Starts running a build.
|
default StartBuildResponse |
startBuild(StartBuildRequest startBuildRequest)
Starts running a build.
|
default StopBuildResponse |
stopBuild(Consumer<StopBuildRequest.Builder> stopBuildRequest)
Attempts to stop running a build.
|
default StopBuildResponse |
stopBuild(StopBuildRequest stopBuildRequest)
Attempts to stop running a build.
|
default UpdateProjectResponse |
updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest)
Changes the settings of a build project.
|
default UpdateProjectResponse |
updateProject(UpdateProjectRequest updateProjectRequest)
Changes the settings of a build project.
|
default UpdateWebhookResponse |
updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest)
Updates the webhook associated with an AWS CodeBuild build project.
|
default UpdateWebhookResponse |
updateWebhook(UpdateWebhookRequest updateWebhookRequest)
Updates the webhook associated with an AWS CodeBuild build project.
|
serviceName
close
static final String SERVICE_NAME
static CodeBuildClient create()
CodeBuildClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CodeBuildClientBuilder builder()
CodeBuildClient
.default BatchDeleteBuildsResponse batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Deletes one or more builds.
batchDeleteBuildsRequest
- InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchDeleteBuildsResponse batchDeleteBuilds(Consumer<BatchDeleteBuildsRequest.Builder> batchDeleteBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Deletes one or more builds.
This is a convenience which creates an instance of the BatchDeleteBuildsRequest.Builder
avoiding the need
to create one manually via BatchDeleteBuildsRequest.builder()
batchDeleteBuildsRequest
- A Consumer
that will call methods on BatchDeleteBuildsInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetBuildsResponse batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets information about builds.
batchGetBuildsRequest
- InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetBuildsResponse batchGetBuilds(Consumer<BatchGetBuildsRequest.Builder> batchGetBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets information about builds.
This is a convenience which creates an instance of the BatchGetBuildsRequest.Builder
avoiding the need to
create one manually via BatchGetBuildsRequest.builder()
batchGetBuildsRequest
- A Consumer
that will call methods on BatchGetBuildsInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetProjectsResponse batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets information about build projects.
batchGetProjectsRequest
- InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchGetProjectsResponse batchGetProjects(Consumer<BatchGetProjectsRequest.Builder> batchGetProjectsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets information about build projects.
This is a convenience which creates an instance of the BatchGetProjectsRequest.Builder
avoiding the need
to create one manually via BatchGetProjectsRequest.builder()
batchGetProjectsRequest
- A Consumer
that will call methods on BatchGetProjectsInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest) throws InvalidInputException, ResourceAlreadyExistsException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Creates a build project.
createProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceAlreadyExistsException
- The specified AWS resource cannot be created, because an AWS resource with the same settings already
exists.AccountLimitExceededException
- An AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateProjectResponse createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) throws InvalidInputException, ResourceAlreadyExistsException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Creates a build project.
This is a convenience which creates an instance of the CreateProjectRequest.Builder
avoiding the need to
create one manually via CreateProjectRequest.builder()
createProjectRequest
- A Consumer
that will call methods on CreateProjectInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceAlreadyExistsException
- The specified AWS resource cannot be created, because an AWS resource with the same settings already
exists.AccountLimitExceededException
- An AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateWebhookResponse createWebhook(CreateWebhookRequest createWebhookRequest) throws InvalidInputException, OAuthProviderException, ResourceAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS 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 AWS resource cannot be created, because an AWS resource with the same settings already
exists.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateWebhookResponse createWebhook(Consumer<CreateWebhookRequest.Builder> createWebhookRequest) throws InvalidInputException, OAuthProviderException, ResourceAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.
If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.
This is a convenience which creates an instance of the CreateWebhookRequest.Builder
avoiding the need to
create one manually via CreateWebhookRequest.builder()
createWebhookRequest
- A Consumer
that will call methods on CreateWebhookInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.OAuthProviderException
- There was a problem with the underlying OAuth provider.ResourceAlreadyExistsException
- The specified AWS resource cannot be created, because an AWS resource with the same settings already
exists.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Deletes a build project.
deleteProjectRequest
- InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteProjectResponse deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Deletes a build project.
This is a convenience which creates an instance of the DeleteProjectRequest.Builder
avoiding the need to
create one manually via DeleteProjectRequest.builder()
deleteProjectRequest
- A Consumer
that will call methods on DeleteProjectInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSourceCredentialsResponse deleteSourceCredentials(DeleteSourceCredentialsRequest deleteSourceCredentialsRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
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 AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteSourceCredentialsResponse deleteSourceCredentials(Consumer<DeleteSourceCredentialsRequest.Builder> deleteSourceCredentialsRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
This is a convenience which creates an instance of the DeleteSourceCredentialsRequest.Builder
avoiding
the need to create one manually via DeleteSourceCredentialsRequest.builder()
deleteSourceCredentialsRequest
- A Consumer
that will call methods on DeleteSourceCredentialsInput.Builder
to create a
request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteWebhookResponse deleteWebhook(DeleteWebhookRequest deleteWebhookRequest) throws InvalidInputException, ResourceNotFoundException, OAuthProviderException, AwsServiceException, SdkClientException, CodeBuildException
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS 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 AWS resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteWebhookResponse deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) throws InvalidInputException, ResourceNotFoundException, OAuthProviderException, AwsServiceException, SdkClientException, CodeBuildException
For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.
This is a convenience which creates an instance of the DeleteWebhookRequest.Builder
avoiding the need to
create one manually via DeleteWebhookRequest.builder()
deleteWebhookRequest
- A Consumer
that will call methods on DeleteWebhookInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ImportSourceCredentialsResponse importSourceCredentials(ImportSourceCredentialsRequest importSourceCredentialsRequest) throws InvalidInputException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Imports the source repository credentials for an AWS 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 AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ImportSourceCredentialsResponse importSourceCredentials(Consumer<ImportSourceCredentialsRequest.Builder> importSourceCredentialsRequest) throws InvalidInputException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
This is a convenience which creates an instance of the ImportSourceCredentialsRequest.Builder
avoiding
the need to create one manually via ImportSourceCredentialsRequest.builder()
importSourceCredentialsRequest
- A Consumer
that will call methods on ImportSourceCredentialsInput.Builder
to create a
request.InvalidInputException
- The input value that was provided is not valid.AccountLimitExceededException
- An AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default InvalidateProjectCacheResponse invalidateProjectCache(InvalidateProjectCacheRequest invalidateProjectCacheRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Resets the cache for a project.
invalidateProjectCacheRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default InvalidateProjectCacheResponse invalidateProjectCache(Consumer<InvalidateProjectCacheRequest.Builder> invalidateProjectCacheRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Resets the cache for a project.
This is a convenience which creates an instance of the InvalidateProjectCacheRequest.Builder
avoiding the
need to create one manually via InvalidateProjectCacheRequest.builder()
invalidateProjectCacheRequest
- A Consumer
that will call methods on InvalidateProjectCacheInput.Builder
to create a
request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBuildsResponse listBuilds() throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build IDs, with each build ID representing a single build.
InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listBuilds(ListBuildsRequest)
,
AWS API
Documentationdefault ListBuildsResponse listBuilds(ListBuildsRequest listBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBuildsResponse listBuilds(Consumer<ListBuildsRequest.Builder> listBuildsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build IDs, with each build ID representing a single build.
This is a convenience which creates an instance of the ListBuildsRequest.Builder
avoiding the need to
create one manually via ListBuildsRequest.builder()
listBuildsRequest
- A Consumer
that will call methods on ListBuildsInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBuildsForProjectResponse listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
listBuildsForProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListBuildsForProjectResponse listBuildsForProject(Consumer<ListBuildsForProjectRequest.Builder> listBuildsForProjectRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
This is a convenience which creates an instance of the ListBuildsForProjectRequest.Builder
avoiding the
need to create one manually via ListBuildsForProjectRequest.builder()
listBuildsForProjectRequest
- A Consumer
that will call methods on ListBuildsForProjectInput.Builder
to create a
request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages() throws AwsServiceException, SdkClientException, CodeBuildException
Gets information about Docker images that are managed by AWS CodeBuild.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest)
,
AWS API Documentationdefault ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest) throws AwsServiceException, SdkClientException, CodeBuildException
Gets information about Docker images that are managed by AWS CodeBuild.
listCuratedEnvironmentImagesRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages(Consumer<ListCuratedEnvironmentImagesRequest.Builder> listCuratedEnvironmentImagesRequest) throws AwsServiceException, SdkClientException, CodeBuildException
Gets information about Docker images that are managed by AWS CodeBuild.
This is a convenience which creates an instance of the ListCuratedEnvironmentImagesRequest.Builder
avoiding the need to create one manually via ListCuratedEnvironmentImagesRequest.builder()
listCuratedEnvironmentImagesRequest
- A Consumer
that will call methods on ListCuratedEnvironmentImagesInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProjectsResponse listProjects() throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build project names, with each build project name representing a single build project.
InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listProjects(ListProjectsRequest)
,
AWS API
Documentationdefault ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListProjectsResponse listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, CodeBuildException
Gets a list of build project names, with each build project name representing a single build project.
This is a convenience which creates an instance of the ListProjectsRequest.Builder
avoiding the need to
create one manually via ListProjectsRequest.builder()
listProjectsRequest
- A Consumer
that will call methods on ListProjectsInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSourceCredentialsResponse listSourceCredentials() throws AwsServiceException, SdkClientException, CodeBuildException
Returns a list of SourceCredentialsInfo
objects.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listSourceCredentials(ListSourceCredentialsRequest)
,
AWS API Documentationdefault ListSourceCredentialsResponse listSourceCredentials(ListSourceCredentialsRequest listSourceCredentialsRequest) throws AwsServiceException, SdkClientException, CodeBuildException
Returns a list of SourceCredentialsInfo
objects.
listSourceCredentialsRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListSourceCredentialsResponse listSourceCredentials(Consumer<ListSourceCredentialsRequest.Builder> listSourceCredentialsRequest) throws AwsServiceException, SdkClientException, CodeBuildException
Returns a list of SourceCredentialsInfo
objects.
This is a convenience which creates an instance of the ListSourceCredentialsRequest.Builder
avoiding the
need to create one manually via ListSourceCredentialsRequest.builder()
listSourceCredentialsRequest
- A Consumer
that will call methods on ListSourceCredentialsInput.Builder
to create a
request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartBuildResponse startBuild(StartBuildRequest startBuildRequest) throws InvalidInputException, ResourceNotFoundException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Starts running a build.
startBuildRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.AccountLimitExceededException
- An AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartBuildResponse startBuild(Consumer<StartBuildRequest.Builder> startBuildRequest) throws InvalidInputException, ResourceNotFoundException, AccountLimitExceededException, AwsServiceException, SdkClientException, CodeBuildException
Starts running a build.
This is a convenience which creates an instance of the StartBuildRequest.Builder
avoiding the need to
create one manually via StartBuildRequest.builder()
startBuildRequest
- A Consumer
that will call methods on StartBuildInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.AccountLimitExceededException
- An AWS service limit was exceeded for the calling AWS account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopBuildResponse stopBuild(StopBuildRequest stopBuildRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Attempts to stop running a build.
stopBuildRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopBuildResponse stopBuild(Consumer<StopBuildRequest.Builder> stopBuildRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Attempts to stop running a build.
This is a convenience which creates an instance of the StopBuildRequest.Builder
avoiding the need to
create one manually via StopBuildRequest.builder()
stopBuildRequest
- A Consumer
that will call methods on StopBuildInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Changes the settings of a build project.
updateProjectRequest
- InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateProjectResponse updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) throws InvalidInputException, ResourceNotFoundException, AwsServiceException, SdkClientException, CodeBuildException
Changes the settings of a build project.
This is a convenience which creates an instance of the UpdateProjectRequest.Builder
avoiding the need to
create one manually via UpdateProjectRequest.builder()
updateProjectRequest
- A Consumer
that will call methods on UpdateProjectInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateWebhookResponse updateWebhook(UpdateWebhookRequest updateWebhookRequest) throws InvalidInputException, ResourceNotFoundException, OAuthProviderException, AwsServiceException, SdkClientException, CodeBuildException
Updates the webhook associated with an AWS 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 AWS resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateWebhookResponse updateWebhook(Consumer<UpdateWebhookRequest.Builder> updateWebhookRequest) throws InvalidInputException, ResourceNotFoundException, OAuthProviderException, AwsServiceException, SdkClientException, CodeBuildException
Updates the webhook associated with an AWS CodeBuild build project.
If you use Bitbucket for your repository, rotateSecret
is ignored.
This is a convenience which creates an instance of the UpdateWebhookRequest.Builder
avoiding the need to
create one manually via UpdateWebhookRequest.builder()
updateWebhookRequest
- A Consumer
that will call methods on UpdateWebhookInput.Builder
to create a request.InvalidInputException
- The input value that was provided is not valid.ResourceNotFoundException
- The specified AWS resource cannot be found.OAuthProviderException
- There was a problem with the underlying OAuth provider.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CodeBuildException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.