AWS CodeBuild AWS CodeBuild #X Amz Target=CodeBuild… API is one of 11 APIs that AWS CodeBuild publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include AWS CodeBuild #X Amz Target=CodeBuild…. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
38 operations
across 38 paths,
and defines 232 schemas.
It is described by OpenAPI 3.2.0, at version 2016-10-06.
Requests are made against 4 base URLs: http://codebuild.{region}.amazonaws.com, https://codebuild.{region}.amazonaws.com, http://codebuild.{region}.amazonaws.com.cn, https://codebuild.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
BatchDeleteBuildsInput
object
1 property
1 required
BuildNotDeleted
object
Information about a build that could not be successfully deleted.
2 properties
BatchDeleteBuildsOutput
object
2 properties
BatchReportModeType
string
ProjectFileSystemLocation
object
Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?
5 properties
BuildArtifacts
object
Information about build output artifacts.
7 properties
BuildBatchPhase
object
Contains information about a stage for a batch build.
6 properties
GitSubmodulesConfig
object
Information about the Git submodules configuration for an CodeBuild build project.
1 property
1 required
ImagePullCredentialsType
string
BucketOwnerAccess
string
Specifies the bucket owner's access for objects that another account uploads to their Amazon S3 bucket. By default, only the account that uploads the objects t…
ResolvedSecondaryArtifacts
array
BuildGroup
object
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 dependenc…
5 properties
ProjectEnvironment
object
Information about the build environment of the build project.
8 properties
3 required
CloudWatchLogsConfig
object
Information about CloudWatch Logs for a build project.
3 properties
1 required
CredentialProviderType
string
SourceAuth
object
Information about the authorization settings for CodeBuild to access the source code to be built. This information is for the CodeBuild console's use only. You…
2 properties
1 required
ProjectFileSystemLocations
array
ComputeTypesAllowed
array
BuildBatch
object
Contains information about a batch build.
30 properties
BuildSummary
object
Contains summary information about a batch build group.
5 properties
EnvironmentVariable
object
Information about an environment variable for a build project or a build.
3 properties
2 required
BuildStatusConfig
object
Contains information that defines how the CodeBuild build project reports the build status to the source provider.
2 properties
RegistryCredential
object
Information about credentials that provide access to a private Docker registry. When this is set: imagePullCredentialsType must be set to SERVICEROLE . images…
2 properties
2 required
ResolvedArtifact
object
Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.
3 properties
ProjectSourceVersion
object
A source identifier and its corresponding version.
2 properties
2 required
ProjectCache
object
Information about the cache for the build project.
3 properties
1 required
ProjectSecondarySourceVersions
array
LogsConfig
object
Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.
2 properties
S3LogsConfig
object
Information about S3 logs for a build project.
4 properties
1 required
BatchGetBuildBatchesInput
object
1 property
1 required
BuildBatchPhaseType
string
LogsConfigStatusType
string
BatchRestrictions
object
Specifies restrictions for the batch build.
2 properties
BatchGetBuildBatchesOutput
object
2 properties
PhaseContext
object
Additional information about a build phase that has an error. You can use this information for troubleshooting.
2 properties
EnvironmentVariables
array
ProjectBuildBatchConfig
object
Contains configuration information about a batch build project.
5 properties
EnvironmentVariableType
string
VpcConfig
object
Information about the VPC configuration that CodeBuild accesses.
3 properties
ProjectSource
object
Information about the build input source code for the build project.
10 properties
1 required
Build
object
Information about a build.
32 properties
BatchGetBuildsOutput
object
2 properties
BatchGetBuildsInput
object
1 property
1 required
DebugSession
object
Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager .
2 properties
ExportedEnvironmentVariables
array
BuildPhase
object
Information about a stage for a build.
6 properties
ExportedEnvironmentVariable
object
Contains information about an exported environment variable. Exported environment variables are used in conjunction with CodePipeline to export environment var…
2 properties
LogsLocation
object
Information about build logs in CloudWatch Logs.
8 properties
NetworkInterface
object
Describes a network interface.
2 properties
ProjectArtifacts
object
Information about the build output artifacts for the build project.
10 properties
1 required
ProjectVisibilityType
string
Specifies the visibility of the project's builds. Possible values are: PUBLICREAD The project builds are visible to the public. PRIVATE The project builds are…
WebhookFilter
object
A filter used to determine which webhooks trigger a build.
3 properties
2 required
ProjectBadge
object
Information about the build badge for the build project.
2 properties
BatchGetProjectsInput
object
1 property
1 required
Tag
object
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.
2 properties
ProjectArtifactsList
array
Project
object
Information about a build project.
28 properties
BatchGetProjectsOutput
object
2 properties
Webhook
object
Information about a webhook that connects repository events to a build project in CodeBuild.
7 properties
ProjectDescription
string
BatchGetReportGroupsInput
object
1 property
1 required
S3ReportExportConfig
object
Information about the S3 bucket where the raw data of a report are exported.
6 properties
ReportGroupStatusType
string
BatchGetReportGroupsOutput
object
2 properties
ReportPackagingType
string
ReportExportConfigType
string
ReportExportConfig
object
Information about the location where the run of a report is exported.
2 properties
ReportGroup
object
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 t…
8 properties
ReportStatusCounts
object
Report
object
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 buil…
12 properties
CodeCoverageReportSummary
object
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 c…
6 properties
BatchGetReportsOutput
object
2 properties
TestReportSummary
object
Information about a test report.
3 properties
3 required
BatchGetReportsInput
object
1 property
1 required
AccountLimitExceededException
ResourceAlreadyExistsException
CreateProjectOutput
object
1 property
CreateProjectInput
object
21 properties
5 required
CreateReportGroupOutput
object
1 property
CreateReportGroupInput
object
4 properties
3 required
CreateWebhookOutput
object
1 property
ResourceNotFoundException
CreateWebhookInput
object
4 properties
1 required
DeleteBuildBatchOutput
object
3 properties
DeleteBuildBatchInput
object
1 property
1 required
DeleteProjectOutput
object
DeleteProjectInput
object
1 property
1 required
DeleteReportGroupOutput
object
DeleteReportGroupInput
object
2 properties
1 required
DeleteResourcePolicyOutput
object
DeleteResourcePolicyInput
object
1 property
1 required
DeleteSourceCredentialsOutput
object
1 property
DeleteSourceCredentialsInput
object
1 property
1 required
DeleteWebhookInput
object
1 property
1 required
DeleteWebhookOutput
object
DescribeCodeCoveragesOutput
object
2 properties
DescribeCodeCoveragesInput
object
7 properties
1 required
CodeCoverage
object
Contains code coverage report information. Line coverage measures how many statements your tests cover. A statement is a single instruction, not including comm…
10 properties
ReportCodeCoverageSortByType
string
TestCase
object
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.
8 properties
TestCaseFilter
object
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.
2 properties
DescribeTestCasesOutput
object
2 properties
DescribeTestCasesInput
object
4 properties
1 required
GetReportGroupTrendInput
object
3 properties
2 required
GetReportGroupTrendOutput
object
2 properties
ReportGroupTrendStats
object
Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .
3 properties
ReportWithRawData
object
Contains the unmodified data for the report. For more information, see .
2 properties
ReportGroupTrendFieldType
string
ReportGroupTrendRawDataList
array
GetResourcePolicyOutput
object
1 property
GetResourcePolicyInput
object
1 property
1 required
SensitiveNonEmptyString
string
ImportSourceCredentialsOutput
object
1 property
ImportSourceCredentialsInput
object
5 properties
3 required
InvalidateProjectCacheOutput
object
InvalidateProjectCacheInput
object
1 property
1 required
ListBuildBatchesInput
object
4 properties
BuildBatchFilter
object
Specifies filters when retrieving batch builds.
1 property
ListBuildBatchesOutput
object
2 properties
ListBuildBatchesForProjectOutput
object
2 properties
ListBuildBatchesForProjectInput
object
5 properties
ListBuildsForProjectInput
object
3 properties
1 required
ListBuildsForProjectOutput
object
2 properties
EnvironmentLanguage
object
A set of Docker images that are related by programming language and are managed by CodeBuild.
2 properties
EnvironmentPlatform
object
A set of Docker images that are related by platform and are managed by CodeBuild.
2 properties
ListCuratedEnvironmentImagesOutput
object
1 property
ListCuratedEnvironmentImagesInput
object
EnvironmentLanguages
array
EnvironmentImage
object
Information about a Docker image that is managed by CodeBuild.
3 properties
EnvironmentPlatforms
array
ListReportGroupsInput
object
4 properties
ReportGroupSortByType
string
ListReportGroupsOutput
object
2 properties
ListReportsForReportGroupOutput
object
2 properties
ReportFilter
object
A filter used to return reports with the status specified by the input status parameter.
1 property
ListReportsForReportGroupInput
object
5 properties
1 required
SharedResourceSortByType
string
ListSharedProjectsOutput
object
2 properties
ListSharedProjectsInput
object
4 properties
ListSharedReportGroupsOutput
object
2 properties
ListSharedReportGroupsInput
object
4 properties
ListSourceCredentialsInput
object
SourceCredentialsInfos
array
ListSourceCredentialsOutput
object
1 property
SourceCredentialsInfo
object
Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.
3 properties
PutResourcePolicyOutput
object
1 property
PutResourcePolicyInput
object
2 properties
2 required
RetryBuildBatchInput
object
2 properties
RetryBuildBatchType
string
RetryBuildBatchOutput
object
1 property
StartBuildBatchInput
object
30 properties
1 required
StartBuildBatchOutput
object
1 property
StopBuildBatchInput
object
1 property
1 required
StopBuildBatchOutput
object
1 property
UpdateProjectInput
object
21 properties
1 required
UpdateProjectOutput
object
1 property
UpdateProjectVisibilityInput
object
3 properties
2 required
UpdateProjectVisibilityOutput
object
3 properties
UpdateReportGroupInput
object
3 properties
1 required
UpdateReportGroupOutput
object
1 property
UpdateWebhookInput
object
5 properties
1 required
UpdateWebhookOutput
object
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AWS CodeBuild publishes across the network.