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

aws_sdk_workdocs/operation/
get_folder_path.rs
