AWS.CodeBuild (aws-elixir v0.7.0) View Source

AWS CodeBuild

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 a ReportGroup.

  • 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 of SourceCredentialsInfo objects. Each SourceCredentialsInfo 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 a Project or ReportGroup 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.

Link to this section Summary

Functions

Retrieves information about one or more batch builds.

Gets information about one or more builds.

Gets information about one or more build projects.

Returns an array of report groups.

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.

Deletes a resource policy that is identified by its resource ARN.

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

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.

Retrieves one or more code coverage reports.

Returns a list of details about test cases for a report.

Gets a resource policy that is identified by its resource ARN.

Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

Retrieves the identifiers of your build batches in the current region.

Retrieves the identifiers of the build batches for a specific project.

Gets a list of build IDs, with each build ID representing a single build.

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

Gets information about Docker images that are managed by AWS CodeBuild.

Gets a list of build project names, with each build project name representing a single build project.

Gets a list ARNs for the report groups in the current AWS account.

Returns a list of ARNs for the reports in the current AWS account.

Returns a list of ARNs for the reports that belong to a ReportGroup.

Gets a list of projects that are shared with other AWS accounts or users.

Gets a list of report groups that are shared with other AWS accounts or users.

Returns a list of SourceCredentialsInfo objects.

Stores a resource policy for the ARN of a Project or ReportGroup object.

Restarts a failed batch build.

Starts a batch build for a project.

Attempts to stop running a build.

Stops a running batch build.

Changes the settings of a build project.

Updates the webhook associated with an AWS CodeBuild build project.

Link to this section Functions

Link to this function

batch_delete_builds(client, input, options \\ [])

View Source

Deletes one or more builds.

Link to this function

batch_get_build_batches(client, input, options \\ [])

View Source

Retrieves information about one or more batch builds.

Link to this function

batch_get_builds(client, input, options \\ [])

View Source

Gets information about one or more builds.

Link to this function

batch_get_projects(client, input, options \\ [])

View Source

Gets information about one or more build projects.

Link to this function

batch_get_report_groups(client, input, options \\ [])

View Source

Returns an array of report groups.

Link to this function

batch_get_reports(client, input, options \\ [])

View Source

Returns an array of reports.

Link to this function

create_project(client, input, options \\ [])

View Source

Creates a build project.

Link to this function

create_report_group(client, input, options \\ [])

View Source

Creates a report group.

A report group contains a collection of reports.

Link to this function

create_webhook(client, input, options \\ [])

View Source

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.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

Link to this function

delete_build_batch(client, input, options \\ [])

View Source

Deletes a batch build.

Link to this function

delete_project(client, input, options \\ [])

View Source

Deletes a build project.

When you delete a project, its builds are not deleted.

Link to this function

delete_report(client, input, options \\ [])

View Source

Deletes a report.

Link to this function

delete_report_group(client, input, options \\ [])

View Source

Deletes a report group.

Before you delete a report group, you must delete its reports.

Link to this function

delete_resource_policy(client, input, options \\ [])

View Source

Deletes a resource policy that is identified by its resource ARN.

Link to this function

delete_source_credentials(client, input, options \\ [])

View Source

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

Link to this function

delete_webhook(client, input, options \\ [])

View Source

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.

Link to this function

describe_code_coverages(client, input, options \\ [])

View Source

Retrieves one or more code coverage reports.

Link to this function

describe_test_cases(client, input, options \\ [])

View Source

Returns a list of details about test cases for a report.

Link to this function

get_report_group_trend(client, input, options \\ [])

View Source
Link to this function

get_resource_policy(client, input, options \\ [])

View Source

Gets a resource policy that is identified by its resource ARN.

Link to this function

import_source_credentials(client, input, options \\ [])

View Source

Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

Link to this function

invalidate_project_cache(client, input, options \\ [])

View Source

Resets the cache for a project.

Link to this function

list_build_batches(client, input, options \\ [])

View Source

Retrieves the identifiers of your build batches in the current region.

Link to this function

list_build_batches_for_project(client, input, options \\ [])

View Source

Retrieves the identifiers of the build batches for a specific project.

Link to this function

list_builds(client, input, options \\ [])

View Source

Gets a list of build IDs, with each build ID representing a single build.

Link to this function

list_builds_for_project(client, input, options \\ [])

View Source

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

Link to this function

list_curated_environment_images(client, input, options \\ [])

View Source

Gets information about Docker images that are managed by AWS CodeBuild.

Link to this function

list_projects(client, input, options \\ [])

View Source

Gets a list of build project names, with each build project name representing a single build project.

Link to this function

list_report_groups(client, input, options \\ [])

View Source

Gets a list ARNs for the report groups in the current AWS account.

Link to this function

list_reports(client, input, options \\ [])

View Source

Returns a list of ARNs for the reports in the current AWS account.

Link to this function

list_reports_for_report_group(client, input, options \\ [])

View Source

Returns a list of ARNs for the reports that belong to a ReportGroup.

Link to this function

list_shared_projects(client, input, options \\ [])

View Source

Gets a list of projects that are shared with other AWS accounts or users.

Link to this function

list_shared_report_groups(client, input, options \\ [])

View Source

Gets a list of report groups that are shared with other AWS accounts or users.

Link to this function

list_source_credentials(client, input, options \\ [])

View Source

Returns a list of SourceCredentialsInfo objects.

Link to this function

put_resource_policy(client, input, options \\ [])

View Source

Stores a resource policy for the ARN of a Project or ReportGroup object.

Link to this function

retry_build(client, input, options \\ [])

View Source

Restarts a build.

Link to this function

retry_build_batch(client, input, options \\ [])

View Source

Restarts a failed batch build.

Only batch builds that have failed can be retried.

Link to this function

start_build(client, input, options \\ [])

View Source

Starts running a build.

Link to this function

start_build_batch(client, input, options \\ [])

View Source

Starts a batch build for a project.

Link to this function

stop_build(client, input, options \\ [])

View Source

Attempts to stop running a build.

Link to this function

stop_build_batch(client, input, options \\ [])

View Source

Stops a running batch build.

Link to this function

update_project(client, input, options \\ [])

View Source

Changes the settings of a build project.

Link to this function

update_report_group(client, input, options \\ [])

View Source

Updates a report group.

Link to this function

update_webhook(client, input, options \\ [])

View Source

Updates the webhook associated with an AWS CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.