aws_sdk_workdocs/operation/
get_document.rs

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

aws_sdk_workdocs/operation/
get_document.rs
