aws_sdk_lexruntime/config/
auth.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Auth scheme resolver trait specific to Amazon Lex Runtime Service
3pub trait ResolveAuthScheme: ::std::marker::Send + ::std::marker::Sync + ::std::fmt::Debug {
4    /// Resolve a priority list of auth scheme options with the given parameters
5    fn resolve_auth_scheme<'a>(
6        &'a self,
7        params: &'a crate::config::auth::Params,
8        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
9        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
10    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a>;
11
12    /// Convert this service-specific resolver into a `SharedAuthSchemeOptionResolver`
13    fn into_shared_resolver(self) -> ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver
14    where
15        Self: ::std::marker::Sized + 'static,
16    {
17        ::aws_smithy_runtime_api::client::auth::SharedAuthSchemeOptionResolver::new(DowncastParams(self))
18    }
19}
20
21#[derive(Debug)]
22struct DowncastParams<T>(T);
23impl<T> ::aws_smithy_runtime_api::client::auth::ResolveAuthSchemeOptions for DowncastParams<T>
24where
25    T: ResolveAuthScheme,
26{
27    fn resolve_auth_scheme_options_v2<'a>(
28        &'a self,
29        params: &'a ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams,
30        cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
31        runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
32    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
33        match params.get::<crate::config::auth::Params>() {
34            ::std::option::Option::Some(concrete_params) => self.0.resolve_auth_scheme(concrete_params, cfg, runtime_components),
35            ::std::option::Option::None => ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(::std::result::Result::Err(
36                "params of expected type was not present".into(),
37            )),
38        }
39    }
40}
41
42/// The default auth scheme resolver
43#[derive(Debug)]
44#[allow(dead_code)]
45pub struct DefaultAuthSchemeResolver {
46    service_defaults: Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>,
47    operation_overrides: ::std::collections::HashMap<&'static str, Vec<::aws_smithy_runtime_api::client::auth::AuthSchemeOption>>,
48}
49
50// TODO(https://github.com/smithy-lang/smithy-rs/issues/4177): Remove `allow(...)` once the issue is addressed.
51// When generating code for tests (e.g., `codegen-client-test`), this manual implementation
52// of the `Default` trait may appear as if it could be derived automatically.
53// However, that is not the case in production.
54#[allow(clippy::derivable_impls)]
55impl Default for DefaultAuthSchemeResolver {
56    fn default() -> Self {
57        Self {
58            service_defaults: vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::builder()
59                .scheme_id(::aws_runtime::auth::sigv4::SCHEME_ID)
60                .build()
61                .expect("required fields set")],
62            operation_overrides: [(
63                "PostContent",
64                vec![::aws_smithy_runtime_api::client::auth::AuthSchemeOption::builder()
65                    .scheme_id(::aws_runtime::auth::sigv4::SCHEME_ID)
66                    .properties({
67                        let mut layer = ::aws_smithy_types::config_bag::Layer::new("PostContentAuthOptionProperties");
68                        layer.store_put(::aws_runtime::auth::PayloadSigningOverride::unsigned_payload());
69                        layer.freeze()
70                    })
71                    .build()
72                    .expect("required fields set")],
73            )]
74            .into(),
75        }
76    }
77}
78
79impl crate::config::auth::ResolveAuthScheme for DefaultAuthSchemeResolver {
80    fn resolve_auth_scheme<'a>(
81        &'a self,
82        params: &'a crate::config::auth::Params,
83        _cfg: &'a ::aws_smithy_types::config_bag::ConfigBag,
84        _runtime_components: &'a ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponents,
85    ) -> ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture<'a> {
86        let operation_name = params.operation_name();
87
88        let modeled_auth_options = match self.operation_overrides.get(operation_name) {
89            Some(overrides) => overrides,
90            None => &self.service_defaults,
91        };
92
93        let _fut = ::aws_smithy_runtime_api::client::auth::AuthSchemeOptionsFuture::ready(Ok(modeled_auth_options.clone()));
94
95        _fut
96    }
97}
98
99/// Configuration parameters for resolving the correct auth scheme
100#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
101pub struct Params {
102    operation_name: ::std::borrow::Cow<'static, str>,
103}
104impl Params {
105    /// Create a builder for [`Params`]
106    pub fn builder() -> crate::config::auth::ParamsBuilder {
107        crate::config::auth::ParamsBuilder::default()
108    }
109
110    /// Return the operation name for [`Params`]
111    pub fn operation_name(&self) -> &str {
112        self.operation_name.as_ref()
113    }
114}
115
116#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
117/// Builder for [`Params`]
118pub struct ParamsBuilder {
119    operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>,
120}
121impl ParamsBuilder {
122    /// Set the operation name for the builder
123    pub fn operation_name(self, operation_name: impl Into<::std::borrow::Cow<'static, str>>) -> Self {
124        self.set_operation_name(::std::option::Option::Some(operation_name.into()))
125    }
126
127    /// Set the operation name for the builder
128    pub fn set_operation_name(mut self, operation_name: ::std::option::Option<::std::borrow::Cow<'static, str>>) -> Self {
129        self.operation_name = operation_name;
130        self
131    }
132    /// Consume this builder, create [`Params`]."
133    ///
134    /// Return [`BuildError`] if any of the required fields are unset.
135    ///
136    pub fn build(self) -> ::std::result::Result<crate::config::auth::Params, crate::config::auth::BuildError> {
137        ::std::result::Result::Ok(crate::config::auth::Params {
138            operation_name: self.operation_name.ok_or_else(|| BuildError::missing("operation_name"))?,
139        })
140    }
141}
142
143/// An error that occurred while constructing `config::auth::Params`
144#[derive(Debug)]
145pub struct BuildError {
146    field: ::std::borrow::Cow<'static, str>,
147}
148
149impl BuildError {
150    fn missing(field: &'static str) -> Self {
151        Self { field: field.into() }
152    }
153}
154
155impl std::fmt::Display for BuildError {
156    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
157        write!(f, "a required field was missing: `{}`", self.field)
158    }
159}
160
161impl std::error::Error for BuildError {}