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

aws_sdk_iotdeviceadvisor/config/
endpoint.rs
