aws_sdk_workdocs/operation/
describe_root_folders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeRootFolders`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeRootFolders;
6impl DescribeRootFolders {
7    /// Creates a new `DescribeRootFolders`
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_root_folders::DescribeRootFoldersInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_root_folders::DescribeRootFoldersOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_root_folders::DescribeRootFoldersError,
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_root_folders::DescribeRootFoldersError>()
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_root_folders::DescribeRootFoldersOutput>()
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_root_folders::DescribeRootFoldersInput,
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("workdocs", "DescribeRootFolders", input, runtime_plugins, stop_point)
54            .await
55    }
56
57    pub(crate) fn operation_runtime_plugins(
58        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
59        client_config: &crate::config::Config,
60        config_override: ::std::option::Option<crate::config::Builder>,
61    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
62        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
63        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
64            ::aws_runtime::auth::sigv4::SCHEME_ID,
65        ]));
66        if let ::std::option::Option::Some(config_override) = config_override {
67            for plugin in config_override.runtime_plugins.iter().cloned() {
68                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
69            }
70            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
71                config_override,
72                client_config.config.clone(),
73                &client_config.runtime_components,
74            ));
75        }
76        runtime_plugins
77    }
78}
79impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeRootFolders {
80    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeRootFolders");
82
83        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84            DescribeRootFoldersRequestSerializer,
85        ));
86        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87            DescribeRootFoldersResponseDeserializer,
88        ));
89
90        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
95        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
96            "DescribeRootFolders",
97            "workdocs",
98        ));
99        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
100        signing_options.double_uri_encode = true;
101        signing_options.content_sha256_header = false;
102        signing_options.normalize_uri_path = true;
103        signing_options.payload_override = None;
104
105        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
106            signing_options,
107            ..::std::default::Default::default()
108        });
109
110        ::std::option::Option::Some(cfg.freeze())
111    }
112
113    fn runtime_components(
114        &self,
115        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
116    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
117        #[allow(unused_mut)]
118        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeRootFolders")
119            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
120            .with_interceptor(DescribeRootFoldersEndpointParamsInterceptor)
121            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
122                crate::operation::describe_root_folders::DescribeRootFoldersError,
123            >::new())
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
125                crate::operation::describe_root_folders::DescribeRootFoldersError,
126            >::new())
127            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
128                crate::operation::describe_root_folders::DescribeRootFoldersError,
129            >::new());
130
131        ::std::borrow::Cow::Owned(rcb)
132    }
133}
134
135#[derive(Debug)]
136struct DescribeRootFoldersResponseDeserializer;
137impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeRootFoldersResponseDeserializer {
138    fn deserialize_nonstreaming(
139        &self,
140        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
141    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
142        let (success, status) = (response.status().is_success(), response.status().as_u16());
143        let headers = response.headers();
144        let body = response.body().bytes().expect("body loaded");
145        #[allow(unused_mut)]
146        let mut force_error = false;
147        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
148        let parse_result = if !success && status != 200 || force_error {
149            crate::protocol_serde::shape_describe_root_folders::de_describe_root_folders_http_error(status, headers, body)
150        } else {
151            crate::protocol_serde::shape_describe_root_folders::de_describe_root_folders_http_response(status, headers, body)
152        };
153        crate::protocol_serde::type_erase_result(parse_result)
154    }
155}
156#[derive(Debug)]
157struct DescribeRootFoldersRequestSerializer;
158impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeRootFoldersRequestSerializer {
159    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
160    fn serialize_input(
161        &self,
162        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
163        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
164    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
165        let input = input
166            .downcast::<crate::operation::describe_root_folders::DescribeRootFoldersInput>()
167            .expect("correct type");
168        let _header_serialization_settings = _cfg
169            .load::<crate::serialization_settings::HeaderSerializationSettings>()
170            .cloned()
171            .unwrap_or_default();
172        let mut request_builder = {
173            fn uri_base(
174                _input: &crate::operation::describe_root_folders::DescribeRootFoldersInput,
175                output: &mut ::std::string::String,
176            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
177                use ::std::fmt::Write as _;
178                ::std::write!(output, "/api/v1/me/root").expect("formatting should succeed");
179                ::std::result::Result::Ok(())
180            }
181            fn uri_query(
182                _input: &crate::operation::describe_root_folders::DescribeRootFoldersInput,
183                mut output: &mut ::std::string::String,
184            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
185                let mut query = ::aws_smithy_http::query::Writer::new(output);
186                if let ::std::option::Option::Some(inner_1) = &_input.limit {
187                    {
188                        query.push_kv("limit", ::aws_smithy_types::primitive::Encoder::from(*inner_1).encode());
189                    }
190                }
191                if let ::std::option::Option::Some(inner_2) = &_input.marker {
192                    {
193                        query.push_kv("marker", &::aws_smithy_http::query::fmt_string(inner_2));
194                    }
195                }
196                ::std::result::Result::Ok(())
197            }
198            #[allow(clippy::unnecessary_wraps)]
199            fn update_http_builder(
200                input: &crate::operation::describe_root_folders::DescribeRootFoldersInput,
201                builder: ::http::request::Builder,
202            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
203                let mut uri = ::std::string::String::new();
204                uri_base(input, &mut uri)?;
205                uri_query(input, &mut uri)?;
206                let builder = crate::protocol_serde::shape_describe_root_folders::ser_describe_root_folders_headers(input, builder)?;
207                ::std::result::Result::Ok(builder.method("GET").uri(uri))
208            }
209            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
210            builder
211        };
212        let body = ::aws_smithy_types::body::SdkBody::from("");
213
214        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
215    }
216}
217#[derive(Debug)]
218struct DescribeRootFoldersEndpointParamsInterceptor;
219
220impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeRootFoldersEndpointParamsInterceptor {
221    fn name(&self) -> &'static str {
222        "DescribeRootFoldersEndpointParamsInterceptor"
223    }
224
225    fn read_before_execution(
226        &self,
227        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
228            '_,
229            ::aws_smithy_runtime_api::client::interceptors::context::Input,
230            ::aws_smithy_runtime_api::client::interceptors::context::Output,
231            ::aws_smithy_runtime_api::client::interceptors::context::Error,
232        >,
233        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
234    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
235        let _input = context
236            .input()
237            .downcast_ref::<DescribeRootFoldersInput>()
238            .ok_or("failed to downcast to DescribeRootFoldersInput")?;
239
240        let params = crate::config::endpoint::Params::builder()
241            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
242            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
243            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
244            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
245            .build()
246            .map_err(|err| {
247                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
248            })?;
249        cfg.interceptor_state()
250            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
251        ::std::result::Result::Ok(())
252    }
253}
254
255// The get_* functions below are generated from JMESPath expressions in the
256// operationContextParams trait. They target the operation's input shape.
257
258/// Error type for the `DescribeRootFoldersError` operation.
259#[non_exhaustive]
260#[derive(::std::fmt::Debug)]
261pub enum DescribeRootFoldersError {
262    /// <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
263    FailedDependencyException(crate::types::error::FailedDependencyException),
264    /// <p>The pagination marker or limit fields are not valid.</p>
265    InvalidArgumentException(crate::types::error::InvalidArgumentException),
266    /// <p>One or more of the dependencies is unavailable.</p>
267    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
268    /// <p>The operation is not permitted.</p>
269    UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
270    /// <p>The caller does not have access to perform the action on the resource.</p>
271    UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
272    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
273    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
274    variable wildcard pattern and check `.code()`:
275     \
276    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
277     \
278    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeRootFoldersError) for what information is available for the error.")]
279    Unhandled(crate::error::sealed_unhandled::Unhandled),
280}
281impl DescribeRootFoldersError {
282    /// Creates the `DescribeRootFoldersError::Unhandled` variant from any error type.
283    pub fn unhandled(
284        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
285    ) -> Self {
286        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
287            source: err.into(),
288            meta: ::std::default::Default::default(),
289        })
290    }
291
292    /// Creates the `DescribeRootFoldersError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
293    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
294        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
295            source: err.clone().into(),
296            meta: err,
297        })
298    }
299    ///
300    /// Returns error metadata, which includes the error code, message,
301    /// request ID, and potentially additional information.
302    ///
303    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
304        match self {
305            Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::InvalidArgumentException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::Unhandled(e) => &e.meta,
311        }
312    }
313    /// Returns `true` if the error kind is `DescribeRootFoldersError::FailedDependencyException`.
314    pub fn is_failed_dependency_exception(&self) -> bool {
315        matches!(self, Self::FailedDependencyException(_))
316    }
317    /// Returns `true` if the error kind is `DescribeRootFoldersError::InvalidArgumentException`.
318    pub fn is_invalid_argument_exception(&self) -> bool {
319        matches!(self, Self::InvalidArgumentException(_))
320    }
321    /// Returns `true` if the error kind is `DescribeRootFoldersError::ServiceUnavailableException`.
322    pub fn is_service_unavailable_exception(&self) -> bool {
323        matches!(self, Self::ServiceUnavailableException(_))
324    }
325    /// Returns `true` if the error kind is `DescribeRootFoldersError::UnauthorizedOperationException`.
326    pub fn is_unauthorized_operation_exception(&self) -> bool {
327        matches!(self, Self::UnauthorizedOperationException(_))
328    }
329    /// Returns `true` if the error kind is `DescribeRootFoldersError::UnauthorizedResourceAccessException`.
330    pub fn is_unauthorized_resource_access_exception(&self) -> bool {
331        matches!(self, Self::UnauthorizedResourceAccessException(_))
332    }
333}
334impl ::std::error::Error for DescribeRootFoldersError {
335    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
336        match self {
337            Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
338            Self::InvalidArgumentException(_inner) => ::std::option::Option::Some(_inner),
339            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
340            Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
341            Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
342            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
343        }
344    }
345}
346impl ::std::fmt::Display for DescribeRootFoldersError {
347    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
348        match self {
349            Self::FailedDependencyException(_inner) => _inner.fmt(f),
350            Self::InvalidArgumentException(_inner) => _inner.fmt(f),
351            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
352            Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
353            Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
354            Self::Unhandled(_inner) => {
355                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
356                    write!(f, "unhandled error ({code})")
357                } else {
358                    f.write_str("unhandled error")
359                }
360            }
361        }
362    }
363}
364impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeRootFoldersError {
365    fn code(&self) -> ::std::option::Option<&str> {
366        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
367    }
368    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
369        ::std::option::Option::None
370    }
371}
372impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeRootFoldersError {
373    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
374        match self {
375            Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
376            Self::InvalidArgumentException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
378            Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
379            Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
380            Self::Unhandled(_inner) => &_inner.meta,
381        }
382    }
383}
384impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeRootFoldersError {
385    fn create_unhandled_error(
386        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
387        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
388    ) -> Self {
389        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
390            source,
391            meta: meta.unwrap_or_default(),
392        })
393    }
394}
395impl ::aws_types::request_id::RequestId for crate::operation::describe_root_folders::DescribeRootFoldersError {
396    fn request_id(&self) -> Option<&str> {
397        self.meta().request_id()
398    }
399}
400
401pub use crate::operation::describe_root_folders::_describe_root_folders_output::DescribeRootFoldersOutput;
402
403pub use crate::operation::describe_root_folders::_describe_root_folders_input::DescribeRootFoldersInput;
404
405mod _describe_root_folders_input;
406
407mod _describe_root_folders_output;
408
409/// Builders
410pub mod builders;
411
412/// Paginator for this operation
413pub mod paginator;
aws_sdk_workdocs/operation/describe_root_folders.rs

aws_sdk_workdocs/operation/
describe_root_folders.rs
