Client

codebuild

R Documentation

AWS CodeBuild¶

Description¶

CodeBuild

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. 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 CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuild User Guide.

Usage¶

codebuild(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

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

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

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¶

svc <- codebuild(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  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 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
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 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
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: Analyzes and accumulates test report values for the specified test reports
get_resource_policy: Gets a resource policy that is identified by its resource ARN
import_source_credentials: Imports the source repository credentials for an 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 identifiers for the specified build project, with each build identifier representing a single build
list_curated_environment_images: Gets information about Docker images that are managed by 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 Amazon Web Services account
list_reports: Returns a list of ARNs for the reports in the current Amazon Web Services 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 Amazon Web Services accounts or users
list_shared_report_groups: Gets a list of report groups that are shared with other Amazon Web Services 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_project_visibility: Changes the public visibility for a project
update_report_group: Updates a report group
update_webhook: Updates the webhook associated with an CodeBuild build project

Examples¶

## Not run: 
svc <- codebuild()
svc$batch_delete_builds(
  Foo = 123
)

## End(Not run)