Codebuild

This page documents function available when using the Codebuild module, created with @service Codebuild.

Index

Documentation

Main.Codebuild.batch_delete_buildsMethod
batch_delete_builds(ids)
batch_delete_builds(ids, params::Dict{String,<:Any})

Deletes one or more builds.

Arguments

  • ids: The IDs of the builds to delete.
Main.Codebuild.batch_get_build_batchesMethod
batch_get_build_batches(ids)
batch_get_build_batches(ids, params::Dict{String,<:Any})

Retrieves information about one or more batch builds.

Arguments

  • ids: An array that contains the batch build identifiers to retrieve.
Main.Codebuild.batch_get_buildsMethod
batch_get_builds(ids)
batch_get_builds(ids, params::Dict{String,<:Any})

Gets information about one or more builds.

Arguments

  • ids: The IDs of the builds.
Main.Codebuild.batch_get_projectsMethod
batch_get_projects(names)
batch_get_projects(names, params::Dict{String,<:Any})

Gets information about one or more build projects.

Arguments

  • names: The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.
Main.Codebuild.batch_get_report_groupsMethod
batch_get_report_groups(report_group_arns)
batch_get_report_groups(report_group_arns, params::Dict{String,<:Any})

Returns an array of report groups.

Arguments

  • report_group_arns: An array of report group ARNs that identify the report groups to return.
Main.Codebuild.batch_get_reportsMethod
batch_get_reports(report_arns)
batch_get_reports(report_arns, params::Dict{String,<:Any})

Returns an array of reports.

Arguments

  • report_arns: An array of ARNs that identify the Report objects to return.
Main.Codebuild.create_projectMethod
create_project(artifacts, environment, name, service_role, source)
create_project(artifacts, environment, name, service_role, source, params::Dict{String,<:Any})

Creates a build project.

Arguments

  • artifacts: Information about the build output artifacts for the build project.
  • environment: Information about the build environment for the build project.
  • name: The name of the build project.
  • service_role: The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
  • source: Information about the build input source code for the build project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "badgeEnabled": Set this to true to generate a publicly accessible URL for your project's build badge.
  • "buildBatchConfig": A ProjectBuildBatchConfig object that defines the batch build options for the project.
  • "cache": Stores recently used information so that it can be quickly accessed at a later time.
  • "concurrentBuildLimit": The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.
  • "description": A description that makes the build project easy to identify.
  • "encryptionKey": The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/&lt;alias-name&gt;).
  • "fileSystemLocations": An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
  • "logsConfig": Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
  • "queuedTimeoutInMinutes": The number of minutes a build is allowed to be queued before it times out.
  • "secondaryArtifacts": An array of ProjectArtifacts objects.
  • "secondarySourceVersions": An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).
  • "secondarySources": An array of ProjectSource objects.
  • "sourceVersion": A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
  • "tags": A list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
  • "timeoutInMinutes": How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.
  • "vpcConfig": VpcConfig enables CodeBuild to access resources in an Amazon VPC.
Main.Codebuild.create_report_groupMethod
create_report_group(export_config, name, type)
create_report_group(export_config, name, type, params::Dict{String,<:Any})

Creates a report group. A report group contains a collection of reports.

Arguments

  • export_config: A ReportExportConfig object that contains information about where the report group test results are exported.
  • name: The name of the report group.
  • type: The type of report group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": A list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
Main.Codebuild.create_webhookMethod
create_webhook(project_name)
create_webhook(project_name, params::Dict{String,<:Any})

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.

Arguments

  • project_name: The name of the CodeBuild project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "branchFilter": A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter.
  • "buildType": Specifies the type of build this webhook will trigger.
  • "filterGroups": An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type. For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.
Main.Codebuild.delete_build_batchMethod
delete_build_batch(id)
delete_build_batch(id, params::Dict{String,<:Any})

Deletes a batch build.

Arguments

  • id: The identifier of the batch build to delete.
Main.Codebuild.delete_projectMethod
delete_project(name)
delete_project(name, params::Dict{String,<:Any})

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

Arguments

  • name: The name of the build project.
Main.Codebuild.delete_reportMethod
delete_report(arn)
delete_report(arn, params::Dict{String,<:Any})

Deletes a report.

Arguments

  • arn: The ARN of the report to delete.
