aws_sdk_workdocs/operation/
get_folder.rs

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

aws_sdk_workdocs/operation/
get_folder.rs
