AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
![]() |
AccountLimitExceededException |
An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account. |
![]() |
AutoRetryConfig |
Information about the auto-retry configuration for the build. |
![]() |
BatchDeleteBuildsRequest |
Container for the parameters to the BatchDeleteBuilds operation. Deletes one or more builds. |
![]() |
BatchDeleteBuildsResponse |
This is the response object from the BatchDeleteBuilds operation. |
![]() |
BatchGetBuildBatchesRequest |
Container for the parameters to the BatchGetBuildBatches operation. Retrieves information about one or more batch builds. |
![]() |
BatchGetBuildBatchesResponse |
This is the response object from the BatchGetBuildBatches operation. |
![]() |
BatchGetBuildsRequest |
Container for the parameters to the BatchGetBuilds operation. Gets information about one or more builds. |
![]() |
BatchGetBuildsResponse |
This is the response object from the BatchGetBuilds operation. |
![]() |
BatchGetFleetsRequest |
Container for the parameters to the BatchGetFleets operation. Gets information about one or more compute fleets. |
![]() |
BatchGetFleetsResponse |
This is the response object from the BatchGetFleets operation. |
![]() |
BatchGetProjectsRequest |
Container for the parameters to the BatchGetProjects operation. Gets information about one or more build projects. |
![]() |
BatchGetProjectsResponse |
This is the response object from the BatchGetProjects operation. |
![]() |
BatchGetReportGroupsRequest |
Container for the parameters to the BatchGetReportGroups operation. Returns an array of report groups. |
![]() |
BatchGetReportGroupsResponse |
This is the response object from the BatchGetReportGroups operation. |
![]() |
BatchGetReportsRequest |
Container for the parameters to the BatchGetReports operation. Returns an array of reports. |
![]() |
BatchGetReportsResponse |
This is the response object from the BatchGetReports operation. |
![]() |
BatchRestrictions |
Specifies restrictions for the batch build. |
![]() |
Build |
Information about a build. |
![]() |
BuildArtifacts |
Information about build output artifacts. |
![]() |
BuildBatch |
Contains information about a batch build. |
![]() |
BuildBatchFilter |
Specifies filters when retrieving batch builds. |
![]() |
BuildBatchPhase |
Contains information about a stage for a batch build. |
![]() |
BuildGroup |
Contains information about a batch build build group. Build groups are used to combine builds that can run in parallel, while still being able to set dependencies on other build groups. |
![]() |
BuildNotDeleted |
Information about a build that could not be successfully deleted. |
![]() |
BuildPhase |
Information about a stage for a build. |
![]() |
BuildStatusConfig |
Contains information that defines how the CodeBuild build project reports the build status to the source provider. |
![]() |
BuildSummary |
Contains summary information about a batch build group. |
![]() |
CloudWatchLogsConfig |
Information about CloudWatch Logs for a build project. |
![]() |
CodeBuildPaginatorFactory |
Paginators for the CodeBuild service |
![]() |
CodeCoverage |
Contains code coverage report information. Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control
structure, such as an |
![]() |
CodeCoverageReportSummary |
Contains a summary of a code coverage report. Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comments, conditionals, etc.
Branch coverage determines if your tests cover every possible branch of a control
structure, such as an |
![]() |
ComputeConfiguration |
Contains compute attributes. These attributes only need be specified when your project's
or fleet's |
![]() |
CreateFleetRequest |
Container for the parameters to the CreateFleet operation. Creates a compute fleet. |
![]() |
CreateFleetResponse |
This is the response object from the CreateFleet operation. |
![]() |
CreateProjectRequest |
Container for the parameters to the CreateProject operation. Creates a build project. |
![]() |
CreateProjectResponse |
This is the response object from the CreateProject operation. |
![]() |
CreateReportGroupRequest |
Container for the parameters to the CreateReportGroup operation. Creates a report group. A report group contains a collection of reports. |
![]() |
CreateReportGroupResponse |
This is the response object from the CreateReportGroup operation. |
![]() |
CreateWebhookRequest |
Container for the parameters to the CreateWebhook operation.
For an existing CodeBuild build project that has its source code stored in a GitHub
or Bitbucket repository, enables CodeBuild to start rebuilding the source code every
time a code change is pushed to the repository.
If you enable webhooks for an CodeBuild project, and the project is used as a build
step in CodePipeline, then two identical builds are created for each commit. One build
is triggered through webhooks, and one through CodePipeline. Because billing is on
a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline,
we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear
the Webhook box. For more information, see step 5 in Change
a Build Project's Settings.
|
![]() |
CreateWebhookResponse |
This is the response object from the CreateWebhook operation. |
![]() |
DebugSession |
Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager. |
![]() |
DeleteBuildBatchRequest |
Container for the parameters to the DeleteBuildBatch operation. Deletes a batch build. |
![]() |
DeleteBuildBatchResponse |
This is the response object from the DeleteBuildBatch operation. |
![]() |
DeleteFleetRequest |
Container for the parameters to the DeleteFleet operation. Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted. |
![]() |
DeleteFleetResponse |
This is the response object from the DeleteFleet operation. |
![]() |
DeleteProjectRequest |
Container for the parameters to the DeleteProject operation. Deletes a build project. When you delete a project, its builds are not deleted. |
![]() |
DeleteProjectResponse |
This is the response object from the DeleteProject operation. |
![]() |
DeleteReportGroupRequest |
Container for the parameters to the DeleteReportGroup operation. Deletes a report group. Before you delete a report group, you must delete its reports. |
![]() |
DeleteReportGroupResponse |
This is the response object from the DeleteReportGroup operation. |
![]() |
DeleteReportRequest |
Container for the parameters to the DeleteReport operation. Deletes a report. |
![]() |
DeleteReportResponse |
This is the response object from the DeleteReport operation. |
![]() |
DeleteResourcePolicyRequest |
Container for the parameters to the DeleteResourcePolicy operation. Deletes a resource policy that is identified by its resource ARN. |
![]() |
DeleteResourcePolicyResponse |
This is the response object from the DeleteResourcePolicy operation. |
![]() |
DeleteSourceCredentialsRequest |
Container for the parameters to the DeleteSourceCredentials operation. Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. |
![]() |
DeleteSourceCredentialsResponse |
This is the response object from the DeleteSourceCredentials operation. |
![]() |
DeleteWebhookRequest |
Container for the parameters to the DeleteWebhook operation. For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. |
![]() |
DeleteWebhookResponse |
This is the response object from the DeleteWebhook operation. |
![]() |
DescribeCodeCoveragesRequest |
Container for the parameters to the DescribeCodeCoverages operation. Retrieves one or more code coverage reports. |
![]() |
DescribeCodeCoveragesResponse |
This is the response object from the DescribeCodeCoverages operation. |
![]() |
DescribeTestCasesRequest |
Container for the parameters to the DescribeTestCases operation. Returns a list of details about test cases for a report. |
![]() |
DescribeTestCasesResponse |
This is the response object from the DescribeTestCases operation. |
![]() |
EnvironmentImage |
Information about a Docker image that is managed by CodeBuild. |
![]() |
EnvironmentLanguage |
A set of Docker images that are related by programming language and are managed by CodeBuild. |
![]() |
EnvironmentPlatform |
A set of Docker images that are related by platform and are managed by CodeBuild. |
![]() |
EnvironmentVariable |
Information about an environment variable for a build project or a build. |
![]() |
ExportedEnvironmentVariable |
Contains information about an exported environment variable. Exported environment variables are used in conjunction with CodePipeline to export environment variables from the current build stage to subsequent stages in the pipeline. For more information, see Working with variables in the CodePipeline User Guide.
During a build, the value of a variable is available starting with the |
![]() |
Fleet |
A set of dedicated instances for your build environment. |
![]() |
FleetProxyRule |
Information about the proxy rule for your reserved capacity instances. |
![]() |
FleetStatus |
The status of the compute fleet. |
![]() |
GetReportGroupTrendRequest |
Container for the parameters to the GetReportGroupTrend operation. Analyzes and accumulates test report values for the specified test reports. |
![]() |
GetReportGroupTrendResponse |
This is the response object from the GetReportGroupTrend operation. |
![]() |
GetResourcePolicyRequest |
Container for the parameters to the GetResourcePolicy operation. Gets a resource policy that is identified by its resource ARN. |
![]() |
GetResourcePolicyResponse |
This is the response object from the GetResourcePolicy operation. |
![]() |
GitSubmodulesConfig |
Information about the Git submodules configuration for an CodeBuild build project. |
![]() |
ImportSourceCredentialsRequest |
Container for the parameters to the ImportSourceCredentials operation. Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. |
![]() |
ImportSourceCredentialsResponse |
This is the response object from the ImportSourceCredentials operation. |
![]() |
InvalidateProjectCacheRequest |
Container for the parameters to the InvalidateProjectCache operation. Resets the cache for a project. |
![]() |
InvalidateProjectCacheResponse |
This is the response object from the InvalidateProjectCache operation. |
![]() |
InvalidInputException |
The input value that was provided is not valid. |
![]() |
ListBuildBatchesForProjectRequest |
Container for the parameters to the ListBuildBatchesForProject operation. Retrieves the identifiers of the build batches for a specific project. |
![]() |
ListBuildBatchesForProjectResponse |
This is the response object from the ListBuildBatchesForProject operation. |
![]() |
ListBuildBatchesRequest |
Container for the parameters to the ListBuildBatches operation. Retrieves the identifiers of your build batches in the current region. |
![]() |
ListBuildBatchesResponse |
This is the response object from the ListBuildBatches operation. |
![]() |
ListBuildsForProjectRequest |
Container for the parameters to the ListBuildsForProject operation. Gets a list of build identifiers for the specified build project, with each build identifier representing a single build. |
![]() |
ListBuildsForProjectResponse |
This is the response object from the ListBuildsForProject operation. |
![]() |
ListBuildsRequest |
Container for the parameters to the ListBuilds operation. Gets a list of build IDs, with each build ID representing a single build. |
![]() |
ListBuildsResponse |
This is the response object from the ListBuilds operation. |
![]() |
ListCuratedEnvironmentImagesRequest |
Container for the parameters to the ListCuratedEnvironmentImages operation. Gets information about Docker images that are managed by CodeBuild. |
![]() |
ListCuratedEnvironmentImagesResponse |
This is the response object from the ListCuratedEnvironmentImages operation. |
![]() |
ListFleetsRequest |
Container for the parameters to the ListFleets operation. Gets a list of compute fleet names with each compute fleet name representing a single compute fleet. |
![]() |
ListFleetsResponse |
This is the response object from the ListFleets operation. |
![]() |
ListProjectsRequest |
Container for the parameters to the ListProjects operation. Gets a list of build project names, with each build project name representing a single build project. |
![]() |
ListProjectsResponse |
This is the response object from the ListProjects operation. |
![]() |
ListReportGroupsRequest |
Container for the parameters to the ListReportGroups operation. Gets a list ARNs for the report groups in the current Amazon Web Services account. |
![]() |
ListReportGroupsResponse |
This is the response object from the ListReportGroups operation. |
![]() |
ListReportsForReportGroupRequest |
Container for the parameters to the ListReportsForReportGroup operation.
Returns a list of ARNs for the reports that belong to a |
![]() |
ListReportsForReportGroupResponse |
This is the response object from the ListReportsForReportGroup operation. |
![]() |
ListReportsRequest |
Container for the parameters to the ListReports operation. Returns a list of ARNs for the reports in the current Amazon Web Services account. |
![]() |
ListReportsResponse |
This is the response object from the ListReports operation. |
![]() |
ListSharedProjectsRequest |
Container for the parameters to the ListSharedProjects operation. Gets a list of projects that are shared with other Amazon Web Services accounts or users. |
![]() |
ListSharedProjectsResponse |
This is the response object from the ListSharedProjects operation. |
![]() |
ListSharedReportGroupsRequest |
Container for the parameters to the ListSharedReportGroups operation. Gets a list of report groups that are shared with other Amazon Web Services accounts or users. |
![]() |
ListSharedReportGroupsResponse |
This is the response object from the ListSharedReportGroups operation. |
![]() |
ListSourceCredentialsRequest |
Container for the parameters to the ListSourceCredentials operation.
Returns a list of |
![]() |
ListSourceCredentialsResponse |
This is the response object from the ListSourceCredentials operation. |
![]() |
LogsConfig |
Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both. |
![]() |
LogsLocation |
Information about build logs in CloudWatch Logs. |
![]() |
NetworkInterface |
Describes a network interface. |
![]() |
OAuthProviderException |
There was a problem with the underlying OAuth provider. |
![]() |
PhaseContext |
Additional information about a build phase that has an error. You can use this information for troubleshooting. |
![]() |
Project |
Information about a build project. |
![]() |
ProjectArtifacts |
Information about the build output artifacts for the build project. |
![]() |
ProjectBadge |
Information about the build badge for the build project. |
![]() |
ProjectBuildBatchConfig |
Contains configuration information about a batch build project. |
![]() |
ProjectCache |
Information about the cache for the build project. |
![]() |
ProjectEnvironment |
Information about the build environment of the build project. |
![]() |
ProjectFileSystemLocation |
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System? |
![]() |
ProjectFleet |
Information about the compute fleet of the build project. For more information, see Working with reserved capacity in CodeBuild. |
![]() |
ProjectSource |
Information about the build input source code for the build project. |
![]() |
ProjectSourceVersion |
A source identifier and its corresponding version. |
![]() |
ProxyConfiguration |
Information about the proxy configurations that apply network access control to your reserved capacity instances. |
![]() |
PutResourcePolicyRequest |
Container for the parameters to the PutResourcePolicy operation.
Stores a resource policy for the ARN of a |
![]() |
PutResourcePolicyResponse |
This is the response object from the PutResourcePolicy operation. |
![]() |
RegistryCredential |
Information about credentials that provide access to a private Docker registry. When this is set:
For more information, see Private Registry with Secrets Manager Sample for 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. |
![]() |
ReportExportConfig |
Information about the location where the run of a report is exported. |
![]() |
ReportFilter |
A filter used to return reports with the status specified by the input |
![]() |
ReportGroup |
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. |
![]() |
ReportGroupTrendStats |
Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see . |
![]() |
ReportWithRawData |
Contains the unmodified data for the report. For more information, see . |
![]() |
ResolvedArtifact |
Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3. |
![]() |
ResourceAlreadyExistsException |
The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists. |
![]() |
ResourceNotFoundException |
The specified Amazon Web Services resource cannot be found. |
![]() |
RetryBuildBatchRequest |
Container for the parameters to the RetryBuildBatch operation. Restarts a failed batch build. Only batch builds that have failed can be retried. |
![]() |
RetryBuildBatchResponse |
This is the response object from the RetryBuildBatch operation. |
![]() |
RetryBuildRequest |
Container for the parameters to the RetryBuild operation. Restarts a build. |
![]() |
RetryBuildResponse |
This is the response object from the RetryBuild operation. |
![]() |
S3LogsConfig |
Information about S3 logs for a build project. |
![]() |
S3ReportExportConfig |
Information about the S3 bucket where the raw data of a report are exported. |
![]() |
ScalingConfigurationInput |
The scaling configuration input of a compute fleet. |
![]() |
ScalingConfigurationOutput |
The scaling configuration output of a compute fleet. |
![]() |
ScopeConfiguration |
Contains configuration information about the scope for a webhook. |
![]() |
SourceAuth |
Information about the authorization settings for CodeBuild to access the source code to be built. |
![]() |
SourceCredentialsInfo |
Information about the credentials for a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. |
![]() |
StartBuildBatchRequest |
Container for the parameters to the StartBuildBatch operation. Starts a batch build for a project. |
![]() |
StartBuildBatchResponse |
This is the response object from the StartBuildBatch operation. |
![]() |
StartBuildRequest |
Container for the parameters to the StartBuild operation. Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output. You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered. |
![]() |
StartBuildResponse |
This is the response object from the StartBuild operation. |
![]() |
StopBuildBatchRequest |
Container for the parameters to the StopBuildBatch operation. Stops a running batch build. |
![]() |
StopBuildBatchResponse |
This is the response object from the StopBuildBatch operation. |
![]() |
StopBuildRequest |
Container for the parameters to the StopBuild operation. Attempts to stop running a build. |
![]() |
StopBuildResponse |
This is the response object from the StopBuild operation. |
![]() |
Tag |
A tag, consisting of a key and a value. This tag is available for use by Amazon Web Services services that support tags in CodeBuild. |
![]() |
TargetTrackingScalingConfiguration |
Defines when a new instance is auto-scaled into the compute fleet. |
![]() |
TestCase |
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. |
![]() |
TestCaseFilter |
A filter used to return specific types of test cases. In order to pass the filter, the report must meet all of the filter properties. |
![]() |
TestReportSummary |
Information about a test report. |
![]() |
UpdateFleetRequest |
Container for the parameters to the UpdateFleet operation. Updates a compute fleet. |
![]() |
UpdateFleetResponse |
This is the response object from the UpdateFleet operation. |
![]() |
UpdateProjectRequest |
Container for the parameters to the UpdateProject operation. Changes the settings of a build project. |
![]() |
UpdateProjectResponse |
This is the response object from the UpdateProject operation. |
![]() |
UpdateProjectVisibilityRequest |
Container for the parameters to the UpdateProjectVisibility operation.
Changes the public visibility for a project. The project's build results, logs, and
artifacts are available to the general public. For more information, see Public
build projects in the CodeBuild User Guide.
The following should be kept in mind when making your projects public:
All of a project's build results, logs, and artifacts, including builds that were
run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source
code, and other sensitive information may have been output to the build logs and artifacts.
You must be careful about what information is output to the build logs. Some best
practice are:
Do not store sensitive values in environment variables. We recommend that you use
an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive
values.
Follow Best
practices for using webhooks in the CodeBuild User Guide to limit which
entities can trigger a build, and do not store the buildspec in the project itself,
to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend
that you review all pull requests to verify that the pull request is a legitimate
change. We also recommend that you validate any artifacts with their checksums to
make sure that the correct artifacts are being downloaded.
|
![]() |
UpdateProjectVisibilityResponse |
This is the response object from the UpdateProjectVisibility operation. |
![]() |
UpdateReportGroupRequest |
Container for the parameters to the UpdateReportGroup operation. Updates a report group. |
![]() |
UpdateReportGroupResponse |
This is the response object from the UpdateReportGroup operation. |
![]() |
UpdateWebhookRequest |
Container for the parameters to the UpdateWebhook operation.
Updates the webhook associated with an CodeBuild build project.
If you use Bitbucket for your repository, |
![]() |
UpdateWebhookResponse |
This is the response object from the UpdateWebhook operation. |
![]() |
VpcConfig |
Information about the VPC configuration that CodeBuild accesses. |
![]() |
Webhook |
Information about a webhook that connects repository events to a build project in CodeBuild. |
![]() |
WebhookFilter |
A filter used to determine which webhooks trigger a build. |
Name | Description | |
---|---|---|
![]() |
ICodeBuildPaginatorFactory |
Paginators for the CodeBuild service |
![]() |
IDescribeCodeCoveragesPaginator |
Paginator for the DescribeCodeCoverages operation |
![]() |
IDescribeTestCasesPaginator |
Paginator for the DescribeTestCases operation |
![]() |
IListBuildBatchesForProjectPaginator |
Paginator for the ListBuildBatchesForProject operation |
![]() |
IListBuildBatchesPaginator |
Paginator for the ListBuildBatches operation |
![]() |
IListBuildsForProjectPaginator |
Paginator for the ListBuildsForProject operation |
![]() |
IListBuildsPaginator |
Paginator for the ListBuilds operation |
![]() |
IListFleetsPaginator |
Paginator for the ListFleets operation |
![]() |
IListProjectsPaginator |
Paginator for the ListProjects operation |
![]() |
IListReportGroupsPaginator |
Paginator for the ListReportGroups operation |
![]() |
IListReportsForReportGroupPaginator |
Paginator for the ListReportsForReportGroup operation |
![]() |
IListReportsPaginator |
Paginator for the ListReports operation |
![]() |
IListSharedProjectsPaginator |
Paginator for the ListSharedProjects operation |
![]() |
IListSharedReportGroupsPaginator |
Paginator for the ListSharedReportGroups operation |