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

aws_sdk_workdocs/config/
endpoint.rs
