aws_sdk_workmail/operation/
describe_user.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeUser`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeUser;
6impl DescribeUser {
7    /// Creates a new `DescribeUser`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::describe_user::DescribeUserInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_user::DescribeUserOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_user::DescribeUserError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::describe_user::DescribeUserError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::describe_user::DescribeUserOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::describe_user::DescribeUserInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("workmail", "DescribeUser", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeUser {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeUser");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            DescribeUserRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            DescribeUserResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
94        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DescribeUser", "workmail"));
95        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
96        signing_options.double_uri_encode = true;
97        signing_options.content_sha256_header = false;
98        signing_options.normalize_uri_path = true;
99        signing_options.payload_override = None;
100
101        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
102            signing_options,
103            ..::std::default::Default::default()
104        });
105
106        ::std::option::Option::Some(cfg.freeze())
107    }
108
109    fn runtime_components(
110        &self,
111        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
112    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
113        #[allow(unused_mut)]
114        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeUser")
115            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
116            .with_interceptor(DescribeUserEndpointParamsInterceptor)
117            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
118                crate::operation::describe_user::DescribeUserError,
119            >::new())
120            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
121                crate::operation::describe_user::DescribeUserError,
122            >::new())
123            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
124                crate::operation::describe_user::DescribeUserError,
125            >::new());
126
127        ::std::borrow::Cow::Owned(rcb)
128    }
129}
130
131#[derive(Debug)]
132struct DescribeUserResponseDeserializer;
133impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeUserResponseDeserializer {
134    fn deserialize_nonstreaming(
135        &self,
136        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
137    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
138        let (success, status) = (response.status().is_success(), response.status().as_u16());
139        let headers = response.headers();
140        let body = response.body().bytes().expect("body loaded");
141        #[allow(unused_mut)]
142        let mut force_error = false;
143        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
144        let parse_result = if !success && status != 200 || force_error {
145            crate::protocol_serde::shape_describe_user::de_describe_user_http_error(status, headers, body)
146        } else {
147            crate::protocol_serde::shape_describe_user::de_describe_user_http_response(status, headers, body)
148        };
149        crate::protocol_serde::type_erase_result(parse_result)
150    }
151}
152#[derive(Debug)]
153struct DescribeUserRequestSerializer;
154impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeUserRequestSerializer {
155    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
156    fn serialize_input(
157        &self,
158        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
159        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
160    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
161        let input = input
162            .downcast::<crate::operation::describe_user::DescribeUserInput>()
163            .expect("correct type");
164        let _header_serialization_settings = _cfg
165            .load::<crate::serialization_settings::HeaderSerializationSettings>()
166            .cloned()
167            .unwrap_or_default();
168        let mut request_builder = {
169            fn uri_base(
170                _input: &crate::operation::describe_user::DescribeUserInput,
171                output: &mut ::std::string::String,
172            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
173                use ::std::fmt::Write as _;
174                ::std::write!(output, "/").expect("formatting should succeed");
175                ::std::result::Result::Ok(())
176            }
177            #[allow(clippy::unnecessary_wraps)]
178            fn update_http_builder(
179                input: &crate::operation::describe_user::DescribeUserInput,
180                builder: ::http::request::Builder,
181            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
182                let mut uri = ::std::string::String::new();
183                uri_base(input, &mut uri)?;
184                ::std::result::Result::Ok(builder.method("POST").uri(uri))
185            }
186            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
187            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
188            builder = _header_serialization_settings.set_default_header(
189                builder,
190                ::http::header::HeaderName::from_static("x-amz-target"),
191                "WorkMailService.DescribeUser",
192            );
193            builder
194        };
195        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_user::ser_describe_user_input(&input)?);
196        if let Some(content_length) = body.content_length() {
197            let content_length = content_length.to_string();
198            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
199        }
200        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
201    }
202}
203#[derive(Debug)]
204struct DescribeUserEndpointParamsInterceptor;
205
206impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeUserEndpointParamsInterceptor {
207    fn name(&self) -> &'static str {
208        "DescribeUserEndpointParamsInterceptor"
209    }
210
211    fn read_before_execution(
212        &self,
213        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
214            '_,
215            ::aws_smithy_runtime_api::client::interceptors::context::Input,
216            ::aws_smithy_runtime_api::client::interceptors::context::Output,
217            ::aws_smithy_runtime_api::client::interceptors::context::Error,
218        >,
219        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
220    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
221        let _input = context
222            .input()
223            .downcast_ref::<DescribeUserInput>()
224            .ok_or("failed to downcast to DescribeUserInput")?;
225
226        let params = crate::config::endpoint::Params::builder()
227            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
228            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
229            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
230            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
231            .build()
232            .map_err(|err| {
233                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
234            })?;
235        cfg.interceptor_state()
236            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
237        ::std::result::Result::Ok(())
238    }
239}
240
241// The get_* functions below are generated from JMESPath expressions in the
242// operationContextParams trait. They target the operation's input shape.
243
244/// Error type for the `DescribeUserError` operation.
245#[non_exhaustive]
246#[derive(::std::fmt::Debug)]
247pub enum DescribeUserError {
248    /// <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
249    DirectoryServiceAuthenticationFailedException(crate::types::error::DirectoryServiceAuthenticationFailedException),
250    /// <p>The directory is unavailable. It might be located in another Region or deleted.</p>
251    DirectoryUnavailableException(crate::types::error::DirectoryUnavailableException),
252    /// <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
253    EntityNotFoundException(crate::types::error::EntityNotFoundException),
254    /// <p>One or more of the input parameters don't match the service's restrictions.</p>
255    InvalidParameterException(crate::types::error::InvalidParameterException),
256    /// <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
257    OrganizationNotFoundException(crate::types::error::OrganizationNotFoundException),
258    /// <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
259    OrganizationStateException(crate::types::error::OrganizationStateException),
260    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
261    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
262    variable wildcard pattern and check `.code()`:
263     \
264    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
265     \
266    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeUserError) for what information is available for the error.")]
267    Unhandled(crate::error::sealed_unhandled::Unhandled),
268}
269impl DescribeUserError {
270    /// Creates the `DescribeUserError::Unhandled` variant from any error type.
271    pub fn unhandled(
272        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
273    ) -> Self {
274        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
275            source: err.into(),
276            meta: ::std::default::Default::default(),
277        })
278    }
279
280    /// Creates the `DescribeUserError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
281    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
282        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
283            source: err.clone().into(),
284            meta: err,
285        })
286    }
287    ///
288    /// Returns error metadata, which includes the error code, message,
289    /// request ID, and potentially additional information.
290    ///
291    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
292        match self {
293            Self::DirectoryServiceAuthenticationFailedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
294            Self::DirectoryUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
295            Self::EntityNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::OrganizationNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
298            Self::OrganizationStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::Unhandled(e) => &e.meta,
300        }
301    }
302    /// Returns `true` if the error kind is `DescribeUserError::DirectoryServiceAuthenticationFailedException`.
303    pub fn is_directory_service_authentication_failed_exception(&self) -> bool {
304        matches!(self, Self::DirectoryServiceAuthenticationFailedException(_))
305    }
306    /// Returns `true` if the error kind is `DescribeUserError::DirectoryUnavailableException`.
307    pub fn is_directory_unavailable_exception(&self) -> bool {
308        matches!(self, Self::DirectoryUnavailableException(_))
309    }
310    /// Returns `true` if the error kind is `DescribeUserError::EntityNotFoundException`.
311    pub fn is_entity_not_found_exception(&self) -> bool {
312        matches!(self, Self::EntityNotFoundException(_))
313    }
314    /// Returns `true` if the error kind is `DescribeUserError::InvalidParameterException`.
315    pub fn is_invalid_parameter_exception(&self) -> bool {
316        matches!(self, Self::InvalidParameterException(_))
317    }
318    /// Returns `true` if the error kind is `DescribeUserError::OrganizationNotFoundException`.
319    pub fn is_organization_not_found_exception(&self) -> bool {
320        matches!(self, Self::OrganizationNotFoundException(_))
321    }
322    /// Returns `true` if the error kind is `DescribeUserError::OrganizationStateException`.
323    pub fn is_organization_state_exception(&self) -> bool {
324        matches!(self, Self::OrganizationStateException(_))
325    }
326}
327impl ::std::error::Error for DescribeUserError {
328    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
329        match self {
330            Self::DirectoryServiceAuthenticationFailedException(_inner) => ::std::option::Option::Some(_inner),
331            Self::DirectoryUnavailableException(_inner) => ::std::option::Option::Some(_inner),
332            Self::EntityNotFoundException(_inner) => ::std::option::Option::Some(_inner),
333            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
334            Self::OrganizationNotFoundException(_inner) => ::std::option::Option::Some(_inner),
335            Self::OrganizationStateException(_inner) => ::std::option::Option::Some(_inner),
336            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
337        }
338    }
339}
340impl ::std::fmt::Display for DescribeUserError {
341    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
342        match self {
343            Self::DirectoryServiceAuthenticationFailedException(_inner) => _inner.fmt(f),
344            Self::DirectoryUnavailableException(_inner) => _inner.fmt(f),
345            Self::EntityNotFoundException(_inner) => _inner.fmt(f),
346            Self::InvalidParameterException(_inner) => _inner.fmt(f),
347            Self::OrganizationNotFoundException(_inner) => _inner.fmt(f),
348            Self::OrganizationStateException(_inner) => _inner.fmt(f),
349            Self::Unhandled(_inner) => {
350                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
351                    write!(f, "unhandled error ({code})")
352                } else {
353                    f.write_str("unhandled error")
354                }
355            }
356        }
357    }
358}
359impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeUserError {
360    fn code(&self) -> ::std::option::Option<&str> {
361        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
362    }
363    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
364        ::std::option::Option::None
365    }
366}
367impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeUserError {
368    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
369        match self {
370            Self::DirectoryServiceAuthenticationFailedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
371            Self::DirectoryUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::EntityNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
374            Self::OrganizationNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
375            Self::OrganizationStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
376            Self::Unhandled(_inner) => &_inner.meta,
377        }
378    }
379}
380impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeUserError {
381    fn create_unhandled_error(
382        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
383        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
384    ) -> Self {
385        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
386            source,
387            meta: meta.unwrap_or_default(),
388        })
389    }
390}
391impl ::aws_types::request_id::RequestId for crate::operation::describe_user::DescribeUserError {
392    fn request_id(&self) -> Option<&str> {
393        self.meta().request_id()
394    }
395}
396
397pub use crate::operation::describe_user::_describe_user_output::DescribeUserOutput;
398
399pub use crate::operation::describe_user::_describe_user_input::DescribeUserInput;
400
401mod _describe_user_input;
402
403mod _describe_user_output;
404
405/// Builders
406pub mod builders;