Main.Codebuild.delete_report_groupMethod
delete_report_group(arn)
delete_report_group(arn, params::Dict{String,<:Any})

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

Arguments

  • arn: The ARN of the report group to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "deleteReports": If true, deletes any reports that belong to a report group before deleting the report group. If false, you must delete any reports in the report group. 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.
Main.Codebuild.delete_resource_policyMethod
delete_resource_policy(resource_arn)
delete_resource_policy(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the resource that is associated with the resource policy.
Main.Codebuild.delete_source_credentialsMethod
delete_source_credentials(arn)
delete_source_credentials(arn, params::Dict{String,<:Any})

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

Arguments

  • arn: The Amazon Resource Name (ARN) of the token.
Main.Codebuild.delete_webhookMethod
delete_webhook(project_name)
delete_webhook(project_name, params::Dict{String,<:Any})

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.

Arguments

  • project_name: The name of the CodeBuild project.
Main.Codebuild.describe_code_coveragesMethod
describe_code_coverages(report_arn)
describe_code_coverages(report_arn, params::Dict{String,<:Any})

Retrieves one or more code coverage reports.

Arguments

  • report_arn: The ARN of the report for which test cases are returned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxLineCoveragePercentage": The maximum line coverage percentage to report.
  • "maxResults": The maximum number of results to return.
  • "minLineCoveragePercentage": The minimum line coverage percentage to report.
  • "nextToken": The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
  • "sortBy": Specifies how the results are sorted. Possible values are: FILEPATH The results are sorted by file path. LINECOVERAGE_PERCENTAGE The results are sorted by the percentage of lines that are covered.
  • "sortOrder": Specifies if the results are sorted in ascending or descending order.
Main.Codebuild.describe_test_casesMethod
describe_test_cases(report_arn)
describe_test_cases(report_arn, params::Dict{String,<:Any})

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

Arguments

  • report_arn: The ARN of the report for which test cases are returned.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A TestCaseFilter object used to filter the returned reports.
  • "maxResults": The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
Main.Codebuild.get_report_group_trendMethod
get_report_group_trend(report_group_arn, trend_field)
get_report_group_trend(report_group_arn, trend_field, params::Dict{String,<:Any})

Analyzes and accumulates test report values for the specified test reports.

Arguments

  • report_group_arn: The ARN of the report group that contains the reports to analyze.
  • trend_field: The test report value to accumulate. This must be one of the following values: Test reports: DURATION Accumulate the test run times for the specified reports. PASSRATE Accumulate the percentage of tests that passed for the specified test reports. TOTAL Accumulate the total number of tests for the specified test reports. Code coverage reports: BRANCHCOVERAGE Accumulate the branch coverage percentages for the specified test reports. BRANCHESCOVERED Accumulate the branches covered values for the specified test reports. BRANCHESMISSED Accumulate the branches missed values for the specified test reports. LINECOVERAGE Accumulate the line coverage percentages for the specified test reports. LINESCOVERED Accumulate the lines covered values for the specified test reports. LINES_MISSED Accumulate the lines not covered values for the specified test reports.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "numOfReports": The number of reports to analyze. This operation always retrieves the most recent reports. If this parameter is omitted, the most recent 100 reports are analyzed.
Main.Codebuild.get_resource_policyMethod
get_resource_policy(resource_arn)
get_resource_policy(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The ARN of the resource that is associated with the resource policy.
Main.Codebuild.import_source_credentialsMethod
import_source_credentials(auth_type, server_type, token)
import_source_credentials(auth_type, server_type, token, params::Dict{String,<:Any})

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

Arguments

  • auth_type: The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.
  • server_type: The source provider used for this project.
  • token: For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "shouldOverwrite": Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.
  • "username": The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.
Main.Codebuild.invalidate_project_cacheMethod
invalidate_project_cache(project_name)
invalidate_project_cache(project_name, params::Dict{String,<:Any})

Resets the cache for a project.

Arguments

  • project_name: The name of the CodeBuild build project that the cache is reset for.
Main.Codebuild.list_build_batchesMethod
list_build_batches()
list_build_batches(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A BuildBatchFilter object that specifies the filters for the search.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
  • "sortOrder": Specifies the sort order of the returned items. Valid values include: ASCENDING: List the batch build identifiers in ascending order by identifier. DESCENDING: List the batch build identifiers in descending order by identifier.
Main.Codebuild.list_build_batches_for_projectMethod
list_build_batches_for_project()
list_build_batches_for_project(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A BuildBatchFilter object that specifies the filters for the search.
  • "maxResults": The maximum number of results to return.
  • "nextToken": The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
  • "projectName": The name of the project.
  • "sortOrder": Specifies the sort order of the returned items. Valid values include: ASCENDING: List the batch build identifiers in ascending order by identifier. DESCENDING: List the batch build identifiers in descending order by identifier.
Main.Codebuild.list_buildsMethod
list_builds()
list_builds(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortOrder": The order to list build IDs. Valid values include: ASCENDING: List the build IDs in ascending order by build ID. DESCENDING: List the build IDs in descending order by build ID.
Main.Codebuild.list_builds_for_projectMethod
list_builds_for_project(project_name)
list_builds_for_project(project_name, params::Dict{String,<:Any})

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

Arguments

  • project_name: The name of the CodeBuild project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortOrder": The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order. Valid values include: ASCENDING: List the build identifiers in ascending order, by build number. DESCENDING: List the build identifiers in descending order, by build number. If the project has more than 100 builds, setting the sort order will result in an error.
Main.Codebuild.list_projectsMethod
list_projects()
list_projects(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortBy": The criterion to be used to list build project names. Valid values include: CREATEDTIME: List based on when each build project was created. LASTMODIFIED_TIME: List based on when information about each build project was last changed. NAME: List based on each build project's name. Use sortOrder to specify in what order to list the build project names based on the preceding criteria.
  • "sortOrder": The order in which to list build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order. Use sortBy to specify the criterion to be used to list build project names.
Main.Codebuild.list_report_groupsMethod
list_report_groups()
list_report_groups(params::Dict{String,<:Any})

Gets a list ARNs for the report groups in the current Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortBy": The criterion to be used to list build report groups. Valid values include: CREATEDTIME: List based on when each report group was created. LASTMODIFIED_TIME: List based on when each report group was last changed. NAME: List based on each report group's name.
  • "sortOrder": Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
Main.Codebuild.list_reportsMethod
list_reports()
list_reports(params::Dict{String,<:Any})

Returns a list of ARNs for the reports in the current Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A ReportFilter object used to filter the returned reports.
  • "maxResults": The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortOrder": Specifies the sort order for the list of returned reports. Valid values are: ASCENDING: return reports in chronological order based on their creation date. DESCENDING: return reports in the reverse chronological order based on their creation date.
Main.Codebuild.list_reports_for_report_groupMethod
list_reports_for_report_group(report_group_arn)
list_reports_for_report_group(report_group_arn, params::Dict{String,<:Any})

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

Arguments

  • report_group_arn: The ARN of the report group for which you want to return report ARNs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filter": A ReportFilter object used to filter the returned reports.
  • "maxResults": The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortOrder": Use to specify whether the results are returned in ascending or descending order.
Main.Codebuild.list_shared_projectsMethod
list_shared_projects()
list_shared_projects(params::Dict{String,<:Any})

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortBy": The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared project was last changed.
  • "sortOrder": The order in which to list shared build projects. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order.
Main.Codebuild.list_shared_report_groupsMethod
list_shared_report_groups()
list_shared_report_groups(params::Dict{String,<:Any})

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.
  • "nextToken": During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.
  • "sortBy": The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include: ARN: List based on the ARN. MODIFIED_TIME: List based on when information about the shared report group was last changed.
  • "sortOrder": The order in which to list shared report groups. Valid values include: ASCENDING: List in ascending order. DESCENDING: List in descending order.
Main.Codebuild.put_resource_policyMethod
put_resource_policy(policy, resource_arn)
put_resource_policy(policy, resource_arn, params::Dict{String,<:Any})

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

Arguments

  • policy: A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.
  • resource_arn: The ARN of the Project or ReportGroup resource you want to associate with a resource policy.
Main.Codebuild.retry_buildMethod
retry_build()
retry_build(params::Dict{String,<:Any})

Restarts a build.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "id": Specifies the identifier of the build to restart.
  • "idempotencyToken": A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
Main.Codebuild.retry_build_batchMethod
retry_build_batch()
retry_build_batch(params::Dict{String,<:Any})

Restarts a failed batch build. Only batch builds that have failed can be retried.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "id": Specifies the identifier of the batch build to restart.
  • "idempotencyToken": A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
  • "retryType": Specifies the type of retry to perform.
Main.Codebuild.start_buildMethod
start_build(project_name)
start_build(project_name, params::Dict{String,<:Any})

Starts running a build.

Arguments

  • project_name: The name of the CodeBuild build project to start running a build.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "artifactsOverride": Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
  • "buildStatusConfigOverride": Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
  • "buildspecOverride": A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILDSRCDIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
  • "cacheOverride": A ProjectCache object specified for this build that overrides the one defined in the build project.
  • "certificateOverride": The name of a certificate for this build that overrides the one specified in the build project.
  • "computeTypeOverride": The name of a compute type for this build that overrides the one specified in the build project.
  • "debugSessionEnabled": Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
  • "encryptionKeyOverride": The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/&lt;alias-name&gt;).
  • "environmentTypeOverride": A container type for this build that overrides the one specified in the build project.
  • "environmentVariablesOverride": A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
  • "gitCloneDepthOverride": The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.
  • "gitSubmodulesConfigOverride": Information about the Git submodules configuration for this build of an CodeBuild build project.
  • "idempotencyToken": A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
  • "imageOverride": The name of an image for this build that overrides the one specified in the build project.
  • "imagePullCredentialsTypeOverride": The type of credentials CodeBuild uses to pull images in your build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICEROLE Specifies that CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICEROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
  • "insecureSslOverride": Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
  • "logsConfigOverride": Log settings for this build that override the log settings defined in the build project.
  • "privilegedModeOverride": Enable this flag to override privileged mode in the build project.
  • "queuedTimeoutInMinutesOverride": The number of minutes a build is allowed to be queued before it times out.
  • "registryCredentialOverride": The credentials for access to a private registry.
  • "reportBuildStatusOverride": Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide. The status of a build triggered by a webhook is always reported to your source provider.
  • "secondaryArtifactsOverride": An array of ProjectArtifacts objects.
  • "secondarySourcesOverride": An array of ProjectSource objects.
  • "secondarySourcesVersionOverride": An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.
  • "serviceRoleOverride": The name of a service role for this build that overrides the one specified in the build project.
  • "sourceAuthOverride": An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.
  • "sourceLocationOverride": A location that overrides, for this build, the source location for the one defined in the build project.
  • "sourceTypeOverride": A source input type, for this build, that overrides the source input defined in the build project.
  • "sourceVersion": The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Amazon S3 The version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
  • "timeoutInMinutesOverride": The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.
Main.Codebuild.start_build_batchMethod
start_build_batch(project_name)
start_build_batch(project_name, params::Dict{String,<:Any})

Starts a batch build for a project.

Arguments

  • project_name: The name of the project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "artifactsOverride": An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.
  • "buildBatchConfigOverride": A BuildBatchConfigOverride object that contains batch build configuration overrides.
  • "buildTimeoutInMinutesOverride": Overrides the build timeout specified in the batch build project.
  • "buildspecOverride": A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project. If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILDSRCDIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.
  • "cacheOverride": A ProjectCache object that specifies cache overrides.
  • "certificateOverride": The name of a certificate for this batch build that overrides the one specified in the batch build project.
  • "computeTypeOverride": The name of a compute type for this batch build that overrides the one specified in the batch build project.
  • "debugSessionEnabled": Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.
  • "encryptionKeyOverride": The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/&lt;alias-name&gt;).
  • "environmentTypeOverride": A container type for this batch build that overrides the one specified in the batch build project.
  • "environmentVariablesOverride": An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.
  • "gitCloneDepthOverride": The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.
  • "gitSubmodulesConfigOverride": A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.
  • "idempotencyToken": A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
  • "imageOverride": The name of an image for this batch build that overrides the one specified in the batch build project.
  • "imagePullCredentialsTypeOverride": The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values: CODEBUILD Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal. SERVICEROLE Specifies that CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICEROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.
  • "insecureSslOverride": Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.
  • "logsConfigOverride": A LogsConfig object that override the log settings defined in the batch build project.
  • "privilegedModeOverride": Enable this flag to override privileged mode in the batch build project.
  • "queuedTimeoutInMinutesOverride": The number of minutes a batch build is allowed to be queued before it times out.
  • "registryCredentialOverride": A RegistryCredential object that overrides credentials for access to a private registry.
  • "reportBuildBatchStatusOverride": Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider.
  • "secondaryArtifactsOverride": An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.
  • "secondarySourcesOverride": An array of ProjectSource objects that override the secondary sources defined in the batch build project.
  • "secondarySourcesVersionOverride": An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.
  • "serviceRoleOverride": The name of a service role for this batch build that overrides the one specified in the batch build project.
  • "sourceAuthOverride": A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.
  • "sourceLocationOverride": A location that overrides, for this batch build, the source location defined in the batch build project.
  • "sourceTypeOverride": The source input type that overrides the source input defined in the batch build project.
  • "sourceVersion": The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider: CodeCommit The commit ID, branch, or Git tag to use. GitHub The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Bitbucket The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. Amazon S3 The version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence. For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
Main.Codebuild.stop_buildMethod
stop_build(id)
stop_build(id, params::Dict{String,<:Any})

Attempts to stop running a build.

Arguments

  • id: The ID of the build.
Main.Codebuild.stop_build_batchMethod
stop_build_batch(id)
stop_build_batch(id, params::Dict{String,<:Any})

Stops a running batch build.

Arguments

  • id: The identifier of the batch build to stop.
Main.Codebuild.update_projectMethod
update_project(name)
update_project(name, params::Dict{String,<:Any})

Changes the settings of a build project.

Arguments

  • name: The name of the build project. You cannot change a build project's name.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "artifacts": Information to be changed about the build output artifacts for the build project.
  • "badgeEnabled": Set this to true to generate a publicly accessible URL for your project's build badge.
  • "buildBatchConfig":
  • "cache": Stores recently used information so that it can be quickly accessed at a later time.
  • "concurrentBuildLimit": The maximum number of concurrent builds that are allowed for this project. New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run. To remove this limit, set this value to -1.
  • "description": A new or replacement description of the build project.
  • "encryptionKey": The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts. You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/&lt;alias-name&gt;).
  • "environment": Information to be changed about the build environment for the build project.
  • "fileSystemLocations": An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.
  • "logsConfig": Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
  • "queuedTimeoutInMinutes": The number of minutes a build is allowed to be queued before it times out.
  • "secondaryArtifacts": An array of ProjectArtifact objects.
  • "secondarySourceVersions": An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).
  • "secondarySources": An array of ProjectSource objects.
  • "serviceRole": The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
  • "source": Information to be changed about the build input source code for the build project.
  • "sourceVersion": A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of: For CodeCommit: the commit ID, branch, or Git tag to use. For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. For Amazon S3: the version ID of the object that represents the build input ZIP file to use. If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level). For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
  • "tags": An updated list of tag key and value pairs associated with this build project. These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
  • "timeoutInMinutes": The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
  • "vpcConfig": VpcConfig enables CodeBuild to access resources in an Amazon VPC.
Main.Codebuild.update_project_visibilityMethod
update_project_visibility(project_arn, project_visibility)
update_project_visibility(project_arn, project_visibility, params::Dict{String,<:Any})

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, especially Amazon Web Services access key IDs and secret access keys, 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.

Arguments

  • project_arn: The Amazon Resource Name (ARN) of the build project.
  • project_visibility:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "resourceAccessRole": The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
Main.Codebuild.update_report_groupMethod
update_report_group(arn)
update_report_group(arn, params::Dict{String,<:Any})

Updates a report group.

Arguments

  • arn: The ARN of the report group to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "exportConfig": Used to specify an updated export type. Valid values are: S3: The report results are exported to an S3 bucket. NO_EXPORT: The report results are not exported.
  • "tags": An updated list of tag key and value pairs associated with this report group. These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.
Main.Codebuild.update_webhookMethod
update_webhook(project_name)
update_webhook(project_name, params::Dict{String,<:Any})

Updates the webhook associated with an CodeBuild build project. If you use Bitbucket for your repository, rotateSecret is ignored.

Arguments

  • project_name: The name of the CodeBuild project.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "branchFilter": A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built. It is recommended that you use filterGroups instead of branchFilter.
  • "buildType": Specifies the type of build this webhook will trigger.
  • "filterGroups": An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.
  • "rotateSecret": A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.