aws_sdk_workdocs/operation/
get_folder_path.rs

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

aws_sdk_workdocs/operation/
get_folder_path.rs
