aws_code_build
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 userListSourceCredentials
: 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.
Summary
Functions
-
batch_delete_builds(Client, Input)
Deletes one or more builds.
- batch_delete_builds(Client, Input, Options)
-
batch_get_build_batches(Client, Input)
Retrieves information about one or more batch builds.
- batch_get_build_batches(Client, Input, Options)
-
batch_get_builds(Client, Input)
Gets information about one or more builds.
- batch_get_builds(Client, Input, Options)
-
batch_get_projects(Client, Input)
Gets information about one or more build projects.
- batch_get_projects(Client, Input, Options)
-
batch_get_report_groups(Client, Input)
Returns an array of report groups.
- batch_get_report_groups(Client, Input, Options)
-
batch_get_reports(Client, Input)
Returns an array of reports.
- batch_get_reports(Client, Input, Options)
-
create_project(Client, Input)
Creates a build project.
- create_project(Client, Input, Options)
-
create_report_group(Client, Input)
Creates a report group.
- create_report_group(Client, Input, Options)
-
create_webhook(Client, Input)
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.
- create_webhook(Client, Input, Options)
-
delete_build_batch(Client, Input)
Deletes a batch build.
- delete_build_batch(Client, Input, Options)
-
delete_project(Client, Input)
Deletes a build project.
- delete_project(Client, Input, Options)
-
delete_report(Client, Input)
Deletes a report.
- delete_report(Client, Input, Options)
-
delete_report_group(Client, Input)
DeleteReportGroup
: Deletes a report group. - delete_report_group(Client, Input, Options)
-
delete_resource_policy(Client, Input)
Deletes a resource policy that is identified by its resource ARN.
- delete_resource_policy(Client, Input, Options)
-
delete_source_credentials(Client, Input)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
- delete_source_credentials(Client, Input, Options)
-
delete_webhook(Client, Input)
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.
- delete_webhook(Client, Input, Options)
-
describe_code_coverages(Client, Input)
Retrieves one or more code coverage reports.
- describe_code_coverages(Client, Input, Options)
-
describe_test_cases(Client, Input)
Returns a list of details about test cases for a report.
- describe_test_cases(Client, Input, Options)
-
get_resource_policy(Client, Input)
Gets a resource policy that is identified by its resource ARN.
- get_resource_policy(Client, Input, Options)
-
import_source_credentials(Client, Input)
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
- import_source_credentials(Client, Input, Options)
-
invalidate_project_cache(Client, Input)
Resets the cache for a project.
- invalidate_project_cache(Client, Input, Options)
-
list_build_batches(Client, Input)
Retrieves the identifiers of your build batches in the current region.
- list_build_batches(Client, Input, Options)
-
list_build_batches_for_project(Client, Input)
Retrieves the identifiers of the build batches for a specific project.
- list_build_batches_for_project(Client, Input, Options)
-
list_builds(Client, Input)
Gets a list of build IDs, with each build ID representing a single build.
- list_builds(Client, Input, Options)
-
list_builds_for_project(Client, Input)
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
- list_builds_for_project(Client, Input, Options)
-
list_curated_environment_images(Client, Input)
Gets information about Docker images that are managed by AWS CodeBuild.
- list_curated_environment_images(Client, Input, Options)
-
list_projects(Client, Input)
Gets a list of build project names, with each build project name representing a single build project.
- list_projects(Client, Input, Options)
-
list_report_groups(Client, Input)
Gets a list ARNs for the report groups in the current AWS account.
- list_report_groups(Client, Input, Options)
-
list_reports(Client, Input)
Returns a list of ARNs for the reports in the current AWS account.
- list_reports(Client, Input, Options)
-
list_reports_for_report_group(Client, Input)
Returns a list of ARNs for the reports that belong to a
ReportGroup
. - list_reports_for_report_group(Client, Input, Options)
-
list_shared_projects(Client, Input)
Gets a list of projects that are shared with other AWS accounts or users.
- list_shared_projects(Client, Input, Options)
-
list_shared_report_groups(Client, Input)
Gets a list of report groups that are shared with other AWS accounts or users.
- list_shared_report_groups(Client, Input, Options)
-
list_source_credentials(Client, Input)
Returns a list of
SourceCredentialsInfo
objects. - list_source_credentials(Client, Input, Options)
-
put_resource_policy(Client, Input)
Stores a resource policy for the ARN of a
Project
orReportGroup
object. - put_resource_policy(Client, Input, Options)
-
retry_build(Client, Input)
Restarts a build.
- retry_build(Client, Input, Options)
-
retry_build_batch(Client, Input)
Restarts a batch build.
- retry_build_batch(Client, Input, Options)
-
start_build(Client, Input)
Starts running a build.
- start_build(Client, Input, Options)
-
start_build_batch(Client, Input)
Starts a batch build for a project.
- start_build_batch(Client, Input, Options)
-
stop_build(Client, Input)
Attempts to stop running a build.
- stop_build(Client, Input, Options)
-
stop_build_batch(Client, Input)
Stops a running batch build.
- stop_build_batch(Client, Input, Options)
-
update_project(Client, Input)
Changes the settings of a build project.
- update_project(Client, Input, Options)
-
update_report_group(Client, Input)
Updates a report group.
- update_report_group(Client, Input, Options)
-
update_webhook(Client, Input)
Updates the webhook associated with an AWS CodeBuild build project.
- update_webhook(Client, Input, Options)
Functions
batch_delete_builds(Client, Input)
Deletes one or more builds.
batch_delete_builds(Client, Input, Options)
batch_get_build_batches(Client, Input)
Retrieves information about one or more batch builds.
batch_get_build_batches(Client, Input, Options)
batch_get_builds(Client, Input)
Gets information about one or more builds.
batch_get_builds(Client, Input, Options)
batch_get_projects(Client, Input)
Gets information about one or more build projects.
batch_get_projects(Client, Input, Options)
batch_get_report_groups(Client, Input)
Returns an array of report groups.
batch_get_report_groups(Client, Input, Options)
batch_get_reports(Client, Input)
Returns an array of reports.
batch_get_reports(Client, Input, Options)
create_project(Client, Input)
Creates a build project.
create_project(Client, Input, Options)
create_report_group(Client, Input)
Creates a report group. A report group contains a collection of reports.
create_report_group(Client, Input, Options)
create_webhook(Client, Input)
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.
create_webhook(Client, Input, Options)
delete_build_batch(Client, Input)
Deletes a batch build.
delete_build_batch(Client, Input, Options)
delete_project(Client, Input)
Deletes a build project. When you delete a project, its builds are not deleted.
delete_project(Client, Input, Options)
delete_report(Client, Input)
Deletes a report.
delete_report(Client, Input, Options)
delete_report_group(Client, Input)
DeleteReportGroup
: Deletes a report group. Before you
delete a report group, you must delete its reports. Use ListReportsForReportGroup
to get the reports in a report group. Use DeleteReport
to delete the reports. If you call DeleteReportGroup
for a
report group that contains one or more reports, an exception is thrown.
delete_report_group(Client, Input, Options)
delete_resource_policy(Client, Input)
Deletes a resource policy that is identified by its resource ARN.
delete_resource_policy(Client, Input, Options)
delete_source_credentials(Client, Input)
Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.
delete_source_credentials(Client, Input, Options)
delete_webhook(Client, Input)
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.
delete_webhook(Client, Input, Options)
describe_code_coverages(Client, Input)
Retrieves one or more code coverage reports.
describe_code_coverages(Client, Input, Options)
describe_test_cases(Client, Input)
Returns a list of details about test cases for a report.
describe_test_cases(Client, Input, Options)
get_resource_policy(Client, Input)
Gets a resource policy that is identified by its resource ARN.
get_resource_policy(Client, Input, Options)
import_source_credentials(Client, Input)
Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.
import_source_credentials(Client, Input, Options)
invalidate_project_cache(Client, Input)
Resets the cache for a project.
invalidate_project_cache(Client, Input, Options)
list_build_batches(Client, Input)
Retrieves the identifiers of your build batches in the current region.
list_build_batches(Client, Input, Options)
list_build_batches_for_project(Client, Input)
Retrieves the identifiers of the build batches for a specific project.
list_build_batches_for_project(Client, Input, Options)
list_builds(Client, Input)
Gets a list of build IDs, with each build ID representing a single build.
list_builds(Client, Input, Options)
list_builds_for_project(Client, Input)
Gets a list of build IDs for the specified build project, with each build ID representing a single build.
list_builds_for_project(Client, Input, Options)
list_curated_environment_images(Client, Input)
Gets information about Docker images that are managed by AWS CodeBuild.
list_curated_environment_images(Client, Input, Options)
list_projects(Client, Input)
Gets a list of build project names, with each build project name representing a single build project.
list_projects(Client, Input, Options)
list_report_groups(Client, Input)
Gets a list ARNs for the report groups in the current AWS account.
list_report_groups(Client, Input, Options)
list_reports(Client, Input)
Returns a list of ARNs for the reports in the current AWS account.
list_reports(Client, Input, Options)
list_reports_for_report_group(Client, Input)
Returns a list of ARNs for the reports that belong to a
ReportGroup
.
list_reports_for_report_group(Client, Input, Options)
list_shared_projects(Client, Input)
Gets a list of projects that are shared with other AWS accounts or users.
list_shared_projects(Client, Input, Options)
list_shared_report_groups(Client, Input)
Gets a list of report groups that are shared with other AWS accounts or users.
list_shared_report_groups(Client, Input, Options)
list_source_credentials(Client, Input)
Returns a list of SourceCredentialsInfo
objects.
list_source_credentials(Client, Input, Options)
put_resource_policy(Client, Input)
Stores a resource policy for the ARN of a Project
or
ReportGroup
object.
put_resource_policy(Client, Input, Options)
retry_build(Client, Input)
Restarts a build.
retry_build(Client, Input, Options)
retry_build_batch(Client, Input)
Restarts a batch build.
retry_build_batch(Client, Input, Options)
start_build(Client, Input)
Starts running a build.
start_build(Client, Input, Options)
start_build_batch(Client, Input)
Starts a batch build for a project.
start_build_batch(Client, Input, Options)
stop_build(Client, Input)
Attempts to stop running a build.
stop_build(Client, Input, Options)
stop_build_batch(Client, Input)
Stops a running batch build.
stop_build_batch(Client, Input, Options)
update_project(Client, Input)
Changes the settings of a build project.
update_project(Client, Input, Options)
update_report_group(Client, Input)
Updates a report group.
update_report_group(Client, Input, Options)
update_webhook(Client, Input)
Updates the webhook associated with an AWS CodeBuild build project.
rotateSecret
is ignored.