Expand description
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. -
BatchGetBuilds
: Gets information about 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. -
BatchGetReportGroups
: Returns an array of report groups. -
BatchGetReports
: Returns an array of reports. -
CreateProject
: Creates a build project. -
CreateReportGroup
: Creates a report group. A report group contains a collection of reports. -
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. -
DeleteProject
: Deletes a build project. -
DeleteReport
: Deletes a report. -
DeleteReportGroup
: Deletes a report group. -
DeleteResourcePolicy
: Deletes a resource policy that is identified by its resource ARN. -
DeleteSourceCredentials
: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. -
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. -
DescribeTestCases
: Returns a list of details about test cases for a report. -
GetResourcePolicy
: Gets a resource policy that is identified by its resource ARN. -
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. -
InvalidateProjectCache
: Resets the cache for a project. -
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. -
ListCuratedEnvironmentImages
: Gets information about Docker images that are managed by AWS CodeBuild. -
ListProjects
: Gets a list of build project names, with each build project name representing a single build project. -
ListReportGroups
: Gets a list ARNs for the report groups in the current AWS account. -
ListReports
: Gets a list ARNs for the reports in the current AWS account. -
ListReportsForReportGroup
: Returns a list of ARNs for the reports that belong to aReportGroup
. -
ListSharedProjects
: Gets a list of ARNs associated with projects shared with the current AWS account or user. -
ListSharedReportGroups
: Gets a list of ARNs associated with report groups shared with the current AWS account or user -
ListSourceCredentials
: Returns a list ofSourceCredentialsInfo
objects. EachSourceCredentialsInfo
object includes the authentication type, token ARN, and type of source provider for one set of credentials. -
PutResourcePolicy
: Stores a resource policy for the ARN of aProject
orReportGroup
object. -
StartBuild
: Starts running a build. -
StopBuild
: Attempts to stop running a build. -
UpdateProject
: Changes the settings of an existing build project. -
UpdateReportGroup
: Changes a report group. -
UpdateWebhook
: Changes the settings of an existing webhook.
If you’re using the service, you’re probably looking for CodeBuildClient and CodeBuild.
Structs§
- Batch
Delete Builds Input - Batch
Delete Builds Output - Batch
GetBuilds Input - Batch
GetBuilds Output - Batch
GetProjects Input - Batch
GetProjects Output - Batch
GetReport Groups Input - Batch
GetReport Groups Output - Batch
GetReports Input - Batch
GetReports Output - Build
Information about a build.
- Build
Artifacts Information about build output artifacts.
- Build
NotDeleted Information about a build that could not be successfully deleted.
- Build
Phase Information about a stage for a build.
- Build
Status Config Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
- Cloud
Watch Logs Config Information about Amazon CloudWatch Logs for a build project.
- Code
Build Client - A client for the AWS CodeBuild API.
- Create
Project Input - Create
Project Output - Create
Report Group Input - Create
Report Group Output - Create
Webhook Input - Create
Webhook Output - Delete
Project Input - Delete
Project Output - Delete
Report Group Input - Delete
Report Group Output - Delete
Report Input - Delete
Report Output - Delete
Resource Policy Input - Delete
Resource Policy Output - Delete
Source Credentials Input - Delete
Source Credentials Output - Delete
Webhook Input - Delete
Webhook Output - Describe
Test Cases Input - Describe
Test Cases Output - Environment
Image Information about a Docker image that is managed by AWS CodeBuild.
- Environment
Language A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
- Environment
Platform A set of Docker images that are related by platform and are managed by AWS CodeBuild.
- Environment
Variable Information about an environment variable for a build project or a build.
- Exported
Environment Variable Information about an exported environment variable.
- GetResource
Policy Input - GetResource
Policy Output - GitSubmodules
Config Information about the Git submodules configuration for an AWS CodeBuild build project.
- Import
Source Credentials Input - Import
Source Credentials Output - Invalidate
Project Cache Input - Invalidate
Project Cache Output - List
Builds ForProject Input - List
Builds ForProject Output - List
Builds Input - List
Builds Output - List
Curated Environment Images Input - List
Curated Environment Images Output - List
Projects Input - List
Projects Output - List
Report Groups Input - List
Report Groups Output - List
Reports ForReport Group Input - List
Reports ForReport Group Output - List
Reports Input - List
Reports Output - List
Shared Projects Input - List
Shared Projects Output - List
Shared Report Groups Input - List
Shared Report Groups Output - List
Source Credentials Input - List
Source Credentials Output - Logs
Config Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.
- Logs
Location Information about build logs in Amazon CloudWatch Logs.
- Network
Interface Describes a network interface.
- Phase
Context Additional information about a build phase that has an error. You can use this information for troubleshooting.
- Project
Information about a build project.
- Project
Artifacts Information about the build output artifacts for the build project.
- Project
Badge Information about the build badge for the build project.
- Project
Cache Information about the cache for the build project.
- Project
Environment Information about the build environment of the build project.
- Project
File System Location Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
- Project
Source Information about the build input source code for the build project.
- Project
Source Version A source identifier and its corresponding version.
- PutResource
Policy Input - PutResource
Policy Output - Registry
Credential Information about credentials that provide access to a private Docker registry. When this is set:
-
imagePullCredentialsType
must be set toSERVICE_ROLE
. -
images cannot be curated or an Amazon ECR image.
For more information, see Private Registry with AWS Secrets Manager Sample for AWS CodeBuild.
-
- Report
Information about the results from running a series of test cases during the run of a build project. The test cases are specified in the buildspec for the build project using one or more paths to the test case files. You can specify any type of tests you want, such as unit tests, integration tests, and functional tests.
- Report
Export Config Information about the location where the run of a report is exported.
- Report
Filter A filter used to return reports with the status specified by the input
status
parameter.- Report
Group A series of reports. Each report contains information about the results from running a series of test cases. You specify the test cases for a report group in the buildspec for a build project using one or more paths to the test case files.
- S3Logs
Config Information about S3 logs for a build project.
- S3Report
Export Config Information about the S3 bucket where the raw data of a report are exported.
- Source
Auth Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.
- Source
Credentials Info Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
- Start
Build Input - Start
Build Output - Stop
Build Input - Stop
Build Output - Tag
A tag, consisting of a key and a value.
This tag is available for use by AWS services that support tags in AWS CodeBuild.
- Test
Case Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.
- Test
Case Filter A filter used to return specific types of test cases.
- Test
Report Summary Information about a test report.
- Update
Project Input - Update
Project Output - Update
Report Group Input - Update
Report Group Output - Update
Webhook Input - Update
Webhook Output - VpcConfig
Information about the VPC configuration that AWS CodeBuild accesses.
- Webhook
Information about a webhook that connects repository events to a build project in AWS CodeBuild.
- Webhook
Filter A filter used to determine which webhooks trigger a build.
Enums§
- Batch
Delete Builds Error - Errors returned by BatchDeleteBuilds
- Batch
GetBuilds Error - Errors returned by BatchGetBuilds
- Batch
GetProjects Error - Errors returned by BatchGetProjects
- Batch
GetReport Groups Error - Errors returned by BatchGetReportGroups
- Batch
GetReports Error - Errors returned by BatchGetReports
- Create
Project Error - Errors returned by CreateProject
- Create
Report Group Error - Errors returned by CreateReportGroup
- Create
Webhook Error - Errors returned by CreateWebhook
- Delete
Project Error - Errors returned by DeleteProject
- Delete
Report Error - Errors returned by DeleteReport
- Delete
Report Group Error - Errors returned by DeleteReportGroup
- Delete
Resource Policy Error - Errors returned by DeleteResourcePolicy
- Delete
Source Credentials Error - Errors returned by DeleteSourceCredentials
- Delete
Webhook Error - Errors returned by DeleteWebhook
- Describe
Test Cases Error - Errors returned by DescribeTestCases
- GetResource
Policy Error - Errors returned by GetResourcePolicy
- Import
Source Credentials Error - Errors returned by ImportSourceCredentials
- Invalidate
Project Cache Error - Errors returned by InvalidateProjectCache
- List
Builds Error - Errors returned by ListBuilds
- List
Builds ForProject Error - Errors returned by ListBuildsForProject
- List
Curated Environment Images Error - Errors returned by ListCuratedEnvironmentImages
- List
Projects Error - Errors returned by ListProjects
- List
Report Groups Error - Errors returned by ListReportGroups
- List
Reports Error - Errors returned by ListReports
- List
Reports ForReport Group Error - Errors returned by ListReportsForReportGroup
- List
Shared Projects Error - Errors returned by ListSharedProjects
- List
Shared Report Groups Error - Errors returned by ListSharedReportGroups
- List
Source Credentials Error - Errors returned by ListSourceCredentials
- PutResource
Policy Error - Errors returned by PutResourcePolicy
- Start
Build Error - Errors returned by StartBuild
- Stop
Build Error - Errors returned by StopBuild
- Update
Project Error - Errors returned by UpdateProject
- Update
Report Group Error - Errors returned by UpdateReportGroup
- Update
Webhook Error - Errors returned by UpdateWebhook
Traits§
- Code
Build - Trait representing the capabilities of the AWS CodeBuild API. AWS CodeBuild clients implement this trait.