aws_sdk_workdocs/operation/
get_document_path.rs

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

aws_sdk_workdocs/operation/
get_document_path.rs
