aws_sdk_notifications/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_notifications 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 invocation ID generator if one was given in config.
120 ///
121 /// 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.
122 pub fn invocation_id_generator(&self) -> ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator> {
123 self.config.load::<::aws_runtime::invocation_id::SharedInvocationIdGenerator>().cloned()
124 }
125 /// Creates a new [service config](crate::Config) from a [shared `config`](::aws_types::sdk_config::SdkConfig).
126 pub fn new(config: &::aws_types::sdk_config::SdkConfig) -> Self {
127 Builder::from(config).build()
128 }
129 /// The signature version 4 service signing name to use in the credential scope when signing requests.
130 ///
131 /// The signing service may be overridden by the `Endpoint`, or by specifying a custom
132 /// [`SigningName`](aws_types::SigningName) during operation construction
133 pub fn signing_name(&self) -> &'static str {
134 "notifications"
135 }
136 /// Returns the AWS region, if it was provided.
137 pub fn region(&self) -> ::std::option::Option<&crate::config::Region> {
138 self.config.load::<crate::config::Region>()
139 }
140 /// 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.
141 #[deprecated(
142 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."
143 )]
144 pub fn credentials_provider(&self) -> Option<crate::config::SharedCredentialsProvider> {
145 ::std::option::Option::None
146 }
147}
148/// Builder for creating a `Config`.
149#[derive(::std::clone::Clone, ::std::fmt::Debug)]
150pub struct Builder {
151 pub(crate) config: ::aws_smithy_types::config_bag::CloneableLayer,
152 pub(crate) runtime_components: crate::config::RuntimeComponentsBuilder,
153 pub(crate) runtime_plugins: ::std::vec::Vec<crate::config::SharedRuntimePlugin>,
154 pub(crate) behavior_version: ::std::option::Option<crate::config::BehaviorVersion>,
155}
156impl ::std::default::Default for Builder {
157 fn default() -> Self {
158 Self {
159 config: ::std::default::Default::default(),
160 runtime_components: crate::config::RuntimeComponentsBuilder::new("service config"),
161 runtime_plugins: ::std::default::Default::default(),
162 behavior_version: ::std::default::Default::default(),
163 }
164 }
165}
166impl Builder {
167 ///
168 /// Constructs a config builder.
169 /// <div class="warning">
170 /// Note that a config created from this builder will not have the same safe defaults as one created by
171 /// the <a href="https://crates.io/crates/aws-config" target="_blank">aws-config</a> crate.
172 /// </div>
173 ///
174 pub fn new() -> Self {
175 Self::default()
176 }
177 /// Constructs a config builder from the given `config_bag`, setting only fields stored in the config bag,
178 /// but not those in runtime components.
179 #[allow(unused)]
180 pub(crate) fn from_config_bag(config_bag: &::aws_smithy_types::config_bag::ConfigBag) -> Self {
181 let mut builder = Self::new();
182 builder.set_stalled_stream_protection(config_bag.load::<crate::config::StalledStreamProtectionConfig>().cloned());
183 builder.set_auth_scheme_preference(config_bag.load::<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>().cloned());
184 builder.set_retry_config(config_bag.load::<::aws_smithy_types::retry::RetryConfig>().cloned());
185 builder.set_timeout_config(config_bag.load::<::aws_smithy_types::timeout::TimeoutConfig>().cloned());
186 builder.set_retry_partition(config_bag.load::<::aws_smithy_runtime::client::retries::RetryPartition>().cloned());
187 builder.set_app_name(config_bag.load::<::aws_types::app_name::AppName>().cloned());
188 builder.set_endpoint_url(config_bag.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()));
189 builder.set_use_fips(config_bag.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0));
190 builder.set_region(config_bag.load::<crate::config::Region>().cloned());
191 builder
192 }
193 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
194 /// to configure protection for stalled streams.
195 pub fn stalled_stream_protection(mut self, stalled_stream_protection_config: crate::config::StalledStreamProtectionConfig) -> Self {
196 self.set_stalled_stream_protection(::std::option::Option::Some(stalled_stream_protection_config));
197 self
198 }
199 /// Set the [`StalledStreamProtectionConfig`](crate::config::StalledStreamProtectionConfig)
200 /// to configure protection for stalled streams.
201 pub fn set_stalled_stream_protection(
202 &mut self,
203 stalled_stream_protection_config: ::std::option::Option<crate::config::StalledStreamProtectionConfig>,
204 ) -> &mut Self {
205 self.config.store_or_unset(stalled_stream_protection_config);
206 self
207 }
208 /// Sets the HTTP client to use when making requests.
209 ///
210 /// # Examples
211 /// ```no_run
212 /// # #[cfg(test)]
213 /// # mod tests {
214 /// # #[test]
215 /// # fn example() {
216 /// use std::time::Duration;
217 /// use aws_sdk_notifications::config::Config;
218 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
219 ///
220 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
221 /// .with_webpki_roots()
222 /// .https_only()
223 /// .enable_http1()
224 /// .enable_http2()
225 /// .build();
226 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
227 ///
228 /// // This connector can then be given to a generated service Config
229 /// let config = my_service_client::Config::builder()
230 /// .endpoint_url("https://example.com")
231 /// .http_client(hyper_client)
232 /// .build();
233 /// let client = my_service_client::Client::from_conf(config);
234 /// # }
235 /// # }
236 /// ```
237 pub fn http_client(mut self, http_client: impl crate::config::HttpClient + 'static) -> Self {
238 self.set_http_client(::std::option::Option::Some(crate::config::IntoShared::into_shared(http_client)));
239 self
240 }
241
242 /// Sets the HTTP client to use when making requests.
243 ///
244 /// # Examples
245 /// ```no_run
246 /// # #[cfg(test)]
247 /// # mod tests {
248 /// # #[test]
249 /// # fn example() {
250 /// use std::time::Duration;
251 /// use aws_sdk_notifications::config::{Builder, Config};
252 /// use aws_smithy_runtime::client::http::hyper_014::HyperClientBuilder;
253 ///
254 /// fn override_http_client(builder: &mut Builder) {
255 /// let https_connector = hyper_rustls::HttpsConnectorBuilder::new()
256 /// .with_webpki_roots()
257 /// .https_only()
258 /// .enable_http1()
259 /// .enable_http2()
260 /// .build();
261 /// let hyper_client = HyperClientBuilder::new().build(https_connector);
262 /// builder.set_http_client(Some(hyper_client));
263 /// }
264 ///
265 /// let mut builder = aws_sdk_notifications::Config::builder();
266 /// override_http_client(&mut builder);
267 /// let config = builder.build();
268 /// # }
269 /// # }
270 /// ```
271 pub fn set_http_client(&mut self, http_client: Option<crate::config::SharedHttpClient>) -> &mut Self {
272 self.runtime_components.set_http_client(http_client);
273 self
274 }
275 /// Adds an auth scheme to the builder
276 ///
277 /// If `auth_scheme` has an existing [AuthSchemeId](aws_smithy_runtime_api::client::auth::AuthSchemeId) in the runtime, the current identity
278 /// resolver and signer for that scheme will be replaced by those from `auth_scheme`.
279 ///
280 /// _Important:_ When introducing a custom auth scheme, ensure you override either
281 /// [`Self::auth_scheme_resolver`] or [`Self::set_auth_scheme_resolver`]
282 /// so that the custom auth scheme is included in the list of resolved auth scheme options.
283 /// [The default auth scheme resolver](crate::config::auth::DefaultAuthSchemeResolver) will not recognize your custom auth scheme.
284 ///
285 /// # Examples
286 /// ```no_run
287 /// # use aws_smithy_runtime_api::{
288 /// # box_error::BoxError,
289 /// # client::{
290 /// # auth::{
291 /// # AuthScheme, AuthSchemeEndpointConfig, AuthSchemeId, AuthSchemeOption,
292 /// # AuthSchemeOptionsFuture, Sign,
293 /// # },
294 /// # identity::{Identity, IdentityFuture, ResolveIdentity, SharedIdentityResolver},
295 /// # orchestrator::HttpRequest,
296 /// # runtime_components::{GetIdentityResolver, RuntimeComponents},
297 /// # },
298 /// # shared::IntoShared,
299 /// # };
300 /// # use aws_smithy_types::config_bag::ConfigBag;
301 /// // Auth scheme with customer identity resolver and signer
302 /// #[derive(Debug)]
303 /// struct CustomAuthScheme {
304 /// id: AuthSchemeId,
305 /// identity_resolver: SharedIdentityResolver,
306 /// signer: CustomSigner,
307 /// }
308 /// impl Default for CustomAuthScheme {
309 /// fn default() -> Self {
310 /// Self {
311 /// id: AuthSchemeId::new("custom"),
312 /// identity_resolver: CustomIdentityResolver.into_shared(),
313 /// signer: CustomSigner,
314 /// }
315 /// }
316 /// }
317 /// impl AuthScheme for CustomAuthScheme {
318 /// fn scheme_id(&self) -> AuthSchemeId {
319 /// self.id.clone()
320 /// }
321 /// fn identity_resolver(
322 /// &self,
323 /// _identity_resolvers: &dyn GetIdentityResolver,
324 /// ) -> Option<SharedIdentityResolver> {
325 /// Some(self.identity_resolver.clone())
326 /// }
327 /// fn signer(&self) -> &dyn Sign {
328 /// &self.signer
329 /// }
330 /// }
331 ///
332 /// #[derive(Debug, Default)]
333 /// struct CustomSigner;
334 /// impl Sign for CustomSigner {
335 /// fn sign_http_request(
336 /// &self,
337 /// _request: &mut HttpRequest,
338 /// _identity: &Identity,
339 /// _auth_scheme_endpoint_config: AuthSchemeEndpointConfig<'_>,
340 /// _runtime_components: &RuntimeComponents,
341 /// _config_bag: &ConfigBag,
342 /// ) -> Result<(), BoxError> {
343 /// // --snip--
344 /// # todo!()
345 /// }
346 /// }
347 ///
348 /// #[derive(Debug)]
349 /// struct CustomIdentityResolver;
350 /// impl ResolveIdentity for CustomIdentityResolver {
351 /// fn resolve_identity<'a>(
352 /// &'a self,
353 /// _runtime_components: &'a RuntimeComponents,
354 /// _config_bag: &'a ConfigBag,
355 /// ) -> IdentityFuture<'a> {
356 /// // --snip--
357 /// # todo!()
358 /// }
359 /// }
360 ///
361 /// // Auth scheme resolver that favors `CustomAuthScheme`
362 /// #[derive(Debug)]
363 /// struct CustomAuthSchemeResolver;
364 /// impl aws_sdk_notifications::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
365 /// fn resolve_auth_scheme<'a>(
366 /// &'a self,
367 /// _params: &'a aws_sdk_notifications::config::auth::Params,
368 /// _cfg: &'a ConfigBag,
369 /// _runtime_components: &'a RuntimeComponents,
370 /// ) -> AuthSchemeOptionsFuture<'a> {
371 /// AuthSchemeOptionsFuture::ready(Ok(vec![AuthSchemeOption::from(AuthSchemeId::new(
372 /// "custom",
373 /// ))]))
374 /// }
375 /// }
376 ///
377 /// let config = aws_sdk_notifications::Config::builder()
378 /// .push_auth_scheme(CustomAuthScheme::default())
379 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
380 /// // other configurations
381 /// .build();
382 /// ```
383 pub fn push_auth_scheme(mut self, auth_scheme: impl ::aws_smithy_runtime_api::client::auth::AuthScheme + 'static) -> Self {
384 self.runtime_components.push_auth_scheme(auth_scheme);
385 self
386 }
387
388 /// Set the auth scheme resolver for the builder
389 ///
390 /// # Examples
391 /// ```no_run
392 /// # use aws_smithy_runtime_api::{
393 /// # client::{
394 /// # auth::AuthSchemeOptionsFuture,
395 /// # runtime_components::RuntimeComponents,
396 /// # },
397 /// # };
398 /// # use aws_smithy_types::config_bag::ConfigBag;
399 /// #[derive(Debug)]
400 /// struct CustomAuthSchemeResolver;
401 /// impl aws_sdk_notifications::config::auth::ResolveAuthScheme for CustomAuthSchemeResolver {
402 /// fn resolve_auth_scheme<'a>(
403 /// &'a self,
404 /// _params: &'a aws_sdk_notifications::config::auth::Params,
405 /// _cfg: &'a ConfigBag,
406 /// _runtime_components: &'a RuntimeComponents,
407 /// ) -> AuthSchemeOptionsFuture<'a> {
408 /// // --snip--
409 /// # todo!()
410 /// }
411 /// }
412 ///
413 /// let config = aws_sdk_notifications::Config::builder()
414 /// .auth_scheme_resolver(CustomAuthSchemeResolver)
415 /// // other configurations
416 /// .build();
417 /// ```
418 pub fn auth_scheme_resolver(mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> Self {
419 self.set_auth_scheme_resolver(auth_scheme_resolver);
420 self
421 }
422
423 /// Set the auth scheme resolver for the builder
424 ///
425 /// # Examples
426 /// See an example for [`Self::auth_scheme_resolver`].
427 pub fn set_auth_scheme_resolver(&mut self, auth_scheme_resolver: impl crate::config::auth::ResolveAuthScheme + 'static) -> &mut Self {
428 self.runtime_components
429 .set_auth_scheme_option_resolver(::std::option::Option::Some(auth_scheme_resolver.into_shared_resolver()));
430 self
431 }
432 /// Set the auth scheme preference for an auth scheme resolver
433 /// (typically the default auth scheme resolver).
434 ///
435 /// Each operation has a predefined order of auth schemes, as determined by the service,
436 /// for auth scheme resolution. By using the auth scheme preference, customers
437 /// can reorder the schemes resolved by the auth scheme resolver.
438 ///
439 /// The preference list is intended as a hint rather than a strict override.
440 /// Any schemes not present in the originally resolved auth schemes will be ignored.
441 ///
442 /// # Examples
443 ///
444 /// ```no_run
445 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
446 /// let config = aws_sdk_notifications::Config::builder()
447 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
448 /// // ...
449 /// .build();
450 /// let client = aws_sdk_notifications::Client::from_conf(config);
451 /// ```
452
453 pub fn auth_scheme_preference(
454 mut self,
455 preference: impl ::std::convert::Into<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>,
456 ) -> Self {
457 self.set_auth_scheme_preference(::std::option::Option::Some(preference.into()));
458 self
459 }
460
461 /// Set the auth scheme preference for an auth scheme resolver
462 /// (typically the default auth scheme resolver).
463 ///
464 /// Each operation has a predefined order of auth schemes, as determined by the service,
465 /// for auth scheme resolution. By using the auth scheme preference, customers
466 /// can reorder the schemes resolved by the auth scheme resolver.
467 ///
468 /// The preference list is intended as a hint rather than a strict override.
469 /// Any schemes not present in the originally resolved auth schemes will be ignored.
470 ///
471 /// # Examples
472 ///
473 /// ```no_run
474 /// # use aws_smithy_runtime_api::client::auth::AuthSchemeId;
475 /// let config = aws_sdk_notifications::Config::builder()
476 /// .auth_scheme_preference([AuthSchemeId::from("scheme1"), AuthSchemeId::from("scheme2")])
477 /// // ...
478 /// .build();
479 /// let client = aws_sdk_notifications::Client::from_conf(config);
480 /// ```
481
482 pub fn set_auth_scheme_preference(
483 &mut self,
484 preference: ::std::option::Option<::aws_smithy_runtime_api::client::auth::AuthSchemePreference>,
485 ) -> &mut Self {
486 self.config.store_or_unset(preference);
487 self
488 }
489 /// Sets the endpoint resolver to use when making requests.
490 ///
491 ///
492 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
493 /// rules for `aws_sdk_notifications`.
494 ///
495 ///
496 /// Note: setting an endpoint resolver will replace any endpoint URL that has been set.
497 /// This method accepts an endpoint resolver [specific to this service](crate::config::endpoint::ResolveEndpoint). If you want to
498 /// provide a shared endpoint resolver, use [`Self::set_endpoint_resolver`].
499 ///
500 /// # Examples
501 /// Create a custom endpoint resolver that resolves a different endpoing per-stage, e.g. staging vs. production.
502 /// ```no_run
503 /// use aws_sdk_notifications::config::endpoint::{ResolveEndpoint, EndpointFuture, Params, Endpoint};
504 /// #[derive(Debug)]
505 /// struct StageResolver { stage: String }
506 /// impl ResolveEndpoint for StageResolver {
507 /// fn resolve_endpoint(&self, params: &Params) -> EndpointFuture<'_> {
508 /// let stage = &self.stage;
509 /// EndpointFuture::ready(Ok(Endpoint::builder().url(format!("{stage}.myservice.com")).build()))
510 /// }
511 /// }
512 /// let resolver = StageResolver { stage: std::env::var("STAGE").unwrap() };
513 /// let config = aws_sdk_notifications::Config::builder().endpoint_resolver(resolver).build();
514 /// let client = aws_sdk_notifications::Client::from_conf(config);
515 /// ```
516 pub fn endpoint_resolver(mut self, endpoint_resolver: impl crate::config::endpoint::ResolveEndpoint + 'static) -> Self {
517 self.set_endpoint_resolver(::std::option::Option::Some(endpoint_resolver.into_shared_resolver()));
518 self
519 }
520
521 /// Sets the endpoint resolver to use when making requests.
522 ///
523 ///
524 /// When unset, the client will used a generated endpoint resolver based on the endpoint resolution
525 /// rules for `aws_sdk_notifications`.
526 ///
527 pub fn set_endpoint_resolver(
528 &mut self,
529 endpoint_resolver: ::std::option::Option<::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver>,
530 ) -> &mut Self {
531 self.runtime_components.set_endpoint_resolver(endpoint_resolver);
532 self
533 }
534 /// Set the retry_config for the builder
535 ///
536 /// # Examples
537 /// ```no_run
538 /// use aws_sdk_notifications::config::Config;
539 /// use aws_sdk_notifications::config::retry::RetryConfig;
540 ///
541 /// let retry_config = RetryConfig::standard().with_max_attempts(5);
542 /// let config = Config::builder().retry_config(retry_config).build();
543 /// ```
544 pub fn retry_config(mut self, retry_config: ::aws_smithy_types::retry::RetryConfig) -> Self {
545 self.set_retry_config(Some(retry_config));
546 self
547 }
548
549 /// Set the retry_config for the builder
550 ///
551 /// # Examples
552 /// ```no_run
553 /// use aws_sdk_notifications::config::{Builder, Config};
554 /// use aws_sdk_notifications::config::retry::RetryConfig;
555 ///
556 /// fn disable_retries(builder: &mut Builder) {
557 /// let retry_config = RetryConfig::standard().with_max_attempts(1);
558 /// builder.set_retry_config(Some(retry_config));
559 /// }
560 ///
561 /// let mut builder = Config::builder();
562 /// disable_retries(&mut builder);
563 /// let config = builder.build();
564 /// ```
565 pub fn set_retry_config(&mut self, retry_config: ::std::option::Option<::aws_smithy_types::retry::RetryConfig>) -> &mut Self {
566 retry_config.map(|r| self.config.store_put(r));
567 self
568 }
569 /// Set the sleep_impl for the builder
570 ///
571 /// # Examples
572 ///
573 /// ```no_run
574 /// use aws_sdk_notifications::config::{AsyncSleep, Config, SharedAsyncSleep, Sleep};
575 ///
576 /// #[derive(Debug)]
577 /// pub struct ForeverSleep;
578 ///
579 /// impl AsyncSleep for ForeverSleep {
580 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
581 /// Sleep::new(std::future::pending())
582 /// }
583 /// }
584 ///
585 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
586 /// let config = Config::builder().sleep_impl(sleep_impl).build();
587 /// ```
588 pub fn sleep_impl(mut self, sleep_impl: impl crate::config::AsyncSleep + 'static) -> Self {
589 self.set_sleep_impl(Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(sleep_impl)));
590 self
591 }
592
593 /// Set the sleep_impl for the builder
594 ///
595 /// # Examples
596 ///
597 /// ```no_run
598 /// use aws_sdk_notifications::config::{AsyncSleep, Builder, Config, SharedAsyncSleep, Sleep};
599 ///
600 /// #[derive(Debug)]
601 /// pub struct ForeverSleep;
602 ///
603 /// impl AsyncSleep for ForeverSleep {
604 /// fn sleep(&self, duration: std::time::Duration) -> Sleep {
605 /// Sleep::new(std::future::pending())
606 /// }
607 /// }
608 ///
609 /// fn set_never_ending_sleep_impl(builder: &mut Builder) {
610 /// let sleep_impl = SharedAsyncSleep::new(ForeverSleep);
611 /// builder.set_sleep_impl(Some(sleep_impl));
612 /// }
613 ///
614 /// let mut builder = Config::builder();
615 /// set_never_ending_sleep_impl(&mut builder);
616 /// let config = builder.build();
617 /// ```
618 pub fn set_sleep_impl(&mut self, sleep_impl: ::std::option::Option<crate::config::SharedAsyncSleep>) -> &mut Self {
619 self.runtime_components.set_sleep_impl(sleep_impl);
620 self
621 }
622 /// Set the timeout_config for the builder
623 ///
624 /// # Examples
625 ///
626 /// ```no_run
627 /// # use std::time::Duration;
628 /// use aws_sdk_notifications::config::Config;
629 /// use aws_sdk_notifications::config::timeout::TimeoutConfig;
630 ///
631 /// let timeout_config = TimeoutConfig::builder()
632 /// .operation_attempt_timeout(Duration::from_secs(1))
633 /// .build();
634 /// let config = Config::builder().timeout_config(timeout_config).build();
635 /// ```
636 pub fn timeout_config(mut self, timeout_config: ::aws_smithy_types::timeout::TimeoutConfig) -> Self {
637 self.set_timeout_config(Some(timeout_config));
638 self
639 }
640
641 /// Set the timeout_config for the builder.
642 ///
643 /// Setting this to `None` has no effect if another source of configuration has set timeouts. If you
644 /// are attempting to disable timeouts, use [`TimeoutConfig::disabled`](::aws_smithy_types::timeout::TimeoutConfig::disabled)
645 ///
646 ///
647 /// # Examples
648 ///
649 /// ```no_run
650 /// # use std::time::Duration;
651 /// use aws_sdk_notifications::config::{Builder, Config};
652 /// use aws_sdk_notifications::config::timeout::TimeoutConfig;
653 ///
654 /// fn set_request_timeout(builder: &mut Builder) {
655 /// let timeout_config = TimeoutConfig::builder()
656 /// .operation_attempt_timeout(Duration::from_secs(1))
657 /// .build();
658 /// builder.set_timeout_config(Some(timeout_config));
659 /// }
660 ///
661 /// let mut builder = Config::builder();
662 /// set_request_timeout(&mut builder);
663 /// let config = builder.build();
664 /// ```
665 pub fn set_timeout_config(&mut self, timeout_config: ::std::option::Option<::aws_smithy_types::timeout::TimeoutConfig>) -> &mut Self {
666 // passing None has no impact.
667 let Some(mut timeout_config) = timeout_config else { return self };
668
669 if let Some(base) = self.config.load::<::aws_smithy_types::timeout::TimeoutConfig>() {
670 timeout_config.take_defaults_from(base);
671 }
672 self.config.store_put(timeout_config);
673 self
674 }
675 /// Set the partition for retry-related state. When clients share a retry partition, they will
676 /// also share things like token buckets and client rate limiters. By default, all clients
677 /// for the same service will share a partition.
678 pub fn retry_partition(mut self, retry_partition: ::aws_smithy_runtime::client::retries::RetryPartition) -> Self {
679 self.set_retry_partition(Some(retry_partition));
680 self
681 }
682 /// Set the partition for retry-related state. When clients share a retry partition, they will
683 /// also share things like token buckets and client rate limiters. By default, all clients
684 /// for the same service will share a partition.
685 pub fn set_retry_partition(
686 &mut self,
687 retry_partition: ::std::option::Option<::aws_smithy_runtime::client::retries::RetryPartition>,
688 ) -> &mut Self {
689 retry_partition.map(|r| self.config.store_put(r));
690 self
691 }
692 /// Set the identity cache for auth.
693 ///
694 /// The identity cache defaults to a lazy caching implementation that will resolve
695 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
696 /// requests will take the value from the cache while it is still valid. Once it expires,
697 /// the next request will result in refreshing the identity.
698 ///
699 /// This configuration allows you to disable or change the default caching mechanism.
700 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
701 /// trait and pass that implementation into this function.
702 ///
703 /// # Examples
704 ///
705 /// Disabling identity caching:
706 /// ```no_run
707 /// use aws_sdk_notifications::config::IdentityCache;
708 ///
709 /// let config = aws_sdk_notifications::Config::builder()
710 /// .identity_cache(IdentityCache::no_cache())
711 /// // ...
712 /// .build();
713 /// let client = aws_sdk_notifications::Client::from_conf(config);
714 /// ```
715 ///
716 /// Customizing lazy caching:
717 /// ```no_run
718 /// use aws_sdk_notifications::config::IdentityCache;
719 /// use std::time::Duration;
720 ///
721 /// let config = aws_sdk_notifications::Config::builder()
722 /// .identity_cache(
723 /// IdentityCache::lazy()
724 /// // change the load timeout to 10 seconds
725 /// .load_timeout(Duration::from_secs(10))
726 /// .build()
727 /// )
728 /// // ...
729 /// .build();
730 /// let client = aws_sdk_notifications::Client::from_conf(config);
731 /// ```
732 ///
733 pub fn identity_cache(mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> Self {
734 self.set_identity_cache(identity_cache);
735 self
736 }
737
738 /// Set the identity cache for auth.
739 ///
740 /// The identity cache defaults to a lazy caching implementation that will resolve
741 /// an identity when it is requested, and place it in the cache thereafter. Subsequent
742 /// requests will take the value from the cache while it is still valid. Once it expires,
743 /// the next request will result in refreshing the identity.
744 ///
745 /// This configuration allows you to disable or change the default caching mechanism.
746 /// To use a custom caching mechanism, implement the [`ResolveCachedIdentity`](crate::config::ResolveCachedIdentity)
747 /// trait and pass that implementation into this function.
748 ///
749 /// # Examples
750 ///
751 /// Disabling identity caching:
752 /// ```no_run
753 /// use aws_sdk_notifications::config::IdentityCache;
754 ///
755 /// let config = aws_sdk_notifications::Config::builder()
756 /// .identity_cache(IdentityCache::no_cache())
757 /// // ...
758 /// .build();
759 /// let client = aws_sdk_notifications::Client::from_conf(config);
760 /// ```
761 ///
762 /// Customizing lazy caching:
763 /// ```no_run
764 /// use aws_sdk_notifications::config::IdentityCache;
765 /// use std::time::Duration;
766 ///
767 /// let config = aws_sdk_notifications::Config::builder()
768 /// .identity_cache(
769 /// IdentityCache::lazy()
770 /// // change the load timeout to 10 seconds
771 /// .load_timeout(Duration::from_secs(10))
772 /// .build()
773 /// )
774 /// // ...
775 /// .build();
776 /// let client = aws_sdk_notifications::Client::from_conf(config);
777 /// ```
778 ///
779 pub fn set_identity_cache(&mut self, identity_cache: impl crate::config::ResolveCachedIdentity + 'static) -> &mut Self {
780 self.runtime_components.set_identity_cache(::std::option::Option::Some(identity_cache));
781 self
782 }
783 /// Add an [interceptor](crate::config::Intercept) that runs at specific stages of the request execution pipeline.
784 ///
785 /// Interceptors targeted at a certain stage are executed according to the pre-defined priority.
786 /// The SDK provides a default set of interceptors. An interceptor configured by this method
787 /// will run after those default interceptors.
788 ///
789 /// # Examples
790 /// ```no_run
791 /// # fn example() {
792 /// use aws_smithy_runtime_api::box_error::BoxError;
793 /// use aws_smithy_runtime_api::client::interceptors::context::BeforeTransmitInterceptorContextMut;
794 /// use aws_smithy_runtime_api::client::interceptors::Intercept;
795 /// use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
796 /// use aws_smithy_types::config_bag::ConfigBag;
797 /// use aws_sdk_notifications::config::Config;
798 /// use ::http::uri::Uri;
799 ///
800 /// fn base_url() -> String {
801 /// // ...
802 /// # String::new()
803 /// }
804 ///
805 /// #[derive(Debug)]
806 /// pub struct UriModifierInterceptor;
807 /// impl Intercept for UriModifierInterceptor {
808 /// fn name(&self) -> &'static str {
809 /// "UriModifierInterceptor"
810 /// }
811 /// fn modify_before_signing(
812 /// &self,
813 /// context: &mut BeforeTransmitInterceptorContextMut<'_>,
814 /// _runtime_components: &RuntimeComponents,
815 /// _cfg: &mut ConfigBag,
816 /// ) -> Result<(), BoxError> {
817 /// let request = context.request_mut();
818 /// let uri = format!("{}{}", base_url(), request.uri());
819 /// *request.uri_mut() = uri.parse::<Uri>()?.into();
820 ///
821 /// Ok(())
822 /// }
823 /// }
824 ///
825 /// let config = Config::builder()
826 /// .interceptor(UriModifierInterceptor)
827 /// .build();
828 /// # }
829 /// ```
830 pub fn interceptor(mut self, interceptor: impl crate::config::Intercept + 'static) -> Self {
831 self.push_interceptor(crate::config::SharedInterceptor::new(interceptor));
832 self
833 }
834
835 /// Like [`Self::interceptor`], but takes a [`SharedInterceptor`](crate::config::SharedInterceptor).
836 pub fn push_interceptor(&mut self, interceptor: crate::config::SharedInterceptor) -> &mut Self {
837 self.runtime_components.push_interceptor(interceptor);
838 self
839 }
840
841 /// Set [`SharedInterceptor`](crate::config::SharedInterceptor)s for the builder.
842 pub fn set_interceptors(&mut self, interceptors: impl IntoIterator<Item = crate::config::SharedInterceptor>) -> &mut Self {
843 self.runtime_components.set_interceptors(interceptors.into_iter());
844 self
845 }
846 /// Sets the time source used for this service
847 pub fn time_source(mut self, time_source: impl ::aws_smithy_async::time::TimeSource + 'static) -> Self {
848 self.set_time_source(::std::option::Option::Some(::aws_smithy_runtime_api::shared::IntoShared::into_shared(
849 time_source,
850 )));
851 self
852 }
853 /// Sets the time source used for this service
854 pub fn set_time_source(&mut self, time_source: ::std::option::Option<::aws_smithy_async::time::SharedTimeSource>) -> &mut Self {
855 self.runtime_components.set_time_source(time_source);
856 self
857 }
858 /// Add type implementing [`ClassifyRetry`](::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry) that will be used by the
859 /// [`RetryStrategy`](::aws_smithy_runtime_api::client::retries::RetryStrategy) to determine what responses should be retried.
860 ///
861 /// A retry classifier configured by this method will run according to its [priority](::aws_smithy_runtime_api::client::retries::classifiers::RetryClassifierPriority).
862 ///
863 /// # Examples
864 /// ```no_run
865 /// # fn example() {
866 /// use aws_smithy_runtime_api::client::interceptors::context::InterceptorContext;
867 /// use aws_smithy_runtime_api::client::orchestrator::OrchestratorError;
868 /// use aws_smithy_runtime_api::client::retries::classifiers::{
869 /// ClassifyRetry, RetryAction, RetryClassifierPriority,
870 /// };
871 /// use aws_smithy_types::error::metadata::ProvideErrorMetadata;
872 /// use aws_smithy_types::retry::ErrorKind;
873 /// use std::error::Error as StdError;
874 /// use std::marker::PhantomData;
875 /// use std::fmt;
876 /// use aws_sdk_notifications::config::Config;
877 /// # #[derive(Debug)]
878 /// # struct SomeOperationError {}
879 /// # impl StdError for SomeOperationError {}
880 /// # impl fmt::Display for SomeOperationError {
881 /// # fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { todo!() }
882 /// # }
883 /// # impl ProvideErrorMetadata for SomeOperationError {
884 /// # fn meta(&self) -> &aws_sdk_notifications::error::ErrorMetadata { todo!() }
885 /// # }
886 ///
887 /// const RETRYABLE_ERROR_CODES: &[&str] = &[
888 /// // List error codes to be retried here...
889 /// ];
890 ///
891 /// // When classifying at an operation's error type, classifiers require a generic parameter.
892 /// // When classifying the HTTP response alone, no generic is needed.
893 /// #[derive(Debug, Default)]
894 /// pub struct ExampleErrorCodeClassifier<E> {
895 /// _inner: PhantomData<E>,
896 /// }
897 ///
898 /// impl<E> ExampleErrorCodeClassifier<E> {
899 /// pub fn new() -> Self {
900 /// Self {
901 /// _inner: PhantomData,
902 /// }
903 /// }
904 /// }
905 ///
906 /// impl<E> ClassifyRetry for ExampleErrorCodeClassifier<E>
907 /// where
908 /// // Adding a trait bound for ProvideErrorMetadata allows us to inspect the error code.
909 /// E: StdError + ProvideErrorMetadata + Send + Sync + 'static,
910 /// {
911 /// fn classify_retry(&self, ctx: &InterceptorContext) -> RetryAction {
912 /// // Check for a result
913 /// let output_or_error = ctx.output_or_error();
914 /// // Check for an error
915 /// let error = match output_or_error {
916 /// Some(Ok(_)) | None => return RetryAction::NoActionIndicated,
917 /// Some(Err(err)) => err,
918 /// };
919 ///
920 /// // Downcast the generic error and extract the code
921 /// let error_code = OrchestratorError::as_operation_error(error)
922 /// .and_then(|err| err.downcast_ref::<E>())
923 /// .and_then(|err| err.code());
924 ///
925 /// // If this error's code is in our list, return an action that tells the RetryStrategy to retry this request.
926 /// if let Some(error_code) = error_code {
927 /// if RETRYABLE_ERROR_CODES.contains(&error_code) {
928 /// return RetryAction::transient_error();
929 /// }
930 /// }
931 ///
932 /// // Otherwise, return that no action is indicated i.e. that this classifier doesn't require a retry.
933 /// // Another classifier may still classify this response as retryable.
934 /// RetryAction::NoActionIndicated
935 /// }
936 ///
937 /// fn name(&self) -> &'static str { "Example Error Code Classifier" }
938 /// }
939 ///
940 /// let config = Config::builder()
941 /// .retry_classifier(ExampleErrorCodeClassifier::<SomeOperationError>::new())
942 /// .build();
943 /// # }
944 /// ```
945 pub fn retry_classifier(
946 mut self,
947 retry_classifier: impl ::aws_smithy_runtime_api::client::retries::classifiers::ClassifyRetry + 'static,
948 ) -> Self {
949 self.push_retry_classifier(::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier::new(
950 retry_classifier,
951 ));
952 self
953 }
954
955 /// Like [`Self::retry_classifier`], but takes a [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier).
956 pub fn push_retry_classifier(
957 &mut self,
958 retry_classifier: ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier,
959 ) -> &mut Self {
960 self.runtime_components.push_retry_classifier(retry_classifier);
961 self
962 }
963
964 /// Set [`SharedRetryClassifier`](::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier)s for the builder, replacing any that
965 /// were previously set.
966 pub fn set_retry_classifiers(
967 &mut self,
968 retry_classifiers: impl IntoIterator<Item = ::aws_smithy_runtime_api::client::retries::classifiers::SharedRetryClassifier>,
969 ) -> &mut Self {
970 self.runtime_components.set_retry_classifiers(retry_classifiers.into_iter());
971 self
972 }
973 /// Sets the name of the app that is using the client.
974 ///
975 /// This _optional_ name is used to identify the application in the user agent that
976 /// gets sent along with requests.
977 pub fn app_name(mut self, app_name: ::aws_types::app_name::AppName) -> Self {
978 self.set_app_name(Some(app_name));
979 self
980 }
981 /// Sets the name of the app that is using the client.
982 ///
983 /// This _optional_ name is used to identify the application in the user agent that
984 /// gets sent along with requests.
985 pub fn set_app_name(&mut self, app_name: ::std::option::Option<::aws_types::app_name::AppName>) -> &mut Self {
986 self.config.store_or_unset(app_name);
987 self
988 }
989 /// Overrides the default invocation ID generator.
990 ///
991 /// 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.
992 pub fn invocation_id_generator(mut self, gen: impl ::aws_runtime::invocation_id::InvocationIdGenerator + 'static) -> Self {
993 self.set_invocation_id_generator(::std::option::Option::Some(
994 ::aws_runtime::invocation_id::SharedInvocationIdGenerator::new(gen),
995 ));
996 self
997 }
998 /// Overrides the default invocation ID generator.
999 ///
1000 /// 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.
1001 pub fn set_invocation_id_generator(
1002 &mut self,
1003 gen: ::std::option::Option<::aws_runtime::invocation_id::SharedInvocationIdGenerator>,
1004 ) -> &mut Self {
1005 self.config.store_or_unset(gen);
1006 self
1007 }
1008 /// Sets the endpoint URL used to communicate with this service.
1009 ///
1010 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1011 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1012 /// [`Builder::endpoint_resolver`].
1013 pub fn endpoint_url(mut self, endpoint_url: impl Into<::std::string::String>) -> Self {
1014 self.set_endpoint_url(Some(endpoint_url.into()));
1015 self
1016 }
1017 /// Sets the endpoint URL used to communicate with this service.
1018 ///
1019 /// Note: this is used in combination with other endpoint rules, e.g. an API that applies a host-label prefix
1020 /// will be prefixed onto this URL. To fully override the endpoint resolver, use
1021 /// [`Builder::endpoint_resolver`].
1022 pub fn set_endpoint_url(&mut self, endpoint_url: Option<::std::string::String>) -> &mut Self {
1023 self.config.store_or_unset(endpoint_url.map(::aws_types::endpoint_config::EndpointUrl));
1024 self
1025 }
1026 /// 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.
1027 pub fn use_fips(mut self, use_fips: impl Into<bool>) -> Self {
1028 self.set_use_fips(Some(use_fips.into()));
1029 self
1030 }
1031 /// 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.
1032 pub fn set_use_fips(&mut self, use_fips: Option<bool>) -> &mut Self {
1033 self.config.store_or_unset(use_fips.map(::aws_types::endpoint_config::UseFips));
1034 self
1035 }
1036 /// Sets the AWS region to use when making requests.
1037 ///
1038 /// # Examples
1039 /// ```no_run
1040 /// use aws_types::region::Region;
1041 /// use aws_sdk_notifications::config::{Builder, Config};
1042 ///
1043 /// let config = aws_sdk_notifications::Config::builder()
1044 /// .region(Region::new("us-east-1"))
1045 /// .build();
1046 /// ```
1047 pub fn region(mut self, region: impl ::std::convert::Into<::std::option::Option<crate::config::Region>>) -> Self {
1048 self.set_region(region.into());
1049 self
1050 }
1051 /// Sets the AWS region to use when making requests.
1052 pub fn set_region(&mut self, region: ::std::option::Option<crate::config::Region>) -> &mut Self {
1053 self.config.store_or_unset(region);
1054 self
1055 }
1056 /// Sets the credentials provider for this service
1057 pub fn credentials_provider(mut self, credentials_provider: impl crate::config::ProvideCredentials + 'static) -> Self {
1058 self.set_credentials_provider(::std::option::Option::Some(crate::config::SharedCredentialsProvider::new(
1059 credentials_provider,
1060 )));
1061 self
1062 }
1063 /// Sets the credentials provider for this service
1064 pub fn set_credentials_provider(&mut self, credentials_provider: ::std::option::Option<crate::config::SharedCredentialsProvider>) -> &mut Self {
1065 if let Some(credentials_provider) = credentials_provider {
1066 self.runtime_components
1067 .set_identity_resolver(::aws_runtime::auth::sigv4::SCHEME_ID, credentials_provider);
1068 }
1069 self
1070 }
1071 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1072 ///
1073 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1074 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1075 /// all operations might be the ideal behavior but could break existing applications.
1076 ///
1077 /// # Examples
1078 ///
1079 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1080 /// ```no_run
1081 /// use aws_sdk_notifications::config::BehaviorVersion;
1082 ///
1083 /// let config = aws_sdk_notifications::Config::builder()
1084 /// .behavior_version(BehaviorVersion::latest())
1085 /// // ...
1086 /// .build();
1087 /// let client = aws_sdk_notifications::Client::from_conf(config);
1088 /// ```
1089 ///
1090 /// Customizing behavior major version:
1091 /// ```no_run
1092 /// use aws_sdk_notifications::config::BehaviorVersion;
1093 ///
1094 /// let config = aws_sdk_notifications::Config::builder()
1095 /// .behavior_version(BehaviorVersion::v2023_11_09())
1096 /// // ...
1097 /// .build();
1098 /// let client = aws_sdk_notifications::Client::from_conf(config);
1099 /// ```
1100 ///
1101 pub fn behavior_version(mut self, behavior_version: crate::config::BehaviorVersion) -> Self {
1102 self.set_behavior_version(Some(behavior_version));
1103 self
1104 }
1105
1106 /// Sets the [`behavior major version`](crate::config::BehaviorVersion).
1107 ///
1108 /// Over time, new best-practice behaviors are introduced. However, these behaviors might not be backwards
1109 /// compatible. For example, a change which introduces new default timeouts or a new retry-mode for
1110 /// all operations might be the ideal behavior but could break existing applications.
1111 ///
1112 /// # Examples
1113 ///
1114 /// Set the behavior major version to `latest`. This is equivalent to enabling the `behavior-version-latest` cargo feature.
1115 /// ```no_run
1116 /// use aws_sdk_notifications::config::BehaviorVersion;
1117 ///
1118 /// let config = aws_sdk_notifications::Config::builder()
1119 /// .behavior_version(BehaviorVersion::latest())
1120 /// // ...
1121 /// .build();
1122 /// let client = aws_sdk_notifications::Client::from_conf(config);
1123 /// ```
1124 ///
1125 /// Customizing behavior major version:
1126 /// ```no_run
1127 /// use aws_sdk_notifications::config::BehaviorVersion;
1128 ///
1129 /// let config = aws_sdk_notifications::Config::builder()
1130 /// .behavior_version(BehaviorVersion::v2023_11_09())
1131 /// // ...
1132 /// .build();
1133 /// let client = aws_sdk_notifications::Client::from_conf(config);
1134 /// ```
1135 ///
1136 pub fn set_behavior_version(&mut self, behavior_version: Option<crate::config::BehaviorVersion>) -> &mut Self {
1137 self.behavior_version = behavior_version;
1138 self
1139 }
1140
1141 /// Convenience method to set the latest behavior major version
1142 ///
1143 /// This is equivalent to enabling the `behavior-version-latest` Cargo feature
1144 pub fn behavior_version_latest(mut self) -> Self {
1145 self.set_behavior_version(Some(crate::config::BehaviorVersion::latest()));
1146 self
1147 }
1148 /// Adds a runtime plugin to the config.
1149 #[allow(unused)]
1150 pub(crate) fn runtime_plugin(mut self, plugin: impl crate::config::RuntimePlugin + 'static) -> Self {
1151 self.push_runtime_plugin(crate::config::SharedRuntimePlugin::new(plugin));
1152 self
1153 }
1154 /// Adds a runtime plugin to the config.
1155 #[allow(unused)]
1156 pub(crate) fn push_runtime_plugin(&mut self, plugin: crate::config::SharedRuntimePlugin) -> &mut Self {
1157 self.runtime_plugins.push(plugin);
1158 self
1159 }
1160 #[cfg(any(feature = "test-util", test))]
1161 #[allow(unused_mut)]
1162 /// Apply test defaults to the builder
1163 pub fn apply_test_defaults(&mut self) -> &mut Self {
1164 self.set_time_source(::std::option::Option::Some(::aws_smithy_async::time::SharedTimeSource::new(
1165 ::aws_smithy_async::time::StaticTimeSource::new(::std::time::UNIX_EPOCH + ::std::time::Duration::from_secs(1234567890)),
1166 )));
1167 self.config.store_put(::aws_runtime::user_agent::AwsUserAgent::for_tests());
1168 self.set_credentials_provider(Some(crate::config::SharedCredentialsProvider::new(
1169 ::aws_credential_types::Credentials::for_tests(),
1170 )));
1171 self.behavior_version = ::std::option::Option::Some(crate::config::BehaviorVersion::latest());
1172 self
1173 }
1174 #[cfg(any(feature = "test-util", test))]
1175 #[allow(unused_mut)]
1176 /// Apply test defaults to the builder
1177 pub fn with_test_defaults(mut self) -> Self {
1178 self.apply_test_defaults();
1179 self
1180 }
1181 /// Builds a [`Config`].
1182 #[allow(unused_mut)]
1183 pub fn build(mut self) -> Config {
1184 let mut layer = self.config;
1185 if self.runtime_components.time_source().is_none() {
1186 self.runtime_components
1187 .set_time_source(::std::option::Option::Some(::std::default::Default::default()));
1188 }
1189 layer.store_put(crate::meta::API_METADATA.clone());
1190 layer.store_put(::aws_types::SigningName::from_static("notifications"));
1191 layer
1192 .load::<::aws_types::region::Region>()
1193 .cloned()
1194 .map(|r| layer.store_put(::aws_types::region::SigningRegion::from(r)));
1195 Config {
1196 config: crate::config::Layer::from(layer.clone())
1197 .with_name("aws_sdk_notifications::config::Config")
1198 .freeze(),
1199 cloneable: layer,
1200 runtime_components: self.runtime_components,
1201 runtime_plugins: self.runtime_plugins,
1202 behavior_version: self.behavior_version,
1203 }
1204 }
1205}
1206#[derive(::std::fmt::Debug)]
1207pub(crate) struct ServiceRuntimePlugin {
1208 config: ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer>,
1209 runtime_components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1210}
1211
1212impl ServiceRuntimePlugin {
1213 pub fn new(_service_config: crate::config::Config) -> Self {
1214 let config = {
1215 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Notifications");
1216 cfg.store_put(::aws_smithy_runtime::client::orchestrator::AuthSchemeAndEndpointOrchestrationV2);
1217 ::std::option::Option::Some(cfg.freeze())
1218 };
1219 let mut runtime_components = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ServiceRuntimePlugin");
1220 runtime_components.set_auth_scheme_option_resolver(::std::option::Option::Some({
1221 use crate::config::auth::ResolveAuthScheme;
1222 crate::config::auth::DefaultAuthSchemeResolver::default().into_shared_resolver()
1223 }));
1224 runtime_components.set_endpoint_resolver(::std::option::Option::Some({
1225 use crate::config::endpoint::ResolveEndpoint;
1226 crate::config::endpoint::DefaultResolver::new().into_shared_resolver()
1227 }));
1228 runtime_components.push_interceptor(::aws_smithy_runtime::client::http::connection_poisoning::ConnectionPoisoningInterceptor::new());
1229 runtime_components.push_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::HttpStatusCodeClassifier::default());
1230 runtime_components.push_interceptor(crate::sdk_feature_tracker::retry_mode::RetryModeFeatureTrackerInterceptor::new());
1231 runtime_components.push_interceptor(::aws_runtime::service_clock_skew::ServiceClockSkewInterceptor::new());
1232 runtime_components.push_interceptor(::aws_runtime::request_info::RequestInfoInterceptor::new());
1233 runtime_components.push_interceptor(::aws_runtime::user_agent::UserAgentInterceptor::new());
1234 runtime_components.push_interceptor(::aws_runtime::invocation_id::InvocationIdInterceptor::new());
1235 runtime_components.push_interceptor(::aws_runtime::recursion_detection::RecursionDetectionInterceptor::new());
1236 runtime_components.push_auth_scheme(::aws_smithy_runtime_api::client::auth::SharedAuthScheme::new(
1237 ::aws_runtime::auth::sigv4::SigV4AuthScheme::new(),
1238 ));
1239 Self { config, runtime_components }
1240 }
1241}
1242
1243impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ServiceRuntimePlugin {
1244 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1245 self.config.clone()
1246 }
1247
1248 fn order(&self) -> ::aws_smithy_runtime_api::client::runtime_plugin::Order {
1249 ::aws_smithy_runtime_api::client::runtime_plugin::Order::Defaults
1250 }
1251
1252 fn runtime_components(
1253 &self,
1254 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1255 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1256 ::std::borrow::Cow::Borrowed(&self.runtime_components)
1257 }
1258}
1259
1260// Cross-operation shared-state singletons
1261
1262/// A plugin that enables configuration for a single operation invocation
1263///
1264/// The `config` method will return a `FrozenLayer` by storing values from `config_override`.
1265/// In the case of default values requested, they will be obtained from `client_config`.
1266#[derive(Debug)]
1267pub(crate) struct ConfigOverrideRuntimePlugin {
1268 pub(crate) config: ::aws_smithy_types::config_bag::FrozenLayer,
1269 pub(crate) components: ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1270}
1271
1272impl ConfigOverrideRuntimePlugin {
1273 #[allow(dead_code)] // unused when a service does not provide any operations
1274 pub(crate) fn new(
1275 config_override: Builder,
1276 initial_config: ::aws_smithy_types::config_bag::FrozenLayer,
1277 initial_components: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1278 ) -> Self {
1279 let mut layer = config_override.config;
1280 let mut components = config_override.runtime_components;
1281 #[allow(unused_mut)]
1282 let mut resolver =
1283 ::aws_smithy_runtime::client::config_override::Resolver::overrid(initial_config, initial_components, &mut layer, &mut components);
1284
1285 resolver
1286 .config_mut()
1287 .load::<::aws_types::region::Region>()
1288 .cloned()
1289 .map(|r| resolver.config_mut().store_put(::aws_types::region::SigningRegion::from(r)));
1290
1291 let _ = resolver;
1292 Self {
1293 config: ::aws_smithy_types::config_bag::Layer::from(layer)
1294 .with_name("aws_sdk_notifications::config::ConfigOverrideRuntimePlugin")
1295 .freeze(),
1296 components,
1297 }
1298 }
1299}
1300
1301impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ConfigOverrideRuntimePlugin {
1302 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
1303 Some(self.config.clone())
1304 }
1305
1306 fn runtime_components(
1307 &self,
1308 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
1309 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
1310 ::std::borrow::Cow::Borrowed(&self.components)
1311 }
1312}
1313
1314pub use ::aws_smithy_runtime::client::identity::IdentityCache;
1315pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
1316pub use ::aws_smithy_types::config_bag::ConfigBag;
1317
1318pub use ::aws_credential_types::Credentials;
1319
1320impl From<&::aws_types::sdk_config::SdkConfig> for Builder {
1321 fn from(input: &::aws_types::sdk_config::SdkConfig) -> Self {
1322 let mut builder = Builder::default();
1323 builder.set_credentials_provider(input.credentials_provider());
1324 builder = builder.region(input.region().cloned());
1325 builder.set_use_fips(input.use_fips());
1326 if input.get_origin("endpoint_url").is_client_config() {
1327 builder.set_endpoint_url(input.endpoint_url().map(|s| s.to_string()));
1328 } else {
1329 builder.set_endpoint_url(
1330 input
1331 .service_config()
1332 .and_then(|conf| {
1333 conf.load_config(service_config_key("AWS_ENDPOINT_URL", "endpoint_url"))
1334 .map(|it| it.parse().unwrap())
1335 })
1336 .or_else(|| input.endpoint_url().map(|s| s.to_string())),
1337 );
1338 }
1339 // resiliency
1340 builder.set_retry_config(input.retry_config().cloned());
1341 builder.set_timeout_config(input.timeout_config().cloned());
1342 builder.set_sleep_impl(input.sleep_impl());
1343
1344 builder.set_http_client(input.http_client());
1345 builder.set_time_source(input.time_source());
1346 builder.set_behavior_version(input.behavior_version());
1347 builder.set_auth_scheme_preference(input.auth_scheme_preference().cloned());
1348 // setting `None` here removes the default
1349 if let Some(config) = input.stalled_stream_protection() {
1350 builder.set_stalled_stream_protection(Some(config));
1351 }
1352
1353 if let Some(cache) = input.identity_cache() {
1354 builder.set_identity_cache(cache);
1355 }
1356 builder.set_app_name(input.app_name().cloned());
1357
1358 builder
1359 }
1360}
1361
1362impl From<&::aws_types::sdk_config::SdkConfig> for Config {
1363 fn from(sdk_config: &::aws_types::sdk_config::SdkConfig) -> Self {
1364 Builder::from(sdk_config).build()
1365 }
1366}
1367
1368pub use ::aws_types::app_name::AppName;
1369
1370#[allow(dead_code)]
1371fn service_config_key<'a>(env: &'a str, profile: &'a str) -> aws_types::service_config::ServiceConfigKey<'a> {
1372 ::aws_types::service_config::ServiceConfigKey::builder()
1373 .service_id("Notifications")
1374 .env(env)
1375 .profile(profile)
1376 .build()
1377 .expect("all field sets explicitly, can't fail")
1378}
1379
1380pub use ::aws_smithy_async::rt::sleep::Sleep;
1381
1382pub(crate) fn base_client_runtime_plugins(mut config: crate::Config) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
1383 let mut configured_plugins = ::std::vec::Vec::new();
1384 ::std::mem::swap(&mut config.runtime_plugins, &mut configured_plugins);
1385 #[cfg(feature = "behavior-version-latest")]
1386 {
1387 if config.behavior_version.is_none() {
1388 config.behavior_version = Some(::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion::latest());
1389 }
1390 }
1391
1392 let default_retry_partition = "notifications";
1393 let default_retry_partition = match config.region() {
1394 Some(region) => ::std::borrow::Cow::from(format!("{default_retry_partition}-{}", region)),
1395 None => ::std::borrow::Cow::from(default_retry_partition),
1396 };
1397
1398 let scope = "aws-sdk-notifications";
1399
1400 let mut plugins = ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins::new()
1401 // defaults
1402 .with_client_plugins(::aws_smithy_runtime::client::defaults::default_plugins(
1403 ::aws_smithy_runtime::client::defaults::DefaultPluginParams::new()
1404 .with_retry_partition_name(default_retry_partition)
1405 .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."))
1406 ))
1407 // user config
1408 .with_client_plugin(
1409 ::aws_smithy_runtime_api::client::runtime_plugin::StaticRuntimePlugin::new()
1410 .with_config(config.config.clone())
1411 .with_runtime_components(config.runtime_components.clone())
1412 )
1413 // codegen config
1414 .with_client_plugin(crate::config::ServiceRuntimePlugin::new(config.clone()))
1415 .with_client_plugin(::aws_smithy_runtime::client::auth::no_auth::NoAuthRuntimePlugin::new())
1416 .with_client_plugin(
1417 ::aws_smithy_runtime::client::metrics::MetricsRuntimePlugin::builder()
1418 .with_scope(scope)
1419 .with_time_source(config.runtime_components.time_source().unwrap_or_default())
1420 .build()
1421 .expect("All required fields have been set")
1422 );
1423
1424 for plugin in configured_plugins {
1425 plugins = plugins.with_client_plugin(plugin);
1426 }
1427 plugins
1428}
1429
1430pub use ::aws_smithy_types::config_bag::FrozenLayer;
1431
1432pub use ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder;
1433
1434pub use ::aws_smithy_runtime_api::client::runtime_plugin::SharedRuntimePlugin;
1435
1436pub use ::aws_smithy_runtime_api::client::behavior_version::BehaviorVersion;
1437
1438pub use ::aws_smithy_runtime_api::client::stalled_stream_protection::StalledStreamProtectionConfig;
1439
1440pub use ::aws_smithy_runtime_api::client::http::SharedHttpClient;
1441
1442pub use ::aws_smithy_async::rt::sleep::SharedAsyncSleep;
1443
1444pub use ::aws_smithy_runtime_api::client::identity::SharedIdentityCache;
1445
1446pub use ::aws_smithy_runtime_api::client::interceptors::SharedInterceptor;
1447
1448pub use ::aws_types::region::Region;
1449
1450pub use ::aws_credential_types::provider::SharedCredentialsProvider;
1451
1452pub use ::aws_smithy_runtime_api::client::http::HttpClient;
1453
1454pub use ::aws_smithy_runtime_api::shared::IntoShared;
1455
1456pub use ::aws_smithy_async::rt::sleep::AsyncSleep;
1457
1458pub use ::aws_smithy_runtime_api::client::identity::ResolveCachedIdentity;
1459
1460pub use ::aws_smithy_runtime_api::client::interceptors::Intercept;
1461
1462pub use ::aws_credential_types::provider::ProvideCredentials;
1463
1464pub use ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin;
1465
1466pub use ::aws_smithy_types::config_bag::Layer;
1467
1468/// Types needed to configure endpoint resolution.
1469pub mod endpoint;
1470
1471/// HTTP request and response types.
1472pub mod http;
1473
1474/// Types needed to implement [`Intercept`](crate::config::Intercept).
1475pub mod interceptors;
1476
1477/// Retry configuration.
1478pub mod retry;
1479
1480/// Timeout configuration.
1481pub mod timeout;
1482
1483/// Types needed to configure auth scheme resolution.
1484pub mod auth;