aws_sdk_s3control/config.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#![allow(clippy::empty_line_after_doc_comments)]
3/// Configuration for a aws_sdk_s3control service client.
4///
5/// Service configuration allows for customization of endpoints, region, credentials providers,
6/// and retry configuration. Generally, it is constructed automatically for you from a shared
7/// configuration loaded by the `aws-config` crate. For example:
8///
9/// ```ignore
10/// // Load a shared config from the environment
11/// let shared_config = aws_config::from_env().load().await;
12/// // The client constructor automatically converts the shared config into the service config
13/// let client = Client::new(&shared_config);
14/// ```
15///
16/// The service config can also be constructed manually using its builder.
17///
18#[derive(::std::clone::Clone, ::std::fmt::Debug)]
19pub struct Config {
20 // Both `config` and `cloneable` are the same config, but the cloneable one
21 // is kept around so that it is possible to convert back into a builder. This can be
22 // optimized in the future.
23 pub(crate) config: crate::config::FrozenLayer,
24 cloneable: ::aws_smithy_types::config_bag::CloneableLayer,
25 pub(crate) runtime_components: crate::config::RuntimeComponentsBuilder,
26 pub(crate) runtime_plugins: ::std::vec::Vec<crate::config::SharedRuntimePlugin>,
27 pub(crate) behavior_version: ::std::option::Option<crate::config::BehaviorVersion>,
28}
29impl Config {
30 ///
31 /// Constructs a config builder.
32 /// <div class="warning">
33 /// Note that a config created from this builder will not have the same safe defaults as one created by
34 /// the <a href="https://crates.io/crates/aws-config" target="_blank">aws-config</a> crate.
35 /// </div>
36 ///
37 pub fn builder() -> Builder {
38 Builder::default()
39 }
40 /// Converts this config back into a builder so that it can be tweaked.
41 pub fn to_builder(&self) -> Builder {
42 Builder {
43 config: self.cloneable.clone(),
44 runtime_components: self.runtime_components.clone(),
45 runtime_plugins: self.runtime_plugins.clone(),
46 behavior_version: self.behavior_version,
47 }
48 }
49 /// Return a reference to the stalled stream protection configuration contained in this config, if any.
50 pub fn stalled_stream_protection(&self) -> ::std::option::Option<&crate::config::StalledStreamProtectionConfig> {
51 self.config.load::<crate::config::StalledStreamProtectionConfig>()
52 }
53 /// Return the [`SharedHttpClient`](crate::config::SharedHttpClient) to use when making requests, if any.
54 pub fn http_client(&self) -> Option<crate::config::SharedHttpClient> {
55 self.runtime_components.http_client()
56 }
57 /// Return the auth schemes configured on this service config
58 pub fn auth_schemes(&self) -> impl Iterator<Item = ::aws_smithy_runtime_api::client::auth::SharedAuthScheme> + '_ {
59 self.runtime_components.auth_schemes()
60 }
61
62 /// Return the auth scheme resolver configured on this service config
63 pub fn auth_scheme_resolver(&self) -> ::std::option::Option<::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver> {
64 self.runtime_components.auth_scheme_option_resolver()
65 }
66 /// Returns the configured auth scheme preference
67 pub fn auth_scheme_preference(&self) -> ::std::option::Option<&::aws_smithy_runtime_api::client::auth::AuthSchemePreference> {
68 self.config.load::<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>()
69 }
70 /// Returns the endpoint resolver.
71 pub fn endpoint_resolver(&self) -> ::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver {
72 self.runtime_components.endpoint_resolver().expect("resolver defaulted if not set")
73 }
74 /// Return a reference to the retry configuration contained in this config, if any.
75 pub fn retry_config(&self) -> ::std::option::Option<&::aws_smithy_types::retry::RetryConfig> {
76 self.config.load::<::aws_smithy_types::retry::RetryConfig>()
77 }
78
79 /// Return a cloned shared async sleep implementation from this config, if any.
80 pub fn sleep_impl(&self) -> ::std::option::Option<crate::config::SharedAsyncSleep> {
81 self.runtime_components.sleep_impl()
82 }
83
84 /// Return a reference to the timeout configuration contained in this config, if any.
85 pub fn timeout_config(&self) -> ::std::option::Option<&::aws_smithy_types::timeout::TimeoutConfig> {
86 self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>()
87 }
88
89 /// Returns a reference to the retry partition contained in this config, if any.
90 ///
91 /// WARNING: This method is unstable and may be removed at any time. Do not rely on this
92 /// method for anything!
93 pub fn retry_partition(&self) -> ::std::option::Option<&::aws_smithy_runtime::client::retries::RetryPartition> {
94 self.config.load::<::aws_smithy_runtime::client::retries::RetryPartition>()
95 }
96 /// Returns the configured identity cache for auth.
97 pub fn identity_cache(&self) -> ::std::option::Option<crate::config::SharedIdentityCache> {
98 self.runtime_components.identity_cache()
99 }
100 /// Returns interceptors currently registered by the user.
101 pub fn interceptors(&self) -> impl Iterator<Item = crate::config::SharedInterceptor> + '_ {
102 self.runtime_components.interceptors()
103 }
104 /// Return time source used for this service.
105 pub fn time_source(&self) -> ::std::option::Option<::aws_smithy_async::time::SharedTimeSource> {
106 self.runtime_components.time_source()
107 }
108 /// Returns retry classifiers currently registered by the user.
109 pub fn retry_classifiers(&self) -> impl Iterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier> + '_ {
110 self.runtime_components.retry_classifiers()
111 }
112 /// Returns the name of the app that is using the client, if it was provided.
113 ///
114 /// This _optional_ name is used to identify the application in the user agent that
115 /// gets sent along with requests.
116 pub fn app_name(&self) -> ::std::option::Option<&::aws_types::app_name::AppName> {
117 self.config.load::<::aws_types::app_name::AppName>()
118 }
119 /// Returns the framework metadata that has been configured, if any.
120 ///
121 /// This _optional_ metadata identifies software frameworks or third-party libraries
122 /// being used with the client, rendered into the user agent as `lib/{name}/{version}`.
123 /// Entries are returned in first-seen (insertion) order, matching the order they are
124 /// rendered into the user agent.
125 pub fn framework_metadata(&self) -> ::std::vec::Vec<&::aws_types::sdk_ua_metadata::FrameworkMetadata> {
126 // `StoreAppend` loads entries newest-first; reverse to first-seen order so
127 // this getter agrees with both the user agent and `SdkConfig::framework_metadata`.
128 let mut entries: ::std::vec::Vec<&::aws_types::sdk_ua_metadata::FrameworkMetadata> =
129 self.config.load::<::aws_types::sdk_ua_metadata::FrameworkMetadata>().collect();
130 entries.reverse();
131 entries
132 }
133 /// Returns the invocation ID generator if one was given in config.
134 ///
135 /// The invocation ID generator generates ID values for the `amz-sdk-invocation-id` header. By default, this will be a random UUID. Overriding it may be useful in tests that examine the HTTP request and need to be deterministic.
136 pub fn invocation_id_generator(&self) -> ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator> {
137 self.config.load::<::aws_runtime::invocation_id::SharedInvocationIdGenerator>().cloned()
138 }
139 /// Creates a new [service config](crate::Config) from a [shared `config`](::aws_types::sdk_config::SdkConfig).
140 pub fn new(config: &::aws_types::sdk_config::SdkConfig) -> Self {
141 Builder::from(config).build()
142 }
143 /// The signature version 4 service signing name to use in the credential scope when signing requests.
144 ///
145 /// The signing service may be overridden by the `Endpoint`, or by specifying a custom
146 /// [`SigningName`](aws_types::SigningName) during operation construction
147 pub fn signing_name(&self) -> &'static str {
148 "s3"
149 }
150 /// Returns the AWS region, if it was provided.
151 pub fn region(&self) -> ::std::option::Option<&crate::config::Region> {
152 self.config.load::<crate::config::Region>()
153 }
154 /// This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a `None`. Do not use.
155 #[deprecated(
156 note = "This function was intended to be removed, and has been broken since release-2023-11-15 as it always returns a `None`. Do not use."
157 )]
158 pub fn credentials_provider(&self) -> Option<crate::config::SharedCredentialsProvider> {
159 ::std::option::Option::None
160 }
161}
162/// Builder for creating a `Config`.
163#[derive(::std::clone::Clone, ::std::fmt::Debug)]
164pub struct Builder {
165 pub(crate) config: ::aws_smithy_types::config_bag::CloneableLayer,
166 pub(crate) runtime_components: crate::config::RuntimeComponentsBuilder,
167 pub(crate) runtime_plugins: ::std::vec::Vec<crate::config::SharedRuntimePlugin>,
168 pub(crate) behavior_version: ::std::option::Option<crate::config::BehaviorVersion>,
169}
170impl ::std::default::Default for Builder {
171 fn default() -> Self {
172 Self {
173 config: ::std::default::Default::default(),
174 runtime_components: crate::config::RuntimeComponentsBuilder::new("service config"),
175 runtime_plugins: ::std::default::Default::default(),
176 behavior_version: ::std::default::Default::default(),
177 }
178 }
179}
180impl Builder {
181 ///
182 /// Constructs a config builder.
183 /// <div class="warning">
184 /// Note that a config created from this builder will not have the same safe defaults as one created by
185 /// the <a href="https://crates.io/crates/aws-config" target="_blank">aws-config</a> crate.
186 /// </div>
187 ///
188 pub fn new() -> Self {
189 Self::default()
190 }
191 /// Constructs a config builder from the given `config_bag`, setting only fields stored in the config bag,
192 /// but not those in runtime components.
193 #[allow(unused)]
194 pub(crate) fn from_config_bag(config_bag: &::aws_smithy_types::config_bag::ConfigBag) -> Self {
195 let mut builder = Self::new();
196 builder.set_stalled_stream_protection(config_bag.load::<crate::config::StalledStreamProtectionConfig>().cloned());
197 builder.set_auth_scheme_preference(config_bag.load::<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>().cloned());
198 builder.set_use_arn_region(config_bag.load::<crate::config::UseArnRegion>().map(|ty| ty.0));
199 builder.set_retry_config(config_bag.load::<::aws_smithy_types::retry::RetryConfig>().cloned());
200 builder.set_timeout_config(config_bag.load::<::aws_smithy_types::timeout::TimeoutConfig>().cloned());
201 builder.set_retry_partition(config_bag.load::<::aws_smithy_runtime::client::retries::RetryPartition>().cloned());
202 builder.set_app_name(config_bag.load::<::aws_types::app_name::AppName>().cloned());
203 for framework_metadata in config_bag.load::<::aws_types::sdk_ua_metadata::FrameworkMetadata>() {
204 builder.push_framework_metadata(framework_metadata.clone());
205 }
206 builder.set_endpoint_url(config_bag.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()));
207 builder.set_use_dual_stack(config_bag.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0));
208 builder.set_use_fips(config_bag.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0));
209 builder.set_region(config_bag.load::<crate::config::Region>().cloned());
210 builder
211 }
212 /// Names operation-input members whose values are captured *and* emitted as
213 /// attributes on the client's built-in metrics (e.g. `["Bucket"]`).
214 ///
215 /// Emitting implies capture, so an emitted member is also readable in-process
216 /// via `CapturedTelemetryAttributes` on the config bag. Names are Smithy input
217 /// member names; only string-valued, non-sensitive members are eligible, and
218 /// naming any other member has no effect. Off by default.
219 ///
220 /// Prefer bounded identifiers here: an emitted member becomes a metric label, so
221 /// high-cardinality values (like object keys) fragment the metrics and inflate
222 /// cost. Use [`Self::capture_input_attributes`] for values you want to read
223 /// in-process without emitting them on the metrics.
224 pub fn emit_input_attributes(mut self, names: impl ::std::iter::IntoIterator<Item = impl ::std::convert::Into<::std::string::String>>) -> Self {
225 let mut requested = self
226 .config
227 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
228 .cloned()
229 .unwrap_or_default();
230 requested.emit(names.into_iter().map(|n| n.into()));
231 self.config.store_put(requested);
232 self
233 }
234
235 /// Names operation-input members whose values are captured into
236 /// `CapturedTelemetryAttributes` for in-process reads (e.g. from a custom
237 /// interceptor), but are **not** emitted on the built-in metrics.
238 ///
239 /// Use this for values you need during the operation lifecycle but do not want on
240 /// the metric label set (for example, high-cardinality identifiers). Names follow
241 /// the same eligibility rules as [`Self::emit_input_attributes`]. Off by default.
242 pub fn capture_input_attributes(
243 mut self,
244 names: impl ::std::iter::IntoIterator<Item = impl ::std::convert::Into<::std::string::String>>,
245 ) -> Self {
246 let mut requested = self
247 .config
248 .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
249 .cloned()
250 .unwrap_or_default();
251 requested.capture_only(names.into_iter().map(|n| n.into()));
252 self.config.store_put(requested);
253 self
254 }
255 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
256 /// to configure protection for stalled streams.
257 pub fn stalled_stream_protection(mut self, stalled_stream_protection_config: crate::config::StalledStreamProtectionConfig) -> Self {
258 self.set_stalled_stream_protection(::std::option::Option::Some(stalled_stream_protection_config));
259 self
260 }
261 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
262 /// to configure protection for stalled streams.
263 pub fn set_stalled_stream_protection(
264 &mut self,
265 stalled_stream_protection_config: ::std::option::Option<crate::config::StalledStreamProtectionConfig>,
266 ) -> &mut Self {
267 self.config.store_or_unset(stalled_stream_protection_config);
268 self
269 }
270 /// Sets the idempotency token provider to use for service calls that require tokens.
271 pub fn idempotency_token_provider(
272 mut self,
273 idempotency_token_provider: impl ::std::convert::Into<crate::idempotency_token::IdempotencyTokenProvider>,
274 ) -> Self {
275 self.set_idempotency_token_provider(::std::option::Option::Some(idempotency_token_provider.into()));
276 self
277 }
278 /// Sets the idempotency token provider to use for service calls that require tokens.
279 pub fn set_idempotency_token_provider(
280 &mut self,
281 idempotency_token_provider: ::std::option::Option<crate::idempotency_token::IdempotencyTokenProvider>,
282 ) -> &mut Self {
283 self.config.store_or_unset(idempotency_token_provider);
284 self
285 }
286 /// Sets the HTTP client to use when making requests.
287 ///
288 /// # Examples
289 /// ```no_run
290 /// # #[cfg(test)]
291 /// # mod tests {
292 /// # #[test]
293 /// # fn example() {
294 /// use std::time::Duration;
295 /// use aws_sdk_s3control::config::Config;
296 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
297 ///
298 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
299 /// .with_webpki_roots()
300 /// .https_only()
301 /// .enable_http1()
302 /// .enable_http2()
303 /// .build();
304 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
305 ///
306 /// // This connector can then be given to a generated service Config
307 /// let config = my_service_client::Config::builder()
308 /// .endpoint_url("https://example.com")
309 /// .http_client(hyper_client)
310 /// .build();
311 /// let client = my_service_client::Client::from_conf(config);
312 /// # }
313 /// # }
314 /// ```
315 pub fn http_client(mut self, http_client: impl crate::config::HttpClient + 'static) -> Self {
316 self.set_http_client(::std::option::Option::Some(crate::config::IntoShared::into_shared(http_client)));
317 self
318 }
319
320 /// Sets the HTTP client to use when making requests.
321 ///
322 /// # Examples
323 /// ```no_run
324 /// # #[cfg(test)]
325 /// # mod tests {
326 /// # #[test]
327 /// # fn example() {
328 /// use std::time::Duration;
329 /// use aws_sdk_s3control::config::{Builder, Config};
330 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
331 ///
332 /// fn override_http_client(builder: &mut Builder) {
333 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
334 /// .with_webpki_roots()
335 /// .https_only()
336 /// .enable_http1()
337 /// .enable_http2()
338 /// .build();
339 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
340 /// builder.set_http_client(Some(hyper_client));
341 /// }
342 ///
343 /// let mut builder = aws_sdk_s3control::Config::builder();
344 /// override_http_client(&mut builder);
345 /// let config = builder.build();
346 /// # }
347 /// # }
348 /// ```
349 pub fn set_http_client(&mut self, http_client: Option<crate::config::SharedHttpClient>) -> &mut Self {
350 self.runtime_components.set_http_client(http_client);
351 self
352 }
353 /// Adds an auth scheme to the builder
354 ///
355 /// If `auth_scheme` has an existing [AuthSchemeId](aws_smithy_runtime_api::client::auth::AuthSchemeId) in the runtime, the current identity
356 /// resolver and signer for that scheme will be replaced by those from `auth_scheme`.
357 ///
358 /// _Important:_ When introducing a custom auth scheme, ensure you override either
359 /// [`Self::auth_scheme_resolver`] or [`Self::set_auth_scheme_resolver`]
360 /// so that the custom auth scheme is included in the list of resolved auth scheme options.
361 /// [The default auth scheme resolver](crate::config::auth::DefaultAuthSchemeResolver) will not recognize your custom auth scheme.
362 ///
363 /// # Examples
364 /// ```no_run
365 /// # use aws_smithy_runtime_api::{
366 /// # box_error::BoxError,
367 /// # client::{
368 /// # auth::{
369 /// # AuthScheme, AuthSchemeEndpointConfig, AuthSchemeId, AuthSchemeOption,
370 /// # AuthSchemeOptionsFuture, Sign,
371 /// # },
372 /// # identity::{Identity, IdentityFuture, ResolveIdentity, SharedIdentityResolver},
373 /// # orchestrator::HttpRequest,
374 /// # runtime_components::{GetIdentityResolver, RuntimeComponents},
375 /// # },
376 /// # shared::IntoShared,
377 /// # };
378 /// # use aws_smithy_types::config_bag::ConfigBag;
379 /// // Auth scheme with customer identity resolver and signer
380 /// #[derive(Debug)]
381 /// struct CustomAuthScheme {
382 /// id: AuthSchemeId,
383 /// identity_resolver: SharedIdentityResolver,
384 /// signer: CustomSigner,
385 /// }
386 /// impl Default for CustomAuthScheme {
387 /// fn default() -> Self {
388 /// Self {
389 /// id: AuthSchemeId::new("custom"),
390 /// identity_resolver: CustomIdentityResolver.into_shared(),
391 /// signer: CustomSigner,
392 /// }
393 /// }
394 /// }
395 /// impl AuthScheme for CustomAuthScheme {
396 /// fn scheme_id(&self) -> AuthSchemeId {
397 /// self.id.clone()
398 /// }
399 /// fn identity_resolver(
400 /// &self,
401 /// _identity_resolvers: &dyn GetIdentityResolver,
402 /// ) -> Option<SharedIdentityResolver> {
403 /// Some(self.identity_resolver.clone())
404 /// }
405 /// fn signer(&self) -> &dyn Sign {
406 /// &self.signer
407 /// }
408 /// }
409 ///
410 /// #[derive(Debug, Default)]
411 /// struct CustomSigner;
412 /// impl Sign for CustomSigner {
413 /// fn sign_http_request(
414 /// &self,
415 /// _request: &mut HttpRequest,
416 /// _identity: &Identity,
417 /// _auth_scheme_endpoint_config: AuthSchemeEndpointConfig<'_>,
418 /// _runtime_components: &RuntimeComponents,
419 /// _config_bag: &ConfigBag,
420 /// ) -> Result<(), BoxError> {
421 /// // --snip--
422 /// # todo!()
423 /// }
424 /// }
425 ///
426 /// #[derive(Debug)]
427 /// struct CustomIdentityResolver;
428 /// impl ResolveIdentity for CustomIdentityResolver {
429 /// fn resolve_identity<'a>(
430 /// &'a self,
431 /// _runtime_components: &'a RuntimeComponents,
432 /// _config_bag: &'a ConfigBag,
433 /// ) -> IdentityFuture<'a> {
434 /// // --snip--
435 /// # todo!()
436 /// }
437 /// }
438 ///
439 /// // Auth scheme resolver that favors `CustomAuthScheme`
440 /// #[derive(Debug)]
441 /// struct CustomAuthSchemeResolver;
442 /// impl aws_sdk_s3control::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
443 /// fn resolve_auth_scheme<'a>(
444 /// &'a self,
445 /// _params: &'a aws_sdk_s3control::config::auth::Params,
446 /// _cfg: &'a ConfigBag,
447 /// _runtime_components: &'a RuntimeComponents,
448 /// ) -> AuthSchemeOptionsFuture<'a> {
449 /// AuthSchemeOptionsFuture::ready(Ok(vec![AuthSchemeOption::from(AuthSchemeId::new(
450 /// "custom",
451 /// ))]))
452 /// }
453 /// }
454 ///
455 /// let config = aws_sdk_s3control::Config::builder()
456 /// .push_auth_scheme(CustomAuthScheme::default())
457 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
458 /// // other configurations
459 /// .build();
460 /// ```
461 pub fn push_auth_scheme(mut self, auth_scheme: impl ::aws_smithy_runtime_api::client::auth::AuthScheme + 'static) -> Self {
462 self.runtime_components.push_auth_scheme(auth_scheme);
463 self
464 }
465
466 /// Set the auth scheme resolver for the builder
467 ///
468 /// # Examples
469 /// ```no_run
470 /// # use aws_smithy_runtime_api::{
471 /// # client::{
472 /// # auth::AuthSchemeOptionsFuture,
473 /// # runtime_components::RuntimeComponents,
474 /// # },
475 /// # };
476 /// # use aws_smithy_types::config_bag::ConfigBag;
477 /// #[derive(Debug)]
478 /// struct CustomAuthSchemeResolver;
479 /// impl aws_sdk_s3control::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
480 /// fn resolve_auth_scheme<'a>(
481 /// &'a self,
482 /// _params: &'a aws_sdk_s3control::config::auth::Params,
483 /// _cfg: &'a ConfigBag,
484 /// _runtime_components: &'a RuntimeComponents,
485 /// ) -> AuthSchemeOptionsFuture<'a> {
486 /// // --snip--
487 /// # todo!()
488 /// }
489 /// }
490 ///
491 /// let config = aws_sdk_s3control::Config::builder()
492 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
493 /// // other configurations
494 /// .build();
495 /// ```
496 pub fn auth_scheme_resolver(mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> Self {
497 self.set_auth_scheme_resolver(auth_scheme_resolver);
498 self
499 }
500
501 /// Set the auth scheme resolver for the builder
502 ///
503 /// # Examples
504 /// See an example for [`Self::auth_scheme_resolver`].
505 pub fn set_auth_scheme_resolver(&mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> &mut Self {
506 self.runtime_components
507 .set_auth_scheme_option_resolver(::std::option::Option::Some(auth_scheme_resolver.into_shared_resolver()));
508 self
509 }
510
511 /// Enable no authentication regardless of what authentication mechanisms operations support
512 ///
513 /// This adds [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback
514 /// and the auth scheme resolver will use it when no other auth schemes are applicable.
515 pub fn allow_no_auth(mut self) -> Self {
516 self.set_allow_no_auth();
517 self
518 }
519
520 /// Enable no authentication regardless of what authentication mechanisms operations support
521 ///
522 /// This adds [NoAuthScheme](aws_smithy_runtime::client::auth::no_auth::NoAuthScheme) as a fallback
523 /// and the auth scheme resolver will use it when no other auth schemes are applicable.
524 pub fn set_allow_no_auth(&mut self) -> &mut Self {
525 self.push_runtime_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePluginV2::new().into_shared());
526 self
527 }
528 /// Set the auth scheme preference for an auth scheme resolver
529 /// (typically the default auth scheme resolver).
530 ///
531 /// Each operation has a predefined order of auth schemes, as determined by the service,
532 /// for auth scheme resolution. By using the auth scheme preference, customers
533 /// can reorder the schemes resolved by the auth scheme resolver.
534 ///
535 /// The preference list is intended as a hint rather than a strict override.
536 /// Any schemes not present in the originally resolved auth schemes will be ignored.
537 ///
538 /// # Examples
539 ///
540 /// ```no_run
541 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
542 /// let config = aws_sdk_s3control::Config::builder()
543 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
544 /// // ...
545 /// .build();
546 /// let client = aws_sdk_s3control::Client::from_conf(config);
547 /// ```
548
549 pub fn auth_scheme_preference(
550 mut self,
551 preference: impl ::std::convert::Into<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>,
552 ) -> Self {
553 self.set_auth_scheme_preference(::std::option::Option::Some(preference.into()));
554 self
555 }
556
557 /// Set the auth scheme preference for an auth scheme resolver
558 /// (typically the default auth scheme resolver).
559 ///
560 /// Each operation has a predefined order of auth schemes, as determined by the service,
561 /// for auth scheme resolution. By using the auth scheme preference, customers
562 /// can reorder the schemes resolved by the auth scheme resolver.
563 ///
564 /// The preference list is intended as a hint rather than a strict override.
565 /// Any schemes not present in the originally resolved auth schemes will be ignored.
566 ///
567 /// # Examples
568 ///
569 /// ```no_run
570 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
571 /// let config = aws_sdk_s3control::Config::builder()
572 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
573 /// // ...
574 /// .build();
575 /// let client = aws_sdk_s3control::Client::from_conf(config);
576 /// ```
577
578 pub fn set_auth_scheme_preference(
579 &mut self,
580 preference: ::std::option::Option<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>,
581 ) -> &mut Self {
582 self.config.store_or_unset(preference);
583 self
584 }
585 /// Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.
586 pub fn use_arn_region(mut self, use_arn_region: impl Into<bool>) -> Self {
587 self.set_use_arn_region(Some(use_arn_region.into()));
588 self
589 }
590 /// Enables this client to use an ARN's region when constructing an endpoint instead of the client's configured region.
591 pub fn set_use_arn_region(&mut self, use_arn_region: Option<bool>) -> &mut Self {
592 self.config.store_or_unset(use_arn_region.map(crate::config::UseArnRegion));
593 self
594 }
595 /// Sets the endpoint resolver to use when making requests.
596 ///
597 ///
598 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
599 /// rules for `aws_sdk_s3control`.
600 ///
601 ///
602 /// Note: setting an endpoint resolver will replace any endpoint URL that has been set.
603 /// This method accepts an endpoint resolver [specific to this service](crate::config::endpoint::ResolveEndpoint). If you want to
604 /// provide a shared endpoint resolver, use [`Self::set_endpoint_resolver`].
605 ///
606 /// # Examples
607 /// Create a custom endpoint resolver that resolves a different endpoing per-stage, e.g. staging vs. production.
608 /// ```no_run
609 /// use aws_sdk_s3control::config::endpoint::{ResolveEndpoint, EndpointFuture, Params, Endpoint};
610 /// #[derive(Debug)]
611 /// struct StageResolver { stage: String }
612 /// impl ResolveEndpoint for StageResolver {
613 /// fn resolve_endpoint(&self, params: &Params) -> EndpointFuture<'_> {
614 /// let stage = &self.stage;
615 /// EndpointFuture::ready(Ok(Endpoint::builder().url(format!("{stage}.myservice.com")).build()))
616 /// }
617 /// }
618 /// let resolver = StageResolver { stage: std::env::var("STAGE").unwrap() };
619 /// let config = aws_sdk_s3control::Config::builder().endpoint_resolver(resolver).build();
620 /// let client = aws_sdk_s3control::Client::from_conf(config);
621 /// ```
622 pub fn endpoint_resolver(mut self, endpoint_resolver: impl crate::config::endpoint::ResolveEndpoint + 'static) -> Self {
623 self.set_endpoint_resolver(::std::option::Option::Some(endpoint_resolver.into_shared_resolver()));
624 self
625 }
626
627 /// Sets the endpoint resolver to use when making requests.
628 ///
629 ///
630 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
631 /// rules for `aws_sdk_s3control`.
632 ///
633 pub fn set_endpoint_resolver(
634 &mut self,
635 endpoint_resolver: ::std::option::Option<::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver>,
636 ) -> &mut Self {
637 self.runtime_components.set_endpoint_resolver(endpoint_resolver);
638 self
639 }
640 /// Set the retry_config for the builder
641 ///
642 /// # Examples
643 /// ```no_run
644 /// use aws_sdk_s3control::config::Config;
645 /// use aws_sdk_s3control::config::retry::RetryConfig;
646 ///
647 /// let retry_config = RetryConfig::standard().with_max_attempts(5);
648 /// let config = Config::builder().retry_config(retry_config).build();
649 /// ```
650 ///
651 /// # Retry token bucket
652 ///
653 /// [`RetryConfig`](::aws_smithy_types::retry::RetryConfig) controls *how many* times to retry and *how long* to back
654 /// off. Retries are **also** gated by a retry token bucket (also called the retry quota) that
655 /// is shared across a [`RetryPartition`](::aws_smithy_runtime::client::retries::RetryPartition). To configure the token bucket — for
656 /// example, to set
657 /// its capacity or to give a workload its own bucket — see [`Self::retry_partition`] and
658 /// [`RetryPartition::custom`](::aws_smithy_runtime::client::retries::RetryPartition::custom).
659 pub fn retry_config(mut self, retry_config: ::aws_smithy_types::retry::RetryConfig) -> Self {
660 self.set_retry_config(Some(retry_config));
661 self
662 }
663
664 /// Set the retry_config for the builder
665 ///
666 /// # Examples
667 /// ```no_run
668 /// use aws_sdk_s3control::config::{Builder, Config};
669 /// use aws_sdk_s3control::config::retry::RetryConfig;
670 ///
671 /// fn disable_retries(builder: &mut Builder) {
672 /// let retry_config = RetryConfig::standard().with_max_attempts(1);
673 /// builder.set_retry_config(Some(retry_config));
674 /// }
675 ///
676 /// let mut builder = Config::builder();
677 /// disable_retries(&mut builder);
678 /// let config = builder.build();
679 /// ```
680 pub fn set_retry_config(&mut self, retry_config: ::std::option::Option<::aws_smithy_types::retry::RetryConfig>) -> &mut Self {
681 retry_config.map(|r| self.config.store_put(r));
682 self
683 }
684 /// Set the sleep_impl for the builder
685 ///
686 /// # Examples
687 ///
688 /// ```no_run
689 /// use aws_sdk_s3control::config::{AsyncSleep, Config, SharedAsyncSleep, Sleep};
690 ///
691 /// #[derive(Debug)]
692 /// pub struct ForeverSleep;
693 ///
694 /// impl AsyncSleep for ForeverSleep {
695 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
696 /// Sleep::new(std::future::pending())
697 /// }
698 /// }
699 ///
700 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
701 /// let config = Config::builder().sleep_impl(sleep_impl).build();
702 /// ```
703 pub fn sleep_impl(mut self, sleep_impl: impl crate::config::AsyncSleep + 'static) -> Self {
704 self.set_sleep_impl(Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(sleep_impl)));
705 self
706 }
707
708 /// Set the sleep_impl for the builder
709 ///
710 /// # Examples
711 ///
712 /// ```no_run
713 /// use aws_sdk_s3control::config::{AsyncSleep, Builder, Config, SharedAsyncSleep, Sleep};
714 ///
715 /// #[derive(Debug)]
716 /// pub struct ForeverSleep;
717 ///
718 /// impl AsyncSleep for ForeverSleep {
719 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
720 /// Sleep::new(std::future::pending())
721 /// }
722 /// }
723 ///
724 /// fn set_never_ending_sleep_impl(builder: &mut Builder) {
725 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
726 /// builder.set_sleep_impl(Some(sleep_impl));
727 /// }
728 ///
729 /// let mut builder = Config::builder();
730 /// set_never_ending_sleep_impl(&mut builder);
731 /// let config = builder.build();
732 /// ```
733 pub fn set_sleep_impl(&mut self, sleep_impl: ::std::option::Option<crate::config::SharedAsyncSleep>) -> &mut Self {
734 self.runtime_components.set_sleep_impl(sleep_impl);
735 self
736 }
737 /// Set the timeout_config for the builder
738 ///
739 /// # Examples
740 ///
741 /// ```no_run
742 /// # use std::time::Duration;
743 /// use aws_sdk_s3control::config::Config;
744 /// use aws_sdk_s3control::config::timeout::TimeoutConfig;
745 ///
746 /// let timeout_config = TimeoutConfig::builder()
747 /// .operation_attempt_timeout(Duration::from_secs(1))
748 /// .build();
749 /// let config = Config::builder().timeout_config(timeout_config).build();
750 /// ```
751 pub fn timeout_config(mut self, timeout_config: ::aws_smithy_types::timeout::TimeoutConfig) -> Self {
752 self.set_timeout_config(Some(timeout_config));
753 self
754 }
755
756 /// Set the timeout_config for the builder.
757 ///
758 /// Setting this to `None` has no effect if another source of configuration has set timeouts. If you
759 /// are attempting to disable timeouts, use [`TimeoutConfig::disabled`](::aws_smithy_types::timeout::TimeoutConfig::disabled)
760 ///
761 ///
762 /// # Examples
763 ///
764 /// ```no_run
765 /// # use std::time::Duration;
766 /// use aws_sdk_s3control::config::{Builder, Config};
767 /// use aws_sdk_s3control::config::timeout::TimeoutConfig;
768 ///
769 /// fn set_request_timeout(builder: &mut Builder) {
770 /// let timeout_config = TimeoutConfig::builder()
771 /// .operation_attempt_timeout(Duration::from_secs(1))
772 /// .build();
773 /// builder.set_timeout_config(Some(timeout_config));
774 /// }
775 ///
776 /// let mut builder = Config::builder();
777 /// set_request_timeout(&mut builder);
778 /// let config = builder.build();
779 /// ```
780 pub fn set_timeout_config(&mut self, timeout_config: ::std::option::Option<::aws_smithy_types::timeout::TimeoutConfig>) -> &mut Self {
781 // passing None has no impact.
782 let Some(mut timeout_config) = timeout_config else { return self };
783
784 if let Some(base) = self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>() {
785 timeout_config.take_defaults_from(base);
786 }
787 self.config.store_put(timeout_config);
788 self
789 }
790 /// Set the partition for retry-related state. When clients share a retry partition, they will
791 /// also share components such as token buckets and client rate limiters.
792 /// See the [`RetryPartition`](::aws_smithy_runtime::client::retries::RetryPartition) documentation for more details.
793 ///
794 /// # Default Behavior
795 ///
796 /// When no retry partition is explicitly set, the SDK automatically creates a default retry partition named `s3control`
797 /// (or `s3control-<region>` if a region is configured).
798 /// All S3 Control clients without an explicit retry partition will share this default partition.
799 ///
800 /// # Notes
801 ///
802 /// - This is an advanced setting. A common reason to set it is to size or isolate the retry
803 /// token bucket — for example, giving a high-throughput workload its own bucket. Otherwise
804 /// most users won't need to modify it.
805 /// - A configured client rate limiter has no effect unless [`RetryConfig::adaptive`](::aws_smithy_types::retry::RetryConfig::adaptive) is used.
806 ///
807 /// # Examples
808 ///
809 /// Creating a custom retry partition with a token bucket:
810 /// ```no_run
811 /// use aws_sdk_s3control::config::Config;
812 /// use aws_sdk_s3control::config::retry::{RetryPartition, TokenBucket};
813 ///
814 /// let token_bucket = TokenBucket::new(10);
815 /// let config = Config::builder()
816 /// .retry_partition(RetryPartition::custom("custom")
817 /// .token_bucket(token_bucket)
818 /// .build()
819 /// )
820 /// .build();
821 /// ```
822 ///
823 /// Sizing the retry token bucket (for example, for a high-throughput workload), or giving a
824 /// workload its own bucket:
825 /// ```no_run
826 /// use aws_sdk_s3control::config::Config;
827 /// use aws_sdk_s3control::config::retry::{RetryPartition, TokenBucket};
828 ///
829 /// let config = Config::builder()
830 /// .retry_partition(
831 /// RetryPartition::custom("high-throughput")
832 /// .token_bucket(TokenBucket::builder().capacity(5000).build())
833 /// .build(),
834 /// )
835 /// .build();
836 /// ```
837 ///
838 /// Configuring a client rate limiter with adaptive retry mode:
839 /// ```no_run
840 /// use aws_sdk_s3control::config::Config;
841 /// use aws_sdk_s3control::config::retry::{ClientRateLimiter, RetryConfig, RetryPartition};
842 ///
843 /// let client_rate_limiter = ClientRateLimiter::new(10.0);
844 /// let config = Config::builder()
845 /// .retry_partition(RetryPartition::custom("custom")
846 /// .client_rate_limiter(client_rate_limiter)
847 /// .build()
848 /// )
849 /// .retry_config(RetryConfig::adaptive())
850 /// .build();
851 /// ```
852 pub fn retry_partition(mut self, retry_partition: ::aws_smithy_runtime::client::retries::RetryPartition) -> Self {
853 self.set_retry_partition(Some(retry_partition));
854 self
855 }
856 /// Like [`Self::retry_partition`], but takes a mutable reference to the builder and an optional `RetryPartition`
857 pub fn set_retry_partition(
858 &mut self,
859 retry_partition: ::std::option::Option<::aws_smithy_runtime::client::retries::RetryPartition>,
860 ) -> &mut Self {
861 retry_partition.map(|r| self.config.store_put(r));
862 self
863 }
864 /// Set the identity cache for auth.
865 ///
866 /// The identity cache defaults to a lazy caching implementation that will resolve
867 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
868 /// requests will take the value from the cache while it is still valid. Once it expires,
869 /// the next request will result in refreshing the identity.
870 ///
871 /// This configuration allows you to disable or change the default caching mechanism.
872 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
873 /// trait and pass that implementation into this function.
874 ///
875 /// # Examples
876 ///
877 /// Disabling identity caching:
878 /// ```no_run
879 /// use aws_sdk_s3control::config::IdentityCache;
880 ///
881 /// let config = aws_sdk_s3control::Config::builder()
882 /// .identity_cache(IdentityCache::no_cache())
883 /// // ...
884 /// .build();
885 /// let client = aws_sdk_s3control::Client::from_conf(config);
886 /// ```
887 ///
888 /// Customizing lazy caching:
889 /// ```no_run
890 /// use aws_sdk_s3control::config::IdentityCache;
891 /// use std::time::Duration;
892 ///
893 /// let config = aws_sdk_s3control::Config::builder()
894 /// .identity_cache(
895 /// IdentityCache::lazy()
896 /// // change the load timeout to 10 seconds
897 /// .load_timeout(Duration::from_secs(10))
898 /// .build()
899 /// )
900 /// // ...
901 /// .build();
902 /// let client = aws_sdk_s3control::Client::from_conf(config);
903 /// ```
904 ///
905 pub fn identity_cache(mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> Self {
906 self.set_identity_cache(identity_cache);
907 self
908 }
909
910 /// Set the identity cache for auth.
911 ///
912 /// The identity cache defaults to a lazy caching implementation that will resolve
913 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
914 /// requests will take the value from the cache while it is still valid. Once it expires,
915 /// the next request will result in refreshing the identity.
916 ///
917 /// This configuration allows you to disable or change the default caching mechanism.
918 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
919 /// trait and pass that implementation into this function.
920 ///
921 /// # Examples
922 ///
923 /// Disabling identity caching:
924 /// ```no_run
925 /// use aws_sdk_s3control::config::IdentityCache;
926 ///
927 /// let config = aws_sdk_s3control::Config::builder()
928 /// .identity_cache(IdentityCache::no_cache())
929 /// // ...
930 /// .build();
931 /// let client = aws_sdk_s3control::Client::from_conf(config);
932 /// ```
933 ///
934 /// Customizing lazy caching:
935 /// ```no_run
936 /// use aws_sdk_s3control::config::IdentityCache;
937 /// use std::time::Duration;
938 ///
939 /// let config = aws_sdk_s3control::Config::builder()
940 /// .identity_cache(
941 /// IdentityCache::lazy()
942 /// // change the load timeout to 10 seconds
943 /// .load_timeout(Duration::from_secs(10))
944 /// .build()
945 /// )
946 /// // ...
947 /// .build();
948 /// let client = aws_sdk_s3control::Client::from_conf(config);
949 /// ```
950 ///
951 pub fn set_identity_cache(&mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> &mut Self {
952 self.runtime_components.set_identity_cache(::std::option::Option::Some(identity_cache));
953 self
954 }
955 /// Add an [interceptor](crate::config::Intercept) that runs at specific stages of the request execution pipeline.
956 ///
957 /// Interceptors targeted at a certain stage are executed according to the pre-defined priority.
958 /// The SDK provides a default set of interceptors. An interceptor configured by this method
959 /// will run after those default interceptors.
960 ///
961 /// # Examples
962 /// ```no_run
963 /// # fn example() {
964 /// use aws_smithy_runtime_api::box_error::BoxError;
965 /// use aws_smithy_runtime_api::client::interceptors::context::BeforeTransmitInterceptorContextMut;
966 /// use aws_smithy_runtime_api::client::interceptors::Intercept;
967 /// use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
968 /// use aws_smithy_types::config_bag::ConfigBag;
969 /// use aws_sdk_s3control::config::Config;
970 /// use ::http::uri::Uri;
971 ///
972 /// fn base_url() -> String {
973 /// // ...
974 /// # String::new()
975 /// }
976 ///
977 /// #[derive(Debug)]
978 /// pub struct UriModifierInterceptor;
979 /// impl Intercept for UriModifierInterceptor {
980 /// fn name(&self) -> &'static str {
981 /// "UriModifierInterceptor"
982 /// }
983 /// fn modify_before_signing(
984 /// &self,
985 /// context: &mut BeforeTransmitInterceptorContextMut<'_>,
986 /// _runtime_components: &RuntimeComponents,
987 /// _cfg: &mut ConfigBag,
988 /// ) -> Result<(), BoxError> {
989 /// let request = context.request_mut();
990 /// let uri = format!("{}{}", base_url(), request.uri());
991 /// *request.uri_mut() = uri.parse::<Uri>()?.into();
992 ///
993 /// Ok(())
994 /// }
995 /// }
996 ///
997 /// let config = Config::builder()
998 /// .interceptor(UriModifierInterceptor)
999 /// .build();
1000 /// # }
1001 /// ```
1002 pub fn interceptor(mut self, interceptor: impl crate::config::Intercept + 'static) -> Self {
1003 self.push_interceptor(crate::config::SharedInterceptor::new(interceptor));
1004 self
1005 }
1006
1007 /// Like [`Self::interceptor`], but takes a [`SharedInterceptor`](crate::config::SharedInterceptor).
1008 pub fn push_interceptor(&mut self, interceptor: crate::config::SharedInterceptor) -> &mut Self {
1009 self.runtime_components.push_interceptor(interceptor);
1010 self
1011 }
1012
1013 /// Set [`SharedInterceptor`](crate::config::SharedInterceptor)s for the builder.
1014 pub fn set_interceptors(&mut self, interceptors: impl IntoIterator<Item = crate::config::SharedInterceptor>) -> &mut Self {
1015 self.runtime_components.set_interceptors(interceptors.into_iter());
1016 self
1017 }
1018 /// Sets the time source used for this service
1019 pub fn time_source(mut self, time_source: impl ::aws_smithy_async::time::TimeSource + 'static) -> Self {
1020 self.set_time_source(::std::option::Option::Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(
1021 time_source,
1022 )));
1023 self
1024 }
1025 /// Sets the time source used for this service
1026 pub fn set_time_source(&mut self, time_source: ::std::option::Option<::aws_smithy_async::time::SharedTimeSource>) -> &mut Self {
1027 self.runtime_components.set_time_source(time_source);
1028 self
1029 }
1030 /// Add type implementing [`ClassifyRetry`](::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry) that will be used by the
1031 /// [`RetryStrategy`](::aws_smithy_runtime_api::client::retries::RetryStrategy) to determine what responses should be retried.
1032 ///
1033 /// A retry classifier configured by this method will run according to its [priority](::aws_smithy_runtime_api::client::retries::classifiers::RetryClassifierPriority).
1034 ///
1035 /// # Examples
1036 /// ```no_run
1037 /// # fn example() {
1038 /// use aws_smithy_runtime_api::client::interceptors::context::InterceptorContext;
1039 /// use aws_smithy_runtime_api::client::orchestrator::OrchestratorError;
1040 /// use aws_smithy_runtime_api::client::retries::classifiers::{
1041 /// ClassifyRetry, RetryAction, RetryClassifierPriority,
1042 /// };
1043 /// use aws_smithy_types::error::metadata::ProvideErrorMetadata;
1044 /// use aws_smithy_types::retry::ErrorKind;
1045 /// use std::error::Error as StdError;
1046 /// use std::marker::PhantomData;
1047 /// use std::fmt;
1048 /// use aws_sdk_s3control::config::Config;
1049 /// # #[derive(Debug)]
1050 /// # struct SomeOperationError {}
1051 /// # impl StdError for SomeOperationError {}
1052 /// # impl fmt::Display for SomeOperationError {
1053 /// # fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { todo!() }
1054 /// # }
1055 /// # impl ProvideErrorMetadata for SomeOperationError {
1056 /// # fn meta(&self) -> &aws_sdk_s3control::error::ErrorMetadata { todo!() }
1057 /// # }
1058 ///
1059 /// const RETRYABLE_ERROR_CODES: &[&str] = &[
1060 /// // List error codes to be retried here...
1061 /// ];
1062 ///
1063 /// // When classifying at an operation's error type, classifiers require a generic parameter.
1064 /// // When classifying the HTTP response alone, no generic is needed.
1065 /// #[derive(Debug, Default)]
1066 /// pub struct ExampleErrorCodeClassifier<E> {
1067 /// _inner: PhantomData<E>,
1068 /// }
1069 ///
1070 /// impl<E> ExampleErrorCodeClassifier<E> {
1071 /// pub fn new() -> Self {
1072 /// Self {
1073 /// _inner: PhantomData,
1074 /// }
1075 /// }
1076 /// }
1077 ///
1078 /// impl<E> ClassifyRetry for ExampleErrorCodeClassifier<E>
1079 /// where
1080 /// // Adding a trait bound for ProvideErrorMetadata allows us to inspect the error code.
1081 /// E: StdError + ProvideErrorMetadata + Send + Sync + 'static,
1082 /// {
1083 /// fn classify_retry(&self, ctx: &InterceptorContext) -> RetryAction {
1084 /// // Check for a result
1085 /// let output_or_error = ctx.output_or_error();
1086 /// // Check for an error
1087 /// let error = match output_or_error {
1088 /// Some(Ok(_)) | None => return RetryAction::NoActionIndicated,
1089 /// Some(Err(err)) => err,
1090 /// };
1091 ///
1092 /// // Downcast the generic error and extract the code
1093 /// let error_code = OrchestratorError::as_operation_error(error)
1094 /// .and_then(|err| err.downcast_ref::<E>())
1095 /// .and_then(|err| err.code());
1096 ///
1097 /// // If this error's code is in our list, return an action that tells the RetryStrategy to retry this request.
1098 /// if let Some(error_code) = error_code {
1099 /// if RETRYABLE_ERROR_CODES.contains(&error_code) {
1100 /// return RetryAction::transient_error();
1101 /// }
1102 /// }
1103 ///
1104 /// // Otherwise, return that no action is indicated i.e. that this classifier doesn't require a retry.
1105 /// // Another classifier may still classify this response as retryable.
1106 /// RetryAction::NoActionIndicated
1107 /// }
1108 ///
1109 /// fn name(&self) -> &'static str { "Example Error Code Classifier" }
1110 /// }
1111 ///
1112 /// let config = Config::builder()
1113 /// .retry_classifier(ExampleErrorCodeClassifier::<SomeOperationError>::new())
1114 /// .build();
1115 /// # }
1116 /// ```
1117 pub fn retry_classifier(
1118 mut self,
1119 retry_classifier: impl ::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry + 'static,
1120 ) -> Self {
1121 self.push_retry_classifier(::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier::new(
1122 retry_classifier,
1123 ));
1124 self
1125 }
1126
1127 /// Like [`Self::retry_classifier`], but takes a [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier).
1128 pub fn push_retry_classifier(
1129 &mut self,
1130 retry_classifier: ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier,
1131 ) -> &mut Self {
1132 self.runtime_components.push_retry_classifier(retry_classifier);
1133 self
1134 }
1135
1136 /// Set [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier)s for the builder, replacing any that
1137 /// were previously set.
1138 pub fn set_retry_classifiers(
1139 &mut self,
1140 retry_classifiers: impl IntoIterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier>,
1141 ) -> &mut Self {
1142 self.runtime_components.set_retry_classifiers(retry_classifiers.into_iter());
1143 self
1144 }
1145 /// Sets the name of the app that is using the client.
1146 ///
1147 /// This _optional_ name is used to identify the application in the user agent that
1148 /// gets sent along with requests.
1149 pub fn app_name(mut self, app_name: ::aws_types::app_name::AppName) -> Self {
1150 self.set_app_name(Some(app_name));
1151 self
1152 }
1153 /// Sets the name of the app that is using the client.
1154 ///
1155 /// This _optional_ name is used to identify the application in the user agent that
1156 /// gets sent along with requests.
1157 pub fn set_app_name(&mut self, app_name: ::std::option::Option<::aws_types::app_name::AppName>) -> &mut Self {
1158 self.config.store_or_unset(app_name);
1159 self
1160 }
1161 /// Appends framework metadata to the user agent.
1162 ///
1163 /// This _optional_ metadata identifies a software framework or third-party library
1164 /// that is being used with the client. It is rendered into the user agent string
1165 /// (as `lib/{name}/{version}`) so that libraries built on top of the AWS SDK can
1166 /// self-identify in the requests they make. Multiple entries may be added; each call
1167 /// appends another entry rather than replacing previous ones.
1168 ///
1169 /// Entries are de-duplicated on `(name, version)`, rendered in first-seen order, and
1170 /// the total number of unique entries included in the user agent is capped (currently
1171 /// at 10); additional entries beyond the cap are dropped with a warning.
1172 pub fn framework_metadata(mut self, framework_metadata: ::aws_types::sdk_ua_metadata::FrameworkMetadata) -> Self {
1173 self.push_framework_metadata(framework_metadata);
1174 self
1175 }
1176 /// Appends framework metadata to the user agent.
1177 ///
1178 /// This _optional_ metadata identifies a software framework or third-party library
1179 /// that is being used with the client. It is rendered into the user agent string
1180 /// (as `lib/{name}/{version}`) so that libraries built on top of the AWS SDK can
1181 /// self-identify in the requests they make. Multiple entries may be added; each call
1182 /// appends another entry rather than replacing previous ones.
1183 pub fn push_framework_metadata(&mut self, framework_metadata: ::aws_types::sdk_ua_metadata::FrameworkMetadata) -> &mut Self {
1184 self.config.store_append(framework_metadata);
1185 self
1186 }
1187 /// Overrides the default invocation ID generator.
1188 ///
1189 /// The invocation ID generator generates ID values for the `amz-sdk-invocation-id` header. By default, this will be a random UUID. Overriding it may be useful in tests that examine the HTTP request and need to be deterministic.
1190 pub fn invocation_id_generator(mut self, gen: impl ::aws_runtime::invocation_id::InvocationIdGenerator + 'static) -> Self {
1191 self.set_invocation_id_generator(::std::option::Option::Some(
1192 ::aws_runtime::invocation_id::SharedInvocationIdGenerator::new(gen),
1193 ));
1194 self
1195 }
1196 /// Overrides the default invocation ID generator.
1197 ///
1198 /// The invocation ID generator generates ID values for the `amz-sdk-invocation-id` header. By default, this will be a random UUID. Overriding it may be useful in tests that examine the HTTP request and need to be deterministic.
1199 pub fn set_invocation_id_generator(
1200 &mut self,
1201 gen: ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator>,
1202 ) -> &mut Self {
1203 self.config.store_or_unset(gen);
1204 self
1205 }
1206 /// Sets the endpoint URL used to communicate with this service.
1207 ///
1208 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1209 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1210 /// [`Builder::endpoint_resolver`].
1211 pub fn endpoint_url(mut self, endpoint_url: impl Into<::std::string::String>) -> Self {
1212 self.set_endpoint_url(Some(endpoint_url.into()));
1213 self
1214 }
1215 /// Sets the endpoint URL used to communicate with this service.
1216 ///
1217 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1218 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1219 /// [`Builder::endpoint_resolver`].
1220 pub fn set_endpoint_url(&mut self, endpoint_url: Option<::std::string::String>) -> &mut Self {
1221 self.config.store_or_unset(endpoint_url.map(::aws_types::endpoint_config::EndpointUrl));
1222 self
1223 }
1224 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1225 pub fn use_dual_stack(mut self, use_dual_stack: impl Into<bool>) -> Self {
1226 self.set_use_dual_stack(Some(use_dual_stack.into()));
1227 self
1228 }
1229 /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
1230 pub fn set_use_dual_stack(&mut self, use_dual_stack: Option<bool>) -> &mut Self {
1231 self.config.store_or_unset(use_dual_stack.map(::aws_types::endpoint_config::UseDualStack));
1232 self
1233 }
1234 /// When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
1235 pub fn use_fips(mut self, use_fips: impl Into<bool>) -> Self {
1236 self.set_use_fips(Some(use_fips.into()));
1237 self
1238 }
1239 /// When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
1240 pub fn set_use_fips(&mut self, use_fips: Option<bool>) -> &mut Self {
1241 self.config.store_or_unset(use_fips.map(::aws_types::endpoint_config::UseFips));
1242 self
1243 }
1244 /// Sets the AWS region to use when making requests.
1245 ///
1246 /// # Examples
1247 /// ```no_run
1248 /// use aws_types::region::Region;
1249 /// use aws_sdk_s3control::config::{Builder, Config};
1250 ///
1251 /// let config = aws_sdk_s3control::Config::builder()
1252 /// .region(Region::new("us-east-1"))
1253 /// .build();
1254 /// ```
1255 pub fn region(mut self, region: impl ::std::convert::Into<::std::option::Option<crate::config::Region>>) -> Self {
1256 self.set_region(region.into());
1257 self
1258 }
1259 /// Sets the AWS region to use when making requests.
1260 pub fn set_region(&mut self, region: ::std::option::Option<crate::config::Region>) -> &mut Self {
1261 self.config.store_or_unset(region);
1262 self
1263 }
1264 /// Sets the credentials provider for this service
1265 pub fn credentials_provider(mut self, credentials_provider: impl crate::config::ProvideCredentials + 'static) -> Self {
1266 self.set_credentials_provider(::std::option::Option::Some(crate::config::SharedCredentialsProvider::new(
1267 credentials_provider,
1268 )));
1269 self
1270 }
1271 /// Sets the credentials provider for this service
1272 pub fn set_credentials_provider(&mut self, credentials_provider: ::std::option::Option<crate::config::SharedCredentialsProvider>) -> &mut Self {
1273 if let Some(credentials_provider) = credentials_provider {
1274 self.runtime_components
1275 .set_identity_resolver(::aws_runtime::auth::sigv4::SCHEME_ID, credentials_provider);
1276 }
1277 self
1278 }
1279 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1280 ///
1281 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1282 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1283 /// all operations might be the ideal behavior but could break existing applications.
1284 ///
1285 /// # Examples
1286 ///
1287 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1288 /// ```no_run
1289 /// use aws_sdk_s3control::config::BehaviorVersion;
1290 ///
1291 /// let config = aws_sdk_s3control::Config::builder()
1292 /// .behavior_version(BehaviorVersion::latest())
1293 /// // ...
1294 /// .build();
1295 /// let client = aws_sdk_s3control::Client::from_conf(config);
1296 /// ```
1297 ///
1298 /// Customizing behavior major version:
1299 /// ```no_run
1300 /// use aws_sdk_s3control::config::BehaviorVersion;
1301 ///
1302 /// let config = aws_sdk_s3control::Config::builder()
1303 /// .behavior_version(BehaviorVersion::v2023_11_09())
1304 /// // ...
1305 /// .build();
1306 /// let client = aws_sdk_s3control::Client::from_conf(config);
1307 /// ```
1308 ///
1309 pub fn behavior_version(mut self, behavior_version: crate::config::BehaviorVersion) -> Self {
1310 self.set_behavior_version(Some(behavior_version));
1311 self
1312 }
1313
1314 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1315 ///
1316 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1317 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1318 /// all operations might be the ideal behavior but could break existing applications.
1319 ///
1320 /// # Examples
1321 ///
1322 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1323 /// ```no_run
1324 /// use aws_sdk_s3control::config::BehaviorVersion;
1325 ///
1326 /// let config = aws_sdk_s3control::Config::builder()
1327 /// .behavior_version(BehaviorVersion::latest())
1328 /// // ...
1329 /// .build();
1330 /// let client = aws_sdk_s3control::Client::from_conf(config);
1331 /// ```
1332 ///
1333 /// Customizing behavior major version:
1334 /// ```no_run
1335 /// use aws_sdk_s3control::config::BehaviorVersion;
1336 ///
1337 /// let config = aws_sdk_s3control::Config::builder()
1338 /// .behavior_version(BehaviorVersion::v2023_11_09())
1339 /// // ...
1340 /// .build();
1341 /// let client = aws_sdk_s3control::Client::from_conf(config);
1342 /// ```
1343 ///
1344 pub fn set_behavior_version(&mut self, behavior_version: Option<crate::config::BehaviorVersion>) -> &mut Self {
1345 self.behavior_version = behavior_version;
1346 self
1347 }
1348
1349 /// Convenience method to set the latest behavior major version
1350 ///
1351 /// This is equivalent to enabling the `behavior-version-latest` Cargo feature
1352 pub fn behavior_version_latest(mut self) -> Self {
1353 self.set_behavior_version(Some(crate::config::BehaviorVersion::latest()));
1354 self
1355 }
1356 /// Adds a runtime plugin to the config.
1357 #[allow(unused)]
1358 pub(crate) fn runtime_plugin(mut self, plugin: impl crate::config::RuntimePlugin + 'static) -> Self {
1359 self.push_runtime_plugin(crate::config::SharedRuntimePlugin::new(plugin));
1360 self
1361 }
1362 /// Adds a runtime plugin to the config.
1363 #[allow(unused)]
1364 pub(crate) fn push_runtime_plugin(&mut self, plugin: crate::config::SharedRuntimePlugin) -> &mut Self {
1365 self.runtime_plugins.push(plugin);
1366 self
1367 }
1368 #[cfg(any(feature = "test-util", test))]
1369 #[allow(unused_mut)]
1370 /// Apply test defaults to the builder. NOTE: Consider migrating to use `apply_test_defaults_v2` instead.
1371 pub fn apply_test_defaults(&mut self) -> &mut Self {
1372 self.set_idempotency_token_provider(Some("00000000-0000-4000-8000-000000000000".into()));
1373 self.set_time_source(::std::option::Option::Some(::aws_smithy_async::time::SharedTimeSource::new(
1374 ::aws_smithy_async::time::StaticTimeSource::new(::std::time::UNIX_EPOCH + ::std::time::Duration::from_secs(1234567890)),
1375 )));
1376 self.config.store_put(::aws_runtime::user_agent::AwsUserAgent::for_tests());
1377 self.set_credentials_provider(Some(crate::config::SharedCredentialsProvider::new(
1378 ::aws_credential_types::Credentials::for_tests(),
1379 )));
1380 self.behavior_version = ::std::option::Option::Some(crate::config::BehaviorVersion::latest());
1381 self
1382 }
1383 #[cfg(any(feature = "test-util", test))]
1384 #[allow(unused_mut)]
1385 /// Apply test defaults to the builder. NOTE: Consider migrating to use `with_test_defaults_v2` instead.
1386 pub fn with_test_defaults(mut self) -> Self {
1387 self.apply_test_defaults();
1388 self
1389 }
1390 #[cfg(any(feature = "test-util", test))]
1391 #[allow(unused_mut)]
1392 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1393 pub fn apply_test_defaults_v2(&mut self) -> &mut Self {
1394 self.apply_test_defaults();
1395 if self.config.load::<crate::config::Region>().is_none() {
1396 self.set_region(::std::option::Option::Some(crate::config::Region::new("us-east-1")));
1397 }
1398 self
1399 }
1400 #[cfg(any(feature = "test-util", test))]
1401 #[allow(unused_mut)]
1402 /// Apply test defaults to the builder. V2 of this function sets additional test defaults such as region configuration (if applicable).
1403 pub fn with_test_defaults_v2(mut self) -> Self {
1404 self.apply_test_defaults_v2();
1405 self
1406 }
1407 /// Builds a [`Config`].
1408 #[allow(unused_mut)]
1409 pub fn build(mut self) -> Config {
1410 let mut layer = self.config;
1411 if self.runtime_components.time_source().is_none() {
1412 self.runtime_components
1413 .set_time_source(::std::option::Option::Some(::std::default::Default::default()));
1414 }
1415 layer.store_put(crate::meta::API_METADATA.clone());
1416 layer.store_put(::aws_types::SigningName::from_static("s3"));
1417 layer
1418 .load::<::aws_types::region::Region>()
1419 .cloned()
1420 .map(|r| layer.store_put(::aws_types::region::SigningRegion::from(r)));
1421 Config {
1422 config: crate::config::Layer::from(layer.clone())
1423 .with_name("aws_sdk_s3control::config::Config")
1424 .freeze(),
1425 cloneable: layer,
1426 runtime_components: self.runtime_components,
1427 runtime_plugins: self.runtime_plugins,
1428 behavior_version: self.behavior_version,
1429 }
1430 }
1431}
1432#[derive(::std::fmt::Debug)]
1433pub(crate) struct ServiceRuntimePlugin {
1434 config: ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer>,
1435 runtime_components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1436}
1437
1438impl ServiceRuntimePlugin {
1439 pub fn new(_service_config: crate::config::Config) -> Self {
1440 let config = {
1441 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("AWSS3ControlServiceV20180820");
1442 cfg.store_put(crate::idempotency_token::default_provider());
1443 cfg.store_put(::aws_smithy_runtime::client::orchestrator::AuthSchemeAndEndpointOrchestrationV2);
1444 ::std::option::Option::Some(cfg.freeze())
1445 };
1446 let mut runtime_components = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ServiceRuntimePlugin");
1447 runtime_components.set_auth_scheme_option_resolver(::std::option::Option::Some({
1448 use crate::config::auth::ResolveAuthScheme;
1449 crate::config::auth::DefaultAuthSchemeResolver::default().into_shared_resolver()
1450 }));
1451 runtime_components.set_endpoint_resolver(::std::option::Option::Some({
1452 use crate::config::endpoint::ResolveEndpoint;
1453 crate::config::endpoint::DefaultResolver::new().into_shared_resolver()
1454 }));
1455 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1456 ::aws_smithy_runtime::client::http::connection_poisoning::ConnectionPoisoningInterceptor::new(),
1457 ));
1458 runtime_components.push_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::HttpStatusCodeClassifier::default());
1459 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1460 crate::sdk_feature_tracker::retry_mode::RetryModeFeatureTrackerInterceptor::new(),
1461 ));
1462 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1463 ::aws_runtime::service_clock_skew::ServiceClockSkewInterceptor::new(),
1464 ));
1465 runtime_components.push_interceptor(::aws_runtime::request_info::RequestInfoInterceptor::new());
1466 runtime_components.push_interceptor(::aws_runtime::user_agent::UserAgentInterceptor::new());
1467 runtime_components.push_interceptor(::aws_runtime::invocation_id::InvocationIdInterceptor::new());
1468 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1469 ::aws_runtime::recursion_detection::RecursionDetectionInterceptor::new(),
1470 ));
1471 runtime_components.push_auth_scheme(::aws_smithy_runtime_api::client::auth::SharedAuthScheme::new(
1472 ::aws_runtime::auth::sigv4::SigV4AuthScheme::new(),
1473 ));
1474 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1475 crate::config::endpoint::EndpointOverrideFeatureTrackerInterceptor,
1476 ));
1477 runtime_components.push_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
1478 crate::observability_feature::ObservabilityFeatureTrackerInterceptor,
1479 ));
1480 Self { config, runtime_components }
1481 }
1482}
1483
1484impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ServiceRuntimePlugin {
1485 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1486 self.config.clone()
1487 }
1488
1489 fn order(&self) -> ::aws_smithy_runtime_api::client::runtime_plugin::Order {
1490 ::aws_smithy_runtime_api::client::runtime_plugin::Order::Defaults
1491 }
1492
1493 fn runtime_components(
1494 &self,
1495 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1496 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1497 ::std::borrow::Cow::Borrowed(&self.runtime_components)
1498 }
1499}
1500
1501// Cross-operation shared-state singletons
1502
1503/// A plugin that enables configuration for a single operation invocation
1504///
1505/// The `config` method will return a `FrozenLayer` by storing values from `config_override`.
1506/// In the case of default values requested, they will be obtained from `client_config`.
1507#[derive(Debug)]
1508pub(crate) struct ConfigOverrideRuntimePlugin {
1509 pub(crate) config: ::aws_smithy_types::config_bag::FrozenLayer,
1510 pub(crate) components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1511}
1512
1513impl ConfigOverrideRuntimePlugin {
1514 #[allow(dead_code)] // unused when a service does not provide any operations
1515 pub(crate) fn new(
1516 config_override: Builder,
1517 initial_config: ::aws_smithy_types::config_bag::FrozenLayer,
1518 initial_components: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1519 ) -> Self {
1520 let mut layer = config_override.config;
1521 let mut components = config_override.runtime_components;
1522 #[allow(unused_mut)]
1523 let mut resolver =
1524 ::aws_smithy_runtime::client::config_override::Resolver::overrid(initial_config, initial_components, &mut layer, &mut components);
1525
1526 resolver
1527 .config_mut()
1528 .load::<::aws_types::region::Region>()
1529 .cloned()
1530 .map(|r| resolver.config_mut().store_put(::aws_types::region::SigningRegion::from(r)));
1531
1532 let _ = resolver;
1533
1534 // When the config override supplies an identity resolver for any auth scheme
1535 // known to the client or the override itself, we give this operation its own
1536 // short-lived identity cache so that new partitions don't accumulate in the
1537 // shared client cache. A lazy cache (not `no_cache`) is used so that resolved
1538 // identities are served from the short-lived identity cache on retries.
1539 //
1540 // This is skipped if the override already sets its own identity cache.
1541 if components.has_identity_resolvers() && components.identity_cache().is_none() {
1542 components.set_identity_cache(::std::option::Option::Some(
1543 ::aws_smithy_runtime::client::identity::IdentityCache::lazy().max_partitions(1).build(),
1544 ));
1545 }
1546
1547 Self {
1548 config: ::aws_smithy_types::config_bag::Layer::from(layer)
1549 .with_name("aws_sdk_s3control::config::ConfigOverrideRuntimePlugin")
1550 .freeze(),
1551 components,
1552 }
1553 }
1554}
1555
1556impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ConfigOverrideRuntimePlugin {
1557 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1558 Some(self.config.clone())
1559 }
1560
1561 fn runtime_components(
1562 &self,
1563 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1564 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1565 ::std::borrow::Cow::Borrowed(&self.components)
1566 }
1567}
1568
1569pub use ::aws_smithy_runtime::client::identity::IdentityCache;
1570pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
1571pub use ::aws_smithy_types::config_bag::ConfigBag;
1572
1573pub use ::aws_credential_types::Credentials;
1574
1575impl From<&::aws_types::sdk_config::SdkConfig> for Builder {
1576 fn from(input: &::aws_types::sdk_config::SdkConfig) -> Self {
1577 let mut builder = Builder::default();
1578 builder.set_credentials_provider(input.credentials_provider());
1579 builder = builder.region(input.region().cloned());
1580 builder.set_use_fips(input.use_fips());
1581 builder.set_use_dual_stack(input.use_dual_stack());
1582 if input.get_origin("endpoint_url").is_client_config() {
1583 builder.set_endpoint_url(input.endpoint_url().map(|s| s.to_string()));
1584 } else {
1585 builder.set_endpoint_url(
1586 input
1587 .service_config()
1588 .and_then(|conf| {
1589 conf.load_config(service_config_key("S3 Control", "AWS_ENDPOINT_URL", "endpoint_url"))
1590 .map(|it| it.parse().unwrap())
1591 })
1592 .or_else(|| input.endpoint_url().map(|s| s.to_string())),
1593 );
1594 }
1595 // resiliency
1596 builder.set_retry_config(input.retry_config().cloned());
1597 builder.set_timeout_config(input.timeout_config().cloned());
1598 builder.set_sleep_impl(input.sleep_impl());
1599
1600 builder.set_http_client(input.http_client());
1601 builder.set_time_source(input.time_source());
1602 builder.set_behavior_version(input.behavior_version());
1603 builder.set_auth_scheme_preference(input.auth_scheme_preference().cloned());
1604 // setting `None` here removes the default
1605 if let Some(config) = input.stalled_stream_protection() {
1606 builder.set_stalled_stream_protection(Some(config));
1607 }
1608
1609 if let Some(cache) = input.identity_cache() {
1610 builder.set_identity_cache(cache);
1611 }
1612 builder.set_app_name(input.app_name().cloned());
1613 for framework_metadata in input.framework_metadata() {
1614 builder.push_framework_metadata(framework_metadata.clone());
1615 }
1616
1617 builder
1618 }
1619}
1620
1621impl From<&::aws_types::sdk_config::SdkConfig> for Config {
1622 fn from(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
1623 Builder::from(sdk_config).build()
1624 }
1625}
1626
1627pub use ::aws_types::app_name::AppName;
1628pub use ::aws_types::sdk_ua_metadata::FrameworkMetadata;
1629
1630#[allow(dead_code)]
1631fn service_config_key<'a>(service_id: &'a str, env: &'a str, profile: &'a str) -> aws_types::service_config::ServiceConfigKey<'a> {
1632 ::aws_types::service_config::ServiceConfigKey::builder()
1633 .service_id(service_id)
1634 .env(env)
1635 .profile(profile)
1636 .build()
1637 .expect("all field sets explicitly, can't fail")
1638}
1639
1640pub use ::aws_smithy_async::rt::sleep::Sleep;
1641
1642pub(crate) fn base_client_runtime_plugins(mut config: crate::Config) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
1643 let mut configured_plugins = ::std::vec::Vec::new();
1644 ::std::mem::swap(&mut config.runtime_plugins, &mut configured_plugins);
1645 #[cfg(feature = "behavior-version-latest")]
1646 {
1647 if config.behavior_version.is_none() {
1648 config.behavior_version = Some(::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion::latest());
1649 }
1650 }
1651
1652 let default_retry_partition = "s3control";
1653 let default_retry_partition = match config.region() {
1654 Some(region) => ::std::borrow::Cow::from(format!("{default_retry_partition}-{region}")),
1655 None => ::std::borrow::Cow::from(default_retry_partition),
1656 };
1657
1658 let scope = "aws-sdk-s3control";
1659
1660 #[allow(deprecated)]
1661 let mut plugins = ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins::new()
1662 // defaults
1663 .with_client_plugins(::aws_smithy_runtime::client::defaults::default_plugins(
1664 ::aws_smithy_runtime::client::defaults::DefaultPluginParams::new()
1665 .with_retry_partition_name(default_retry_partition)
1666 .with_behavior_version(config.behavior_version.expect("Invalid client configuration: A behavior major version must be set when sending a request or constructing a client. You must set it during client construction or by enabling the `behavior-version-latest` cargo feature."))
1667 .with_is_aws_sdk(true)
1668 ))
1669 // user config
1670 .with_client_plugin(
1671 ::aws_smithy_runtime_api::client::runtime_plugin::StaticRuntimePlugin::new()
1672 .with_config(config.config.clone())
1673 .with_runtime_components(config.runtime_components.clone())
1674 )
1675 // codegen config
1676 .with_client_plugin(crate::config::ServiceRuntimePlugin::new(config.clone()))
1677 .with_client_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePlugin::new())
1678 .with_client_plugin(
1679 ::aws_smithy_runtime::client::metrics::MetricsRuntimePlugin::builder()
1680 .with_scope(scope)
1681 .with_time_source(config.runtime_components.time_source().unwrap_or_default())
1682 .build()
1683 .expect("All required fields have been set")
1684 );
1685
1686 for plugin in configured_plugins {
1687 plugins = plugins.with_client_plugin(plugin);
1688 }
1689 plugins
1690}
1691
1692pub use ::aws_smithy_types::config_bag::FrozenLayer;
1693
1694pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder;
1695
1696pub use ::aws_smithy_runtime_api::client::runtime_plugin::SharedRuntimePlugin;
1697
1698pub use ::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
1699
1700pub use ::aws_smithy_runtime_api::client::stalled_stream_protection::StalledStreamProtectionConfig;
1701
1702pub use ::aws_smithy_runtime_api::client::http::SharedHttpClient;
1703
1704pub use ::aws_smithy_async::rt::sleep::SharedAsyncSleep;
1705
1706pub use ::aws_smithy_runtime_api::client::identity::SharedIdentityCache;
1707
1708pub use ::aws_smithy_runtime_api::client::interceptors::SharedInterceptor;
1709
1710pub use ::aws_types::region::Region;
1711
1712pub use ::aws_credential_types::provider::SharedCredentialsProvider;
1713
1714#[derive(Debug, Clone)]
1715pub(crate) struct UseArnRegion(pub(crate) bool);
1716impl ::aws_smithy_types::config_bag::Storable for UseArnRegion {
1717 type Storer = ::aws_smithy_types::config_bag::StoreReplace<Self>;
1718}
1719
1720pub use ::aws_smithy_runtime_api::client::http::HttpClient;
1721
1722pub use ::aws_smithy_runtime_api::shared::IntoShared;
1723
1724pub use ::aws_smithy_async::rt::sleep::AsyncSleep;
1725
1726pub use ::aws_smithy_runtime_api::client::identity::ResolveCachedIdentity;
1727
1728pub use ::aws_smithy_runtime_api::client::interceptors::Intercept;
1729
1730pub use ::aws_credential_types::provider::ProvideCredentials;
1731
1732pub use ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin;
1733
1734pub use ::aws_smithy_types::config_bag::Layer;
1735
1736/// Types needed to configure endpoint resolution.
1737pub mod endpoint;
1738
1739/// HTTP request and response types.
1740pub mod http;
1741
1742/// Types needed to implement [`Intercept`](crate::config::Intercept).
1743pub mod interceptors;
1744
1745/// Retry configuration.
1746///
1747/// [`RetryConfig`](crate::config::retry::RetryConfig) sets the number of retry attempts and the backoff between them. Retries are additionally bounded by a retry token bucket (a shared retry quota): [`TokenBucket`](crate::config::retry::TokenBucket) holds the tokens and [`RetryPartition`](crate::config::retry::RetryPartition) determines which clients and operations share one. To size the token bucket or give a workload its own, use [`Builder::retry_partition`](crate::config::Builder::retry_partition).
1748pub mod retry;
1749
1750/// Timeout configuration.
1751pub mod timeout;
1752
1753/// Types needed to configure auth scheme resolution.
1754pub mod auth;