AWS SDK Version 3 for .NET
API Reference

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.

Classes

NameDescription
Class AccountLimitExceededException

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

Class BatchDeleteBuildsRequest

Container for the parameters to the BatchDeleteBuilds operation. Deletes one or more builds.

Class BatchDeleteBuildsResponse

This is the response object from the BatchDeleteBuilds operation.

Class BatchGetBuildBatchesRequest

Container for the parameters to the BatchGetBuildBatches operation. Retrieves information about one or more batch builds.

Class BatchGetBuildBatchesResponse

This is the response object from the BatchGetBuildBatches operation.

Class BatchGetBuildsRequest

Container for the parameters to the BatchGetBuilds operation. Gets information about one or more builds.

Class BatchGetBuildsResponse

This is the response object from the BatchGetBuilds operation.

Class BatchGetFleetsRequest

Container for the parameters to the BatchGetFleets operation. Gets information about one or more compute fleets.

Class BatchGetFleetsResponse

This is the response object from the BatchGetFleets operation.

Class BatchGetProjectsRequest

Container for the parameters to the BatchGetProjects operation. Gets information about one or more build projects.

Class BatchGetProjectsResponse

This is the response object from the BatchGetProjects operation.

Class BatchGetReportGroupsRequest

Container for the parameters to the BatchGetReportGroups operation. Returns an array of report groups.

Class BatchGetReportGroupsResponse

This is the response object from the BatchGetReportGroups operation.

Class BatchGetReportsRequest

Container for the parameters to the BatchGetReports operation. Returns an array of reports.

Class BatchGetReportsResponse

This is the response object from the BatchGetReports operation.

Class BatchRestrictions

Specifies restrictions for the batch build.

Class Build

Information about a build.

Class BuildArtifacts

Information about build output artifacts.

Class BuildBatch

Contains information about a batch build.

Class BuildBatchFilter

Specifies filters when retrieving batch builds.

Class BuildBatchPhase

Contains information about a stage for a batch build.

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

Class BuildNotDeleted

Information about a build that could not be successfully deleted.

Class BuildPhase

Information about a stage for a build.

Class BuildStatusConfig

Contains information that defines how the CodeBuild build project reports the build status to the source provider.

Class BuildSummary

Contains summary information about a batch build group.

Class CloudWatchLogsConfig

Information about CloudWatch Logs for a build project.

Class CodeBuildPaginatorFactory

Paginators for the CodeBuild service

Class 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 if or case statement.

Class 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 if or case statement.

Class CreateFleetRequest

Container for the parameters to the CreateFleet operation. Creates a compute fleet.

Class CreateFleetResponse

This is the response object from the CreateFleet operation.

Class CreateProjectRequest

Container for the parameters to the CreateProject operation. Creates a build project.

Class CreateProjectResponse

This is the response object from the CreateProject operation.

Class CreateReportGroupRequest

Container for the parameters to the CreateReportGroup operation. Creates a report group. A report group contains a collection of reports.

Class CreateReportGroupResponse

This is the response object from the CreateReportGroup operation.

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

Class CreateWebhookResponse

This is the response object from the CreateWebhook operation.

Class DebugSession

Contains information about the debug session for a build. For more information, see Viewing a running build in Session Manager.

Class DeleteBuildBatchRequest

Container for the parameters to the DeleteBuildBatch operation. Deletes a batch build.

Class DeleteBuildBatchResponse

This is the response object from the DeleteBuildBatch operation.

Class DeleteFleetRequest

Container for the parameters to the DeleteFleet operation. Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

Class DeleteFleetResponse

This is the response object from the DeleteFleet operation.

Class DeleteProjectRequest

Container for the parameters to the DeleteProject operation. Deletes a build project. When you delete a project, its builds are not deleted.

Class DeleteProjectResponse

This is the response object from the DeleteProject operation.

Class DeleteReportGroupRequest

Container for the parameters to the DeleteReportGroup operation. Deletes a report group. Before you delete a report group, you must delete its reports.

Class DeleteReportGroupResponse

This is the response object from the DeleteReportGroup operation.

Class DeleteReportRequest

Container for the parameters to the DeleteReport operation. Deletes a report.

Class DeleteReportResponse

This is the response object from the DeleteReport operation.

Class DeleteResourcePolicyRequest

Container for the parameters to the DeleteResourcePolicy operation. Deletes a resource policy that is identified by its resource ARN.

Class DeleteResourcePolicyResponse

This is the response object from the DeleteResourcePolicy operation.

Class DeleteSourceCredentialsRequest

Container for the parameters to the DeleteSourceCredentials operation. Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

Class DeleteSourceCredentialsResponse

This is the response object from the DeleteSourceCredentials operation.

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

Class DeleteWebhookResponse

This is the response object from the DeleteWebhook operation.

Class DescribeCodeCoveragesRequest

Container for the parameters to the DescribeCodeCoverages operation. Retrieves one or more code coverage reports.

Class DescribeCodeCoveragesResponse

This is the response object from the DescribeCodeCoverages operation.

Class DescribeTestCasesRequest

Container for the parameters to the DescribeTestCases operation. Returns a list of details about test cases for a report.

