software.amazon.awssdk.services.codebuild

Interface CodeBuildClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface CodeBuildClient
extends SdkClient, SdkAutoCloseable

Service client for accessing null. This can be created using the static builder() method. AWS CodeBuild

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, and 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 will run 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 represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, 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 repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

• DeleteProject: Deletes a build project.

• DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

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 repository, enables AWS CodeBuild to begin automatically 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 repository, enables AWS CodeBuild to begin automatically 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 DeleteWebhookResponse	deleteWebhook(Consumer<DeleteWebhookRequest.Builder> deleteWebhookRequest) For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically 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 repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.
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.
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.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CodeBuildClient create()

Create a CodeBuildClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CodeBuildClientBuilder builder()

Create a builder that can be used to configure and create a CodeBuildClient.

batchDeleteBuilds

default BatchDeleteBuildsResponse batchDeleteBuilds(BatchDeleteBuildsRequest batchDeleteBuildsRequest)
                                             throws InvalidInputException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CodeBuildException

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.

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

See Also:

AWS API Documentation

batchDeleteBuilds

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

Parameters:

batchDeleteBuildsRequest - A Consumer that will call methods on BatchDeleteBuildsInput.Builder to create a request.

Returns:

Result of the BatchDeleteBuilds operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

batchGetBuilds

default BatchGetBuildsResponse batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
                                       throws InvalidInputException,
                                              AwsServiceException,
                                              SdkClientException,
                                              CodeBuildException

Gets information about builds.

Parameters:

batchGetBuildsRequest -

Returns:

Result of the BatchGetBuilds operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

batchGetBuilds

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

Parameters:

batchGetBuildsRequest - A Consumer that will call methods on BatchGetBuildsInput.Builder to create a request.

Returns:

Result of the BatchGetBuilds operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

batchGetProjects

default BatchGetProjectsResponse batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
                                           throws InvalidInputException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CodeBuildException

Gets information about 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.

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

See Also:

AWS API Documentation

batchGetProjects

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

Parameters:

batchGetProjectsRequest - A Consumer that will call methods on BatchGetProjectsInput.Builder to create a request.

Returns:

Result of the BatchGetProjects operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws InvalidInputException,
                                            ResourceAlreadyExistsException,
                                            AccountLimitExceededException,
                                            AwsServiceException,
                                            SdkClientException,
                                            CodeBuildException

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

See Also:

AWS API Documentation

createProject

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

Parameters:

createProjectRequest - A Consumer that will call methods on CreateProjectInput.Builder to create a request.

Returns:

Result of the CreateProject operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

createWebhook

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 repository, enables AWS CodeBuild to begin automatically 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 will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 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 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

See Also:

AWS API Documentation

createWebhook

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 repository, enables AWS CodeBuild to begin automatically 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 will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 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()

Parameters:

createWebhookRequest - A Consumer that will call methods on CreateWebhookInput.Builder to create a request.

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

See Also:

AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws InvalidInputException,
                                            AwsServiceException,
                                            SdkClientException,
                                            CodeBuildException

Deletes a build project.

Parameters:

deleteProjectRequest -

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

deleteProject

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

Parameters:

deleteProjectRequest - A Consumer that will call methods on DeleteProjectInput.Builder to create a request.

Returns:

Result of the DeleteProject operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

deleteWebhook

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 repository, stops AWS CodeBuild from automatically 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 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

See Also:

AWS API Documentation

deleteWebhook

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 repository, stops AWS CodeBuild from automatically 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()

Parameters:

deleteWebhookRequest - A Consumer that will call methods on DeleteWebhookInput.Builder to create a request.

Returns:

Result of the DeleteWebhook operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listBuilds

default ListBuildsResponse listBuilds()
                               throws InvalidInputException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CodeBuildException

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

Returns:

Result of the ListBuilds operation returned by the service.

Throws:

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

See Also:

listBuilds(ListBuildsRequest), AWS API Documentation

listBuilds

default ListBuildsResponse listBuilds(ListBuildsRequest listBuildsRequest)
                               throws InvalidInputException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CodeBuildException

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.

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

See Also:

AWS API Documentation

listBuilds

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

Parameters:

listBuildsRequest - A Consumer that will call methods on ListBuildsInput.Builder to create a request.

Returns:

Result of the ListBuilds operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listBuildsForProject

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.

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

See Also:

AWS API Documentation

listBuildsForProject

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

Parameters:

listBuildsForProjectRequest - A Consumer that will call methods on ListBuildsForProjectInput.Builder to create a request.

Returns:

Result of the ListBuildsForProject operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listCuratedEnvironmentImages

default ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages()
                                                                   throws AwsServiceException,
                                                                          SdkClientException,
                                                                          CodeBuildException

Gets information about Docker images that are managed by AWS CodeBuild.

Returns:

Result of the ListCuratedEnvironmentImages operation returned by the service.

Throws:

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

See Also:

listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest), AWS API Documentation

listCuratedEnvironmentImages

default ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
                                                                   throws AwsServiceException,
                                                                          SdkClientException,
                                                                          CodeBuildException

Gets information about Docker images that are managed by AWS CodeBuild.

Parameters:

listCuratedEnvironmentImagesRequest -

Returns:

Result of the ListCuratedEnvironmentImages operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listCuratedEnvironmentImages

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

Parameters:

listCuratedEnvironmentImagesRequest - A Consumer that will call methods on ListCuratedEnvironmentImagesInput.Builder to create a request.

Returns:

Result of the ListCuratedEnvironmentImages operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listProjects

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.

Returns:

Result of the ListProjects operation returned by the service.

Throws:

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

See Also:

listProjects(ListProjectsRequest), AWS API Documentation

listProjects

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

Parameters:

listProjectsRequest -

Returns:

Result of the ListProjects operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

listProjects

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

Parameters:

listProjectsRequest - A Consumer that will call methods on ListProjectsInput.Builder to create a request.

Returns:

Result of the ListProjects operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

startBuild

default StartBuildResponse startBuild(StartBuildRequest startBuildRequest)
                               throws InvalidInputException,
                                      ResourceNotFoundException,
                                      AccountLimitExceededException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CodeBuildException

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

See Also:

AWS API Documentation

startBuild

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

Parameters:

startBuildRequest - A Consumer that will call methods on StartBuildInput.Builder to create a request.

Returns:

Result of the StartBuild operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

stopBuild

default StopBuildResponse stopBuild(StopBuildRequest stopBuildRequest)
                             throws InvalidInputException,
                                    ResourceNotFoundException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CodeBuildException

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

See Also:

AWS API Documentation

stopBuild

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

Parameters:

stopBuildRequest - A Consumer that will call methods on StopBuildInput.Builder to create a request.

Returns:

Result of the StopBuild operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws InvalidInputException,
                                            ResourceNotFoundException,
                                            AwsServiceException,
                                            SdkClientException,
                                            CodeBuildException

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

See Also:

AWS API Documentation

updateProject

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

Parameters:

updateProjectRequest - A Consumer that will call methods on UpdateProjectInput.Builder to create a request.

Returns:

Result of the UpdateProject operation returned by the service.

Throws:

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

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()