Struct aws_sdk_codebuild::client::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.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_codebuild::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_codebuild::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateFleet
operation has
a Client::create_fleet
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_fleet()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn batch_delete_builds(&self) -> BatchDeleteBuildsFluentBuilder
pub fn batch_delete_builds(&self) -> BatchDeleteBuildsFluentBuilder
Constructs a fluent builder for the BatchDeleteBuilds
operation.
- The fluent builder is configurable:
ids(impl Into<String>)
/set_ids(Option<Vec::<String>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn batch_get_build_batches(&self) -> BatchGetBuildBatchesFluentBuilder
pub fn batch_get_build_batches(&self) -> BatchGetBuildBatchesFluentBuilder
Constructs a fluent builder for the BatchGetBuildBatches
operation.
- The fluent builder is configurable:
ids(impl Into<String>)
/set_ids(Option<Vec::<String>>)
:
required: trueAn 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>
source§impl Client
impl Client
sourcepub fn batch_get_builds(&self) -> BatchGetBuildsFluentBuilder
pub fn batch_get_builds(&self) -> BatchGetBuildsFluentBuilder
Constructs a fluent builder for the BatchGetBuilds
operation.
- The fluent builder is configurable:
ids(impl Into<String>)
/set_ids(Option<Vec::<String>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn batch_get_fleets(&self) -> BatchGetFleetsFluentBuilder
pub fn batch_get_fleets(&self) -> BatchGetFleetsFluentBuilder
Constructs a fluent builder for the BatchGetFleets
operation.
- The fluent builder is configurable:
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueThe names or ARNs of the compute fleets.
- On success, responds with
BatchGetFleetsOutput
with field(s):fleets(Option<Vec::<Fleet>>)
:Information about the requested compute fleets.
fleets_not_found(Option<Vec::<String>>)
:The names of compute fleets for which information could not be found.
- On failure, responds with
SdkError<BatchGetFleetsError>
source§impl Client
impl Client
sourcepub fn batch_get_projects(&self) -> BatchGetProjectsFluentBuilder
pub fn batch_get_projects(&self) -> BatchGetProjectsFluentBuilder
Constructs a fluent builder for the BatchGetProjects
operation.
- The fluent builder is configurable:
names(impl Into<String>)
/set_names(Option<Vec::<String>>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn batch_get_report_groups(&self) -> BatchGetReportGroupsFluentBuilder
pub fn batch_get_report_groups(&self) -> BatchGetReportGroupsFluentBuilder
Constructs a fluent builder for the BatchGetReportGroups
operation.
- The fluent builder is configurable:
report_group_arns(impl Into<String>)
/set_report_group_arns(Option<Vec::<String>>)
:
required: trueAn 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>
source§impl Client
impl Client
sourcepub fn batch_get_reports(&self) -> BatchGetReportsFluentBuilder
pub fn batch_get_reports(&self) -> BatchGetReportsFluentBuilder
Constructs a fluent builder for the BatchGetReports
operation.
- The fluent builder is configurable:
report_arns(impl Into<String>)
/set_report_arns(Option<Vec::<String>>)
:
required: trueAn 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>
source§impl Client
impl Client
sourcepub fn create_fleet(&self) -> CreateFleetFluentBuilder
pub fn create_fleet(&self) -> CreateFleetFluentBuilder
Constructs a fluent builder for the CreateFleet
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the compute fleet.
base_capacity(i32)
/set_base_capacity(Option<i32>)
:
required: trueThe initial number of machines allocated to the fleet, which defines the number of builds that can run in parallel.
environment_type(EnvironmentType)
/set_environment_type(Option<EnvironmentType>)
:
required: trueThe environment type of the compute fleet.
-
The environment type
ARM_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo). -
The environment type
LINUX_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). -
The environment type
LINUX_GPU_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). -
The environment type
WINDOWS_SERVER_2019_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). -
The environment type
WINDOWS_SERVER_2022_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
-
compute_type(ComputeType)
/set_compute_type(Option<ComputeType>)
:
required: trueInformation about the compute resources the compute fleet uses. Available values include:
-
BUILD_GENERAL1_SMALL
: Use up to 3 GB memory and 2 vCPUs for builds. -
BUILD_GENERAL1_MEDIUM
: Use up to 7 GB memory and 4 vCPUs for builds. -
BUILD_GENERAL1_LARGE
: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_XLARGE
: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_2XLARGE
: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE
:-
For environment type
LINUX_CONTAINER
, you can use up to 15 GB memory and 8 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. -
For environment type
ARM_CONTAINER
, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
-
scaling_configuration(ScalingConfigurationInput)
/set_scaling_configuration(Option<ScalingConfigurationInput>)
:
required: falseThe scaling configuration of the compute fleet.
overflow_behavior(FleetOverflowBehavior)
/set_overflow_behavior(Option<FleetOverflowBehavior>)
:
required: falseThe compute fleet overflow behavior.
-
For overflow behavior
QUEUE
, your overflow builds need to wait on the existing fleet instance to become available. -
For overflow behavior
ON_DEMAND
, your overflow builds run on CodeBuild on-demand.
-
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
- On success, responds with
CreateFleetOutput
with field(s):fleet(Option<Fleet>)
:Information about the compute fleet
- On failure, responds with
SdkError<CreateFleetError>
source§impl Client
impl Client
sourcepub fn create_project(&self) -> CreateProjectFluentBuilder
pub fn create_project(&self) -> CreateProjectFluentBuilder
Constructs a fluent builder for the CreateProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the build project.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description that makes the build project easy to identify.
source(ProjectSource)
/set_source(Option<ProjectSource>)
:
required: trueInformation about the build input source code for the build project.
secondary_sources(ProjectSource)
/set_secondary_sources(Option<Vec::<ProjectSource>>)
:
required: falseAn array of
ProjectSource
objects.source_version(impl Into<String>)
/set_source_version(Option<String>)
:
required: falseA 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(ProjectSourceVersion)
/set_secondary_source_versions(Option<Vec::<ProjectSourceVersion>>)
:
required: falseAn 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>)
:
required: trueInformation about the build output artifacts for the build project.
secondary_artifacts(ProjectArtifacts)
/set_secondary_artifacts(Option<Vec::<ProjectArtifacts>>)
:
required: falseAn array of
ProjectArtifacts
objects.cache(ProjectCache)
/set_cache(Option<ProjectCache>)
:
required: falseStores recently used information so that it can be quickly accessed at a later time.
environment(ProjectEnvironment)
/set_environment(Option<ProjectEnvironment>)
:
required: trueInformation about the build environment for the build project.
service_role(impl Into<String>)
/set_service_role(Option<String>)
:
required: trueThe 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>)
:
required: falseHow 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>)
:
required: falseThe number of minutes a build is allowed to be queued before it times out.
encryption_key(impl Into<String>)
/set_encryption_key(Option<String>)
:
required: falseThe 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA 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>)
:
required: falseVpcConfig enables CodeBuild to access resources in an Amazon VPC.
badge_enabled(bool)
/set_badge_enabled(Option<bool>)
:
required: falseSet this to true to generate a publicly accessible URL for your project’s build badge.
logs_config(LogsConfig)
/set_logs_config(Option<LogsConfig>)
:
required: falseInformation 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(ProjectFileSystemLocation)
/set_file_system_locations(Option<Vec::<ProjectFileSystemLocation>>)
:
required: falseAn 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>)
:
required: falseA
ProjectBuildBatchConfig
object that defines the batch build options for the project.concurrent_build_limit(i32)
/set_concurrent_build_limit(Option<i32>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn create_report_group(&self) -> CreateReportGroupFluentBuilder
pub fn create_report_group(&self) -> CreateReportGroupFluentBuilder
Constructs a fluent builder for the CreateReportGroup
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the report group.
r#type(ReportType)
/set_type(Option<ReportType>)
:
required: trueThe type of report group.
export_config(ReportExportConfig)
/set_export_config(Option<ReportExportConfig>)
:
required: trueA
ReportExportConfig
object that contains information about where the report group test results are exported.tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn create_webhook(&self) -> CreateWebhookFluentBuilder
pub fn create_webhook(&self) -> CreateWebhookFluentBuilder
Constructs a fluent builder for the CreateWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the CodeBuild project.
branch_filter(impl Into<String>)
/set_branch_filter(Option<String>)
:
required: falseA 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::<WebhookFilter>)
/set_filter_groups(Option<Vec::<Vec::<WebhookFilter>>>)
:
required: falseAn 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>)
:
required: falseSpecifies 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>
source§impl Client
impl Client
sourcepub fn delete_build_batch(&self) -> DeleteBuildBatchFluentBuilder
pub fn delete_build_batch(&self) -> DeleteBuildBatchFluentBuilder
Constructs a fluent builder for the DeleteBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
pub fn delete_fleet(&self) -> DeleteFleetFluentBuilder
Constructs a fluent builder for the DeleteFleet
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the compute fleet.
- On success, responds with
DeleteFleetOutput
- On failure, responds with
SdkError<DeleteFleetError>
source§impl Client
impl Client
sourcepub fn delete_project(&self) -> DeleteProjectFluentBuilder
pub fn delete_project(&self) -> DeleteProjectFluentBuilder
Constructs a fluent builder for the DeleteProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the build project.
- On success, responds with
DeleteProjectOutput
- On failure, responds with
SdkError<DeleteProjectError>
source§impl Client
impl Client
sourcepub fn delete_report(&self) -> DeleteReportFluentBuilder
pub fn delete_report(&self) -> DeleteReportFluentBuilder
Constructs a fluent builder for the DeleteReport
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the report to delete.
- On success, responds with
DeleteReportOutput
- On failure, responds with
SdkError<DeleteReportError>
source§impl Client
impl Client
sourcepub fn delete_report_group(&self) -> DeleteReportGroupFluentBuilder
pub fn delete_report_group(&self) -> DeleteReportGroupFluentBuilder
Constructs a fluent builder for the DeleteReportGroup
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the report group to delete.
delete_reports(bool)
/set_delete_reports(Option<bool>)
:
required: falseIf
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>
source§impl Client
impl Client
sourcepub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
pub fn delete_resource_policy(&self) -> DeleteResourcePolicyFluentBuilder
Constructs a fluent builder for the DeleteResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource that is associated with the resource policy.
- On success, responds with
DeleteResourcePolicyOutput
- On failure, responds with
SdkError<DeleteResourcePolicyError>
source§impl Client
impl Client
sourcepub fn delete_source_credentials(&self) -> DeleteSourceCredentialsFluentBuilder
pub fn delete_source_credentials(&self) -> DeleteSourceCredentialsFluentBuilder
Constructs a fluent builder for the DeleteSourceCredentials
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn delete_webhook(&self) -> DeleteWebhookFluentBuilder
pub fn delete_webhook(&self) -> DeleteWebhookFluentBuilder
Constructs a fluent builder for the DeleteWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the CodeBuild project.
- On success, responds with
DeleteWebhookOutput
- On failure, responds with
SdkError<DeleteWebhookError>
source§impl Client
impl Client
sourcepub fn describe_code_coverages(&self) -> DescribeCodeCoveragesFluentBuilder
pub fn describe_code_coverages(&self) -> DescribeCodeCoveragesFluentBuilder
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>)
:
required: trueThe ARN of the report for which test cases are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe
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>)
:
required: falseThe maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:
required: falseSpecifies if the results are sorted in ascending or descending order.
sort_by(ReportCodeCoverageSortByType)
/set_sort_by(Option<ReportCodeCoverageSortByType>)
:
required: falseSpecifies 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>)
:
required: falseThe minimum line coverage percentage to report.
max_line_coverage_percentage(f64)
/set_max_line_coverage_percentage(Option<f64>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn describe_test_cases(&self) -> DescribeTestCasesFluentBuilder
pub fn describe_test_cases(&self) -> DescribeTestCasesFluentBuilder
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>)
:
required: trueThe ARN of the report for which test cases are returned.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseDuring 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>)
:
required: falseThe 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>)
:
required: falseA
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>
source§impl Client
impl Client
sourcepub fn get_report_group_trend(&self) -> GetReportGroupTrendFluentBuilder
pub fn get_report_group_trend(&self) -> GetReportGroupTrendFluentBuilder
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>)
:
required: trueThe ARN of the report group that contains the reports to analyze.
num_of_reports(i32)
/set_num_of_reports(Option<i32>)
:
required: falseThe 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>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
pub fn get_resource_policy(&self) -> GetResourcePolicyFluentBuilder
Constructs a fluent builder for the GetResourcePolicy
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn import_source_credentials(&self) -> ImportSourceCredentialsFluentBuilder
pub fn import_source_credentials(&self) -> ImportSourceCredentialsFluentBuilder
Constructs a fluent builder for the ImportSourceCredentials
operation.
- The fluent builder is configurable:
username(impl Into<String>)
/set_username(Option<String>)
:
required: falseThe 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>)
:
required: trueFor GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password.
server_type(ServerType)
/set_server_type(Option<ServerType>)
:
required: trueThe source provider used for this project.
auth_type(AuthType)
/set_auth_type(Option<AuthType>)
:
required: trueThe 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>)
:
required: falseSet 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>
source§impl Client
impl Client
sourcepub fn invalidate_project_cache(&self) -> InvalidateProjectCacheFluentBuilder
pub fn invalidate_project_cache(&self) -> InvalidateProjectCacheFluentBuilder
Constructs a fluent builder for the InvalidateProjectCache
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the CodeBuild build project that the cache is reset for.
- On success, responds with
InvalidateProjectCacheOutput
- On failure, responds with
SdkError<InvalidateProjectCacheError>
source§impl Client
impl Client
sourcepub fn list_build_batches(&self) -> ListBuildBatchesFluentBuilder
pub fn list_build_batches(&self) -> ListBuildBatchesFluentBuilder
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>)
:
required: falseA
BuildBatchFilter
object that specifies the filters for the search.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:
required: falseSpecifies 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>)
:
required: falseThe
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>
source§impl Client
impl Client
sourcepub fn list_build_batches_for_project(
&self
) -> ListBuildBatchesForProjectFluentBuilder
pub fn list_build_batches_for_project( &self ) -> ListBuildBatchesForProjectFluentBuilder
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>)
:
required: falseThe name of the project.
filter(BuildBatchFilter)
/set_filter(Option<BuildBatchFilter>)
:
required: falseA
BuildBatchFilter
object that specifies the filters for the search.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:
required: falseSpecifies 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>)
:
required: falseThe
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>
source§impl Client
impl Client
sourcepub fn list_builds(&self) -> ListBuildsFluentBuilder
pub fn list_builds(&self) -> ListBuildsFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseDuring 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>
source§impl Client
impl Client
sourcepub fn list_builds_for_project(&self) -> ListBuildsForProjectFluentBuilder
pub fn list_builds_for_project(&self) -> ListBuildsForProjectFluentBuilder
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>)
:
required: trueThe name of the CodeBuild project.
sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:
required: falseThe 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>)
:
required: falseDuring 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>
source§impl Client
impl Client
sourcepub fn list_curated_environment_images(
&self
) -> ListCuratedEnvironmentImagesFluentBuilder
pub fn list_curated_environment_images( &self ) -> ListCuratedEnvironmentImagesFluentBuilder
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>
source§impl Client
impl Client
sourcepub fn list_fleets(&self) -> ListFleetsFluentBuilder
pub fn list_fleets(&self) -> ListFleetsFluentBuilder
Constructs a fluent builder for the ListFleets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseDuring 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.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of paginated compute fleets returned per response. Use
nextToken
to iterate pages in the list of returned compute fleets.sort_order(SortOrderType)
/set_sort_order(Option<SortOrderType>)
:
required: falseThe order in which to list compute fleets. Valid values include:
-
ASCENDING
: List in ascending order. -
DESCENDING
: List in descending order.
Use
sortBy
to specify the criterion to be used to list compute fleet names.-
sort_by(FleetSortByType)
/set_sort_by(Option<FleetSortByType>)
:
required: falseThe criterion to be used to list compute fleet names. Valid values include:
-
CREATED_TIME
: List based on when each compute fleet was created. -
LAST_MODIFIED_TIME
: List based on when information about each compute fleet was last changed. -
NAME
: List based on each compute fleet’s name.
Use
sortOrder
to specify in what order to list the compute fleet names based on the preceding criteria.-
- On success, responds with
ListFleetsOutput
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.
fleets(Option<Vec::<String>>)
:The list of compute fleet names.
- On failure, responds with
SdkError<ListFleetsError>
source§impl Client
impl Client
sourcepub fn list_projects(&self) -> ListProjectsFluentBuilder
pub fn list_projects(&self) -> ListProjectsFluentBuilder
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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseDuring 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>
source§impl Client
impl Client
sourcepub fn list_report_groups(&self) -> ListReportGroupsFluentBuilder
pub fn list_report_groups(&self) -> ListReportGroupsFluentBuilder
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>)
:
required: falseUsed 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>)
:
required: falseThe 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>)
:
required: falseDuring 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_reports(&self) -> ListReportsFluentBuilder
pub fn list_reports(&self) -> ListReportsFluentBuilder
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>)
:
required: falseSpecifies 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>)
:
required: falseDuring 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>)
:
required: falseThe 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>)
:
required: falseA
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>
source§impl Client
impl Client
sourcepub fn list_reports_for_report_group(
&self
) -> ListReportsForReportGroupFluentBuilder
pub fn list_reports_for_report_group( &self ) -> ListReportsForReportGroupFluentBuilder
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>)
:
required: trueThe ARN of the report group for which you want to return report ARNs.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseDuring 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>)
:
required: falseUse to specify whether the results are returned in ascending or descending order.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe 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>)
:
required: falseA
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>
source§impl Client
impl Client
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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseDuring 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>
source§impl Client
impl Client
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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseDuring 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn list_source_credentials(&self) -> ListSourceCredentialsFluentBuilder
pub fn list_source_credentials(&self) -> ListSourceCredentialsFluentBuilder
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>
source§impl Client
impl Client
sourcepub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
pub fn put_resource_policy(&self) -> PutResourcePolicyFluentBuilder
Constructs a fluent builder for the PutResourcePolicy
operation.
- The fluent builder is configurable:
policy(impl Into<String>)
/set_policy(Option<String>)
:
required: trueA 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>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn retry_build(&self) -> RetryBuildFluentBuilder
pub fn retry_build(&self) -> RetryBuildFluentBuilder
Constructs a fluent builder for the RetryBuild
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseSpecifies the identifier of the build to restart.
idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
:
required: falseA 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>
source§impl Client
impl Client
sourcepub fn retry_build_batch(&self) -> RetryBuildBatchFluentBuilder
pub fn retry_build_batch(&self) -> RetryBuildBatchFluentBuilder
Constructs a fluent builder for the RetryBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: falseSpecifies the identifier of the batch build to restart.
idempotency_token(impl Into<String>)
/set_idempotency_token(Option<String>)
:
required: falseA 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>)
:
required: falseSpecifies 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>
source§impl Client
impl Client
sourcepub fn start_build(&self) -> StartBuildFluentBuilder
pub fn start_build(&self) -> StartBuildFluentBuilder
Constructs a fluent builder for the StartBuild
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the CodeBuild build project to start running a build.
secondary_sources_override(ProjectSource)
/set_secondary_sources_override(Option<Vec::<ProjectSource>>)
:
required: falseAn array of
ProjectSource
objects.secondary_sources_version_override(ProjectSourceVersion)
/set_secondary_sources_version_override(Option<Vec::<ProjectSourceVersion>>)
:
required: falseAn 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>)
:
required: falseThe 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>)
:
required: falseBuild output artifact settings that override, for this build only, the latest ones already defined in the build project.
secondary_artifacts_override(ProjectArtifacts)
/set_secondary_artifacts_override(Option<Vec::<ProjectArtifacts>>)
:
required: falseAn array of
ProjectArtifacts
objects.environment_variables_override(EnvironmentVariable)
/set_environment_variables_override(Option<Vec::<EnvironmentVariable>>)
:
required: falseA 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>)
:
required: falseA 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>)
:
required: falseA 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>)
:
required: falseAn 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>)
:
required: falseThe 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>)
:
required: falseInformation about the Git submodules configuration for this build of an CodeBuild build project.
buildspec_override(impl Into<String>)
/set_buildspec_override(Option<String>)
:
required: falseA buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.
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.Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.
insecure_ssl_override(bool)
/set_insecure_ssl_override(Option<bool>)
:
required: falseEnable 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>)
:
required: falseSet 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>)
:
required: falseContains 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>)
:
required: falseA container type for this build that overrides the one specified in the build project.
image_override(impl Into<String>)
/set_image_override(Option<String>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe name of a certificate for this build that overrides the one specified in the build project.
cache_override(ProjectCache)
/set_cache_override(Option<ProjectCache>)
:
required: falseA 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>)
:
required: falseThe 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>)
:
required: falseEnable this flag to override privileged mode in the build project.
timeout_in_minutes_override(i32)
/set_timeout_in_minutes_override(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseA 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>)
:
required: falseLog settings for this build that override the log settings defined in the build project.
registry_credential_override(RegistryCredential)
/set_registry_credential_override(Option<RegistryCredential>)
:
required: falseThe credentials for access to a private registry.
image_pull_credentials_type_override(ImagePullCredentialsType)
/set_image_pull_credentials_type_override(Option<ImagePullCredentialsType>)
:
required: falseThe 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>)
:
required: falseSpecifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.
fleet_override(ProjectFleet)
/set_fleet_override(Option<ProjectFleet>)
:
required: falseA ProjectFleet object specified for this build that overrides the one defined in the build project.
- 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>
source§impl Client
impl Client
sourcepub fn start_build_batch(&self) -> StartBuildBatchFluentBuilder
pub fn start_build_batch(&self) -> StartBuildBatchFluentBuilder
Constructs a fluent builder for the StartBuildBatch
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the project.
secondary_sources_override(ProjectSource)
/set_secondary_sources_override(Option<Vec::<ProjectSource>>)
:
required: falseAn array of
ProjectSource
objects that override the secondary sources defined in the batch build project.secondary_sources_version_override(ProjectSourceVersion)
/set_secondary_sources_version_override(Option<Vec::<ProjectSourceVersion>>)
:
required: falseAn 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>)
:
required: falseThe 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>)
:
required: falseAn array of
ProjectArtifacts
objects that contains information about the build output artifact overrides for the build project.secondary_artifacts_override(ProjectArtifacts)
/set_secondary_artifacts_override(Option<Vec::<ProjectArtifacts>>)
:
required: falseAn array of
ProjectArtifacts
objects that override the secondary artifacts defined in the batch build project.environment_variables_override(EnvironmentVariable)
/set_environment_variables_override(Option<Vec::<EnvironmentVariable>>)
:
required: falseAn 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>)
:
required: falseThe 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>)
:
required: falseA 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>)
:
required: falseA
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>)
:
required: falseThe 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>)
:
required: falseA
GitSubmodulesConfig
object that overrides the Git submodules configuration for this batch build.buildspec_override(impl Into<String>)
/set_buildspec_override(Option<String>)
:
required: falseA 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>)
:
required: falseEnable 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>)
:
required: falseSet 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>)
:
required: falseA 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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseA
ProjectCache
object that specifies cache overrides.service_role_override(impl Into<String>)
/set_service_role_override(Option<String>)
:
required: falseThe 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>)
:
required: falseEnable 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>)
:
required: falseOverrides the build timeout specified in the batch build project.
queued_timeout_in_minutes_override(i32)
/set_queued_timeout_in_minutes_override(Option<i32>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseA 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>)
:
required: falseA
LogsConfig
object that override the log settings defined in the batch build project.registry_credential_override(RegistryCredential)
/set_registry_credential_override(Option<RegistryCredential>)
:
required: falseA
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>)
:
required: falseThe 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>)
:
required: falseA
BuildBatchConfigOverride
object that contains batch build configuration overrides.debug_session_enabled(bool)
/set_debug_session_enabled(Option<bool>)
:
required: falseSpecifies 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>
source§impl Client
impl Client
sourcepub fn stop_build(&self) -> StopBuildFluentBuilder
pub fn stop_build(&self) -> StopBuildFluentBuilder
Constructs a fluent builder for the StopBuild
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn stop_build_batch(&self) -> StopBuildBatchFluentBuilder
pub fn stop_build_batch(&self) -> StopBuildBatchFluentBuilder
Constructs a fluent builder for the StopBuildBatch
operation.
- The fluent builder is configurable:
id(impl Into<String>)
/set_id(Option<String>)
:
required: trueThe 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>
source§impl Client
impl Client
sourcepub fn update_fleet(&self) -> UpdateFleetFluentBuilder
pub fn update_fleet(&self) -> UpdateFleetFluentBuilder
Constructs a fluent builder for the UpdateFleet
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the compute fleet.
base_capacity(i32)
/set_base_capacity(Option<i32>)
:
required: falseThe initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.
environment_type(EnvironmentType)
/set_environment_type(Option<EnvironmentType>)
:
required: falseThe environment type of the compute fleet.
-
The environment type
ARM_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo). -
The environment type
LINUX_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai). -
The environment type
LINUX_GPU_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney). -
The environment type
WINDOWS_SERVER_2019_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland). -
The environment type
WINDOWS_SERVER_2022_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see Build environment compute types in the CodeBuild user guide.
-
compute_type(ComputeType)
/set_compute_type(Option<ComputeType>)
:
required: falseInformation about the compute resources the compute fleet uses. Available values include:
-
BUILD_GENERAL1_SMALL
: Use up to 3 GB memory and 2 vCPUs for builds. -
BUILD_GENERAL1_MEDIUM
: Use up to 7 GB memory and 4 vCPUs for builds. -
BUILD_GENERAL1_LARGE
: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_XLARGE
: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type. -
BUILD_GENERAL1_2XLARGE
: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
If you use
BUILD_GENERAL1_SMALL
:-
For environment type
LINUX_CONTAINER
, you can use up to 3 GB memory and 2 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds. -
For environment type
ARM_CONTAINER
, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.
If you use
BUILD_GENERAL1_LARGE
:-
For environment type
LINUX_CONTAINER
, you can use up to 15 GB memory and 8 vCPUs for builds. -
For environment type
LINUX_GPU_CONTAINER
, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. -
For environment type
ARM_CONTAINER
, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see Build environment compute types in the CodeBuild User Guide.
-
scaling_configuration(ScalingConfigurationInput)
/set_scaling_configuration(Option<ScalingConfigurationInput>)
:
required: falseThe scaling configuration of the compute fleet.
overflow_behavior(FleetOverflowBehavior)
/set_overflow_behavior(Option<FleetOverflowBehavior>)
:
required: falseThe compute fleet overflow behavior.
-
For overflow behavior
QUEUE
, your overflow builds need to wait on the existing fleet instance to become available. -
For overflow behavior
ON_DEMAND
, your overflow builds run on CodeBuild on-demand.
-
tags(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseA list of tag key and value pairs associated with this compute fleet.
These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.
- On success, responds with
UpdateFleetOutput
with field(s):fleet(Option<Fleet>)
:A
Fleet
object.
- On failure, responds with
SdkError<UpdateFleetError>
source§impl Client
impl Client
sourcepub fn update_project(&self) -> UpdateProjectFluentBuilder
pub fn update_project(&self) -> UpdateProjectFluentBuilder
Constructs a fluent builder for the UpdateProject
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the build project.
You cannot change a build project’s name.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA new or replacement description of the build project.
source(ProjectSource)
/set_source(Option<ProjectSource>)
:
required: falseInformation to be changed about the build input source code for the build project.
secondary_sources(ProjectSource)
/set_secondary_sources(Option<Vec::<ProjectSource>>)
:
required: falseAn array of
ProjectSource
objects.source_version(impl Into<String>)
/set_source_version(Option<String>)
:
required: falseA 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(ProjectSourceVersion)
/set_secondary_source_versions(Option<Vec::<ProjectSourceVersion>>)
:
required: falseAn 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>)
:
required: falseInformation to be changed about the build output artifacts for the build project.
secondary_artifacts(ProjectArtifacts)
/set_secondary_artifacts(Option<Vec::<ProjectArtifacts>>)
:
required: falseAn array of
ProjectArtifact
objects.cache(ProjectCache)
/set_cache(Option<ProjectCache>)
:
required: falseStores recently used information so that it can be quickly accessed at a later time.
environment(ProjectEnvironment)
/set_environment(Option<ProjectEnvironment>)
:
required: falseInformation to be changed about the build environment for the build project.
service_role(impl Into<String>)
/set_service_role(Option<String>)
:
required: falseThe 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>)
:
required: falseThe 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>)
:
required: falseThe number of minutes a build is allowed to be queued before it times out.
encryption_key(impl Into<String>)
/set_encryption_key(Option<String>)
:
required: falseThe 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn 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>)
:
required: falseVpcConfig enables CodeBuild to access resources in an Amazon VPC.
badge_enabled(bool)
/set_badge_enabled(Option<bool>)
:
required: falseSet this to true to generate a publicly accessible URL for your project’s build badge.
logs_config(LogsConfig)
/set_logs_config(Option<LogsConfig>)
:
required: falseInformation about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.
file_system_locations(ProjectFileSystemLocation)
/set_file_system_locations(Option<Vec::<ProjectFileSystemLocation>>)
:
required: falseAn 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>)
:
required: falseContains configuration information about a batch build project.
concurrent_build_limit(i32)
/set_concurrent_build_limit(Option<i32>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn update_project_visibility(&self) -> UpdateProjectVisibilityFluentBuilder
pub fn update_project_visibility(&self) -> UpdateProjectVisibilityFluentBuilder
Constructs a fluent builder for the UpdateProjectVisibility
operation.
- The fluent builder is configurable:
project_arn(impl Into<String>)
/set_project_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) of the build project.
project_visibility(ProjectVisibilityType)
/set_project_visibility(Option<ProjectVisibilityType>)
:
required: trueSpecifies 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>)
:
required: falseThe 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>
source§impl Client
impl Client
sourcepub fn update_report_group(&self) -> UpdateReportGroupFluentBuilder
pub fn update_report_group(&self) -> UpdateReportGroupFluentBuilder
Constructs a fluent builder for the UpdateReportGroup
operation.
- The fluent builder is configurable:
arn(impl Into<String>)
/set_arn(Option<String>)
:
required: trueThe ARN of the report group to update.
export_config(ReportExportConfig)
/set_export_config(Option<ReportExportConfig>)
:
required: falseUsed 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(Tag)
/set_tags(Option<Vec::<Tag>>)
:
required: falseAn 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>
source§impl Client
impl Client
sourcepub fn update_webhook(&self) -> UpdateWebhookFluentBuilder
pub fn update_webhook(&self) -> UpdateWebhookFluentBuilder
Constructs a fluent builder for the UpdateWebhook
operation.
- The fluent builder is configurable:
project_name(impl Into<String>)
/set_project_name(Option<String>)
:
required: trueThe name of the CodeBuild project.
branch_filter(impl Into<String>)
/set_branch_filter(Option<String>)
:
required: falseA 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(Option<bool>)
:
required: falseA 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::<WebhookFilter>)
/set_filter_groups(Option<Vec::<Vec::<WebhookFilter>>>)
:
required: falseAn 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>)
:
required: falseSpecifies 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>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more