Package software.amazon.awssdk.services.codebuild

Interface CodeBuildClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CodeBuildClient
extends AutoCloseable

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

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

• DeleteProject: Deletes a build project.

• 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	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchGetBuildsResponse	batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)	Gets information about builds.
default BatchGetProjectsResponse	batchGetProjects(BatchGetProjectsRequest 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(CreateProjectRequest createProjectRequest)	Creates a build project.
default DeleteProjectResponse	deleteProject(DeleteProjectRequest deleteProjectRequest)	Deletes a build project.
default ListBuildsResponse	listBuilds(ListBuildsRequest listBuildsRequest)	Gets a list of build IDs, 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(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)	Gets information about Docker images that are managed by AWS CodeBuild.
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(StartBuildRequest startBuildRequest)	Starts running a build.
default StopBuildResponse	stopBuild(StopBuildRequest stopBuildRequest)	Attempts to stop running a build.
default UpdateProjectResponse	updateProject(UpdateProjectRequest updateProjectRequest)	Changes the settings of a build project.

Methods inherited from interface java.lang.AutoCloseable

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.

batchGetBuilds

default BatchGetBuildsResponse batchGetBuilds(BatchGetBuildsRequest batchGetBuildsRequest)
                                       throws InvalidInputException,
                                              SdkBaseException,
                                              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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

batchGetProjects

default BatchGetProjectsResponse batchGetProjects(BatchGetProjectsRequest batchGetProjectsRequest)
                                           throws InvalidInputException,
                                                  SdkBaseException,
                                                  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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createProject

default CreateProjectResponse createProject(CreateProjectRequest createProjectRequest)
                                     throws InvalidInputException,
                                            ResourceAlreadyExistsException,
                                            AccountLimitExceededException,
                                            SdkBaseException,
                                            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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteProject

default DeleteProjectResponse deleteProject(DeleteProjectRequest deleteProjectRequest)
                                     throws InvalidInputException,
                                            SdkBaseException,
                                            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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listBuilds

default ListBuildsResponse listBuilds(ListBuildsRequest listBuildsRequest)
                               throws InvalidInputException,
                                      SdkBaseException,
                                      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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listBuildsForProject

default ListBuildsForProjectResponse listBuildsForProject(ListBuildsForProjectRequest listBuildsForProjectRequest)
                                                   throws InvalidInputException,
                                                          ResourceNotFoundException,
                                                          SdkBaseException,
                                                          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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listCuratedEnvironmentImages

default ListCuratedEnvironmentImagesResponse listCuratedEnvironmentImages(ListCuratedEnvironmentImagesRequest listCuratedEnvironmentImagesRequest)
                                                                   throws SdkBaseException,
                                                                          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:

SdkBaseException

SdkClientException

CodeBuildException

See Also:

AWS API Documentation

listProjects

default ListProjectsResponse listProjects(ListProjectsRequest listProjectsRequest)
                                   throws InvalidInputException,
                                          SdkBaseException,
                                          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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

startBuild

default StartBuildResponse startBuild(StartBuildRequest startBuildRequest)
                               throws InvalidInputException,
                                      ResourceNotFoundException,
                                      AccountLimitExceededException,
                                      SdkBaseException,
                                      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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

stopBuild

default StopBuildResponse stopBuild(StopBuildRequest stopBuildRequest)
                             throws InvalidInputException,
                                    ResourceNotFoundException,
                                    SdkBaseException,
                                    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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

updateProject

default UpdateProjectResponse updateProject(UpdateProjectRequest updateProjectRequest)
                                     throws InvalidInputException,
                                            ResourceNotFoundException,
                                            SdkBaseException,
                                            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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()