codebuild: AWS CodeBuild

Description Usage Arguments Value Service syntax Operations Examples

View source: R/paws.R

Description

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:

Usage

1
codebuild(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- codebuild(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
svc <- codebuild()
# The following example gets information about builds with the specified
# build IDs.
svc$batch_get_builds(
  ids = list(
    "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX",
    "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX"
  )
)

## End(Not run)

paws documentation built on Sept. 5, 2021, 5:19 p.m.

Related to codebuild in paws...