aws_sdk_codebuild/
client.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[derive(Debug)]
3pub(crate) struct Handle {
4    pub(crate) conf: crate::Config,
5    #[allow(dead_code)] // unused when a service does not provide any operations
6    pub(crate) runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
7}
8
9/// Client for AWS CodeBuild
10///
11/// Client for invoking operations on AWS CodeBuild. Each operation on AWS CodeBuild is a method on this
12/// this struct. `.send()` MUST be invoked on the generated operations to dispatch the request to the service.
13/// ## Constructing a `Client`
14///
15/// A [`Config`] is required to construct a client. For most use cases, the [`aws-config`]
16/// crate should be used to automatically resolve this config using
17/// [`aws_config::load_from_env()`], since this will resolve an [`SdkConfig`] which can be shared
18/// across multiple different AWS SDK clients. This config resolution process can be customized
19/// by calling [`aws_config::from_env()`] instead, which returns a [`ConfigLoader`] that uses
20/// the [builder pattern] to customize the default config.
21///
22/// In the simplest case, creating a client looks as follows:
23/// ```rust,no_run
24/// # async fn wrapper() {
25/// let config = aws_config::load_from_env().await;
26/// let client = aws_sdk_codebuild::Client::new(&config);
27/// # }
28/// ```
29///
30/// Occasionally, SDKs may have additional service-specific values that can be set on the [`Config`] that
31/// is absent from [`SdkConfig`], or slightly different settings for a specific client may be desired.
32/// The [`Builder`](crate::config::Builder) struct implements `From<&SdkConfig>`, so setting these specific settings can be
33/// done as follows:
34///
35/// ```rust,no_run
36/// # async fn wrapper() {
37/// let sdk_config = ::aws_config::load_from_env().await;
38/// let config = aws_sdk_codebuild::config::Builder::from(&sdk_config)
39/// # /*
40///     .some_service_specific_setting("value")
41/// # */
42///     .build();
43/// # }
44/// ```
45///
46/// See the [`aws-config` docs] and [`Config`] for more information on customizing configuration.
47///
48/// _Note:_ Client construction is expensive due to connection thread pool initialization, and should
49/// be done once at application start-up.
50///
51/// [`Config`]: crate::Config
52/// [`ConfigLoader`]: https://docs.rs/aws-config/*/aws_config/struct.ConfigLoader.html
53/// [`SdkConfig`]: https://docs.rs/aws-config/*/aws_config/struct.SdkConfig.html
54/// [`aws-config` docs]: https://docs.rs/aws-config/*
55/// [`aws-config`]: https://crates.io/crates/aws-config
56/// [`aws_config::from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.from_env.html
57/// [`aws_config::load_from_env()`]: https://docs.rs/aws-config/*/aws_config/fn.load_from_env.html
58/// [builder pattern]: https://rust-lang.github.io/api-guidelines/type-safety.html#builders-enable-construction-of-complex-values-c-builder
59/// # Using the `Client`
60///
61/// A client has a function for every operation that can be performed by the service.
62/// For example, the [`BatchGetCommandExecutions`](crate::operation::batch_get_command_executions) operation has
63/// a [`Client::batch_get_command_executions`], function which returns a builder for that operation.
64/// The fluent builder ultimately has a `send()` function that returns an async future that
65/// returns a result, as illustrated below:
66///
67/// ```rust,ignore
68/// let result = client.batch_get_command_executions()
69///     .sandbox_id("example")
70///     .send()
71///     .await;
72/// ```
73///
74/// The underlying HTTP requests that get made by this can be modified with the `customize_operation`
75/// function on the fluent builder. See the [`customize`](crate::client::customize) module for more
76/// information.
77#[derive(::std::clone::Clone, ::std::fmt::Debug)]
78pub struct Client {
79    handle: ::std::sync::Arc<Handle>,
80}
81
82impl Client {
83    /// Creates a new client from the service [`Config`](crate::Config).
84    ///
85    /// # Panics
86    ///
87    /// This method will panic in the following cases:
88    ///
89    /// - Retries or timeouts are enabled without a `sleep_impl` configured.
90    /// - Identity caching is enabled without a `sleep_impl` and `time_source` configured.
91    /// - No `behavior_version` is provided.
92    ///
93    /// The panic message for each of these will have instructions on how to resolve them.
94    #[track_caller]
95    pub fn from_conf(conf: crate::Config) -> Self {
96        let handle = Handle {
97            conf: conf.clone(),
98            runtime_plugins: crate::config::base_client_runtime_plugins(conf),
99        };
100        if let Err(err) = Self::validate_config(&handle) {
101            panic!("Invalid client configuration: {err}");
102        }
103        Self {
104            handle: ::std::sync::Arc::new(handle),
105        }
106    }
107
108    /// Returns the client's configuration.
109    pub fn config(&self) -> &crate::Config {
110        &self.handle.conf
111    }
112
113    fn validate_config(handle: &Handle) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
114        let mut cfg = ::aws_smithy_types::config_bag::ConfigBag::base();
115        handle
116            .runtime_plugins
117            .apply_client_configuration(&mut cfg)?
118            .validate_base_client_config(&cfg)?;
119        Ok(())
120    }
121}
122
123impl Client {
124    /// Creates a new client from an [SDK Config](::aws_types::sdk_config::SdkConfig).
125    ///
126    /// # Panics
127    ///
128    /// - This method will panic if the `sdk_config` is missing an async sleep implementation. If you experience this panic, set
129    ///     the `sleep_impl` on the Config passed into this function to fix it.
130    /// - This method will panic if the `sdk_config` is missing an HTTP connector. If you experience this panic, set the
131    ///     `http_connector` on the Config passed into this function to fix it.
132    /// - This method will panic if no `BehaviorVersion` is provided. If you experience this panic, set `behavior_version` on the Config or enable the `behavior-version-latest` Cargo feature.
133    #[track_caller]
134    pub fn new(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
135        Self::from_conf(sdk_config.into())
136    }
137}
138
139mod batch_delete_builds;
140
141mod batch_get_build_batches;
142
143mod batch_get_builds;
144
145mod batch_get_command_executions;
146
147mod batch_get_fleets;
148
149mod batch_get_projects;
150
151mod batch_get_report_groups;
152
153mod batch_get_reports;
154
155mod batch_get_sandboxes;
156
157mod create_fleet;
158
159mod create_project;
160
161mod create_report_group;
162
163mod create_webhook;
164
165/// Operation customization and supporting types.
166///
167/// The underlying HTTP requests made during an operation can be customized
168/// by calling the `customize()` method on the builder returned from a client
169/// operation call. For example, this can be used to add an additional HTTP header:
170///
171/// ```ignore
172/// # async fn wrapper() -> ::std::result::Result<(), aws_sdk_codebuild::Error> {
173/// # let client: aws_sdk_codebuild::Client = unimplemented!();
174/// use ::http::header::{HeaderName, HeaderValue};
175///
176/// let result = client.batch_delete_builds()
177///     .customize()
178///     .mutate_request(|req| {
179///         // Add `x-example-header` with value
180///         req.headers_mut()
181///             .insert(
182///                 HeaderName::from_static("x-example-header"),
183///                 HeaderValue::from_static("1"),
184///             );
185///     })
186///     .send()
187///     .await;
188/// # }
189/// ```
190pub mod customize;
191
192mod delete_build_batch;
193
194mod delete_fleet;
195
196mod delete_project;
197
198mod delete_report;
199
200mod delete_report_group;
201
202mod delete_resource_policy;
203
204mod delete_source_credentials;
205
206mod delete_webhook;
207
208mod describe_code_coverages;
209
210mod describe_test_cases;
211
212mod get_report_group_trend;
213
214mod get_resource_policy;
215
216mod import_source_credentials;
217
218mod invalidate_project_cache;
219
220mod list_build_batches;
221
222mod list_build_batches_for_project;
223
224mod list_builds;
225
226mod list_builds_for_project;
227
228mod list_command_executions_for_sandbox;
229
230mod list_curated_environment_images;
231
232mod list_fleets;
233
234mod list_projects;
235
236mod list_report_groups;
237
238mod list_reports;
239
240mod list_reports_for_report_group;
241
242mod list_sandboxes;
243
244mod list_sandboxes_for_project;
245
246mod list_shared_projects;
247
248mod list_shared_report_groups;
249
250mod list_source_credentials;
251
252mod put_resource_policy;
253
254mod retry_build;
255
256mod retry_build_batch;
257
258mod start_build;
259
260mod start_build_batch;
261
262mod start_command_execution;
263
264mod start_sandbox;
265
266mod start_sandbox_connection;
267
268mod stop_build;
269
270mod stop_build_batch;
271
272mod stop_sandbox;
273
274mod update_fleet;
275
276mod update_project;
277
278mod update_project_visibility;
279
280mod update_report_group;
281
282mod update_webhook;