aws_sdk_workdocs/config/
endpoint.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use ::aws_smithy_runtime_api::client::endpoint::EndpointFuture;
3pub use ::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver;
4pub use ::aws_smithy_types::endpoint::Endpoint;
5
6/// Interceptor that tracks endpoint override business metric.
7#[derive(Debug, Default)]
8pub(crate) struct EndpointOverrideFeatureTrackerInterceptor;
9
10#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
11impl ::aws_smithy_runtime_api::client::interceptors::Intercept for EndpointOverrideFeatureTrackerInterceptor {
12    fn name(&self) -> &'static str {
13        "EndpointOverrideFeatureTrackerInterceptor"
14    }
15
16    fn read_before_execution(
17        &self,
18        _context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<'_>,
19        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
20    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
21        if cfg.load::<::aws_types::endpoint_config::EndpointUrl>().is_some() {
22            cfg.interceptor_state()
23                .store_append(::aws_runtime::sdk_feature::AwsSdkFeature::EndpointOverride);
24        }
25        ::std::result::Result::Ok(())
26    }
27}
28
29#[cfg(test)]
30mod test {
31
32    /// For region ap-northeast-1 with FIPS disabled and DualStack disabled
33    #[test]
34    fn test_1() {
35        let params = crate::config::endpoint::Params::builder()
36            .region("ap-northeast-1".to_string())
37            .use_fips(false)
38            .use_dual_stack(false)
39            .build()
40            .expect("invalid params");
41        let resolver = crate::config::endpoint::DefaultResolver::new();
42        let endpoint = resolver.resolve_endpoint(&params);
43        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.ap-northeast-1.amazonaws.com");
44        assert_eq!(
45            endpoint,
46            ::aws_smithy_types::endpoint::Endpoint::builder()
47                .url("https://workdocs.ap-northeast-1.amazonaws.com")
48                .build()
49        );
50    }
51
52    /// For region ap-southeast-1 with FIPS disabled and DualStack disabled
53    #[test]
54    fn test_2() {
55        let params = crate::config::endpoint::Params::builder()
56            .region("ap-southeast-1".to_string())
57            .use_fips(false)
58            .use_dual_stack(false)
59            .build()
60            .expect("invalid params");
61        let resolver = crate::config::endpoint::DefaultResolver::new();
62        let endpoint = resolver.resolve_endpoint(&params);
63        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.ap-southeast-1.amazonaws.com");
64        assert_eq!(
65            endpoint,
66            ::aws_smithy_types::endpoint::Endpoint::builder()
67                .url("https://workdocs.ap-southeast-1.amazonaws.com")
68                .build()
69        );
70    }
71
72    /// For region ap-southeast-2 with FIPS disabled and DualStack disabled
73    #[test]
74    fn test_3() {
75        let params = crate::config::endpoint::Params::builder()
76            .region("ap-southeast-2".to_string())
77            .use_fips(false)
78            .use_dual_stack(false)
79            .build()
80            .expect("invalid params");
81        let resolver = crate::config::endpoint::DefaultResolver::new();
82        let endpoint = resolver.resolve_endpoint(&params);
83        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.ap-southeast-2.amazonaws.com");
84        assert_eq!(
85            endpoint,
86            ::aws_smithy_types::endpoint::Endpoint::builder()
87                .url("https://workdocs.ap-southeast-2.amazonaws.com")
88                .build()
89        );
90    }
91
92    /// For region eu-west-1 with FIPS disabled and DualStack disabled
93    #[test]
94    fn test_4() {
95        let params = crate::config::endpoint::Params::builder()
96            .region("eu-west-1".to_string())
97            .use_fips(false)
98            .use_dual_stack(false)
99            .build()
100            .expect("invalid params");
101        let resolver = crate::config::endpoint::DefaultResolver::new();
102        let endpoint = resolver.resolve_endpoint(&params);
103        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.eu-west-1.amazonaws.com");
104        assert_eq!(
105            endpoint,
106            ::aws_smithy_types::endpoint::Endpoint::builder()
107                .url("https://workdocs.eu-west-1.amazonaws.com")
108                .build()
109        );
110    }
111
112    /// For region us-east-1 with FIPS disabled and DualStack disabled
113    #[test]
114    fn test_5() {
115        let params = crate::config::endpoint::Params::builder()
116            .region("us-east-1".to_string())
117            .use_fips(false)
118            .use_dual_stack(false)
119            .build()
120            .expect("invalid params");
121        let resolver = crate::config::endpoint::DefaultResolver::new();
122        let endpoint = resolver.resolve_endpoint(&params);
123        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-east-1.amazonaws.com");
124        assert_eq!(
125            endpoint,
126            ::aws_smithy_types::endpoint::Endpoint::builder()
127                .url("https://workdocs.us-east-1.amazonaws.com")
128                .build()
129        );
130    }
131
132    /// For region us-east-1 with FIPS enabled and DualStack disabled
133    #[test]
134    fn test_6() {
135        let params = crate::config::endpoint::Params::builder()
136            .region("us-east-1".to_string())
137            .use_fips(true)
138            .use_dual_stack(false)
139            .build()
140            .expect("invalid params");
141        let resolver = crate::config::endpoint::DefaultResolver::new();
142        let endpoint = resolver.resolve_endpoint(&params);
143        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-east-1.amazonaws.com");
144        assert_eq!(
145            endpoint,
146            ::aws_smithy_types::endpoint::Endpoint::builder()
147                .url("https://workdocs-fips.us-east-1.amazonaws.com")
148                .build()
149        );
150    }
151
152    /// For region us-west-2 with FIPS disabled and DualStack disabled
153    #[test]
154    fn test_7() {
155        let params = crate::config::endpoint::Params::builder()
156            .region("us-west-2".to_string())
157            .use_fips(false)
158            .use_dual_stack(false)
159            .build()
160            .expect("invalid params");
161        let resolver = crate::config::endpoint::DefaultResolver::new();
162        let endpoint = resolver.resolve_endpoint(&params);
163        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-west-2.amazonaws.com");
164        assert_eq!(
165            endpoint,
166            ::aws_smithy_types::endpoint::Endpoint::builder()
167                .url("https://workdocs.us-west-2.amazonaws.com")
168                .build()
169        );
170    }
171
172    /// For region us-west-2 with FIPS enabled and DualStack disabled
173    #[test]
174    fn test_8() {
175        let params = crate::config::endpoint::Params::builder()
176            .region("us-west-2".to_string())
177            .use_fips(true)
178            .use_dual_stack(false)
179            .build()
180            .expect("invalid params");
181        let resolver = crate::config::endpoint::DefaultResolver::new();
182        let endpoint = resolver.resolve_endpoint(&params);
183        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-west-2.amazonaws.com");
184        assert_eq!(
185            endpoint,
186            ::aws_smithy_types::endpoint::Endpoint::builder()
187                .url("https://workdocs-fips.us-west-2.amazonaws.com")
188                .build()
189        );
190    }
191
192    /// For region us-east-1 with FIPS enabled and DualStack enabled
193    #[test]
194    fn test_9() {
195        let params = crate::config::endpoint::Params::builder()
196            .region("us-east-1".to_string())
197            .use_fips(true)
198            .use_dual_stack(true)
199            .build()
200            .expect("invalid params");
201        let resolver = crate::config::endpoint::DefaultResolver::new();
202        let endpoint = resolver.resolve_endpoint(&params);
203        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-east-1.api.aws");
204        assert_eq!(
205            endpoint,
206            ::aws_smithy_types::endpoint::Endpoint::builder()
207                .url("https://workdocs-fips.us-east-1.api.aws")
208                .build()
209        );
210    }
211
212    /// For region us-east-1 with FIPS disabled and DualStack enabled
213    #[test]
214    fn test_10() {
215        let params = crate::config::endpoint::Params::builder()
216            .region("us-east-1".to_string())
217            .use_fips(false)
218            .use_dual_stack(true)
219            .build()
220            .expect("invalid params");
221        let resolver = crate::config::endpoint::DefaultResolver::new();
222        let endpoint = resolver.resolve_endpoint(&params);
223        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-east-1.api.aws");
224        assert_eq!(
225            endpoint,
226            ::aws_smithy_types::endpoint::Endpoint::builder()
227                .url("https://workdocs.us-east-1.api.aws")
228                .build()
229        );
230    }
231
232    /// For region cn-north-1 with FIPS enabled and DualStack enabled
233    #[test]
234    fn test_11() {
235        let params = crate::config::endpoint::Params::builder()
236            .region("cn-north-1".to_string())
237            .use_fips(true)
238            .use_dual_stack(true)
239            .build()
240            .expect("invalid params");
241        let resolver = crate::config::endpoint::DefaultResolver::new();
242        let endpoint = resolver.resolve_endpoint(&params);
243        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.cn-north-1.api.amazonwebservices.com.cn");
244        assert_eq!(
245            endpoint,
246            ::aws_smithy_types::endpoint::Endpoint::builder()
247                .url("https://workdocs-fips.cn-north-1.api.amazonwebservices.com.cn")
248                .build()
249        );
250    }
251
252    /// For region cn-north-1 with FIPS enabled and DualStack disabled
253    #[test]
254    fn test_12() {
255        let params = crate::config::endpoint::Params::builder()
256            .region("cn-north-1".to_string())
257            .use_fips(true)
258            .use_dual_stack(false)
259            .build()
260            .expect("invalid params");
261        let resolver = crate::config::endpoint::DefaultResolver::new();
262        let endpoint = resolver.resolve_endpoint(&params);
263        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.cn-north-1.amazonaws.com.cn");
264        assert_eq!(
265            endpoint,
266            ::aws_smithy_types::endpoint::Endpoint::builder()
267                .url("https://workdocs-fips.cn-north-1.amazonaws.com.cn")
268                .build()
269        );
270    }
271
272    /// For region cn-north-1 with FIPS disabled and DualStack enabled
273    #[test]
274    fn test_13() {
275        let params = crate::config::endpoint::Params::builder()
276            .region("cn-north-1".to_string())
277            .use_fips(false)
278            .use_dual_stack(true)
279            .build()
280            .expect("invalid params");
281        let resolver = crate::config::endpoint::DefaultResolver::new();
282        let endpoint = resolver.resolve_endpoint(&params);
283        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.cn-north-1.api.amazonwebservices.com.cn");
284        assert_eq!(
285            endpoint,
286            ::aws_smithy_types::endpoint::Endpoint::builder()
287                .url("https://workdocs.cn-north-1.api.amazonwebservices.com.cn")
288                .build()
289        );
290    }
291
292    /// For region cn-north-1 with FIPS disabled and DualStack disabled
293    #[test]
294    fn test_14() {
295        let params = crate::config::endpoint::Params::builder()
296            .region("cn-north-1".to_string())
297            .use_fips(false)
298            .use_dual_stack(false)
299            .build()
300            .expect("invalid params");
301        let resolver = crate::config::endpoint::DefaultResolver::new();
302        let endpoint = resolver.resolve_endpoint(&params);
303        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.cn-north-1.amazonaws.com.cn");
304        assert_eq!(
305            endpoint,
306            ::aws_smithy_types::endpoint::Endpoint::builder()
307                .url("https://workdocs.cn-north-1.amazonaws.com.cn")
308                .build()
309        );
310    }
311
312    /// For region us-gov-east-1 with FIPS enabled and DualStack enabled
313    #[test]
314    fn test_15() {
315        let params = crate::config::endpoint::Params::builder()
316            .region("us-gov-east-1".to_string())
317            .use_fips(true)
318            .use_dual_stack(true)
319            .build()
320            .expect("invalid params");
321        let resolver = crate::config::endpoint::DefaultResolver::new();
322        let endpoint = resolver.resolve_endpoint(&params);
323        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-gov-east-1.api.aws");
324        assert_eq!(
325            endpoint,
326            ::aws_smithy_types::endpoint::Endpoint::builder()
327                .url("https://workdocs-fips.us-gov-east-1.api.aws")
328                .build()
329        );
330    }
331
332    /// For region us-gov-east-1 with FIPS enabled and DualStack disabled
333    #[test]
334    fn test_16() {
335        let params = crate::config::endpoint::Params::builder()
336            .region("us-gov-east-1".to_string())
337            .use_fips(true)
338            .use_dual_stack(false)
339            .build()
340            .expect("invalid params");
341        let resolver = crate::config::endpoint::DefaultResolver::new();
342        let endpoint = resolver.resolve_endpoint(&params);
343        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-gov-east-1.amazonaws.com");
344        assert_eq!(
345            endpoint,
346            ::aws_smithy_types::endpoint::Endpoint::builder()
347                .url("https://workdocs-fips.us-gov-east-1.amazonaws.com")
348                .build()
349        );
350    }
351
352    /// For region us-gov-east-1 with FIPS disabled and DualStack enabled
353    #[test]
354    fn test_17() {
355        let params = crate::config::endpoint::Params::builder()
356            .region("us-gov-east-1".to_string())
357            .use_fips(false)
358            .use_dual_stack(true)
359            .build()
360            .expect("invalid params");
361        let resolver = crate::config::endpoint::DefaultResolver::new();
362        let endpoint = resolver.resolve_endpoint(&params);
363        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-gov-east-1.api.aws");
364        assert_eq!(
365            endpoint,
366            ::aws_smithy_types::endpoint::Endpoint::builder()
367                .url("https://workdocs.us-gov-east-1.api.aws")
368                .build()
369        );
370    }
371
372    /// For region us-gov-east-1 with FIPS disabled and DualStack disabled
373    #[test]
374    fn test_18() {
375        let params = crate::config::endpoint::Params::builder()
376            .region("us-gov-east-1".to_string())
377            .use_fips(false)
378            .use_dual_stack(false)
379            .build()
380            .expect("invalid params");
381        let resolver = crate::config::endpoint::DefaultResolver::new();
382        let endpoint = resolver.resolve_endpoint(&params);
383        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-gov-east-1.amazonaws.com");
384        assert_eq!(
385            endpoint,
386            ::aws_smithy_types::endpoint::Endpoint::builder()
387                .url("https://workdocs.us-gov-east-1.amazonaws.com")
388                .build()
389        );
390    }
391
392    /// For region us-iso-east-1 with FIPS enabled and DualStack disabled
393    #[test]
394    fn test_19() {
395        let params = crate::config::endpoint::Params::builder()
396            .region("us-iso-east-1".to_string())
397            .use_fips(true)
398            .use_dual_stack(false)
399            .build()
400            .expect("invalid params");
401        let resolver = crate::config::endpoint::DefaultResolver::new();
402        let endpoint = resolver.resolve_endpoint(&params);
403        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-iso-east-1.c2s.ic.gov");
404        assert_eq!(
405            endpoint,
406            ::aws_smithy_types::endpoint::Endpoint::builder()
407                .url("https://workdocs-fips.us-iso-east-1.c2s.ic.gov")
408                .build()
409        );
410    }
411
412    /// For region us-iso-east-1 with FIPS disabled and DualStack disabled
413    #[test]
414    fn test_20() {
415        let params = crate::config::endpoint::Params::builder()
416            .region("us-iso-east-1".to_string())
417            .use_fips(false)
418            .use_dual_stack(false)
419            .build()
420            .expect("invalid params");
421        let resolver = crate::config::endpoint::DefaultResolver::new();
422        let endpoint = resolver.resolve_endpoint(&params);
423        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-iso-east-1.c2s.ic.gov");
424        assert_eq!(
425            endpoint,
426            ::aws_smithy_types::endpoint::Endpoint::builder()
427                .url("https://workdocs.us-iso-east-1.c2s.ic.gov")
428                .build()
429        );
430    }
431
432    /// For region us-isob-east-1 with FIPS enabled and DualStack disabled
433    #[test]
434    fn test_21() {
435        let params = crate::config::endpoint::Params::builder()
436            .region("us-isob-east-1".to_string())
437            .use_fips(true)
438            .use_dual_stack(false)
439            .build()
440            .expect("invalid params");
441        let resolver = crate::config::endpoint::DefaultResolver::new();
442        let endpoint = resolver.resolve_endpoint(&params);
443        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs-fips.us-isob-east-1.sc2s.sgov.gov");
444        assert_eq!(
445            endpoint,
446            ::aws_smithy_types::endpoint::Endpoint::builder()
447                .url("https://workdocs-fips.us-isob-east-1.sc2s.sgov.gov")
448                .build()
449        );
450    }
451
452    /// For region us-isob-east-1 with FIPS disabled and DualStack disabled
453    #[test]
454    fn test_22() {
455        let params = crate::config::endpoint::Params::builder()
456            .region("us-isob-east-1".to_string())
457            .use_fips(false)
458            .use_dual_stack(false)
459            .build()
460            .expect("invalid params");
461        let resolver = crate::config::endpoint::DefaultResolver::new();
462        let endpoint = resolver.resolve_endpoint(&params);
463        let endpoint = endpoint.expect("Expected valid endpoint: https://workdocs.us-isob-east-1.sc2s.sgov.gov");
464        assert_eq!(
465            endpoint,
466            ::aws_smithy_types::endpoint::Endpoint::builder()
467                .url("https://workdocs.us-isob-east-1.sc2s.sgov.gov")
468                .build()
469        );
470    }
471
472    /// For custom endpoint with region set and fips disabled and dualstack disabled
473    #[test]
474    fn test_23() {
475        let params = crate::config::endpoint::Params::builder()
476            .region("us-east-1".to_string())
477            .use_fips(false)
478            .use_dual_stack(false)
479            .endpoint("https://example.com".to_string())
480            .build()
481            .expect("invalid params");
482        let resolver = crate::config::endpoint::DefaultResolver::new();
483        let endpoint = resolver.resolve_endpoint(&params);
484        let endpoint = endpoint.expect("Expected valid endpoint: https://example.com");
485        assert_eq!(
486            endpoint,
487            ::aws_smithy_types::endpoint::Endpoint::builder().url("https://example.com").build()
488        );
489    }
490
491    /// For custom endpoint with region not set and fips disabled and dualstack disabled
492    #[test]
493    fn test_24() {
494        let params = crate::config::endpoint::Params::builder()
495            .use_fips(false)
496            .use_dual_stack(false)
497            .endpoint("https://example.com".to_string())
498            .build()
499            .expect("invalid params");
500        let resolver = crate::config::endpoint::DefaultResolver::new();
501        let endpoint = resolver.resolve_endpoint(&params);
502        let endpoint = endpoint.expect("Expected valid endpoint: https://example.com");
503        assert_eq!(
504            endpoint,
505            ::aws_smithy_types::endpoint::Endpoint::builder().url("https://example.com").build()
506        );
507    }
508
509    /// For custom endpoint with fips enabled and dualstack disabled
510    #[test]
511    fn test_25() {
512        let params = crate::config::endpoint::Params::builder()
513            .region("us-east-1".to_string())
514            .use_fips(true)
515            .use_dual_stack(false)
516            .endpoint("https://example.com".to_string())
517            .build()
518            .expect("invalid params");
519        let resolver = crate::config::endpoint::DefaultResolver::new();
520        let endpoint = resolver.resolve_endpoint(&params);
521        let error = endpoint.expect_err("expected error: Invalid Configuration: FIPS and custom endpoint are not supported [For custom endpoint with fips enabled and dualstack disabled]");
522        assert_eq!(format!("{}", error), "Invalid Configuration: FIPS and custom endpoint are not supported")
523    }
524
525    /// For custom endpoint with fips disabled and dualstack enabled
526    #[test]
527    fn test_26() {
528        let params = crate::config::endpoint::Params::builder()
529            .region("us-east-1".to_string())
530            .use_fips(false)
531            .use_dual_stack(true)
532            .endpoint("https://example.com".to_string())
533            .build()
534            .expect("invalid params");
535        let resolver = crate::config::endpoint::DefaultResolver::new();
536        let endpoint = resolver.resolve_endpoint(&params);
537        let error = endpoint.expect_err("expected error: Invalid Configuration: Dualstack and custom endpoint are not supported [For custom endpoint with fips disabled and dualstack enabled]");
538        assert_eq!(
539            format!("{}", error),
540            "Invalid Configuration: Dualstack and custom endpoint are not supported"
541        )
542    }
543
544    /// Missing region
545    #[test]
546    fn test_27() {
547        let params = crate::config::endpoint::Params::builder().build().expect("invalid params");
548        let resolver = crate::config::endpoint::DefaultResolver::new();
549        let endpoint = resolver.resolve_endpoint(&params);
550        let error = endpoint.expect_err("expected error: Invalid Configuration: Missing Region [Missing region]");
551        assert_eq!(format!("{}", error), "Invalid Configuration: Missing Region")
552    }
553}
554
555/// Endpoint resolver trait specific to Amazon WorkDocs
556pub trait ResolveEndpoint: ::std::marker::Send + ::std::marker::Sync + ::std::fmt::Debug {
557    /// Resolve an endpoint with the given parameters
558    fn resolve_endpoint<'a>(&'a self, params: &'a crate::config::endpoint::Params) -> ::aws_smithy_runtime_api::client::endpoint::EndpointFuture<'a>;
559
560    /// Convert this service-specific resolver into a `SharedEndpointResolver`
561    ///
562    /// The resulting resolver will downcast `EndpointResolverParams` into `crate::config::endpoint::Params`.
563    fn into_shared_resolver(self) -> ::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver
564    where
565        Self: Sized + 'static,
566    {
567        ::aws_smithy_runtime_api::client::endpoint::SharedEndpointResolver::new(DowncastParams(self))
568    }
569}
570
571#[derive(Debug)]
572struct DowncastParams<T>(T);
573impl<T> ::aws_smithy_runtime_api::client::endpoint::ResolveEndpoint for DowncastParams<T>
574where
575    T: ResolveEndpoint,
576{
577    fn resolve_endpoint<'a>(
578        &'a self,
579        params: &'a ::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams,
580    ) -> ::aws_smithy_runtime_api::client::endpoint::EndpointFuture<'a> {
581        let ep = match params.get::<crate::config::endpoint::Params>() {
582            Some(params) => self.0.resolve_endpoint(params),
583            None => ::aws_smithy_runtime_api::client::endpoint::EndpointFuture::ready(Err("params of expected type was not present".into())),
584        };
585        ep
586    }
587}
588
589/// The default endpoint resolver
590#[derive(Debug, Default)]
591pub struct DefaultResolver {
592    partition_resolver: crate::endpoint_lib::partition::PartitionResolver,
593}
594
595impl DefaultResolver {
596    /// Create a new endpoint resolver with default settings
597    pub fn new() -> Self {
598        Self {
599            partition_resolver: crate::endpoint_lib::DEFAULT_PARTITION_RESOLVER.clone(),
600        }
601    }
602
603    fn resolve_endpoint(
604        &self,
605        params: &crate::config::endpoint::Params,
606    ) -> ::std::result::Result<::aws_smithy_types::endpoint::Endpoint, ::aws_smithy_runtime_api::box_error::BoxError> {
607        let mut diagnostic_collector = crate::endpoint_lib::diagnostic::DiagnosticCollector::new();
608        Ok(
609            crate::config::endpoint::internals::resolve_endpoint(params, &mut diagnostic_collector, &self.partition_resolver)
610                .map_err(|err| err.with_source(diagnostic_collector.take_last_error()))?,
611        )
612    }
613}
614
615impl crate::config::endpoint::ResolveEndpoint for DefaultResolver {
616    fn resolve_endpoint(&self, params: &crate::config::endpoint::Params) -> ::aws_smithy_runtime_api::client::endpoint::EndpointFuture<'_> {
617        ::aws_smithy_runtime_api::client::endpoint::EndpointFuture::ready(self.resolve_endpoint(params))
618    }
619}
620
621#[non_exhaustive]
622#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
623/// Configuration parameters for resolving the correct endpoint
624pub struct Params {
625    /// The AWS region used to dispatch the request.
626    pub(crate) region: ::std::option::Option<::std::string::String>,
627    /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
628    pub(crate) use_dual_stack: bool,
629    /// 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.
630    pub(crate) use_fips: bool,
631    /// Override the endpoint used to send this request
632    pub(crate) endpoint: ::std::option::Option<::std::string::String>,
633}
634impl Params {
635    /// Create a builder for [`Params`]
636    pub fn builder() -> crate::config::endpoint::ParamsBuilder {
637        crate::config::endpoint::ParamsBuilder::default()
638    }
639    /// The AWS region used to dispatch the request.
640    pub fn region(&self) -> ::std::option::Option<&str> {
641        self.region.as_deref()
642    }
643    /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
644    pub fn use_dual_stack(&self) -> ::std::option::Option<bool> {
645        Some(self.use_dual_stack)
646    }
647    /// 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.
648    pub fn use_fips(&self) -> ::std::option::Option<bool> {
649        Some(self.use_fips)
650    }
651    /// Override the endpoint used to send this request
652    pub fn endpoint(&self) -> ::std::option::Option<&str> {
653        self.endpoint.as_deref()
654    }
655}
656
657/// Builder for [`Params`]
658#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
659pub struct ParamsBuilder {
660    region: ::std::option::Option<::std::string::String>,
661    use_dual_stack: ::std::option::Option<bool>,
662    use_fips: ::std::option::Option<bool>,
663    endpoint: ::std::option::Option<::std::string::String>,
664}
665impl ParamsBuilder {
666    /// Consume this builder, creating [`Params`].
667    pub fn build(self) -> ::std::result::Result<crate::config::endpoint::Params, crate::config::endpoint::InvalidParams> {
668        if let Some(region) = &self.region {
669            if !crate::endpoint_lib::host::is_valid_host_label(
670                region.as_ref() as &str,
671                true,
672                &mut crate::endpoint_lib::diagnostic::DiagnosticCollector::new(),
673            ) {
674                return Err(crate::config::endpoint::InvalidParams::invalid_value(
675                    "region",
676                    "must be a valid host label",
677                ));
678            }
679        };
680        Ok(
681            #[allow(clippy::unnecessary_lazy_evaluations)]
682            crate::config::endpoint::Params {
683                region: self.region,
684                use_dual_stack: self
685                    .use_dual_stack
686                    .or_else(|| Some(false))
687                    .ok_or_else(|| crate::config::endpoint::InvalidParams::missing("use_dual_stack"))?,
688                use_fips: self
689                    .use_fips
690                    .or_else(|| Some(false))
691                    .ok_or_else(|| crate::config::endpoint::InvalidParams::missing("use_fips"))?,
692                endpoint: self.endpoint,
693            },
694        )
695    }
696    /// Sets the value for region
697    ///
698    /// The AWS region used to dispatch the request.
699    pub fn region(mut self, value: impl Into<::std::string::String>) -> Self {
700        self.region = Some(value.into());
701        self
702    }
703
704    /// Sets the value for region
705    ///
706    /// The AWS region used to dispatch the request.
707    pub fn set_region(mut self, param: Option<::std::string::String>) -> Self {
708        self.region = param;
709        self
710    }
711    /// Sets the value for use_dual_stack
712    ///
713    /// When unset, this parameter has a default value of `false`.
714    /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
715    pub fn use_dual_stack(mut self, value: impl Into<bool>) -> Self {
716        self.use_dual_stack = Some(value.into());
717        self
718    }
719
720    /// Sets the value for use_dual_stack
721    ///
722    /// When unset, this parameter has a default value of `false`.
723    /// When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
724    pub fn set_use_dual_stack(mut self, param: Option<bool>) -> Self {
725        self.use_dual_stack = param;
726        self
727    }
728    /// Sets the value for use_fips
729    ///
730    /// When unset, this parameter has a default value of `false`.
731    /// 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.
732    pub fn use_fips(mut self, value: impl Into<bool>) -> Self {
733        self.use_fips = Some(value.into());
734        self
735    }
736
737    /// Sets the value for use_fips
738    ///
739    /// When unset, this parameter has a default value of `false`.
740    /// 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.
741    pub fn set_use_fips(mut self, param: Option<bool>) -> Self {
742        self.use_fips = param;
743        self
744    }
745    /// Sets the value for endpoint
746    ///
747    /// Override the endpoint used to send this request
748    pub fn endpoint(mut self, value: impl Into<::std::string::String>) -> Self {
749        self.endpoint = Some(value.into());
750        self
751    }
752
753    /// Sets the value for endpoint
754    ///
755    /// Override the endpoint used to send this request
756    pub fn set_endpoint(mut self, param: Option<::std::string::String>) -> Self {
757        self.endpoint = param;
758        self
759    }
760}
761
762/// An error that occurred during endpoint resolution
763#[derive(Debug)]
764pub struct InvalidParams {
765    field: std::borrow::Cow<'static, str>,
766    kind: InvalidParamsErrorKind,
767}
768
769/// The kind of invalid parameter error
770#[derive(Debug)]
771enum InvalidParamsErrorKind {
772    MissingField,
773    InvalidValue { message: &'static str },
774}
775
776impl InvalidParams {
777    #[allow(dead_code)]
778    fn missing(field: &'static str) -> Self {
779        Self {
780            field: field.into(),
781            kind: InvalidParamsErrorKind::MissingField,
782        }
783    }
784
785    #[allow(dead_code)]
786    fn invalid_value(field: &'static str, message: &'static str) -> Self {
787        Self {
788            field: field.into(),
789            kind: InvalidParamsErrorKind::InvalidValue { message },
790        }
791    }
792}
793
794impl std::fmt::Display for InvalidParams {
795    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
796        match self.kind {
797            InvalidParamsErrorKind::MissingField => write!(f, "a required field was missing: `{}`", self.field),
798            InvalidParamsErrorKind::InvalidValue { message } => write!(f, "invalid value for field: `{}` - {}", self.field, message),
799        }
800    }
801}
802
803impl std::error::Error for InvalidParams {}
804
805mod internals;
aws_sdk_workdocs/config/endpoint.rs

aws_sdk_workdocs/config/
endpoint.rs
