Struct aws_sdk_codebuild::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AWS CodeBuild
Client for invoking operations on AWS CodeBuild. Each operation on AWS CodeBuild is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_codebuild::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_codebuild::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_codebuild::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn batch_delete_builds(&self) -> BatchDeleteBuilds
pub fn batch_delete_builds(&self) -> BatchDeleteBuilds
Constructs a fluent builder for the BatchDeleteBuilds
operation.
- The fluent builder is configurable:
ids(Vec<String>)
/set_ids(Option<Vec<String>>)
:The IDs of the builds to delete.
- On success, responds with
BatchDeleteBuildsOutput
with field(s):builds_deleted(Option<Vec<String>>)
:The IDs of the builds that were successfully deleted.
builds_not_deleted(Option<Vec<BuildNotDeleted>>)
:Information about any builds that could not be successfully deleted.
- On failure, responds with
SdkError<BatchDeleteBuildsError>
sourcepub fn batch_get_build_batches(&self) -> BatchGetBuildBatches
pub fn batch_get_build_batches(&self) -> BatchGetBuildBatches
Constructs a fluent builder for the BatchGetBuildBatches
operation.
- The fluent builder is configurable:
ids(Vec<String>)
/set_ids(Option<Vec<String>>)
:An array that contains the batch build identifiers to retrieve.
- On success, responds with
BatchGetBuildBatchesOutput
with field(s):build_batches(Option<Vec<BuildBatch>>)
:An array of
BuildBatch
objects that represent the retrieved batch builds.build_batches_not_found(Option<Vec<String>>)
:An array that contains the identifiers of any batch builds that are not found.
- On failure, responds with
SdkError<BatchGetBuildBatchesError>
sourcepub fn batch_get_builds(&self) -> BatchGetBuilds
pub fn batch_get_builds(&self) -> BatchGetBuilds
Constructs a fluent builder for the BatchGetBuilds
operation.
- The fluent builder is configurable:
ids(Vec<String>)
/set_ids(Option<Vec<String>>)
:The IDs of the builds.
- On success, responds with
BatchGetBuildsOutput
with field(s):builds(Option<Vec<Build>>)
:Information about the requested builds.
builds_not_found(Option<Vec<String>>)
:The IDs of builds for which information could not be found.
- On failure, responds with
SdkError<BatchGetBuildsError>
sourcepub fn batch_get_projects(&self) -> BatchGetProjects
pub fn batch_get_projects(&self) -> BatchGetProjects
Constructs a fluent builder for the BatchGetProjects
operation.
- The fluent builder is configurable:
names(Vec<String>)
/set_names(Option<Vec<String>>)
: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.
- On success, responds with
BatchGetProjectsOutput
with field(s):projects(Option<Vec<Project>>)
:Information about the requested build projects.
projects_not_found(Option<Vec<String>>)
:The names of build projects for which information could not be found.
- On failure, responds with
SdkError<BatchGetProjectsError>
sourcepub fn batch_get_report_groups(&self) -> BatchGetReportGroups
pub fn batch_get_report_groups(&self) -> BatchGetReportGroups
Constructs a fluent builder for the BatchGetReportGroups
operation.
- The fluent builder is configurable:
report_group_arns(Vec<String>)
/set_report_group_arns(Option<Vec<String>>)
:An array of report group ARNs that identify the report groups to return.
- On success, responds with
BatchGetReportGroupsOutput
with field(s):report_groups(Option<Vec<ReportGroup>>)
:The array of report groups returned by
BatchGetReportGroups
.report_groups_not_found(Option<Vec<String>>)
:An array of ARNs passed to
BatchGetReportGroups
that are not associated with aReportGroup
.
- On failure, responds with
SdkError<BatchGetReportGroupsError>
sourcepub fn batch_get_reports(&self) -> BatchGetReports
pub fn batch_get_reports(&self) -> BatchGetReports
Constructs a fluent builder for the BatchGetReports
operation.
- The fluent builder is configurable:
report_arns(Vec<String>)
/set_report_arns(Option<Vec<String>>)
:An array of ARNs that identify the
Report
objects to return.
- On success, responds with
BatchGetReportsOutput
with field(s):reports(Option<Vec<Report>>)
:The array of
Report
objects returned byBatchGetReports
.reports_not_found(Option<Vec<String>>)
:An array of ARNs passed to
BatchGetReportGroups
that are not associated with aReport
.
- On failure, responds with
SdkError<BatchGetReportsError>
sourcepub fn create_project(&self) -> CreateProject
pub fn create_project(&self) -> CreateProject
Constructs a fluent builder for the CreateProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the build project.
description(impl Into<String>)
/set_description(Option<String>)
:A description that makes the build project easy to identify.
source(ProjectSource)
/set_source(Option<ProjectSource>)
:Information about the build input source code for the build project.
secondary_sources(Vec<ProjectSource>)
/set_secondary_sources(Option<Vec<ProjectSource>>)
:An array of
ProjectSource
objects.source_version(impl Into<String>)
/set_source_version(Option<String>)
: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 examplepr/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 thissourceVersion
(at the project level).For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
-
secondary_source_versions(Vec<ProjectSourceVersion>)
/set_secondary_source_versions(Option<Vec<ProjectSourceVersion>>)
:An array of
ProjectSourceVersion
objects. IfsecondarySourceVersions
is specified at the build level, then they take precedence over thesesecondarySourceVersions
(at the project level).artifacts(ProjectArtifacts)
/set_artifacts(Option<ProjectArtifacts>)
:Information about the build output artifacts for the build project.
secondary_artifacts(Vec<ProjectArtifacts>)
/set_secondary_artifacts(Option<Vec<ProjectArtifacts>>)
:An array of
ProjectArtifacts
objects.cache(ProjectCache)
/set_cache(Option<ProjectCache>)
:Stores recently used information so that it can be quickly accessed at a later time.
environment(ProjectEnvironment)
/set_environment(Option<ProjectEnvironment>)
:Information about the build environment for the build project.
service_role(impl Into<String>)
/set_service_role(Option<String>)
: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.
timeout_in_minutes(i32)
/set_timeout_in_minutes(Option<i32>)
: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.
queued_timeout_in_minutes(i32)
/set_queued_timeout_in_minutes(Option<i32>)
:The number of minutes a build is allowed to be queued before it times out.
encryption_key(impl Into<String>)
/set_encryption_key(Option<String>)
: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/
).tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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.
vpc_config(VpcConfig)
/set_vpc_config(Option<VpcConfig>)
:VpcConfig enables CodeBuild to access resources in an Amazon VPC.
badge_enabled(bool)
/set_badge_enabled(Option<bool>)
:Set this to true to generate a publicly accessible URL for your project’s build badge.
logs_config(LogsConfig)
/set_logs_config(Option<LogsConfig>)
:Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.
file_system_locations(Vec<ProjectFileSystemLocation>)
/set_file_system_locations(Option<Vec<ProjectFileSystemLocation>>)
:An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.build_batch_config(ProjectBuildBatchConfig)
/set_build_batch_config(Option<ProjectBuildBatchConfig>)
:A
ProjectBuildBatchConfig
object that defines the batch build options for the project.concurrent_build_limit(i32)
/set_concurrent_build_limit(Option<i32>)
: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.
- On success, responds with
CreateProjectOutput
with field(s):project(Option<Project>)
:Information about the build project that was created.
- On failure, responds with
SdkError<CreateProjectError>
sourcepub fn create_report_group(&self) -> CreateReportGroup
pub fn create_report_group(&self) -> CreateReportGroup
Constructs a fluent builder for the CreateReportGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the report group.
r#type(ReportType)
/set_type(Option<ReportType>)
:The type of report group.
export_config(ReportExportConfig)
/set_export_config(Option<ReportExportConfig>)
:A
ReportExportConfig
object that contains information about where the report group test results are exported.tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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.
- On success, responds with
CreateReportGroupOutput
with field(s):report_group(Option<ReportGroup>)
:Information about the report group that was created.
- On failure, responds with
SdkError<CreateReportGroupError>
sourcepub fn create_webhook(&self) -> CreateWebhook
pub fn create_webhook(&self) -> CreateWebhook
Constructs a fluent builder for the CreateWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild project.
branch_filter(impl Into<String>)
/set_branch_filter(Option<String>)
: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 ofbranchFilter
.filter_groups(Vec<Vec<WebhookFilter>>)
/set_filter_groups(Option<Vec<Vec<WebhookFilter>>>)
:An array of arrays of
WebhookFilter
objects used to determine which webhooks are triggered. At least oneWebhookFilter
in the array must specifyEVENT
as itstype
.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.build_type(WebhookBuildType)
/set_build_type(Option<WebhookBuildType>)
:Specifies the type of build this webhook will trigger.
- On success, responds with
CreateWebhookOutput
with field(s):webhook(Option<Webhook>)
:Information about a webhook that connects repository events to a build project in CodeBuild.
- On failure, responds with
SdkError<CreateWebhookError>
sourcepub fn delete_build_batch(&self) -> DeleteBuildBatch
pub fn delete_build_batch(&self) -> DeleteBuildBatch
Constructs a fluent builder for the DeleteBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The identifier of the batch build to delete.
- On success, responds with
DeleteBuildBatchOutput
with field(s):status_code(Option<String>)
:The status code.
builds_deleted(Option<Vec<String>>)
:An array of strings that contain the identifiers of the builds that were deleted.
builds_not_deleted(Option<Vec<BuildNotDeleted>>)
:An array of
BuildNotDeleted
objects that specify the builds that could not be deleted.
- On failure, responds with
SdkError<DeleteBuildBatchError>
sourcepub fn delete_project(&self) -> DeleteProject
pub fn delete_project(&self) -> DeleteProject
Constructs a fluent builder for the DeleteProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the build project.
- On success, responds with
DeleteProjectOutput
- On failure, responds with
SdkError<DeleteProjectError>
sourcepub fn delete_report(&self) -> DeleteReport
pub fn delete_report(&self) -> DeleteReport
Constructs a fluent builder for the DeleteReport
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the report to delete.
- On success, responds with
DeleteReportOutput
- On failure, responds with
SdkError<DeleteReportError>
sourcepub fn delete_report_group(&self) -> DeleteReportGroup
pub fn delete_report_group(&self) -> DeleteReportGroup
Constructs a fluent builder for the DeleteReportGroup
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the report group to delete.
delete_reports(bool)
/set_delete_reports(bool)
: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 callDeleteReportGroup
for a report group that contains one or more reports, an exception is thrown.
- On success, responds with
DeleteReportGroupOutput
- On failure, responds with
SdkError<DeleteReportGroupError>
sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicy
pub fn delete_resource_policy(&self) -> DeleteResourcePolicy
Constructs a fluent builder for the DeleteResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource that is associated with the resource policy.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
sourcepub fn delete_source_credentials(&self) -> DeleteSourceCredentials
pub fn delete_source_credentials(&self) -> DeleteSourceCredentials
Constructs a fluent builder for the DeleteSourceCredentials
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The Amazon Resource Name (ARN) of the token.
- On success, responds with
DeleteSourceCredentialsOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the token.
- On failure, responds with
SdkError<DeleteSourceCredentialsError>
sourcepub fn delete_webhook(&self) -> DeleteWebhook
pub fn delete_webhook(&self) -> DeleteWebhook
Constructs a fluent builder for the DeleteWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild project.
- On success, responds with
DeleteWebhookOutput
- On failure, responds with
SdkError<DeleteWebhookError>
sourcepub fn describe_code_coverages(&self) -> DescribeCodeCoverages
pub fn describe_code_coverages(&self) -> DescribeCodeCoverages
Constructs a fluent builder for the DescribeCodeCoverages
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
report_arn(impl Into<String>)
/set_report_arn(Option<String>)
:The ARN of the report for which test cases are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
nextToken
value returned from a previous call toDescribeCodeCoverages
. This specifies the next item to return. To return the beginning of the list, exclude this parameter.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:Specifies if the results are sorted in ascending or descending order.
sort_by(ReportCodeCoverageSortByType)
/set_sort_by(Option<ReportCodeCoverageSortByType>)
:Specifies how the results are sorted. Possible values are:
- FILE_PATH
-
The results are sorted by file path.
- LINE_COVERAGE_PERCENTAGE
-
The results are sorted by the percentage of lines that are covered.
min_line_coverage_percentage(f64)
/set_min_line_coverage_percentage(Option<f64>)
:The minimum line coverage percentage to report.
max_line_coverage_percentage(f64)
/set_max_line_coverage_percentage(Option<f64>)
:The maximum line coverage percentage to report.
- On success, responds with
DescribeCodeCoveragesOutput
with field(s):next_token(Option<String>)
:If there are more items to return, this contains a token that is passed to a subsequent call to
DescribeCodeCoverages
to retrieve the next set of items.code_coverages(Option<Vec<CodeCoverage>>)
:An array of
CodeCoverage
objects that contain the results.
- On failure, responds with
SdkError<DescribeCodeCoveragesError>
sourcepub fn describe_test_cases(&self) -> DescribeTestCases
pub fn describe_test_cases(&self) -> DescribeTestCases
Constructs a fluent builder for the DescribeTestCases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
report_arn(impl Into<String>)
/set_report_arn(Option<String>)
:The ARN of the report for which test cases are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated test cases returned per response. Use
nextToken
to iterate pages in the list of returnedTestCase
objects. The default value is 100.filter(TestCaseFilter)
/set_filter(Option<TestCaseFilter>)
:A
TestCaseFilter
object used to filter the returned reports.
- On success, responds with
DescribeTestCasesOutput
with field(s):next_token(Option<String>)
: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.test_cases(Option<Vec<TestCase>>)
:The returned list of test cases.
- On failure, responds with
SdkError<DescribeTestCasesError>
sourcepub fn get_report_group_trend(&self) -> GetReportGroupTrend
pub fn get_report_group_trend(&self) -> GetReportGroupTrend
Constructs a fluent builder for the GetReportGroupTrend
operation.
- The fluent builder is configurable:
report_group_arn(impl Into<String>)
/set_report_group_arn(Option<String>)
:The ARN of the report group that contains the reports to analyze.
num_of_reports(i32)
/set_num_of_reports(Option<i32>)
: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.
trend_field(ReportGroupTrendFieldType)
/set_trend_field(Option<ReportGroupTrendFieldType>)
: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.
- PASS_RATE
-
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:
-
- BRANCH_COVERAGE
-
Accumulate the branch coverage percentages for the specified test reports.
- BRANCHES_COVERED
-
Accumulate the branches covered values for the specified test reports.
- BRANCHES_MISSED
-
Accumulate the branches missed values for the specified test reports.
- LINE_COVERAGE
-
Accumulate the line coverage percentages for the specified test reports.
- LINES_COVERED
-
Accumulate the lines covered values for the specified test reports.
- LINES_MISSED
-
Accumulate the lines not covered values for the specified test reports.
- On success, responds with
GetReportGroupTrendOutput
with field(s):stats(Option<ReportGroupTrendStats>)
:Contains the accumulated trend data.
raw_data(Option<Vec<ReportWithRawData>>)
:An array that contains the raw data for each report.
- On failure, responds with
SdkError<GetReportGroupTrendError>
sourcepub fn get_resource_policy(&self) -> GetResourcePolicy
pub fn get_resource_policy(&self) -> GetResourcePolicy
Constructs a fluent builder for the GetResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the resource that is associated with the resource policy.
- On success, responds with
GetResourcePolicyOutput
with field(s):policy(Option<String>)
:The resource policy for the resource identified by the input ARN parameter.
- On failure, responds with
SdkError<GetResourcePolicyError>
sourcepub fn import_source_credentials(&self) -> ImportSourceCredentials
pub fn import_source_credentials(&self) -> ImportSourceCredentials
Constructs a fluent builder for the ImportSourceCredentials
operation.
- The fluent builder is configurable:
username(impl Into<String>)
/set_username(Option<String>)
:The Bitbucket username when the
authType
is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.token(impl Into<String>)
/set_token(Option<String>)
:For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
server_type(ServerType)
/set_server_type(Option<ServerType>)
:The source provider used for this project.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
: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.
should_overwrite(bool)
/set_should_overwrite(Option<bool>)
:Set to
false
to prevent overwriting the repository source credentials. Set totrue
to overwrite the repository source credentials. The default value istrue
.
- On success, responds with
ImportSourceCredentialsOutput
with field(s):arn(Option<String>)
:The Amazon Resource Name (ARN) of the token.
- On failure, responds with
SdkError<ImportSourceCredentialsError>
sourcepub fn invalidate_project_cache(&self) -> InvalidateProjectCache
pub fn invalidate_project_cache(&self) -> InvalidateProjectCache
Constructs a fluent builder for the InvalidateProjectCache
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild build project that the cache is reset for.
- On success, responds with
InvalidateProjectCacheOutput
- On failure, responds with
SdkError<InvalidateProjectCacheError>
sourcepub fn list_build_batches(&self) -> ListBuildBatches
pub fn list_build_batches(&self) -> ListBuildBatches
Constructs a fluent builder for the ListBuildBatches
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
filter(BuildBatchFilter)
/set_filter(Option<BuildBatchFilter>)
:A
BuildBatchFilter
object that specifies the filters for the search.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
nextToken
value returned from a previous call toListBuildBatches
. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
- On success, responds with
ListBuildBatchesOutput
with field(s):ids(Option<Vec<String>>)
:An array of strings that contains the batch build identifiers.
next_token(Option<String>)
:If there are more items to return, this contains a token that is passed to a subsequent call to
ListBuildBatches
to retrieve the next set of items.
- On failure, responds with
SdkError<ListBuildBatchesError>
sourcepub fn list_build_batches_for_project(&self) -> ListBuildBatchesForProject
pub fn list_build_batches_for_project(&self) -> ListBuildBatchesForProject
Constructs a fluent builder for the ListBuildBatchesForProject
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the project.
filter(BuildBatchFilter)
/set_filter(Option<BuildBatchFilter>)
:A
BuildBatchFilter
object that specifies the filters for the search.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The
nextToken
value returned from a previous call toListBuildBatchesForProject
. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
- On success, responds with
ListBuildBatchesForProjectOutput
with field(s):ids(Option<Vec<String>>)
:An array of strings that contains the batch build identifiers.
next_token(Option<String>)
:If there are more items to return, this contains a token that is passed to a subsequent call to
ListBuildBatchesForProject
to retrieve the next set of items.
- On failure, responds with
SdkError<ListBuildBatchesForProjectError>
sourcepub fn list_builds(&self) -> ListBuilds
pub fn list_builds(&self) -> ListBuilds
Constructs a fluent builder for the ListBuilds
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.
- On success, responds with
ListBuildsOutput
with field(s):ids(Option<Vec<String>>)
:A list of build IDs, with each build ID representing a single build.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListBuildsError>
sourcepub fn list_builds_for_project(&self) -> ListBuildsForProject
pub fn list_builds_for_project(&self) -> ListBuildsForProject
Constructs a fluent builder for the ListBuildsForProject
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild project.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.
- On success, responds with
ListBuildsForProjectOutput
with field(s):ids(Option<Vec<String>>)
:A list of build identifiers for the specified build project, with each build ID representing a single build.
next_token(Option<String>)
: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.
- On failure, responds with
SdkError<ListBuildsForProjectError>
sourcepub fn list_curated_environment_images(&self) -> ListCuratedEnvironmentImages
pub fn list_curated_environment_images(&self) -> ListCuratedEnvironmentImages
Constructs a fluent builder for the ListCuratedEnvironmentImages
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListCuratedEnvironmentImagesOutput
with field(s):platforms(Option<Vec<EnvironmentPlatform>>)
:Information about supported platforms for Docker images that are managed by CodeBuild.
- On failure, responds with
SdkError<ListCuratedEnvironmentImagesError>
sourcepub fn list_projects(&self) -> ListProjects
pub fn list_projects(&self) -> ListProjects
Constructs a fluent builder for the ListProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_by(ProjectSortByType)
/set_sort_by(Option<ProjectSortByType>)
:The criterion to be used to list build project names. Valid values include:
-
CREATED_TIME
: List based on when each build project was created. -
LAST_MODIFIED_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.-
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.
- On success, responds with
ListProjectsOutput
with field(s):next_token(Option<String>)
: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.
projects(Option<Vec<String>>)
:The list of build project names, with each build project name representing a single build project.
- On failure, responds with
SdkError<ListProjectsError>
sourcepub fn list_report_groups(&self) -> ListReportGroups
pub fn list_report_groups(&self) -> ListReportGroups
Constructs a fluent builder for the ListReportGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:Used to specify the order to sort the list of returned report groups. Valid values are
ASCENDING
andDESCENDING
.sort_by(ReportGroupSortByType)
/set_sort_by(Option<ReportGroupSortByType>)
:The criterion to be used to list build report groups. Valid values include:
-
CREATED_TIME
: List based on when each report group was created. -
LAST_MODIFIED_TIME
: List based on when each report group was last changed. -
NAME
: List based on each report group’s name.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated report groups returned per response. Use
nextToken
to iterate pages in the list of returnedReportGroup
objects. The default value is 100.
- On success, responds with
ListReportGroupsOutput
with field(s):next_token(Option<String>)
: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.report_groups(Option<Vec<String>>)
:The list of ARNs for the report groups in the current Amazon Web Services account.
- On failure, responds with
SdkError<ListReportGroupsError>
sourcepub fn list_reports(&self) -> ListReports
pub fn list_reports(&self) -> ListReports
Constructs a fluent builder for the ListReports
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated reports returned per response. Use
nextToken
to iterate pages in the list of returnedReport
objects. The default value is 100.filter(ReportFilter)
/set_filter(Option<ReportFilter>)
:A
ReportFilter
object used to filter the returned reports.
- On success, responds with
ListReportsOutput
with field(s):next_token(Option<String>)
: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.reports(Option<Vec<String>>)
:The list of returned ARNs for the reports in the current Amazon Web Services account.
- On failure, responds with
SdkError<ListReportsError>
sourcepub fn list_reports_for_report_group(&self) -> ListReportsForReportGroup
pub fn list_reports_for_report_group(&self) -> ListReportsForReportGroup
Constructs a fluent builder for the ListReportsForReportGroup
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
report_group_arn(impl Into<String>)
/set_report_group_arn(Option<String>)
:The ARN of the report group for which you want to return report ARNs.
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:Use to specify whether the results are returned in ascending or descending order.
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated reports in this report group returned per response. Use
nextToken
to iterate pages in the list of returnedReport
objects. The default value is 100.filter(ReportFilter)
/set_filter(Option<ReportFilter>)
:A
ReportFilter
object used to filter the returned reports.
- On success, responds with
ListReportsForReportGroupOutput
with field(s):next_token(Option<String>)
: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.reports(Option<Vec<String>>)
:The list of report ARNs.
- On failure, responds with
SdkError<ListReportsForReportGroupError>
Constructs a fluent builder for the ListSharedProjects
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_by(SharedResourceSortByType)
/set_sort_by(Option<SharedResourceSortByType>)
: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.
-
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:The order in which to list shared build projects. Valid values include:
-
ASCENDING
: List in ascending order. -
DESCENDING
: List in descending order.
-
max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated shared build projects returned per response. Use
nextToken
to iterate pages in the list of returnedProject
objects. The default value is 100.next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.
- On success, responds with
ListSharedProjectsOutput
with field(s):next_token(Option<String>)
: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.projects(Option<Vec<String>>)
:The list of ARNs for the build projects shared with the current Amazon Web Services account or user.
- On failure, responds with
SdkError<ListSharedProjectsError>
Constructs a fluent builder for the ListSharedReportGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:The order in which to list shared report groups. Valid values include:
-
ASCENDING
: List in ascending order. -
DESCENDING
: List in descending order.
-
sort_by(SharedResourceSortByType)
/set_sort_by(Option<SharedResourceSortByType>)
: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.
-
next_token(impl Into<String>)
/set_next_token(Option<String>)
: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.max_results(i32)
/set_max_results(Option<i32>)
:The maximum number of paginated shared report groups per response. Use
nextToken
to iterate pages in the list of returnedReportGroup
objects. The default value is 100.
- On success, responds with
ListSharedReportGroupsOutput
with field(s):next_token(Option<String>)
: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.report_groups(Option<Vec<String>>)
:The list of ARNs for the report groups shared with the current Amazon Web Services account or user.
- On failure, responds with
SdkError<ListSharedReportGroupsError>
sourcepub fn list_source_credentials(&self) -> ListSourceCredentials
pub fn list_source_credentials(&self) -> ListSourceCredentials
Constructs a fluent builder for the ListSourceCredentials
operation.
- The fluent builder takes no input, just
send
it. - On success, responds with
ListSourceCredentialsOutput
with field(s):source_credentials_infos(Option<Vec<SourceCredentialsInfo>>)
:A list of
SourceCredentialsInfo
objects. EachSourceCredentialsInfo
object includes the authentication type, token ARN, and type of source provider for one set of credentials.
- On failure, responds with
SdkError<ListSourceCredentialsError>
sourcepub fn put_resource_policy(&self) -> PutResourcePolicy
pub fn put_resource_policy(&self) -> PutResourcePolicy
Constructs a fluent builder for the PutResourcePolicy
operation.
- The fluent builder is configurable:
policy(impl Into<String>)
/set_policy(Option<String>)
:A JSON-formatted resource policy. For more information, see Sharing a Project and Sharing a Report Group in the CodeBuild User Guide.
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The ARN of the
Project
orReportGroup
resource you want to associate with a resource policy.
- On success, responds with
PutResourcePolicyOutput
with field(s):resource_arn(Option<String>)
:The ARN of the
Project
orReportGroup
resource that is associated with a resource policy.
- On failure, responds with
SdkError<PutResourcePolicyError>
sourcepub fn retry_build(&self) -> RetryBuild
pub fn retry_build(&self) -> RetryBuild
Constructs a fluent builder for the RetryBuild
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:Specifies the identifier of the build to restart.
idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
:A unique, case sensitive identifier you provide to ensure the idempotency of the
RetryBuild
request. The token is included in theRetryBuild
request and is valid for five minutes. If you repeat theRetryBuild
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.
- On success, responds with
RetryBuildOutput
with field(s):build_value(Option<Build>)
:Information about a build.
- On failure, responds with
SdkError<RetryBuildError>
sourcepub fn retry_build_batch(&self) -> RetryBuildBatch
pub fn retry_build_batch(&self) -> RetryBuildBatch
Constructs a fluent builder for the RetryBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:Specifies the identifier of the batch build to restart.
idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
:A unique, case sensitive identifier you provide to ensure the idempotency of the
RetryBuildBatch
request. The token is included in theRetryBuildBatch
request and is valid for five minutes. If you repeat theRetryBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.retry_type(RetryBuildBatchType)
/set_retry_type(Option<RetryBuildBatchType>)
:Specifies the type of retry to perform.
- On success, responds with
RetryBuildBatchOutput
with field(s):build_batch(Option<BuildBatch>)
:Contains information about a batch build.
- On failure, responds with
SdkError<RetryBuildBatchError>
sourcepub fn start_build(&self) -> StartBuild
pub fn start_build(&self) -> StartBuild
Constructs a fluent builder for the StartBuild
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild build project to start running a build.
secondary_sources_override(Vec<ProjectSource>)
/set_secondary_sources_override(Option<Vec<ProjectSource>>)
:An array of
ProjectSource
objects.secondary_sources_version_override(Vec<ProjectSourceVersion>)
/set_secondary_sources_version_override(Option<Vec<ProjectSourceVersion>>)
:An array of
ProjectSourceVersion
objects that specify one or more versions of the project’s secondary sources to be used for this build only.source_version(impl Into<String>)
/set_source_version(Option<String>)
: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 examplepr/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 thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
artifacts_override(ProjectArtifacts)
/set_artifacts_override(Option<ProjectArtifacts>)
:Build output artifact settings that override, for this build only, the latest ones already defined in the build project.
secondary_artifacts_override(Vec<ProjectArtifacts>)
/set_secondary_artifacts_override(Option<Vec<ProjectArtifacts>>)
:An array of
ProjectArtifacts
objects.environment_variables_override(Vec<EnvironmentVariable>)
/set_environment_variables_override(Option<Vec<EnvironmentVariable>>)
:A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.
source_type_override(SourceType)
/set_source_type_override(Option<SourceType>)
:A source input type, for this build, that overrides the source input defined in the build project.
source_location_override(impl Into<String>)
/set_source_location_override(Option<String>)
:A location that overrides, for this build, the source location for the one defined in the build project.
source_auth_override(SourceAuth)
/set_source_auth_override(Option<SourceAuth>)
: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.
git_clone_depth_override(i32)
/set_git_clone_depth_override(Option<i32>)
: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.
git_submodules_config_override(GitSubmodulesConfig)
/set_git_submodules_config_override(Option<GitSubmodulesConfig>)
:Information about the Git submodules configuration for this build of an CodeBuild build project.
buildspec_override(impl Into<String>)
/set_buildspec_override(Option<String>)
: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
CODEBUILD_SRC_DIR
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.insecure_ssl_override(bool)
/set_insecure_ssl_override(Option<bool>)
: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.
report_build_status_override(bool)
/set_report_build_status_override(Option<bool>)
: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.
build_status_config_override(BuildStatusConfig)
/set_build_status_config_override(Option<BuildStatusConfig>)
: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
, orBITBUCKET
.environment_type_override(EnvironmentType)
/set_environment_type_override(Option<EnvironmentType>)
:A container type for this build that overrides the one specified in the build project.
image_override(impl Into<String>)
/set_image_override(Option<String>)
:The name of an image for this build that overrides the one specified in the build project.
compute_type_override(ComputeType)
/set_compute_type_override(Option<ComputeType>)
:The name of a compute type for this build that overrides the one specified in the build project.
certificate_override(impl Into<String>)
/set_certificate_override(Option<String>)
:The name of a certificate for this build that overrides the one specified in the build project.
cache_override(ProjectCache)
/set_cache_override(Option<ProjectCache>)
:A ProjectCache object specified for this build that overrides the one defined in the build project.
service_role_override(impl Into<String>)
/set_service_role_override(Option<String>)
:The name of a service role for this build that overrides the one specified in the build project.
privileged_mode_override(bool)
/set_privileged_mode_override(Option<bool>)
:Enable this flag to override privileged mode in the build project.
timeout_in_minutes_override(i32)
/set_timeout_in_minutes_override(Option<i32>)
: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.
queued_timeout_in_minutes_override(i32)
/set_queued_timeout_in_minutes_override(Option<i32>)
:The number of minutes a build is allowed to be queued before it times out.
encryption_key_override(impl Into<String>)
/set_encryption_key_override(Option<String>)
: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/
).idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
: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.
logs_config_override(LogsConfig)
/set_logs_config_override(Option<LogsConfig>)
:Log settings for this build that override the log settings defined in the build project.
registry_credential_override(RegistryCredential)
/set_registry_credential_override(Option<RegistryCredential>)
:The credentials for access to a private registry.
image_pull_credentials_type_override(ImagePullCredentialsType)
/set_image_pull_credentials_type_override(Option<ImagePullCredentialsType>)
: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.
- SERVICE_ROLE
-
Specifies that CodeBuild uses your build project’s service role.
When using a cross-account or private registry image, you must use
SERVICE_ROLE
credentials. When using an CodeBuild curated image, you must useCODEBUILD
credentials.debug_session_enabled(bool)
/set_debug_session_enabled(Option<bool>)
:Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
- On success, responds with
StartBuildOutput
with field(s):build_value(Option<Build>)
:Information about the build to be run.
- On failure, responds with
SdkError<StartBuildError>
sourcepub fn start_build_batch(&self) -> StartBuildBatch
pub fn start_build_batch(&self) -> StartBuildBatch
Constructs a fluent builder for the StartBuildBatch
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the project.
secondary_sources_override(Vec<ProjectSource>)
/set_secondary_sources_override(Option<Vec<ProjectSource>>)
:An array of
ProjectSource
objects that override the secondary sources defined in the batch build project.secondary_sources_version_override(Vec<ProjectSourceVersion>)
/set_secondary_sources_version_override(Option<Vec<ProjectSourceVersion>>)
:An array of
ProjectSourceVersion
objects that override the secondary source versions in the batch build project.source_version(impl Into<String>)
/set_source_version(Option<String>)
: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 examplepr/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 thissourceVersion
(at the build level) takes precedence.For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
artifacts_override(ProjectArtifacts)
/set_artifacts_override(Option<ProjectArtifacts>)
:An array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.secondary_artifacts_override(Vec<ProjectArtifacts>)
/set_secondary_artifacts_override(Option<Vec<ProjectArtifacts>>)
:An array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.environment_variables_override(Vec<EnvironmentVariable>)
/set_environment_variables_override(Option<Vec<EnvironmentVariable>>)
:An array of
EnvironmentVariable
objects that override, or add to, the environment variables defined in the batch build project.source_type_override(SourceType)
/set_source_type_override(Option<SourceType>)
:The source input type that overrides the source input defined in the batch build project.
source_location_override(impl Into<String>)
/set_source_location_override(Option<String>)
:A location that overrides, for this batch build, the source location defined in the batch build project.
source_auth_override(SourceAuth)
/set_source_auth_override(Option<SourceAuth>)
: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.git_clone_depth_override(i32)
/set_git_clone_depth_override(Option<i32>)
: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.
git_submodules_config_override(GitSubmodulesConfig)
/set_git_submodules_config_override(Option<GitSubmodulesConfig>)
:A
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.buildspec_override(impl Into<String>)
/set_buildspec_override(Option<String>)
: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
CODEBUILD_SRC_DIR
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.insecure_ssl_override(bool)
/set_insecure_ssl_override(Option<bool>)
: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.
report_build_batch_status_override(bool)
/set_report_build_batch_status_override(Option<bool>)
: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, aninvalidInputException
is thrown.The status of a build triggered by a webhook is always reported to your source provider.
environment_type_override(EnvironmentType)
/set_environment_type_override(Option<EnvironmentType>)
:A container type for this batch build that overrides the one specified in the batch build project.
image_override(impl Into<String>)
/set_image_override(Option<String>)
:The name of an image for this batch build that overrides the one specified in the batch build project.
compute_type_override(ComputeType)
/set_compute_type_override(Option<ComputeType>)
:The name of a compute type for this batch build that overrides the one specified in the batch build project.
certificate_override(impl Into<String>)
/set_certificate_override(Option<String>)
:The name of a certificate for this batch build that overrides the one specified in the batch build project.
cache_override(ProjectCache)
/set_cache_override(Option<ProjectCache>)
:A
ProjectCache
object that specifies cache overrides.service_role_override(impl Into<String>)
/set_service_role_override(Option<String>)
:The name of a service role for this batch build that overrides the one specified in the batch build project.
privileged_mode_override(bool)
/set_privileged_mode_override(Option<bool>)
:Enable this flag to override privileged mode in the batch build project.
build_timeout_in_minutes_override(i32)
/set_build_timeout_in_minutes_override(Option<i32>)
:Overrides the build timeout specified in the batch build project.
queued_timeout_in_minutes_override(i32)
/set_queued_timeout_in_minutes_override(Option<i32>)
:The number of minutes a batch build is allowed to be queued before it times out.
encryption_key_override(impl Into<String>)
/set_encryption_key_override(Option<String>)
: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/
).idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
:A unique, case sensitive identifier you provide to ensure the idempotency of the
StartBuildBatch
request. The token is included in theStartBuildBatch
request and is valid for five minutes. If you repeat theStartBuildBatch
request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.logs_config_override(LogsConfig)
/set_logs_config_override(Option<LogsConfig>)
:A
LogsConfig
object that override the log settings defined in the batch build project.registry_credential_override(RegistryCredential)
/set_registry_credential_override(Option<RegistryCredential>)
:A
RegistryCredential
object that overrides credentials for access to a private registry.image_pull_credentials_type_override(ImagePullCredentialsType)
/set_image_pull_credentials_type_override(Option<ImagePullCredentialsType>)
: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.
- SERVICE_ROLE
-
Specifies that CodeBuild uses your build project’s service role.
When using a cross-account or private registry image, you must use
SERVICE_ROLE
credentials. When using an CodeBuild curated image, you must useCODEBUILD
credentials.build_batch_config_override(ProjectBuildBatchConfig)
/set_build_batch_config_override(Option<ProjectBuildBatchConfig>)
:A
BuildBatchConfigOverride
object that contains batch build configuration overrides.debug_session_enabled(bool)
/set_debug_session_enabled(Option<bool>)
: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.
- On success, responds with
StartBuildBatchOutput
with field(s):build_batch(Option<BuildBatch>)
:A
BuildBatch
object that contains information about the batch build.
- On failure, responds with
SdkError<StartBuildBatchError>
sourcepub fn stop_build(&self) -> StopBuild
pub fn stop_build(&self) -> StopBuild
Constructs a fluent builder for the StopBuild
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The ID of the build.
- On success, responds with
StopBuildOutput
with field(s):build_value(Option<Build>)
:Information about the build.
- On failure, responds with
SdkError<StopBuildError>
sourcepub fn stop_build_batch(&self) -> StopBuildBatch
pub fn stop_build_batch(&self) -> StopBuildBatch
Constructs a fluent builder for the StopBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:The identifier of the batch build to stop.
- On success, responds with
StopBuildBatchOutput
with field(s):build_batch(Option<BuildBatch>)
:Contains information about a batch build.
- On failure, responds with
SdkError<StopBuildBatchError>
sourcepub fn update_project(&self) -> UpdateProject
pub fn update_project(&self) -> UpdateProject
Constructs a fluent builder for the UpdateProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:The name of the build project.
You cannot change a build project’s name.
description(impl Into<String>)
/set_description(Option<String>)
:A new or replacement description of the build project.
source(ProjectSource)
/set_source(Option<ProjectSource>)
:Information to be changed about the build input source code for the build project.
secondary_sources(Vec<ProjectSource>)
/set_secondary_sources(Option<Vec<ProjectSource>>)
:An array of
ProjectSource
objects.source_version(impl Into<String>)
/set_source_version(Option<String>)
: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 examplepr/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 thissourceVersion
(at the project level).For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.
-
secondary_source_versions(Vec<ProjectSourceVersion>)
/set_secondary_source_versions(Option<Vec<ProjectSourceVersion>>)
:An array of
ProjectSourceVersion
objects. IfsecondarySourceVersions
is specified at the build level, then they take over thesesecondarySourceVersions
(at the project level).artifacts(ProjectArtifacts)
/set_artifacts(Option<ProjectArtifacts>)
:Information to be changed about the build output artifacts for the build project.
secondary_artifacts(Vec<ProjectArtifacts>)
/set_secondary_artifacts(Option<Vec<ProjectArtifacts>>)
:An array of
ProjectArtifact
objects.cache(ProjectCache)
/set_cache(Option<ProjectCache>)
:Stores recently used information so that it can be quickly accessed at a later time.
environment(ProjectEnvironment)
/set_environment(Option<ProjectEnvironment>)
:Information to be changed about the build environment for the build project.
service_role(impl Into<String>)
/set_service_role(Option<String>)
: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.
timeout_in_minutes(i32)
/set_timeout_in_minutes(Option<i32>)
: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.
queued_timeout_in_minutes(i32)
/set_queued_timeout_in_minutes(Option<i32>)
:The number of minutes a build is allowed to be queued before it times out.
encryption_key(impl Into<String>)
/set_encryption_key(Option<String>)
: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/
).tags(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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.
vpc_config(VpcConfig)
/set_vpc_config(Option<VpcConfig>)
:VpcConfig enables CodeBuild to access resources in an Amazon VPC.
badge_enabled(bool)
/set_badge_enabled(Option<bool>)
:Set this to true to generate a publicly accessible URL for your project’s build badge.
logs_config(LogsConfig)
/set_logs_config(Option<LogsConfig>)
:Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
file_system_locations(Vec<ProjectFileSystemLocation>)
/set_file_system_locations(Option<Vec<ProjectFileSystemLocation>>)
:An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
of a file system created using Amazon Elastic File System.build_batch_config(ProjectBuildBatchConfig)
/set_build_batch_config(Option<ProjectBuildBatchConfig>)
:Contains configuration information about a batch build project.
concurrent_build_limit(i32)
/set_concurrent_build_limit(Option<i32>)
: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.
- On success, responds with
UpdateProjectOutput
with field(s):project(Option<Project>)
:Information about the build project that was changed.
- On failure, responds with
SdkError<UpdateProjectError>
sourcepub fn update_project_visibility(&self) -> UpdateProjectVisibility
pub fn update_project_visibility(&self) -> UpdateProjectVisibility
Constructs a fluent builder for the UpdateProjectVisibility
operation.
- The fluent builder is configurable:
project_arn(impl Into<String>)
/set_project_arn(Option<String>)
:The Amazon Resource Name (ARN) of the build project.
project_visibility(ProjectVisibilityType)
/set_project_visibility(Option<ProjectVisibilityType>)
:Specifies the visibility of the project’s builds. Possible values are:
- PUBLIC_READ
-
The project builds are visible to the public.
- PRIVATE
-
The project builds are not visible to the public.
resource_access_role(impl Into<String>)
/set_resource_access_role(Option<String>)
:The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project’s builds.
- On success, responds with
UpdateProjectVisibilityOutput
with field(s):project_arn(Option<String>)
:The Amazon Resource Name (ARN) of the build project.
public_project_alias(Option<String>)
:Contains the project identifier used with the public build APIs.
project_visibility(Option<ProjectVisibilityType>)
:Specifies the visibility of the project’s builds. Possible values are:
- PUBLIC_READ
-
The project builds are visible to the public.
- PRIVATE
-
The project builds are not visible to the public.
- On failure, responds with
SdkError<UpdateProjectVisibilityError>
sourcepub fn update_report_group(&self) -> UpdateReportGroup
pub fn update_report_group(&self) -> UpdateReportGroup
Constructs a fluent builder for the UpdateReportGroup
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:The ARN of the report group to update.
export_config(ReportExportConfig)
/set_export_config(Option<ReportExportConfig>)
: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(Vec<Tag>)
/set_tags(Option<Vec<Tag>>)
: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.
- On success, responds with
UpdateReportGroupOutput
with field(s):report_group(Option<ReportGroup>)
:Information about the updated report group.
- On failure, responds with
SdkError<UpdateReportGroupError>
sourcepub fn update_webhook(&self) -> UpdateWebhook
pub fn update_webhook(&self) -> UpdateWebhook
Constructs a fluent builder for the UpdateWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:The name of the CodeBuild project.
branch_filter(impl Into<String>)
/set_branch_filter(Option<String>)
: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 ofbranchFilter
.rotate_secret(bool)
/set_rotate_secret(bool)
: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.filter_groups(Vec<Vec<WebhookFilter>>)
/set_filter_groups(Option<Vec<Vec<WebhookFilter>>>)
: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 oneEVENT
WebhookFilter
.build_type(WebhookBuildType)
/set_build_type(Option<WebhookBuildType>)
:Specifies the type of build this webhook will trigger.
- On success, responds with
UpdateWebhookOutput
with field(s):webhook(Option<Webhook>)
:Information about a repository’s webhook that is associated with a project in CodeBuild.
- On failure, responds with
SdkError<UpdateWebhookError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more