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

aws_sdk_workdocs/operation/
describe_root_folders.rs