Class DescribeTestCasesResponse

This is the response object from the DescribeTestCases operation.

Class EnvironmentImage

Information about a Docker image that is managed by CodeBuild.

Class EnvironmentLanguage

A set of Docker images that are related by programming language and are managed by CodeBuild.

Class EnvironmentPlatform

A set of Docker images that are related by platform and are managed by CodeBuild.

Class EnvironmentVariable

Information about an environment variable for a build project or a build.

Class 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 install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.

Class Fleet

A set of dedicated instances for your build environment.

Class FleetStatus

The status of the compute fleet.

Class GetReportGroupTrendRequest

Container for the parameters to the GetReportGroupTrend operation. Analyzes and accumulates test report values for the specified test reports.

Class GetReportGroupTrendResponse

This is the response object from the GetReportGroupTrend operation.

Class GetResourcePolicyRequest

Container for the parameters to the GetResourcePolicy operation. Gets a resource policy that is identified by its resource ARN.

Class GetResourcePolicyResponse

This is the response object from the GetResourcePolicy operation.

Class GitSubmodulesConfig

Information about the Git submodules configuration for an CodeBuild build project.

Class 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, or Bitbucket repository.

Class ImportSourceCredentialsResponse

This is the response object from the ImportSourceCredentials operation.

Class InvalidateProjectCacheRequest

Container for the parameters to the InvalidateProjectCache operation. Resets the cache for a project.

Class InvalidateProjectCacheResponse

This is the response object from the InvalidateProjectCache operation.

Class InvalidInputException

The input value that was provided is not valid.

Class ListBuildBatchesForProjectRequest

Container for the parameters to the ListBuildBatchesForProject operation. Retrieves the identifiers of the build batches for a specific project.

Class ListBuildBatchesForProjectResponse

This is the response object from the ListBuildBatchesForProject operation.

Class ListBuildBatchesRequest

Container for the parameters to the ListBuildBatches operation. Retrieves the identifiers of your build batches in the current region.

Class ListBuildBatchesResponse

This is the response object from the ListBuildBatches operation.

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

Class ListBuildsForProjectResponse

This is the response object from the ListBuildsForProject operation.

Class ListBuildsRequest

Container for the parameters to the ListBuilds operation. Gets a list of build IDs, with each build ID representing a single build.

Class ListBuildsResponse

This is the response object from the ListBuilds operation.

Class ListCuratedEnvironmentImagesRequest

Container for the parameters to the ListCuratedEnvironmentImages operation. Gets information about Docker images that are managed by CodeBuild.

Class ListCuratedEnvironmentImagesResponse

This is the response object from the ListCuratedEnvironmentImages operation.

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

Class ListFleetsResponse

This is the response object from the ListFleets operation.

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

Class ListProjectsResponse

This is the response object from the ListProjects operation.

Class ListReportGroupsRequest

Container for the parameters to the ListReportGroups operation. Gets a list ARNs for the report groups in the current Amazon Web Services account.

Class ListReportGroupsResponse

This is the response object from the ListReportGroups operation.

Class ListReportsForReportGroupRequest

Container for the parameters to the ListReportsForReportGroup operation. Returns a list of ARNs for the reports that belong to a ReportGroup.

Class ListReportsForReportGroupResponse

This is the response object from the ListReportsForReportGroup operation.

Class ListReportsRequest

Container for the parameters to the ListReports operation. Returns a list of ARNs for the reports in the current Amazon Web Services account.

Class ListReportsResponse

This is the response object from the ListReports operation.

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

Class ListSharedProjectsResponse

This is the response object from the ListSharedProjects operation.

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

Class ListSharedReportGroupsResponse

This is the response object from the ListSharedReportGroups operation.

Class ListSourceCredentialsRequest

Container for the parameters to the ListSourceCredentials operation. Returns a list of SourceCredentialsInfo objects.

Class ListSourceCredentialsResponse

This is the response object from the ListSourceCredentials operation.

Class LogsConfig

Information about logs for a build project. These can be logs in CloudWatch Logs, built in a specified S3 bucket, or both.

Class LogsLocation

Information about build logs in CloudWatch Logs.

Class NetworkInterface

Describes a network interface.

Class OAuthProviderException

There was a problem with the underlying OAuth provider.

Class PhaseContext

Additional information about a build phase that has an error. You can use this information for troubleshooting.

Class Project

Information about a build project.

Class ProjectArtifacts

Information about the build output artifacts for the build project.

Class ProjectBadge

Information about the build badge for the build project.

Class ProjectBuildBatchConfig

Contains configuration information about a batch build project.

Class ProjectCache

Information about the cache for the build project.

Class ProjectEnvironment

Information about the build environment of the build project.

Class ProjectFileSystemLocation

Information about a file system created by Amazon Elastic File System (EFS). For more information, see What Is Amazon Elastic File System?

Class ProjectFleet

Information about the compute fleet of the build project. For more information, see Working with reserved capacity in CodeBuild.

Class ProjectSource

Information about the build input source code for the build project.

Class ProjectSourceVersion

A source identifier and its corresponding version.

