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

aws_sdk_workdocs/operation/
get_folder_path.rs
