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

aws_sdk_workdocs/operation/
get_folder_path.rs