Class PutResourcePolicyRequest

Container for the parameters to the PutResourcePolicy operation. Stores a resource policy for the ARN of a Project or ReportGroup object.

Class PutResourcePolicyResponse

This is the response object from the PutResourcePolicy operation.

Class RegistryCredential

Information about credentials that provide access to a private Docker registry. When this is set:

  • imagePullCredentialsType must be set to SERVICE_ROLE.

  • images cannot be curated or an Amazon ECR image.

For more information, see Private Registry with Secrets Manager Sample for CodeBuild.

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

Class ReportExportConfig

Information about the location where the run of a report is exported.

Class ReportFilter

A filter used to return reports with the status specified by the input status parameter.

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

Class ReportGroupTrendStats

Contains trend statistics for a set of reports. The actual values depend on the type of trend being collected. For more information, see .

Class ReportWithRawData

Contains the unmodified data for the report. For more information, see .

Class ResolvedArtifact

Represents a resolved build artifact. A resolved artifact is an artifact that is built and deployed to the destination, such as Amazon S3.

Class ResourceAlreadyExistsException

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

Class ResourceNotFoundException

The specified Amazon Web Services resource cannot be found.

Class RetryBuildBatchRequest

Container for the parameters to the RetryBuildBatch operation. Restarts a failed batch build. Only batch builds that have failed can be retried.

Class RetryBuildBatchResponse

This is the response object from the RetryBuildBatch operation.

Class RetryBuildRequest

Container for the parameters to the RetryBuild operation. Restarts a build.

Class RetryBuildResponse

This is the response object from the RetryBuild operation.

Class S3LogsConfig

Information about S3 logs for a build project.

Class S3ReportExportConfig

Information about the S3 bucket where the raw data of a report are exported.

Class ScalingConfigurationInput

The scaling configuration input of a compute fleet.

Class ScalingConfigurationOutput

The scaling configuration output of a compute fleet.

Class SourceAuth

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. Your code should not get or set this information directly.

Class SourceCredentialsInfo

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

Class StartBuildBatchRequest

Container for the parameters to the StartBuildBatch operation. Starts a batch build for a project.

Class StartBuildBatchResponse

This is the response object from the StartBuildBatch operation.

Class StartBuildRequest

Container for the parameters to the StartBuild operation. Starts running a build.

Class StartBuildResponse

This is the response object from the StartBuild operation.

Class StopBuildBatchRequest

Container for the parameters to the StopBuildBatch operation. Stops a running batch build.

Class StopBuildBatchResponse

This is the response object from the StopBuildBatch operation.

Class StopBuildRequest

Container for the parameters to the StopBuild operation. Attempts to stop running a build.

Class StopBuildResponse

This is the response object from the StopBuild operation.

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

Class TargetTrackingScalingConfiguration

Defines when a new instance is auto-scaled into the compute fleet.

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

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

Class TestReportSummary

Information about a test report.

Class UpdateFleetRequest

Container for the parameters to the UpdateFleet operation. Updates a compute fleet.

Class UpdateFleetResponse

This is the response object from the UpdateFleet operation.

Class UpdateProjectRequest

Container for the parameters to the UpdateProject operation. Changes the settings of a build project.

Class UpdateProjectResponse

This is the response object from the UpdateProject operation.

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

Class UpdateProjectVisibilityResponse

This is the response object from the UpdateProjectVisibility operation.

Class UpdateReportGroupRequest

Container for the parameters to the UpdateReportGroup operation. Updates a report group.

Class UpdateReportGroupResponse

This is the response object from the UpdateReportGroup operation.

Class 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, rotateSecret is ignored.

Class UpdateWebhookResponse

This is the response object from the UpdateWebhook operation.

Class VpcConfig

Information about the VPC configuration that CodeBuild accesses.

Class Webhook

Information about a webhook that connects repository events to a build project in CodeBuild.

Class WebhookFilter

A filter used to determine which webhooks trigger a build.

Interfaces

NameDescription
Interface ICodeBuildPaginatorFactory

Paginators for the CodeBuild service

Interface IDescribeCodeCoveragesPaginator

Paginator for the DescribeCodeCoverages operation

Interface IDescribeTestCasesPaginator

Paginator for the DescribeTestCases operation

Interface IListBuildBatchesForProjectPaginator

Paginator for the ListBuildBatchesForProject operation

Interface IListBuildBatchesPaginator

Paginator for the ListBuildBatches operation

Interface IListBuildsForProjectPaginator

Paginator for the ListBuildsForProject operation

Interface IListBuildsPaginator

Paginator for the ListBuilds operation

Interface IListFleetsPaginator

Paginator for the ListFleets operation

Interface IListProjectsPaginator

Paginator for the ListProjects operation

Interface IListReportGroupsPaginator

Paginator for the ListReportGroups operation

Interface IListReportsForReportGroupPaginator

Paginator for the ListReportsForReportGroup operation

Interface IListReportsPaginator

Paginator for the ListReports operation

Interface IListSharedProjectsPaginator

Paginator for the ListSharedProjects operation

Interface IListSharedReportGroupsPaginator

Paginator for the ListSharedReportGroups operation